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