Whamcloud - gitweb
fdb2ecd1395f42053dfec763ad209506a2d76fe8
[fs/lustre-release.git] / lustre / include / obd.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef __OBD_H
34 #define __OBD_H
35
36 #include <linux/kobject.h>
37 #include <linux/spinlock.h>
38 #include <linux/sysfs.h>
39
40 #include <uapi/linux/lustre/lustre_idl.h>
41 #include <lustre_lib.h>
42 #include <libcfs/bitmap.h>
43 #ifdef HAVE_SERVER_SUPPORT
44 # include <lu_target.h>
45 # include <obd_target.h>
46 #endif
47 #include <lu_ref.h>
48 #include <lustre_export.h>
49 #include <lustre_fid.h>
50 #include <lustre_fld.h>
51 #include <lustre_handles.h>
52 #include <lustre_intent.h>
53 #include <lvfs.h>
54 #include <lustre_quota.h>
55
56 #define MAX_OBD_DEVICES 8192
57
58 struct osc_async_rc {
59         int     ar_rc;
60         int     ar_force_sync;
61         __u64   ar_min_xid;
62 };
63
64 struct lov_oinfo {                 /* per-stripe data structure */
65         struct ost_id   loi_oi;    /* object ID/Sequence on the target OST */
66         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
67         int loi_ost_gen;           /* generation of this loi_ost_idx */
68
69         unsigned long loi_kms_valid:1;
70         __u64 loi_kms;             /* known minimum size */
71         struct ost_lvb loi_lvb;
72         struct osc_async_rc     loi_ar;
73 };
74
75 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
76 {
77         oinfo->loi_kms = kms;
78         oinfo->loi_kms_valid = 1;
79 }
80
81 struct lov_stripe_md;
82 struct obd_info;
83
84 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
85
86 /* obd info for a particular level (lov, osc). */
87 struct obd_info {
88         /* OBD_STATFS_* flags */
89         __u64                   oi_flags;
90         /* statfs data specific for every OSC, if needed at all. */
91         struct obd_statfs      *oi_osfs;
92         /* An update callback which is called to update some data on upper
93          * level. E.g. it is used for update lsm->lsm_oinfo at every received
94          * request in osc level for enqueue requests. It is also possible to
95          * update some caller data from LOV layer if needed. */
96         obd_enqueue_update_f    oi_cb_up;
97 };
98
99 struct obd_type {
100         struct list_head         typ_chain;
101         struct obd_ops          *typ_dt_ops;
102         struct md_ops           *typ_md_ops;
103         struct proc_dir_entry   *typ_procroot;
104         struct proc_dir_entry   *typ_procsym;
105         struct dentry           *typ_debugfs_entry;
106 #ifdef HAVE_SERVER_SUPPORT
107         bool                     typ_sym_filter;
108 #endif
109         char                    *typ_name;
110         int                      typ_refcnt;
111         struct lu_device_type   *typ_lu;
112         spinlock_t               obd_type_lock;
113         struct kobject           typ_kobj;
114 };
115
116 struct brw_page {
117         u64              off;
118         struct page     *pg;
119         u32              count;
120         u32              flag;
121 };
122
123 struct timeout_item {
124         enum timeout_event ti_event;
125         time64_t           ti_timeout;
126         timeout_cb_t       ti_cb;
127         void              *ti_cb_data;
128         struct list_head   ti_obd_list;
129         struct list_head   ti_chain;
130 };
131
132 #define OBD_MAX_RIF_DEFAULT     8
133 #define OBD_MAX_RIF_MAX         512
134 #define OSC_MAX_RIF_MAX         256
135 #define OSC_MAX_DIRTY_DEFAULT   2000     /* Arbitrary large value */
136 #define OSC_MAX_DIRTY_MB_MAX    2048     /* arbitrary, but < MAX_LONG bytes */
137 #define OSC_DEFAULT_RESENDS     10
138
139 /* possible values for fo_sync_lock_cancel */
140 enum {
141         NEVER_SYNC_ON_CANCEL = 0,
142         BLOCKING_SYNC_ON_CANCEL = 1,
143         ALWAYS_SYNC_ON_CANCEL = 2,
144         NUM_SYNC_ON_CANCEL_STATES
145 };
146
147 /*
148  * Limit reply buffer size for striping data to one x86_64 page. This
149  * value is chosen to fit the striping data for common use cases while
150  * staying well below the limit at which the buffer must be backed by
151  * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
152  * on the MDS.
153  */
154 #define OBD_MAX_DEFAULT_EA_SIZE 4096
155
156 /*
157  * Lustre can handle larger xattrs internally, but we must respect the Linux
158  * VFS limitation or tools like tar cannot interact with Lustre volumes
159  * correctly.
160  */
161 #define OBD_MAX_EA_SIZE         XATTR_SIZE_MAX
162
163
164 enum obd_cl_sem_lock_class {
165         OBD_CLI_SEM_NORMAL,
166         OBD_CLI_SEM_MGC,
167         OBD_CLI_SEM_MDCOSC,
168 };
169
170 struct mdc_rpc_lock;
171 struct obd_import;
172 struct client_obd {
173         struct rw_semaphore      cl_sem;
174         struct obd_uuid          cl_target_uuid;
175         struct obd_import       *cl_import; /* ptlrpc connection state */
176         size_t                   cl_conn_count;
177
178         /* Cache maximum and default values for easize. This is
179          * strictly a performance optimization to minimize calls to
180          * obd_size_diskmd(). The default values are used to calculate the
181          * initial size of a request buffer. The ptlrpc layer will resize the
182          * buffer as needed to accommodate a larger reply from the
183          * server. The default values should be small enough to avoid wasted
184          * memory and excessive use of vmalloc(), yet large enough to avoid
185          * reallocating the buffer in the common use case. */
186
187         /* Default EA size for striping attributes. It is initialized at
188          * mount-time based on the default stripe width of the filesystem,
189          * then it tracks the largest observed EA size advertised by
190          * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
191         __u32                    cl_default_mds_easize;
192
193         /* Maximum possible EA size computed at mount-time based on
194          * the number of OSTs in the filesystem. May be increased at
195          * run-time if a larger observed size is advertised by the MDT. */
196         __u32                    cl_max_mds_easize;
197
198         /* Data-on-MDT specific value to set larger reply buffer for possible
199          * data read along with open/stat requests. By default it tries to use
200          * unused space in reply buffer.
201          * This value is used to ensure that reply buffer has at least as
202          * much free space as value indicates. That free space is gained from
203          * LOV EA buffer which is small for DoM files and on big systems can
204          * provide up to 32KB of extra space in reply buffer.
205          * Default value is 8K now.
206          */
207         __u32                    cl_dom_min_inline_repsize;
208
209         enum lustre_sec_part     cl_sp_me;
210         enum lustre_sec_part     cl_sp_to;
211         struct sptlrpc_flavor    cl_flvr_mgc; /* fixed flavor of mgc->mgs */
212
213         /* the grant values are protected by loi_list_lock below */
214         unsigned long            cl_dirty_pages;      /* all _dirty_ in pages */
215         unsigned long            cl_dirty_max_pages;  /* allowed w/o rpc */
216         unsigned long            cl_dirty_transit;    /* dirty synchronous */
217         unsigned long            cl_avail_grant;   /* bytes of credit for ost */
218         unsigned long            cl_lost_grant;    /* lost credits (trunc) */
219         /* grant consumed for dirty pages */
220         unsigned long            cl_dirty_grant;
221
222         /* since we allocate grant by blocks, we don't know how many grant will
223          * be used to add a page into cache. As a solution, we reserve maximum
224          * grant before trying to dirty a page and unreserve the rest.
225          * See osc_{reserve|unreserve}_grant for details. */
226         long                    cl_reserved_grant;
227         struct list_head        cl_cache_waiters; /* waiting for cache/grant */
228         time64_t                cl_next_shrink_grant;   /* seconds */
229         struct list_head        cl_grant_chain;
230         time64_t                cl_grant_shrink_interval; /* seconds */
231
232         /* A chunk is an optimal size used by osc_extent to determine
233          * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
234         int                     cl_chunkbits;
235         /* extent insertion metadata overhead to be accounted in grant,
236          * in bytes */
237         unsigned int            cl_grant_extent_tax;
238         /* maximum extent size, in number of pages */
239         unsigned int            cl_max_extent_pages;
240
241         /* keep track of objects that have lois that contain pages which
242          * have been queued for async brw.  this lock also protects the
243          * lists of osc_client_pages that hang off of the loi */
244         /*
245          * ->cl_loi_list_lock protects consistency of
246          * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
247          * ->ap_completion() call-backs are executed under this lock. As we
248          * cannot guarantee that these call-backs never block on all platforms
249          * (as a matter of fact they do block on Mac OS X), type of
250          * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
251          * and blocking mutex on Mac OS X. (Alternative is to make this lock
252          * blocking everywhere, but we don't want to slow down fast-path of
253          * our main platform.)
254          *
255          * NB by Jinshan: though field names are still _loi_, but actually
256          * osc_object{}s are in the list.
257          */
258         spinlock_t              cl_loi_list_lock;
259         struct list_head        cl_loi_ready_list;
260         struct list_head        cl_loi_hp_ready_list;
261         struct list_head        cl_loi_write_list;
262         struct list_head        cl_loi_read_list;
263         __u32                   cl_r_in_flight;
264         __u32                   cl_w_in_flight;
265         /* just a sum of the loi/lop pending numbers to be exported by /proc */
266         atomic_t                cl_pending_w_pages;
267         atomic_t                cl_pending_r_pages;
268         u32                     cl_max_pages_per_rpc;
269         u32                     cl_max_rpcs_in_flight;
270         u32                     cl_max_short_io_bytes;
271         struct obd_histogram    cl_read_rpc_hist;
272         struct obd_histogram    cl_write_rpc_hist;
273         struct obd_histogram    cl_read_page_hist;
274         struct obd_histogram    cl_write_page_hist;
275         struct obd_histogram    cl_read_offset_hist;
276         struct obd_histogram    cl_write_offset_hist;
277
278         /** LRU for osc caching pages */
279         struct cl_client_cache  *cl_cache;
280         /** member of cl_cache->ccc_lru */
281         struct list_head         cl_lru_osc;
282         /** # of available LRU slots left in the per-OSC cache.
283          * Available LRU slots are shared by all OSCs of the same file system,
284          * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
285         atomic_long_t           *cl_lru_left;
286         /** # of busy LRU pages. A page is considered busy if it's in writeback
287          * queue, or in transfer. Busy pages can't be discarded so they are not
288          * in LRU cache. */
289         atomic_long_t            cl_lru_busy;
290         /** # of LRU pages in the cache for this client_obd */
291         atomic_long_t            cl_lru_in_list;
292         /** # of threads are shrinking LRU cache. To avoid contention, it's not
293          * allowed to have multiple threads shrinking LRU cache. */
294         atomic_t                 cl_lru_shrinkers;
295         /** The time when this LRU cache was last used. */
296         time64_t                 cl_lru_last_used;
297         /** stats: how many reclaims have happened for this client_obd.
298          * reclaim and shrink - shrink is async, voluntarily rebalancing;
299          * reclaim is sync, initiated by IO thread when the LRU slots are
300          * in shortage. */
301         __u64                    cl_lru_reclaim;
302         /** List of LRU pages for this client_obd */
303         struct list_head         cl_lru_list;
304         /** Lock for LRU page list */
305         spinlock_t               cl_lru_list_lock;
306         /** # of unstable pages in this client_obd.
307          * An unstable page is a page state that WRITE RPC has finished but
308          * the transaction has NOT yet committed. */
309         atomic_long_t            cl_unstable_count;
310         /** Link to osc_shrinker_list */
311         struct list_head         cl_shrink_list;
312
313         /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
314         atomic_t                 cl_destroy_in_flight;
315         wait_queue_head_t        cl_destroy_waitq;
316
317         /* modify rpcs in flight
318          * currently used for metadata only */
319         spinlock_t               cl_mod_rpcs_lock;
320         __u16                    cl_max_mod_rpcs_in_flight;
321         __u16                    cl_mod_rpcs_in_flight;
322         __u16                    cl_close_rpcs_in_flight;
323         wait_queue_head_t        cl_mod_rpcs_waitq;
324         unsigned long           *cl_mod_tag_bitmap;
325         struct obd_histogram     cl_mod_rpcs_hist;
326
327         /* mgc datastruct */
328         struct mutex              cl_mgc_mutex;
329         struct local_oid_storage *cl_mgc_los;
330         struct dt_object         *cl_mgc_configs_dir;
331         struct obd_export        *cl_mgc_mgsexp;
332         atomic_t                  cl_mgc_refcount;
333         /* in-flight control list and total RPCs counter */
334         struct list_head         cl_flight_waiters;
335         __u32                    cl_rpcs_in_flight;
336
337         /* checksumming for data sent over the network */
338         unsigned int             cl_checksum:1, /* 0 = disabled, 1 = enabled */
339                                  cl_checksum_dump:1; /* same */
340         /* supported checksum types that are worked out at connect time */
341         __u32                    cl_supp_cksum_types;
342         /* checksum algorithm to be used */
343         enum cksum_types         cl_cksum_type;
344
345         /* also protected by the poorly named _loi_list_lock lock above */
346         struct osc_async_rc      cl_ar;
347
348         /* sequence manager */
349         struct lu_client_seq    *cl_seq;
350         struct rw_semaphore      cl_seq_rwsem;
351
352         atomic_t                 cl_resends; /* resend count */
353
354         /* ptlrpc work for writeback in ptlrpcd context */
355         void                    *cl_writeback_work;
356         void                    *cl_lru_work;
357         struct mutex              cl_quota_mutex;
358         /* hash tables for osc_quota_info */
359         struct cfs_hash         *cl_quota_hash[LL_MAXQUOTAS];
360         /* the xid of the request updating the hash tables */
361         __u64                    cl_quota_last_xid;
362         /* Links to the global list of registered changelog devices */
363         struct list_head         cl_chg_dev_linkage;
364 };
365 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
366
367 struct obd_id_info {
368         u32      idx;
369         u64     *data;
370 };
371
372 struct echo_client_obd {
373         struct obd_export      *ec_exp; /* the local connection to osc/lov */
374         spinlock_t              ec_lock;
375         struct list_head        ec_objects;
376         struct list_head        ec_locks;
377         __u64                   ec_unique;
378 };
379
380 /* Generic subset of OSTs */
381 struct ost_pool {
382         __u32              *op_array;      /* array of index of
383                                                    lov_obd->lov_tgts */
384         unsigned int        op_count;      /* number of OSTs in the array */
385         unsigned int        op_size;       /* allocated size of lp_array */
386         struct rw_semaphore op_rw_sem;     /* to protect ost_pool use */
387 };
388
389 /* allow statfs data caching for 1 second */
390 #define OBD_STATFS_CACHE_SECONDS 1
391
392 struct lov_tgt_desc {
393         struct list_head    ltd_kill;
394         struct obd_uuid     ltd_uuid;
395         struct obd_device  *ltd_obd;
396         struct obd_export  *ltd_exp;
397         __u32               ltd_gen;
398         __u32               ltd_index;   /* index in lov_obd->tgts */
399         unsigned long       ltd_active:1,/* is this target up for requests */
400                             ltd_activate:1,/* should  target be activated */
401                             ltd_reap:1;  /* should this target be deleted */
402 };
403
404 struct lov_md_tgt_desc {
405         struct obd_device *lmtd_mdc;
406         __u32              lmtd_index;
407 };
408
409 struct lov_obd {
410         struct lov_desc         desc;
411         struct lov_tgt_desc   **lov_tgts;               /* sparse array */
412         struct ost_pool         lov_packed;             /* all OSTs in a packed
413                                                            array */
414         struct mutex            lov_lock;
415         struct obd_connect_data lov_ocd;
416         struct proc_dir_entry  *targets_proc_entry;
417         atomic_t                lov_refcount;
418         __u32                   lov_death_row;  /* tgts scheduled to be deleted */
419         __u32                   lov_tgt_size;   /* size of tgts array */
420         int                     lov_connects;
421         int                     lov_pool_count;
422         struct cfs_hash        *lov_pools_hash_body; /* used for key access */
423         struct list_head        lov_pool_list;  /* used for sequential access */
424         struct proc_dir_entry  *lov_pool_proc_entry;
425         enum lustre_sec_part    lov_sp_me;
426
427         /* Cached LRU and unstable data from upper layer */
428         struct cl_client_cache *lov_cache;
429
430         struct rw_semaphore     lov_notify_lock;
431         /* Data-on-MDT: MDC array */
432         struct lov_md_tgt_desc  *lov_mdc_tgts;
433
434         struct kobject          *lov_tgts_kobj;
435 };
436
437 struct lmv_tgt_desc {
438         struct obd_uuid         ltd_uuid;
439         struct obd_device       *ltd_obd;
440         struct obd_export       *ltd_exp;
441         __u32                   ltd_idx;
442         struct mutex            ltd_fid_mutex;
443         unsigned long           ltd_active:1; /* target up for requests */
444 };
445
446 struct lmv_obd {
447         struct lu_client_fld    lmv_fld;
448         spinlock_t              lmv_lock;
449         struct lmv_desc         desc;
450
451         struct mutex            lmv_init_mutex;
452         int                     connected;
453         int                     max_easize;
454         int                     max_def_easize;
455         u32                     lmv_statfs_start;
456
457         u32                     tgts_size; /* size of tgts array */
458         struct lmv_tgt_desc     **tgts;
459
460         struct obd_connect_data conn_data;
461         struct kobject          *lmv_tgts_kobj;
462         void                    *lmv_cache;
463 };
464
465 /* Minimum sector size is 512 */
466 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
467
468 struct niobuf_local {
469         __u64           lnb_file_offset;
470         __u32           lnb_page_offset;
471         __u32           lnb_len;
472         __u32           lnb_flags;
473         int             lnb_rc;
474         struct page     *lnb_page;
475         void            *lnb_data;
476         __u16           lnb_guards[MAX_GUARD_NUMBER];
477         __u16           lnb_guard_rpc:1;
478         __u16           lnb_guard_disk:1;
479 };
480
481 struct tgt_thread_big_cache {
482         struct niobuf_local     local[PTLRPC_MAX_BRW_PAGES];
483 };
484
485 #define LUSTRE_FLD_NAME         "fld"
486 #define LUSTRE_SEQ_NAME         "seq"
487
488 #define LUSTRE_MDD_NAME         "mdd"
489 #define LUSTRE_OSD_LDISKFS_NAME "osd-ldiskfs"
490 #define LUSTRE_OSD_ZFS_NAME     "osd-zfs"
491 #define LUSTRE_VVP_NAME         "vvp"
492 #define LUSTRE_LMV_NAME         "lmv"
493 #define LUSTRE_SLP_NAME         "slp"
494 #define LUSTRE_LOD_NAME         "lod"
495 #define LUSTRE_OSP_NAME         "osp"
496 #define LUSTRE_LWP_NAME         "lwp"
497
498 /* obd device type names */
499  /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
500 #define LUSTRE_MDS_NAME         "mds"
501 #define LUSTRE_MDT_NAME         "mdt"
502 #define LUSTRE_MDC_NAME         "mdc"
503 #define LUSTRE_OSS_NAME         "ost"       /* FIXME change name to oss */
504 #define LUSTRE_OST_NAME         "obdfilter" /* FIXME change name to ost */
505 #define LUSTRE_OSC_NAME         "osc"
506 #define LUSTRE_LOV_NAME         "lov"
507 #define LUSTRE_MGS_NAME         "mgs"
508 #define LUSTRE_MGC_NAME         "mgc"
509
510 #define LUSTRE_ECHO_NAME        "obdecho"
511 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
512 #define LUSTRE_QMT_NAME         "qmt"
513
514 /* Constant obd names (post-rename) */
515 #define LUSTRE_MDS_OBDNAME "MDS"
516 #define LUSTRE_OSS_OBDNAME "OSS"
517 #define LUSTRE_MGS_OBDNAME "MGS"
518 #define LUSTRE_MGC_OBDNAME "MGC"
519
520 static inline int is_lwp_on_mdt(char *name)
521 {
522         char   *ptr;
523
524         ptr = strrchr(name, '-');
525         if (ptr == NULL) {
526                 CERROR("%s is not a obdname\n", name);
527                 return 0;
528         }
529
530         /* LWP name on MDT is fsname-MDTxxxx-lwp-MDTxxxx */
531
532         if (strncmp(ptr + 1, "MDT", 3) != 0)
533                 return 0;
534
535         while (*(--ptr) != '-' && ptr != name);
536
537         if (ptr == name)
538                 return 0;
539
540         if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
541                 return 0;
542
543         return 1;
544 }
545
546 static inline int is_lwp_on_ost(char *name)
547 {
548         char   *ptr;
549
550         ptr = strrchr(name, '-');
551         if (ptr == NULL) {
552                 CERROR("%s is not a obdname\n", name);
553                 return 0;
554         }
555
556         /* LWP name on OST is fsname-MDTxxxx-lwp-OSTxxxx */
557
558         if (strncmp(ptr + 1, "OST", 3) != 0)
559                 return 0;
560
561         while (*(--ptr) != '-' && ptr != name);
562
563         if (ptr == name)
564                 return 0;
565
566         if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
567                 return 0;
568
569         return 1;
570 }
571
572 /*
573  * Events signalled through obd_notify() upcall-chain.
574  */
575 enum obd_notify_event {
576         /* Device connect start */
577         OBD_NOTIFY_CONNECT,
578         /* Device activated */
579         OBD_NOTIFY_ACTIVE,
580         /* Device deactivated */
581         OBD_NOTIFY_INACTIVE,
582         /* Connect data for import were changed */
583         OBD_NOTIFY_OCD,
584         /* Administratively deactivate/activate event */
585         OBD_NOTIFY_DEACTIVATE,
586         OBD_NOTIFY_ACTIVATE
587 };
588
589 /*
590  * Data structure used to pass obd_notify()-event to non-obd listeners (llite
591  * being main example).
592  */
593 struct obd_notify_upcall {
594         int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
595                           enum obd_notify_event ev, void *owner);
596         /* Opaque datum supplied by upper layer listener */
597         void *onu_owner;
598 };
599
600 struct target_recovery_data {
601         svc_handler_t           trd_recovery_handler;
602         pid_t                   trd_processing_task;
603         struct completion       trd_starting;
604         struct completion       trd_finishing;
605 };
606
607 struct obd_llog_group {
608         struct llog_ctxt   *olg_ctxts[LLOG_MAX_CTXTS];
609         wait_queue_head_t  olg_waitq;
610         spinlock_t         olg_lock;
611         struct mutex       olg_cat_processing;
612 };
613
614 /* corresponds to one of the obd's */
615 #define OBD_DEVICE_MAGIC        0XAB5CD6EF
616
617 struct obd_device {
618         struct obd_type                 *obd_type;
619         __u32                            obd_magic; /* OBD_DEVICE_MAGIC */
620         int                              obd_minor; /* device number: lctl dl */
621         struct lu_device                *obd_lu_dev;
622
623         /* common and UUID name of this device */
624         struct obd_uuid                  obd_uuid;
625         char                             obd_name[MAX_OBD_NAME];
626
627         /* bitfield modification is protected by obd_dev_lock */
628         unsigned long
629                 obd_attached:1,         /* finished attach */
630                 obd_set_up:1,           /* finished setup */
631                 obd_recovering:1,       /* there are recoverable clients */
632                 obd_abort_recovery:1,   /* recovery expired */
633                 obd_version_recov:1,    /* obd uses version checking */
634                 obd_replayable:1,       /* recovery enabled; inform clients */
635                 obd_no_transno:1,       /* no committed-transno notification */
636                 obd_no_recov:1,         /* fail instead of retry messages */
637                 obd_stopping:1,         /* started cleanup */
638                 obd_starting:1,         /* started setup */
639                 obd_force:1,            /* cleanup with > 0 obd refcount */
640                 obd_fail:1,             /* cleanup with failover */
641                 obd_no_conn:1,          /* deny new connections */
642                 obd_inactive:1,         /* device active/inactive
643                                          * (for /proc/status only!!) */
644                 obd_no_ir:1,            /* no imperative recovery. */
645                 obd_process_conf:1,     /* device is processing mgs config */
646                 obd_checksum_dump:1;    /* dump pages upon cksum error */
647
648         /* use separate field as it is set in interrupt to don't mess with
649          * protection of other bits using _bh lock */
650         unsigned long obd_recovery_expired:1;
651         /* uuid-export hash body */
652         struct cfs_hash             *obd_uuid_hash;
653         /* nid-export hash body */
654         struct cfs_hash             *obd_nid_hash;
655         /* nid stats body */
656         struct cfs_hash             *obd_nid_stats_hash;
657         /* client_generation-export hash body */
658         struct cfs_hash             *obd_gen_hash;
659         struct list_head        obd_nid_stats;
660         struct list_head        obd_exports;
661         struct list_head        obd_unlinked_exports;
662         struct list_head        obd_delayed_exports;
663         struct list_head        obd_lwp_list;
664         atomic_t                obd_refcount;
665         int                     obd_num_exports;
666         spinlock_t              obd_nid_lock;
667         struct ldlm_namespace  *obd_namespace;
668         struct ptlrpc_client    obd_ldlm_client; /* XXX OST/MDS only */
669         /* a spinlock is OK for what we do now, may need a semaphore later */
670         spinlock_t              obd_dev_lock; /* protect OBD bitfield above */
671         spinlock_t              obd_osfs_lock;
672         struct obd_statfs       obd_osfs;       /* locked by obd_osfs_lock */
673         time64_t                obd_osfs_age;
674         __u64                   obd_last_committed;
675         struct mutex            obd_dev_mutex;
676         struct lvfs_run_ctxt    obd_lvfs_ctxt;
677         struct obd_llog_group   obd_olg;        /* default llog group */
678         struct obd_device       *obd_observer;
679         struct rw_semaphore     obd_observer_link_sem;
680         struct obd_notify_upcall obd_upcall;
681         struct obd_export       *obd_self_export;
682         struct obd_export       *obd_lwp_export;
683         /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
684         struct list_head        obd_exports_timed;
685         time64_t                obd_eviction_timer;     /* for ping evictor */
686
687         int                     obd_max_recoverable_clients;
688         atomic_t                obd_connected_clients;
689         int                     obd_stale_clients;
690         /* this lock protects all recovery list_heads, timer and
691          * obd_next_recovery_transno value */
692         spinlock_t              obd_recovery_task_lock;
693         __u64                   obd_next_recovery_transno;
694         int                     obd_replayed_requests;
695         int                     obd_requests_queued_for_recovery;
696         wait_queue_head_t       obd_next_transno_waitq;
697         /* protected by obd_recovery_task_lock */
698         struct hrtimer          obd_recovery_timer;
699         /* seconds */
700         time64_t                obd_recovery_start;
701         /* seconds, for lprocfs_status */
702         time64_t                obd_recovery_end;
703         time64_t                obd_recovery_time_hard;
704         time64_t                obd_recovery_timeout;
705         int                     obd_recovery_ir_factor;
706
707         /* new recovery stuff from CMD2 */
708         int                             obd_replayed_locks;
709         atomic_t                        obd_req_replay_clients;
710         atomic_t                        obd_lock_replay_clients;
711         struct target_recovery_data     obd_recovery_data;
712
713         /* all lists are protected by obd_recovery_task_lock */
714         struct list_head                obd_req_replay_queue;
715         struct list_head                obd_lock_replay_queue;
716         struct list_head                obd_final_req_queue;
717
718         union {
719 #ifdef HAVE_SERVER_SUPPORT
720                 struct obd_device_target obt;
721                 struct filter_obd filter;
722                 struct ost_obd ost;
723                 struct echo_obd echo;
724 #endif
725                 struct client_obd cli;
726                 struct echo_client_obd echo_client;
727                 struct lov_obd lov;
728                 struct lmv_obd lmv;
729         } u;
730
731         /* Fields used by LProcFS */
732         struct lprocfs_stats            *obd_stats;
733
734         struct lprocfs_stats            *obd_md_stats;
735
736         struct dentry                   *obd_debugfs_entry;
737         struct proc_dir_entry   *obd_proc_entry;
738         struct proc_dir_entry   *obd_proc_exports_entry;
739         struct dentry                   *obd_svc_debugfs_entry;
740         struct lprocfs_stats    *obd_svc_stats;
741         const struct attribute         **obd_attrs;
742         struct lprocfs_vars     *obd_vars;
743         atomic_t                obd_evict_inprogress;
744         wait_queue_head_t       obd_evict_inprogress_waitq;
745         struct list_head        obd_evict_list; /* protected with pet_lock */
746
747         /**
748          * LDLM pool part. Save last calculated SLV and Limit.
749          */
750         rwlock_t                        obd_pool_lock;
751         __u64                           obd_pool_slv;
752         int                             obd_pool_limit;
753
754         int                             obd_conn_inprogress;
755
756         /**
757          * List of outstanding class_incref()'s fo this OBD. For debugging. */
758         struct lu_ref                   obd_reference;
759
760         struct kset                     obd_kset; /* sysfs object collection */
761         struct kobj_type                obd_ktype;
762         struct completion               obd_kobj_unregister;
763 };
764
765 /* get/set_info keys */
766 #define KEY_ASYNC               "async"
767 #define KEY_CHANGELOG_CLEAR     "changelog_clear"
768 #define KEY_FID2PATH            "fid2path"
769 #define KEY_CHECKSUM            "checksum"
770 #define KEY_CLEAR_FS            "clear_fs"
771 #define KEY_CONN_DATA           "conn_data"
772 #define KEY_EVICT_BY_NID        "evict_by_nid"
773 #define KEY_FIEMAP              "fiemap"
774 #define KEY_FLUSH_CTX           "flush_ctx"
775 #define KEY_GRANT_SHRINK        "grant_shrink"
776 #define KEY_HSM_COPYTOOL_SEND   "hsm_send"
777 #define KEY_INIT_RECOV_BACKUP   "init_recov_bk"
778 #define KEY_INTERMDS            "inter_mds"
779 #define KEY_LAST_ID             "last_id"
780 #define KEY_LAST_FID            "last_fid"
781 #define KEY_MAX_EASIZE          "max_easize"
782 #define KEY_DEFAULT_EASIZE      "default_easize"
783 #define KEY_MGSSEC              "mgssec"
784 #define KEY_READ_ONLY           "read-only"
785 #define KEY_REGISTER_TARGET     "register_target"
786 #define KEY_SET_FS              "set_fs"
787 #define KEY_TGT_COUNT           "tgt_count"
788 /*      KEY_SET_INFO in lustre_idl.h */
789 #define KEY_SPTLRPC_CONF        "sptlrpc_conf"
790
791 #define KEY_CACHE_LRU_SHRINK    "cache_lru_shrink"
792 #define KEY_OSP_CONNECTED       "osp_connected"
793
794 /* Flags for op_xvalid */
795 enum op_xvalid {
796         OP_XVALID_CTIME_SET     = BIT(0),       /* 0x0001 */
797         OP_XVALID_BLOCKS        = BIT(1),       /* 0x0002 */
798         OP_XVALID_OWNEROVERRIDE = BIT(2),       /* 0x0004 */
799         OP_XVALID_FLAGS         = BIT(3),       /* 0x0008 */
800         OP_XVALID_PROJID        = BIT(4),       /* 0x0010 */
801         OP_XVALID_LAZYSIZE      = BIT(5),       /* 0x0020 */
802         OP_XVALID_LAZYBLOCKS    = BIT(6),       /* 0x0040 */
803 };
804
805 struct lu_context;
806
807 static inline int it_to_lock_mode(struct lookup_intent *it)
808 {
809         /* CREAT needs to be tested before open (both could be set) */
810         if (it->it_op & IT_CREAT)
811                 return LCK_CW;
812         else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
813                 return LCK_CR;
814         else if (it->it_op & IT_LAYOUT)
815                 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
816         else if (it->it_op &  IT_READDIR)
817                 return LCK_PR;
818         else if (it->it_op &  IT_GETXATTR)
819                 return LCK_PR;
820
821         LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
822         return -EINVAL;
823 }
824
825 enum md_op_flags {
826         MF_MDC_CANCEL_FID1      = 1 << 0,
827         MF_MDC_CANCEL_FID2      = 1 << 1,
828         MF_MDC_CANCEL_FID3      = 1 << 2,
829         MF_MDC_CANCEL_FID4      = 1 << 3,
830         MF_GET_MDT_IDX          = 1 << 4,
831 };
832
833 enum md_cli_flags {
834         CLI_SET_MEA     = 1 << 0,
835         CLI_RM_ENTRY    = 1 << 1,
836         CLI_HASH64      = 1 << 2,
837         CLI_API32       = 1 << 3,
838         CLI_MIGRATE     = 1 << 4,
839 };
840
841 enum md_op_code {
842         LUSTRE_OPC_MKDIR        = 0,
843         LUSTRE_OPC_SYMLINK      = 1,
844         LUSTRE_OPC_MKNOD        = 2,
845         LUSTRE_OPC_CREATE       = 3,
846         LUSTRE_OPC_ANY          = 5,
847 };
848
849 /**
850  * GETXATTR is not included as only a couple of fields in the reply body
851  * is filled, but not FID which is needed for common intent handling in
852  * mdc_finish_intent_lock()
853  */
854 static inline bool it_has_reply_body(const struct lookup_intent *it)
855 {
856         return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
857 }
858
859 struct md_op_data {
860         struct lu_fid           op_fid1; /* operation fid1 (usualy parent) */
861         struct lu_fid           op_fid2; /* operation fid2 (usualy child) */
862         struct lu_fid           op_fid3; /* 2 extra fids to find conflicting */
863         struct lu_fid           op_fid4; /* to the operation locks. */
864         u32                     op_mds;  /* what mds server open will go to */
865         __u32                   op_mode;
866         enum md_op_code         op_code;
867         struct lustre_handle    op_open_handle;
868         s64                     op_mod_time;
869         const char              *op_name;
870         size_t                  op_namelen;
871         struct rw_semaphore     *op_mea1_sem;
872         struct rw_semaphore     *op_mea2_sem;
873         struct lmv_stripe_md    *op_mea1;
874         struct lmv_stripe_md    *op_mea2;
875         struct lmv_stripe_md    *op_default_mea1;       /* default LMV */
876         __u32                   op_suppgids[2];
877         __u32                   op_fsuid;
878         __u32                   op_fsgid;
879         cfs_cap_t               op_cap;
880         void                    *op_data;
881         size_t                  op_data_size;
882
883         /* iattr fields and blocks. */
884         struct iattr            op_attr;
885         enum op_xvalid          op_xvalid;      /* eXtra validity flags */
886         loff_t                  op_attr_blocks;
887         u64                     op_valid;       /* OBD_MD_* */
888         unsigned int            op_attr_flags;  /* LUSTRE_{SYNC,..}_FL */
889
890         enum md_op_flags        op_flags;
891
892         /* Various operation flags. */
893         enum mds_op_bias        op_bias;
894
895         /* used to transfer info between the stacks of MD client
896          * see enum op_cli_flags */
897         enum md_cli_flags       op_cli_flags;
898
899         /* File object data version for HSM release, on client */
900         __u64                   op_data_version;
901         struct lustre_handle    op_lease_handle;
902
903         /* File security context, for creates/metadata ops */
904         const char             *op_file_secctx_name;
905         __u32                   op_file_secctx_name_size;
906         void                   *op_file_secctx;
907         __u32                   op_file_secctx_size;
908
909         __u32                   op_projid;
910
911         /* Used by readdir */
912         unsigned int            op_max_pages;
913
914         __u16                   op_mirror_id;
915
916         /*
917          * used to access migrating dir: if it's set, assume migration is
918          * finished, use the new layout to access dir, otherwise use old layout.
919          * By default it's not set, because new files are created under new
920          * layout, if we can't find file with name under both old and new
921          * layout, we are sure file with name doesn't exist, but in reverse
922          * order there may be a race with creation by others.
923          */
924         bool                    op_post_migrate;
925         /* used to access dir with bash hash */
926         __u32                   op_stripe_index;
927 };
928
929 struct md_callback {
930         int (*md_blocking_ast)(struct ldlm_lock *lock,
931                                struct ldlm_lock_desc *desc,
932                                void *data, int flag);
933 };
934
935 struct md_enqueue_info;
936 /* metadata stat-ahead */
937 typedef int (* md_enqueue_cb_t)(struct ptlrpc_request *req,
938                                 struct md_enqueue_info *minfo,
939                                 int rc);
940
941 struct md_enqueue_info {
942         struct md_op_data               mi_data;
943         struct lookup_intent            mi_it;
944         struct lustre_handle            mi_lockh;
945         struct inode                   *mi_dir;
946         struct ldlm_enqueue_info        mi_einfo;
947         md_enqueue_cb_t                 mi_cb;
948         void                           *mi_cbdata;
949 };
950
951 struct obd_ops {
952         struct module *o_owner;
953         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
954                            void *karg, void __user *uarg);
955         int (*o_get_info)(const struct lu_env *env, struct obd_export *,
956                           __u32 keylen, void *key, __u32 *vallen, void *val);
957         int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
958                                 __u32 keylen, void *key,
959                                 __u32 vallen, void *val,
960                                 struct ptlrpc_request_set *set);
961         int (*o_setup) (struct obd_device *dev, struct lustre_cfg *cfg);
962         int (*o_precleanup)(struct obd_device *dev);
963         int (*o_cleanup)(struct obd_device *dev);
964         int (*o_process_config)(struct obd_device *dev, size_t len, void *data);
965         int (*o_postrecov)(struct obd_device *dev);
966         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
967                           int priority);
968         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
969         /* connect to the target device with given connection
970          * data. @ocd->ocd_connect_flags is modified to reflect flags actually
971          * granted by the target, which are guaranteed to be a subset of flags
972          * asked for. If @ocd == NULL, use default parameters. */
973         int (*o_connect)(const struct lu_env *env,
974                          struct obd_export **exp, struct obd_device *src,
975                          struct obd_uuid *cluuid, struct obd_connect_data *ocd,
976                          void *localdata);
977         int (*o_reconnect)(const struct lu_env *env,
978                            struct obd_export *exp, struct obd_device *src,
979                            struct obd_uuid *cluuid,
980                            struct obd_connect_data *ocd,
981                            void *localdata);
982         int (*o_disconnect)(struct obd_export *exp);
983
984         /* Initialize/finalize fids infrastructure. */
985         int (*o_fid_init)(struct obd_device *obd,
986                           struct obd_export *exp, enum lu_cli_type type);
987         int (*o_fid_fini)(struct obd_device *obd);
988
989         /* Allocate new fid according to passed @hint. */
990         int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
991                            struct lu_fid *fid, struct md_op_data *op_data);
992
993         /*
994          * Object with @fid is getting deleted, we may want to do something
995          * about this.
996          */
997         int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
998                         struct obd_statfs *osfs, time64_t max_age, __u32 flags);
999         int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
1000                               time64_t max_age, struct ptlrpc_request_set *set);
1001         int (*o_create)(const struct lu_env *env, struct obd_export *exp,
1002                         struct obdo *oa);
1003         int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
1004                          struct obdo *oa);
1005         int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
1006                          struct obdo *oa);
1007         int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
1008                          struct obdo *oa);
1009         int (*o_preprw)(const struct lu_env *env, int cmd,
1010                         struct obd_export *exp, struct obdo *oa, int objcount,
1011                         struct obd_ioobj *obj, struct niobuf_remote *remote,
1012                         int *nr_pages, struct niobuf_local *local);
1013         int (*o_commitrw)(const struct lu_env *env, int cmd,
1014                           struct obd_export *exp, struct obdo *oa,
1015                           int objcount, struct obd_ioobj *obj,
1016                           struct niobuf_remote *remote, int pages,
1017                           struct niobuf_local *local, int rc);
1018         int (*o_init_export)(struct obd_export *exp);
1019         int (*o_destroy_export)(struct obd_export *exp);
1020
1021         int (*o_import_event)(struct obd_device *, struct obd_import *,
1022                               enum obd_import_event);
1023
1024         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1025                         enum obd_notify_event ev);
1026
1027         int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1028         struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1029
1030         /* quota methods */
1031         int (*o_quotactl)(struct obd_device *, struct obd_export *,
1032                           struct obd_quotactl *);
1033
1034         /* pools methods */
1035         int (*o_pool_new)(struct obd_device *obd, char *poolname);
1036         int (*o_pool_del)(struct obd_device *obd, char *poolname);
1037         int (*o_pool_add)(struct obd_device *obd, char *poolname,
1038                           char *ostname);
1039         int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1040                           char *ostname);
1041 };
1042
1043 /* lmv structures */
1044 struct lustre_md {
1045         struct mdt_body         *body;
1046         struct lu_buf            layout;
1047         union {
1048                 struct lmv_stripe_md    *lmv;
1049                 struct lmv_foreign_md   *lfm;
1050         };
1051         struct lmv_stripe_md    *default_lmv;
1052 #ifdef CONFIG_FS_POSIX_ACL
1053         struct posix_acl        *posix_acl;
1054 #endif
1055 };
1056
1057 struct md_open_data {
1058         struct obd_client_handle        *mod_och;
1059         struct ptlrpc_request           *mod_open_req;
1060         struct ptlrpc_request           *mod_close_req;
1061         atomic_t                         mod_refcount;
1062         bool                             mod_is_create;
1063 };
1064
1065 struct obd_client_handle {
1066         struct lustre_handle     och_open_handle;
1067         struct lu_fid            och_fid;
1068         struct md_open_data     *och_mod;
1069         struct lustre_handle     och_lease_handle; /* open lock for lease */
1070         __u32                    och_magic;
1071         int                      och_flags;
1072 };
1073
1074 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1075
1076 struct lookup_intent;
1077 struct cl_attr;
1078
1079 struct md_ops {
1080         int (*m_close)(struct obd_export *, struct md_op_data *,
1081                        struct md_open_data *, struct ptlrpc_request **);
1082
1083         int (*m_create)(struct obd_export *, struct md_op_data *,
1084                         const void *, size_t, umode_t, uid_t, gid_t,
1085                         cfs_cap_t, __u64, struct ptlrpc_request **);
1086
1087         int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1088                          const union ldlm_policy_data *, struct md_op_data *,
1089                          struct lustre_handle *, __u64);
1090
1091         int (*m_getattr)(struct obd_export *, struct md_op_data *,
1092                          struct ptlrpc_request **);
1093
1094         int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1095                              struct lookup_intent *,
1096                              struct ptlrpc_request **,
1097                              ldlm_blocking_callback, __u64);
1098
1099         int (*m_link)(struct obd_export *, struct md_op_data *,
1100                       struct ptlrpc_request **);
1101
1102         int (*m_rename)(struct obd_export *, struct md_op_data *,
1103                         const char *, size_t, const char *, size_t,
1104                         struct ptlrpc_request **);
1105
1106         int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1107                          size_t , struct ptlrpc_request **);
1108
1109         int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1110                        struct ptlrpc_request **);
1111
1112         int (*m_read_page)(struct obd_export *, struct md_op_data *,
1113                            struct md_callback *cb_op, __u64 hash_offset,
1114                            struct page **ppage);
1115
1116         int (*m_unlink)(struct obd_export *, struct md_op_data *,
1117                         struct ptlrpc_request **);
1118
1119         int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1120                           u64, const char *, const void *, size_t, unsigned int,
1121                           u32, struct ptlrpc_request **);
1122
1123         int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1124                           u64, const char *, size_t, struct ptlrpc_request **);
1125
1126         int (*m_intent_getattr_async)(struct obd_export *,
1127                                       struct md_enqueue_info *);
1128
1129         int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1130                                  struct lu_fid *, __u64 *bits);
1131
1132         int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1133
1134         int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1135         int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1136
1137         int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1138                               struct ptlrpc_request **);
1139
1140         int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1141
1142         int (*m_get_lustre_md)(struct obd_export *, struct ptlrpc_request *,
1143                                struct obd_export *, struct obd_export *,
1144                                struct lustre_md *);
1145
1146         int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1147
1148         int (*m_merge_attr)(struct obd_export *,
1149                             const struct lmv_stripe_md *lsm,
1150                             struct cl_attr *attr, ldlm_blocking_callback);
1151
1152         int (*m_set_open_replay_data)(struct obd_export *,
1153                                       struct obd_client_handle *,
1154                                       struct lookup_intent *);
1155
1156         int (*m_clear_open_replay_data)(struct obd_export *,
1157                                         struct obd_client_handle *);
1158
1159         int (*m_set_lock_data)(struct obd_export *,
1160                                const struct lustre_handle *, void *, __u64 *);
1161
1162         enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1163                                        const struct lu_fid *, enum ldlm_type,
1164                                        union ldlm_policy_data *, enum ldlm_mode,
1165                                        struct lustre_handle *);
1166
1167         int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1168                                union ldlm_policy_data *, enum ldlm_mode,
1169                                enum ldlm_cancel_flags flags, void *opaque);
1170
1171         int (*m_get_fid_from_lsm)(struct obd_export *,
1172                                   const struct lmv_stripe_md *,
1173                                   const char *name, int namelen,
1174                                   struct lu_fid *fid);
1175         int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1176                           const union lmv_mds_md *lmv, size_t lmv_size);
1177 };
1178
1179 static inline struct md_open_data *obd_mod_alloc(void)
1180 {
1181         struct md_open_data *mod;
1182         OBD_ALLOC_PTR(mod);
1183         if (mod == NULL)
1184                 return NULL;
1185         atomic_set(&mod->mod_refcount, 1);
1186         return mod;
1187 }
1188
1189 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1190 #define obd_mod_put(mod)                                          \
1191 ({                                                                \
1192         if (atomic_dec_and_test(&(mod)->mod_refcount)) {          \
1193                 if ((mod)->mod_open_req)                          \
1194                         ptlrpc_req_finished((mod)->mod_open_req); \
1195                 OBD_FREE_PTR(mod);                                \
1196         }                                                         \
1197 })
1198
1199 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1200 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1201 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1202
1203 /* return 1 if client should be resend request */
1204 static inline int client_should_resend(int resend, struct client_obd *cli)
1205 {
1206         return atomic_read(&cli->cl_resends) ?
1207                atomic_read(&cli->cl_resends) > resend : 1;
1208 }
1209
1210 /**
1211  * Return device name for this device
1212  *
1213  * XXX: lu_device is declared before obd_device, while a pointer pointing
1214  * back to obd_device in lu_device, so this helper function defines here
1215  * instead of in lu_object.h
1216  */
1217 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1218 {
1219         return lu_dev->ld_obd->obd_name;
1220 }
1221
1222 static inline bool filename_is_volatile(const char *name, size_t namelen,
1223                                         int *idx)
1224 {
1225         const char      *start;
1226         char            *end;
1227
1228         if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1229                 return false;
1230
1231         /* caller does not care of idx */
1232         if (idx == NULL)
1233                 return true;
1234
1235         /* volatile file, the MDT can be set from name */
1236         /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1237         /* if no MDT is specified, use std way */
1238         if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1239                 goto bad_format;
1240         /* test for no MDT idx case */
1241         if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1242             (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1243                 *idx = -1;
1244                 return true;
1245         }
1246         /* we have an idx, read it */
1247         start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1248         *idx = simple_strtoul(start, &end, 16);
1249         /* error cases:
1250          * no digit, no trailing :, negative value
1251          */
1252         if (((*idx == 0) && (end == start)) ||
1253             (*end != ':') || (*idx < 0))
1254                 goto bad_format;
1255
1256         return true;
1257 bad_format:
1258         /* bad format of mdt idx, we cannot return an error
1259          * to caller so we use hash algo */
1260         CERROR("Bad volatile file name format: %s\n",
1261                name + LUSTRE_VOLATILE_HDR_LEN);
1262         return false;
1263 }
1264
1265 static inline int cli_brw_size(struct obd_device *obd)
1266 {
1267         LASSERT(obd != NULL);
1268         return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1269 }
1270
1271 /*
1272  * When RPC size or the max RPCs in flight is increased, the max dirty pages
1273  * of the client should be increased accordingly to avoid sending fragmented
1274  * RPCs over the network when the client runs out of the maximum dirty space
1275  * when so many RPCs are being generated.
1276  */
1277 static inline void client_adjust_max_dirty(struct client_obd *cli)
1278 {
1279          /* initializing */
1280         if (cli->cl_dirty_max_pages <= 0) {
1281                 cli->cl_dirty_max_pages =
1282                         (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1283         } else {
1284                 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1285                                           cli->cl_max_pages_per_rpc;
1286
1287                 if (dirty_max > cli->cl_dirty_max_pages)
1288                         cli->cl_dirty_max_pages = dirty_max;
1289         }
1290
1291         if (cli->cl_dirty_max_pages > totalram_pages / 8)
1292                 cli->cl_dirty_max_pages = totalram_pages / 8;
1293
1294         /* This value is exported to userspace through the max_dirty_mb
1295          * parameter.  So we round up the number of pages to make it a round
1296          * number of MBs. */
1297         cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1298                                            1 << (20 - PAGE_SHIFT));
1299 }
1300
1301 #endif /* __OBD_H */