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