Whamcloud - gitweb
LU-1346 libcfs: replace libcfs wrappers with kernel API
[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, 2012, Whamcloud, Inc.
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 #if defined(__linux__)
41 #include <linux/obd.h>
42 #elif defined(__APPLE__)
43 #include <darwin/obd.h>
44 #elif defined(__WINNT__)
45 #include <winnt/obd.h>
46 #else
47 #error Unsupported operating system.
48 #endif
49
50 #define IOC_OSC_TYPE         'h'
51 #define IOC_OSC_MIN_NR       20
52 #define IOC_OSC_SET_ACTIVE   _IOWR(IOC_OSC_TYPE, 21, struct obd_device *)
53 #define IOC_OSC_MAX_NR       50
54
55 #define IOC_MDC_TYPE         'i'
56 #define IOC_MDC_MIN_NR       20
57 #define IOC_MDC_MAX_NR       50
58
59 #include <lustre/lustre_idl.h>
60 #ifdef HAVE_SERVER_SUPPORT
61 # include <lu_target.h>
62 #endif
63 #include <lu_ref.h>
64 #include <lustre_lib.h>
65 #include <lustre_export.h>
66 #include <lustre_fld.h>
67 #include <lustre_capa.h>
68
69 #include <libcfs/bitmap.h>
70
71
72 #define MAX_OBD_DEVICES 8192
73
74 struct osc_async_rc {
75         int     ar_rc;
76         int     ar_force_sync;
77         __u64   ar_min_xid;
78 };
79
80 struct lov_oinfo {                 /* per-stripe data structure */
81         struct ost_id   loi_oi;    /* object ID/Sequence on the target OST */
82         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
83         int loi_ost_gen;           /* generation of this loi_ost_idx */
84
85         unsigned long loi_kms_valid:1;
86         __u64 loi_kms;             /* known minimum size */
87         struct ost_lvb loi_lvb;
88         struct osc_async_rc     loi_ar;
89 };
90 #define loi_id  loi_oi.oi_id
91 #define loi_seq loi_oi.oi_seq
92
93 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
94 {
95         oinfo->loi_kms = kms;
96         oinfo->loi_kms_valid = 1;
97 }
98
99 static inline void loi_init(struct lov_oinfo *loi)
100 {
101 }
102
103 struct lov_stripe_md {
104         cfs_atomic_t     lsm_refc;
105         spinlock_t      lsm_lock;
106         pid_t            lsm_lock_owner; /* debugging */
107
108         /* maximum possible file size, might change as OSTs status changes,
109          * e.g. disconnected, deactivated */
110         __u64            lsm_maxbytes;
111         struct {
112                 /* Public members. */
113                 __u64 lw_object_id;        /* lov object id */
114                 __u64 lw_object_seq;       /* lov object seq */
115
116                 /* LOV-private members start here -- only for use in lov/. */
117                 __u32 lw_magic;
118                 __u32 lw_stripe_size;      /* size of the stripe */
119                 __u32 lw_pattern;          /* striping pattern (RAID0, RAID1) */
120                 __u16 lw_stripe_count;  /* number of objects being striped over */
121                 __u16 lw_layout_gen;       /* generation of the layout */
122                 char  lw_pool_name[LOV_MAXPOOLNAME]; /* pool name */
123         } lsm_wire;
124
125         struct lov_oinfo *lsm_oinfo[0];
126 };
127
128 #define lsm_object_id    lsm_wire.lw_object_id
129 #define lsm_object_seq   lsm_wire.lw_object_seq
130 #define lsm_magic        lsm_wire.lw_magic
131 #define lsm_layout_gen   lsm_wire.lw_layout_gen
132 #define lsm_stripe_size  lsm_wire.lw_stripe_size
133 #define lsm_pattern      lsm_wire.lw_pattern
134 #define lsm_stripe_count lsm_wire.lw_stripe_count
135 #define lsm_pool_name    lsm_wire.lw_pool_name
136
137 struct obd_info;
138
139 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
140
141 /* obd info for a particular level (lov, osc). */
142 struct obd_info {
143         /* Lock policy. It keeps an extent which is specific for a particular
144          * OSC. (e.g. lov_prep_enqueue_set initialises extent of the policy,
145          * and osc_enqueue passes it into ldlm_lock_match & ldlm_cli_enqueue. */
146         ldlm_policy_data_t      oi_policy;
147         /* Flags used for set request specific flags:
148            - while lock handling, the flags obtained on the enqueue
149            request are set here.
150            - while stats, the flags used for control delay/resend.
151            - while setattr, the flags used for distinguish punch operation
152          */
153         __u64                   oi_flags;
154         /* Lock handle specific for every OSC lock. */
155         struct lustre_handle   *oi_lockh;
156         /* lsm data specific for every OSC. */
157         struct lov_stripe_md   *oi_md;
158         /* obdo data specific for every OSC, if needed at all. */
159         struct obdo            *oi_oa;
160         /* statfs data specific for every OSC, if needed at all. */
161         struct obd_statfs      *oi_osfs;
162         /* An update callback which is called to update some data on upper
163          * level. E.g. it is used for update lsm->lsm_oinfo at every recieved
164          * request in osc level for enqueue requests. It is also possible to
165          * update some caller data from LOV layer if needed. */
166         obd_enqueue_update_f    oi_cb_up;
167         /* oss capability, its type is obd_capa in client to avoid copy.
168          * in contrary its type is lustre_capa in OSS. */
169         void                   *oi_capa;
170         /* transfer jobid from ost_sync() to filter_sync()... */
171         char                   *oi_jobid;
172 };
173
174 /* compare all relevant fields. */
175 static inline int lov_stripe_md_cmp(struct lov_stripe_md *m1,
176                                     struct lov_stripe_md *m2)
177 {
178         /*
179          * ->lsm_wire contains padding, but it should be zeroed out during
180          * allocation.
181          */
182         return memcmp(&m1->lsm_wire, &m2->lsm_wire, sizeof m1->lsm_wire);
183 }
184
185 static inline int lov_lum_lsm_cmp(struct lov_user_md *lum,
186                                   struct lov_stripe_md  *lsm)
187 {
188         if (lsm->lsm_magic != lum->lmm_magic)
189                 return 1;
190         if ((lsm->lsm_stripe_count != 0) && (lum->lmm_stripe_count != 0) &&
191             (lsm->lsm_stripe_count != lum->lmm_stripe_count))
192                 return 2;
193         if ((lsm->lsm_stripe_size != 0) && (lum->lmm_stripe_size != 0) &&
194             (lsm->lsm_stripe_size != lum->lmm_stripe_size))
195                 return 3;
196         if ((lsm->lsm_pattern != 0) && (lum->lmm_pattern != 0) &&
197             (lsm->lsm_pattern != lum->lmm_pattern))
198                 return 4;
199         if ((lsm->lsm_magic == LOV_MAGIC_V3) &&
200             (strncmp(lsm->lsm_pool_name,
201                      ((struct lov_user_md_v3 *)lum)->lmm_pool_name,
202                      LOV_MAXPOOLNAME) != 0))
203                 return 5;
204         return 0;
205 }
206
207 static inline int lov_lum_swab_if_needed(struct lov_user_md_v3 *lumv3,
208                                          int *lmm_magic,
209                                          struct lov_user_md *lum)
210 {
211         if (lum && cfs_copy_from_user(lumv3, lum,sizeof(struct lov_user_md_v1)))
212                 return -EFAULT;
213
214         *lmm_magic = lumv3->lmm_magic;
215
216         if (*lmm_magic == __swab32(LOV_USER_MAGIC_V1)) {
217                 lustre_swab_lov_user_md_v1((struct lov_user_md_v1 *)lumv3);
218                 *lmm_magic = LOV_USER_MAGIC_V1;
219         } else if (*lmm_magic == LOV_USER_MAGIC_V3) {
220                 if (lum && cfs_copy_from_user(lumv3, lum, sizeof(*lumv3)))
221                         return -EFAULT;
222         } else if (*lmm_magic == __swab32(LOV_USER_MAGIC_V3)) {
223                 if (lum && cfs_copy_from_user(lumv3, lum, sizeof(*lumv3)))
224                         return -EFAULT;
225                 lustre_swab_lov_user_md_v3(lumv3);
226                 *lmm_magic = LOV_USER_MAGIC_V3;
227         } else if (*lmm_magic != LOV_USER_MAGIC_V1) {
228                 CDEBUG(D_IOCTL,
229                        "bad userland LOV MAGIC: %#08x != %#08x nor %#08x\n",
230                        *lmm_magic, LOV_USER_MAGIC_V1, LOV_USER_MAGIC_V3);
231                        return -EINVAL;
232         }
233         return 0;
234 }
235
236 void lov_stripe_lock(struct lov_stripe_md *md);
237 void lov_stripe_unlock(struct lov_stripe_md *md);
238
239 struct obd_type {
240         cfs_list_t typ_chain;
241         struct obd_ops *typ_dt_ops;
242         struct md_ops *typ_md_ops;
243         cfs_proc_dir_entry_t *typ_procroot;
244         char *typ_name;
245         int  typ_refcnt;
246         struct lu_device_type *typ_lu;
247         spinlock_t obd_type_lock;
248 };
249
250 struct brw_page {
251         obd_off  off;
252         cfs_page_t *pg;
253         int count;
254         obd_flag flag;
255 };
256
257 /* Individual type definitions */
258
259 struct ost_server_data;
260
261 struct osd_properties {
262         size_t osd_max_ea_size;
263 };
264
265 #define OBT_MAGIC       0xBDDECEAE
266 /* hold common fields for "target" device */
267 struct obd_device_target {
268         __u32                     obt_magic;
269         __u32                     obt_instance;
270         struct super_block       *obt_sb;
271         /** last_rcvd file */
272         struct file              *obt_rcvd_filp;
273 #ifdef HAVE_SERVER_SUPPORT
274         struct lu_target         *obt_lut;
275 #endif
276         __u64                     obt_mount_count;
277         struct rw_semaphore       obt_rwsem;
278         struct vfsmount          *obt_vfsmnt;
279         struct file              *obt_health_check_filp;
280         struct osd_properties     obt_osd_properties;
281         struct obd_job_stats      obt_jobstats;
282 };
283
284 /* llog contexts */
285 enum llog_ctxt_id {
286         LLOG_CONFIG_ORIG_CTXT  =  0,
287         LLOG_CONFIG_REPL_CTXT,
288         LLOG_MDS_OST_ORIG_CTXT,
289         LLOG_MDS_OST_REPL_CTXT,
290         LLOG_SIZE_ORIG_CTXT,
291         LLOG_SIZE_REPL_CTXT,
292         LLOG_RD1_ORIG_CTXT,
293         LLOG_RD1_REPL_CTXT,
294         LLOG_TEST_ORIG_CTXT,
295         LLOG_TEST_REPL_CTXT,
296         LLOG_LOVEA_ORIG_CTXT,
297         LLOG_LOVEA_REPL_CTXT,
298         LLOG_CHANGELOG_ORIG_CTXT,      /**< changelog generation on mdd */
299         LLOG_CHANGELOG_REPL_CTXT,      /**< changelog access on clients */
300         LLOG_CHANGELOG_USER_ORIG_CTXT, /**< for multiple changelog consumers */
301         LLOG_MAX_CTXTS
302 };
303
304 #define FILTER_SUBDIR_COUNT      32            /* set to zero for no subdirs */
305
306 struct filter_subdirs {
307        cfs_dentry_t *dentry[FILTER_SUBDIR_COUNT];
308 };
309
310
311 struct filter_ext {
312         __u64                fe_start;
313         __u64                fe_end;
314 };
315
316 struct filter_obd {
317         /* NB this field MUST be first */
318         struct obd_device_target fo_obt;
319         const char          *fo_fstype;
320
321         int                  fo_group_count;
322         cfs_dentry_t        *fo_dentry_O;
323         cfs_dentry_t       **fo_dentry_O_groups;
324         struct filter_subdirs   *fo_dentry_O_sub;
325         struct mutex            fo_init_lock;   /* group initialization lock*/
326         int                     fo_committed_group;
327
328         spinlock_t              fo_objidlock;   /* protect fo_lastobjid */
329
330         unsigned long           fo_destroys_in_progress;
331         struct mutex            fo_create_locks[FILTER_SUBDIR_COUNT];
332
333         cfs_list_t fo_export_list;
334         int                  fo_subdir_count;
335
336         obd_size             fo_tot_dirty;      /* protected by obd_osfs_lock */
337         obd_size             fo_tot_granted;    /* all values in bytes */
338         obd_size             fo_tot_pending;
339         int                  fo_tot_granted_clients;
340
341         obd_size             fo_readcache_max_filesize;
342         spinlock_t              fo_flags_lock;
343         unsigned int         fo_read_cache:1,   /**< enable read-only cache */
344                              fo_writethrough_cache:1,/**< read cache writes */
345                              fo_mds_ost_sync:1, /**< MDS-OST orphan recovery*/
346                              fo_raid_degraded:1;/**< RAID device degraded */
347
348         struct obd_import   *fo_mdc_imp;
349         struct obd_uuid      fo_mdc_uuid;
350         struct lustre_handle fo_mdc_conn;
351         struct file        **fo_last_objid_files;
352         __u64               *fo_last_objids; /* last created objid for groups,
353                                               * protected by fo_objidlock */
354
355         struct mutex            fo_alloc_lock;
356
357         cfs_atomic_t         fo_r_in_flight;
358         cfs_atomic_t         fo_w_in_flight;
359
360         /*
361          * per-filter pool of kiobuf's allocated by filter_common_setup() and
362          * torn down by filter_cleanup().
363          *
364          * This pool contains kiobuf used by
365          * filter_{prep,commit}rw_{read,write}() and is shared by all OST
366          * threads.
367          *
368          * Locking: protected by internal lock of cfs_hash, pool can be
369          * found from this hash table by t_id of ptlrpc_thread.
370          */
371         struct cfs_hash         *fo_iobuf_hash;
372
373         cfs_list_t              fo_llog_list;
374         spinlock_t              fo_llog_list_lock;
375
376         struct brw_stats         fo_filter_stats;
377
378         int                      fo_fmd_max_num; /* per exp filter_mod_data */
379         int                      fo_fmd_max_age; /* jiffies to fmd expiry */
380         unsigned long            fo_syncjournal:1, /* sync journal on writes */
381                                  fo_sync_lock_cancel:2;/* sync on lock cancel */
382
383
384         /* sptlrpc stuff */
385         rwlock_t                fo_sptlrpc_lock;
386         struct sptlrpc_rule_set  fo_sptlrpc_rset;
387
388         /* capability related */
389         unsigned int             fo_fl_oss_capa;
390         cfs_list_t               fo_capa_keys;
391         cfs_hlist_head_t        *fo_capa_hash;
392         struct llog_commit_master *fo_lcm;
393         int                      fo_sec_level;
394 };
395
396 struct timeout_item {
397         enum timeout_event ti_event;
398         cfs_time_t         ti_timeout;
399         timeout_cb_t       ti_cb;
400         void              *ti_cb_data;
401         cfs_list_t         ti_obd_list;
402         cfs_list_t         ti_chain;
403 };
404
405 #define OSC_MAX_RIF_DEFAULT       8
406 #define MDS_OSC_MAX_RIF_DEFAULT   50
407 #define OSC_MAX_RIF_MAX         256
408 #define OSC_MAX_DIRTY_DEFAULT  (OSC_MAX_RIF_DEFAULT * 4)
409 #define OSC_MAX_DIRTY_MB_MAX   2048     /* arbitrary, but < MAX_LONG bytes */
410 #define OSC_DEFAULT_RESENDS      10
411
412 /* possible values for fo_sync_lock_cancel */
413 enum {
414         NEVER_SYNC_ON_CANCEL = 0,
415         BLOCKING_SYNC_ON_CANCEL = 1,
416         ALWAYS_SYNC_ON_CANCEL = 2,
417         NUM_SYNC_ON_CANCEL_STATES
418 };
419
420 #define MDC_MAX_RIF_DEFAULT       8
421 #define MDC_MAX_RIF_MAX         512
422
423 struct mdc_rpc_lock;
424 struct obd_import;
425 struct client_obd {
426         struct rw_semaphore  cl_sem;
427         struct obd_uuid          cl_target_uuid;
428         struct obd_import       *cl_import; /* ptlrpc connection state */
429         int                      cl_conn_count;
430         /* max_mds_easize is purely a performance thing so we don't have to
431          * call obd_size_diskmd() all the time. */
432         int                      cl_default_mds_easize;
433         int                      cl_max_mds_easize;
434         int                      cl_max_mds_cookiesize;
435
436         enum lustre_sec_part     cl_sp_me;
437         enum lustre_sec_part     cl_sp_to;
438         struct sptlrpc_flavor    cl_flvr_mgc;   /* fixed flavor of mgc->mgs */
439
440         //struct llog_canceld_ctxt *cl_llcd; /* it's included by obd_llog_ctxt */
441         void                    *cl_llcd_offset;
442
443         /* the grant values are protected by loi_list_lock below */
444         long                     cl_dirty;         /* all _dirty_ in bytes */
445         long                     cl_dirty_max;     /* allowed w/o rpc */
446         long                     cl_dirty_transit; /* dirty synchronous */
447         long                     cl_avail_grant;   /* bytes of credit for ost */
448         long                     cl_lost_grant;    /* lost credits (trunc) */
449
450         /* since we allocate grant by blocks, we don't know how many grant will
451          * be used to add a page into cache. As a solution, we reserve maximum
452          * grant before trying to dirty a page and unreserve the rest.
453          * See osc_{reserve|unreserve}_grant for details. */
454         long                 cl_reserved_grant;
455         cfs_list_t           cl_cache_waiters; /* waiting for cache/grant */
456         cfs_time_t           cl_next_shrink_grant;   /* jiffies */
457         cfs_list_t           cl_grant_shrink_list;  /* Timeout event list */
458         int                  cl_grant_shrink_interval; /* seconds */
459
460         /* A chunk is an optimal size used by osc_extent to determine
461          * the extent size. A chunk is max(CFS_PAGE_SIZE, OST block size) */
462         int                  cl_chunkbits;
463         int                  cl_chunk;
464         int                  cl_extent_tax; /* extent overhead, by bytes */
465
466         /* keep track of objects that have lois that contain pages which
467          * have been queued for async brw.  this lock also protects the
468          * lists of osc_client_pages that hang off of the loi */
469         /*
470          * ->cl_loi_list_lock protects consistency of
471          * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
472          * ->ap_completion() call-backs are executed under this lock. As we
473          * cannot guarantee that these call-backs never block on all platforms
474          * (as a matter of fact they do block on Mac OS X), type of
475          * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
476          * and blocking mutex on Mac OS X. (Alternative is to make this lock
477          * blocking everywhere, but we don't want to slow down fast-path of
478          * our main platform.)
479          *
480          * Exact type of ->cl_loi_list_lock is defined in arch/obd.h together
481          * with client_obd_list_{un,}lock() and
482          * client_obd_list_lock_{init,done}() functions.
483          *
484          * NB by Jinshan: though field names are still _loi_, but actually
485          * osc_object{}s are in the list.
486          */
487         client_obd_lock_t        cl_loi_list_lock;
488         cfs_list_t               cl_loi_ready_list;
489         cfs_list_t               cl_loi_hp_ready_list;
490         cfs_list_t               cl_loi_write_list;
491         cfs_list_t               cl_loi_read_list;
492         int                      cl_r_in_flight;
493         int                      cl_w_in_flight;
494         /* just a sum of the loi/lop pending numbers to be exported by /proc */
495         cfs_atomic_t             cl_pending_w_pages;
496         cfs_atomic_t             cl_pending_r_pages;
497         int                      cl_max_pages_per_rpc;
498         int                      cl_max_rpcs_in_flight;
499         struct obd_histogram     cl_read_rpc_hist;
500         struct obd_histogram     cl_write_rpc_hist;
501         struct obd_histogram     cl_read_page_hist;
502         struct obd_histogram     cl_write_page_hist;
503         struct obd_histogram     cl_read_offset_hist;
504         struct obd_histogram     cl_write_offset_hist;
505
506         /* lru for osc caching pages */
507         struct cl_client_cache  *cl_cache;
508         cfs_list_t               cl_lru_osc; /* member of cl_cache->ccc_lru */
509         cfs_atomic_t            *cl_lru_left;
510         cfs_atomic_t             cl_lru_busy;
511         cfs_atomic_t             cl_lru_shrinkers;
512         cfs_atomic_t             cl_lru_in_list;
513         cfs_list_t               cl_lru_list; /* lru page list */
514         client_obd_lock_t        cl_lru_list_lock; /* page list protector */
515
516         /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
517         cfs_atomic_t             cl_destroy_in_flight;
518         cfs_waitq_t              cl_destroy_waitq;
519
520         struct mdc_rpc_lock     *cl_rpc_lock;
521         struct mdc_rpc_lock     *cl_close_lock;
522
523         /* mgc datastruct */
524         struct semaphore         cl_mgc_sem;
525         struct vfsmount         *cl_mgc_vfsmnt;
526         struct dentry           *cl_mgc_configs_dir;
527         cfs_atomic_t             cl_mgc_refcount;
528         struct obd_export       *cl_mgc_mgsexp;
529
530         /* checksumming for data sent over the network */
531         unsigned int             cl_checksum:1; /* 0 = disabled, 1 = enabled */
532         /* supported checksum types that are worked out at connect time */
533         __u32                    cl_supp_cksum_types;
534         /* checksum algorithm to be used */
535         cksum_type_t             cl_cksum_type;
536
537         /* also protected by the poorly named _loi_list_lock lock above */
538         struct osc_async_rc      cl_ar;
539
540         /* used by quotacheck when the servers are older than 2.4 */
541         int                      cl_qchk_stat; /* quotacheck stat of the peer */
542 #define CL_NOT_QUOTACHECKED 1   /* client->cl_qchk_stat init value */
543 #if LUSTRE_VERSION_CODE >= OBD_OCD_VERSION(2, 7, 50, 0)
544 #warning "please consider removing quotacheck compatibility code"
545 #endif
546
547         /* sequence manager */
548         struct lu_client_seq    *cl_seq;
549
550         cfs_atomic_t             cl_resends; /* resend count */
551
552         /* ptlrpc work for writeback in ptlrpcd context */
553         void                    *cl_writeback_work;
554         /* hash tables for osc_quota_info */
555         cfs_hash_t              *cl_quota_hash[MAXQUOTAS];
556 };
557 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
558
559 struct obd_id_info {
560         __u32   idx;
561         obd_id  *data;
562 };
563
564 /* */
565
566 struct echo_obd {
567         struct obd_device_target eo_obt;
568         struct obdo             eo_oa;
569         spinlock_t               eo_lock;
570         __u64                    eo_lastino;
571         struct lustre_handle    eo_nl_lock;
572         cfs_atomic_t            eo_prep;
573 };
574
575 struct ost_obd {
576         struct ptlrpc_service   *ost_service;
577         struct ptlrpc_service   *ost_create_service;
578         struct ptlrpc_service   *ost_io_service;
579         struct mutex            ost_health_mutex;
580 };
581
582 struct echo_client_obd {
583         struct obd_export       *ec_exp;   /* the local connection to osc/lov */
584         spinlock_t              ec_lock;
585         cfs_list_t           ec_objects;
586         cfs_list_t           ec_locks;
587         int                  ec_nstripes;
588         __u64                ec_unique;
589 };
590
591 struct lov_qos_oss {
592         struct obd_uuid     lqo_uuid;       /* ptlrpc's c_remote_uuid */
593         cfs_list_t          lqo_oss_list;   /* link to lov_qos */
594         __u64               lqo_bavail;     /* total bytes avail on OSS */
595         __u64               lqo_penalty;    /* current penalty */
596         __u64               lqo_penalty_per_obj;/* penalty decrease every obj*/
597         time_t              lqo_used;       /* last used time, seconds */
598         __u32               lqo_ost_count;  /* number of osts on this oss */
599 };
600
601 struct ltd_qos {
602         struct lov_qos_oss *ltq_oss;         /* oss info */
603         __u64               ltq_penalty;     /* current penalty */
604         __u64               ltq_penalty_per_obj; /* penalty decrease every obj*/
605         __u64               ltq_weight;      /* net weighting */
606         time_t              ltq_used;        /* last used time, seconds */
607         unsigned int        ltq_usable:1;    /* usable for striping */
608 };
609
610 /* Generic subset of OSTs */
611 struct ost_pool {
612         __u32              *op_array;      /* array of index of
613                                                    lov_obd->lov_tgts */
614         unsigned int        op_count;      /* number of OSTs in the array */
615         unsigned int        op_size;       /* allocated size of lp_array */
616         struct rw_semaphore op_rw_sem;     /* to protect ost_pool use */
617 };
618
619 /* Round-robin allocator data */
620 struct lov_qos_rr {
621         __u32               lqr_start_idx;   /* start index of new inode */
622         __u32               lqr_offset_idx;  /* aliasing for start_idx  */
623         int                 lqr_start_count; /* reseed counter */
624         struct ost_pool     lqr_pool;        /* round-robin optimized list */
625         unsigned long       lqr_dirty:1;     /* recalc round-robin list */
626 };
627
628 /* allow statfs data caching for 1 second */
629 #define OBD_STATFS_CACHE_SECONDS 1
630
631 struct lov_statfs_data {
632         struct obd_info   lsd_oi;
633         struct obd_statfs lsd_statfs;
634 };
635 /* Stripe placement optimization */
636 struct lov_qos {
637         cfs_list_t          lq_oss_list; /* list of OSSs that targets use */
638         struct rw_semaphore lq_rw_sem;
639         __u32               lq_active_oss_count;
640         unsigned int        lq_prio_free;   /* priority for free space */
641         unsigned int        lq_threshold_rr;/* priority for rr */
642         struct lov_qos_rr   lq_rr;          /* round robin qos data */
643         unsigned long       lq_dirty:1,     /* recalc qos data */
644                             lq_same_space:1,/* the ost's all have approx.
645                                                the same space avail */
646                             lq_reset:1,     /* zero current penalties */
647                             lq_statfs_in_progress:1; /* statfs op in
648                                                         progress */
649         /* qos statfs data */
650         struct lov_statfs_data *lq_statfs_data;
651         cfs_waitq_t         lq_statfs_waitq; /* waitqueue to notify statfs
652                                               * requests completion */
653 };
654
655 struct lov_tgt_desc {
656         cfs_list_t          ltd_kill;
657         struct obd_uuid     ltd_uuid;
658         struct obd_device  *ltd_obd;
659         struct obd_export  *ltd_exp;
660         struct ltd_qos      ltd_qos;     /* qos info per target */
661         __u32               ltd_gen;
662         __u32               ltd_index;   /* index in lov_obd->tgts */
663         unsigned long       ltd_active:1,/* is this target up for requests */
664                             ltd_activate:1,/* should  target be activated */
665                             ltd_reap:1;  /* should this target be deleted */
666 };
667
668 /* Pool metadata */
669 #define pool_tgt_size(_p)   _p->pool_obds.op_size
670 #define pool_tgt_count(_p)  _p->pool_obds.op_count
671 #define pool_tgt_array(_p)  _p->pool_obds.op_array
672 #define pool_tgt_rw_sem(_p) _p->pool_obds.op_rw_sem
673
674 struct pool_desc {
675         char                  pool_name[LOV_MAXPOOLNAME + 1]; /* name of pool */
676         struct ost_pool       pool_obds;              /* pool members */
677         cfs_atomic_t          pool_refcount;          /* pool ref. counter */
678         struct lov_qos_rr     pool_rr;                /* round robin qos */
679         cfs_hlist_node_t      pool_hash;              /* access by poolname */
680         cfs_list_t            pool_list;              /* serial access */
681         cfs_proc_dir_entry_t *pool_proc_entry;        /* file in /proc */
682         struct obd_device    *pool_lobd;              /* obd of the lov/lod to which
683                                                        * this pool belongs */
684 };
685
686 struct lov_obd {
687         struct lov_desc         desc;
688         struct lov_tgt_desc   **lov_tgts;              /* sparse array */
689         struct ost_pool         lov_packed;            /* all OSTs in a packed
690                                                           array */
691         struct mutex            lov_lock;
692         struct obd_connect_data lov_ocd;
693         cfs_atomic_t            lov_refcount;
694         __u32                   lov_tgt_count;         /* how many OBD's */
695         __u32                   lov_active_tgt_count;  /* how many active */
696         __u32                   lov_death_row;/* tgts scheduled to be deleted */
697         __u32                   lov_tgt_size;   /* size of tgts array */
698         int                     lov_connects;
699         int                     lov_pool_count;
700         cfs_hash_t             *lov_pools_hash_body; /* used for key access */
701         cfs_list_t              lov_pool_list; /* used for sequential access */
702         cfs_proc_dir_entry_t   *lov_pool_proc_entry;
703         enum lustre_sec_part    lov_sp_me;
704
705         /* Cached LRU pages from upper layer */
706         void                   *lov_cache;
707 };
708
709 struct lmv_tgt_desc {
710         struct obd_uuid         ltd_uuid;
711         struct obd_export      *ltd_exp;
712         int                     ltd_active; /* is this target up for requests */
713         int                     ltd_idx;
714         struct mutex            ltd_fid_mutex;
715 };
716
717 enum placement_policy {
718         PLACEMENT_CHAR_POLICY   = 0,
719         PLACEMENT_NID_POLICY    = 1,
720         PLACEMENT_INVAL_POLICY  = 2,
721         PLACEMENT_MAX_POLICY
722 };
723
724 typedef enum placement_policy placement_policy_t;
725
726 struct lmv_obd {
727         int                     refcount;
728         struct lu_client_fld    lmv_fld;
729         spinlock_t              lmv_lock;
730         placement_policy_t      lmv_placement;
731         struct lmv_desc         desc;
732         struct obd_uuid         cluuid;
733         struct obd_export       *exp;
734
735         int                     connected;
736         int                     max_easize;
737         int                     max_def_easize;
738         int                     max_cookiesize;
739         int                     server_timeout;
740         struct mutex            init_mutex;
741
742         struct lmv_tgt_desc     *tgts;
743         int                     tgts_size;
744
745         struct obd_connect_data *datas;
746         int                     datas_size;
747
748         struct obd_connect_data conn_data;
749 };
750
751 struct niobuf_local {
752         __u64 lnb_file_offset;
753         __u32 lnb_page_offset;
754         __u32 len;
755         __u32 flags;
756         cfs_page_t    *page;
757         cfs_dentry_t  *dentry;
758         int lnb_grant_used;
759         int rc;
760 };
761
762 #define LUSTRE_FLD_NAME         "fld"
763 #define LUSTRE_SEQ_NAME         "seq"
764
765 #define LUSTRE_CMM_NAME         "cmm"
766 #define LUSTRE_MDD_NAME         "mdd"
767 #define LUSTRE_OSD_LDISKFS_NAME "osd-ldiskfs"
768 #define LUSTRE_OSD_ZFS_NAME     "osd-zfs"
769 #define LUSTRE_VVP_NAME         "vvp"
770 #define LUSTRE_LMV_NAME         "lmv"
771 #define LUSTRE_CMM_MDC_NAME     "cmm-mdc"
772 #define LUSTRE_SLP_NAME         "slp"
773 #define LUSTRE_LOD_NAME         "lod"
774 #define LUSTRE_OSP_NAME         "osp"
775
776 /* obd device type names */
777  /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
778 #define LUSTRE_MDS_NAME         "mds"
779 #define LUSTRE_MDT_NAME         "mdt"
780 #define LUSTRE_MDC_NAME         "mdc"
781 #define LUSTRE_OSS_NAME         "ost"       /* FIXME change name to oss */
782 #define LUSTRE_OST_NAME         "obdfilter" /* FIXME change name to ost */
783 #define LUSTRE_OSC_NAME         "osc"
784 #define LUSTRE_LOV_NAME         "lov"
785 #define LUSTRE_MGS_NAME         "mgs"
786 #define LUSTRE_MGC_NAME         "mgc"
787
788 #define LUSTRE_CACHEOBD_NAME    "cobd"
789 #define LUSTRE_ECHO_NAME        "obdecho"
790 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
791 #define LUSTRE_QMT_NAME         "qmt"
792
793 /* Constant obd names (post-rename) */
794 #define LUSTRE_MDS_OBDNAME "MDS"
795 #define LUSTRE_OSS_OBDNAME "OSS"
796 #define LUSTRE_MGS_OBDNAME "MGS"
797 #define LUSTRE_MGC_OBDNAME "MGC"
798
799 /* Don't conflict with on-wire flags OBD_BRW_WRITE, etc */
800 #define N_LOCAL_TEMP_PAGE 0x10000000
801
802 static inline int is_osp_on_ost(char *name)
803 {
804         char   *ptr;
805
806         ptr = strrchr(name, '-');
807         if (ptr == NULL) {
808                 CERROR("%s is not a obdname\n", name);
809                 return 0;
810         }
811
812         if (strncmp(ptr + 1, "OST", 3) != 0 && strncmp(ptr + 1, "MDT", 3) != 0)
813                 return 0;
814
815         /* match the "-osp" */
816         if (ptr - name < strlen(LUSTRE_OSP_NAME) + 1)
817                 return 0;
818
819         ptr -= (strlen(LUSTRE_OSP_NAME) + 1);
820         if (*ptr != '-')
821                 return 0;
822
823         if (strncmp(ptr + 1, LUSTRE_OSP_NAME, strlen(LUSTRE_OSP_NAME)) != 0)
824                 return 0;
825
826         return 1;
827 }
828
829 struct obd_trans_info {
830         __u64                    oti_transno;
831         __u64                    oti_xid;
832         /* Only used on the server side for tracking acks. */
833         struct oti_req_ack_lock {
834                 struct lustre_handle lock;
835                 __u32                mode;
836         }                        oti_ack_locks[4];
837         void                    *oti_handle;
838         struct llog_cookie       oti_onecookie;
839         struct llog_cookie      *oti_logcookies;
840         int                      oti_numcookies;
841         /** synchronous write is needed */
842         long                     oti_sync_write:1;
843
844         /* initial thread handling transaction */
845         struct ptlrpc_thread *   oti_thread;
846         __u32                    oti_conn_cnt;
847         /** VBR: versions */
848         __u64                    oti_pre_version;
849         /** JobID */
850         char                    *oti_jobid;
851
852         struct obd_uuid         *oti_ost_uuid;
853 };
854
855 static inline void oti_init(struct obd_trans_info *oti,
856                             struct ptlrpc_request *req)
857 {
858         if (oti == NULL)
859                 return;
860         memset(oti, 0, sizeof(*oti));
861
862         if (req == NULL)
863                 return;
864
865         oti->oti_xid = req->rq_xid;
866         /** VBR: take versions from request */
867         if (req->rq_reqmsg != NULL &&
868             lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
869                 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
870                 oti->oti_pre_version = pre_version ? pre_version[0] : 0;
871                 oti->oti_transno = lustre_msg_get_transno(req->rq_reqmsg);
872         }
873
874         /** called from mds_create_objects */
875         if (req->rq_repmsg != NULL)
876                 oti->oti_transno = lustre_msg_get_transno(req->rq_repmsg);
877         oti->oti_thread = req->rq_svc_thread;
878         if (req->rq_reqmsg != NULL)
879                 oti->oti_conn_cnt = lustre_msg_get_conn_cnt(req->rq_reqmsg);
880 }
881
882 static inline void oti_alloc_cookies(struct obd_trans_info *oti,int num_cookies)
883 {
884         if (!oti)
885                 return;
886
887         if (num_cookies == 1)
888                 oti->oti_logcookies = &oti->oti_onecookie;
889         else
890                 OBD_ALLOC_LARGE(oti->oti_logcookies,
891                                 num_cookies * sizeof(oti->oti_onecookie));
892
893         oti->oti_numcookies = num_cookies;
894 }
895
896 static inline void oti_free_cookies(struct obd_trans_info *oti)
897 {
898         if (!oti || !oti->oti_logcookies)
899                 return;
900
901         if (oti->oti_logcookies == &oti->oti_onecookie)
902                 LASSERT(oti->oti_numcookies == 1);
903         else
904                 OBD_FREE_LARGE(oti->oti_logcookies,
905                                oti->oti_numcookies*sizeof(oti->oti_onecookie));
906         oti->oti_logcookies = NULL;
907         oti->oti_numcookies = 0;
908 }
909
910 /*
911  * Events signalled through obd_notify() upcall-chain.
912  */
913 enum obd_notify_event {
914         /* target added */
915         OBD_NOTIFY_CREATE,
916         /* Device connect start */
917         OBD_NOTIFY_CONNECT,
918         /* Device activated */
919         OBD_NOTIFY_ACTIVE,
920         /* Device deactivated */
921         OBD_NOTIFY_INACTIVE,
922         /* Device disconnected */
923         OBD_NOTIFY_DISCON,
924         /* Connect data for import were changed */
925         OBD_NOTIFY_OCD,
926         /* Sync request */
927         OBD_NOTIFY_SYNC_NONBLOCK,
928         OBD_NOTIFY_SYNC,
929         /* Configuration event */
930         OBD_NOTIFY_CONFIG,
931         /* Administratively deactivate/activate event */
932         OBD_NOTIFY_DEACTIVATE,
933         OBD_NOTIFY_ACTIVATE
934 };
935
936 /* bit-mask flags for config events */
937 enum config_flags {
938         CONFIG_LOG      = 0x1,  /* finished processing config log */
939         CONFIG_SYNC     = 0x2,  /* mdt synced 1 ost */
940         CONFIG_TARGET   = 0x4   /* one target is added */
941 };
942
943 /*
944  * Data structure used to pass obd_notify()-event to non-obd listeners (llite
945  * and liblustre being main examples).
946  */
947 struct obd_notify_upcall {
948         int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
949                           enum obd_notify_event ev, void *owner, void *data);
950         /* Opaque datum supplied by upper layer listener */
951         void *onu_owner;
952 };
953
954 struct target_recovery_data {
955         svc_handler_t           trd_recovery_handler;
956         pid_t                   trd_processing_task;
957         struct completion       trd_starting;
958         struct completion       trd_finishing;
959 };
960
961 /**
962   * In HEAD for CMD, the object is created in group number which is 3>=
963   * or indexing starts from 3. To test this assertions are added to disallow
964   * group 0. But to run 2.0 mds server on 1.8.x disk format (i.e. interop_mode)
965   * object in group 0 needs to be allowed.
966   * So for interop mode following changes needs to be done:
967   * 1. No need to assert on group 0 or allow group 0
968   * 2. The group number indexing starts from 0 instead of 3
969   */
970
971 #define LASSERT_SEQ_IS_MDT(seq) LASSERT(fid_seq_is_mdt(seq))
972
973 static inline __u64 objseq_to_mdsno(obd_seq seq)
974 {
975         LASSERT_SEQ_IS_MDT(seq);
976         if (seq == FID_SEQ_OST_MDT0)
977                 return 0;
978         return seq - FID_SEQ_OST_MDT1 + 1;
979 }
980
981 static inline int mdt_to_obd_objseq(int mdtid)
982 {
983         /**
984          * MDS0 uses seq 0 pre FID-on-OST, other MDSes will use seq from
985          * FID_SEQ_OST_MDT1
986          */
987         if (mdtid)
988                 return FID_SEQ_OST_MDT1 + mdtid - 1;
989         return 0;
990 }
991
992 struct obd_llog_group {
993         cfs_list_t         olg_list;
994         int                olg_seq;
995         struct llog_ctxt  *olg_ctxts[LLOG_MAX_CTXTS];
996         cfs_waitq_t        olg_waitq;
997         spinlock_t         olg_lock;
998         struct obd_export *olg_exp;
999         int                olg_initializing;
1000         struct mutex       olg_cat_processing;
1001 };
1002
1003 /* corresponds to one of the obd's */
1004 #define OBD_DEVICE_MAGIC        0XAB5CD6EF
1005 #define OBD_DEV_BY_DEVNAME      0xffffd0de
1006
1007 struct obd_device {
1008         struct obd_type        *obd_type;
1009         __u32                   obd_magic;
1010
1011         /* common and UUID name of this device */
1012         char                    obd_name[MAX_OBD_NAME];
1013         struct obd_uuid         obd_uuid;
1014
1015         struct lu_device       *obd_lu_dev;
1016
1017         int                     obd_minor;
1018         /* bitfield modification is protected by obd_dev_lock */
1019         unsigned long obd_attached:1,      /* finished attach */
1020                       obd_set_up:1,        /* finished setup */
1021                       obd_recovering:1,    /* there are recoverable clients */
1022                       obd_abort_recovery:1,/* recovery expired */
1023                       obd_version_recov:1, /* obd uses version checking */
1024                       obd_replayable:1,    /* recovery is enabled; inform clients */
1025                       obd_no_transno:1,    /* no committed-transno notification */
1026                       obd_no_recov:1,      /* fail instead of retry messages */
1027                       obd_stopping:1,      /* started cleanup */
1028                       obd_starting:1,      /* started setup */
1029                       obd_force:1,         /* cleanup with > 0 obd refcount */
1030                       obd_fail:1,          /* cleanup with failover */
1031                       obd_async_recov:1,   /* allow asynchronous orphan cleanup */
1032                       obd_no_conn:1,       /* deny new connections */
1033                       obd_inactive:1,      /* device active/inactive
1034                                            * (for /proc/status only!!) */
1035                       obd_no_ir:1,         /* no imperative recovery. */
1036                       obd_process_conf:1;  /* device is processing mgs config */
1037         /* use separate field as it is set in interrupt to don't mess with
1038          * protection of other bits using _bh lock */
1039         unsigned long obd_recovery_expired:1;
1040         /* uuid-export hash body */
1041         cfs_hash_t             *obd_uuid_hash;
1042         /* nid-export hash body */
1043         cfs_hash_t             *obd_nid_hash;
1044         /* nid stats body */
1045         cfs_hash_t             *obd_nid_stats_hash;
1046         cfs_list_t              obd_nid_stats;
1047         cfs_atomic_t            obd_refcount;
1048         cfs_waitq_t             obd_refcount_waitq;
1049         cfs_list_t              obd_exports;
1050         cfs_list_t              obd_unlinked_exports;
1051         cfs_list_t              obd_delayed_exports;
1052         int                     obd_num_exports;
1053         spinlock_t              obd_nid_lock;
1054         struct ldlm_namespace  *obd_namespace;
1055         struct ptlrpc_client    obd_ldlm_client; /* XXX OST/MDS only */
1056         /* a spinlock is OK for what we do now, may need a semaphore later */
1057         spinlock_t              obd_dev_lock; /* protect OBD bitfield above */
1058         struct mutex            obd_dev_mutex;
1059         __u64                   obd_last_committed;
1060         struct fsfilt_operations *obd_fsops;
1061         spinlock_t              obd_osfs_lock;
1062         struct obd_statfs       obd_osfs;       /* locked by obd_osfs_lock */
1063         __u64                   obd_osfs_age;
1064         struct lvfs_run_ctxt    obd_lvfs_ctxt;
1065         struct obd_llog_group   obd_olg;        /* default llog group */
1066         struct obd_device       *obd_observer;
1067         struct rw_semaphore     obd_observer_link_sem;
1068         struct obd_notify_upcall obd_upcall;
1069         struct obd_export       *obd_self_export;
1070         /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
1071         cfs_list_t              obd_exports_timed;
1072         time_t                  obd_eviction_timer; /* for ping evictor */
1073
1074         int                              obd_max_recoverable_clients;
1075         cfs_atomic_t                     obd_connected_clients;
1076         int                              obd_stale_clients;
1077         int                              obd_delayed_clients;
1078         /* this lock protects all recovery list_heads, timer and
1079          * obd_next_recovery_transno value */
1080         spinlock_t                       obd_recovery_task_lock;
1081         __u64                            obd_next_recovery_transno;
1082         int                              obd_replayed_requests;
1083         int                              obd_requests_queued_for_recovery;
1084         cfs_waitq_t                      obd_next_transno_waitq;
1085         /* protected by obd_recovery_task_lock */
1086         cfs_timer_t                      obd_recovery_timer;
1087         time_t                           obd_recovery_start; /* seconds */
1088         time_t                           obd_recovery_end; /* seconds, for lprocfs_status */
1089         int                              obd_recovery_time_hard;
1090         int                              obd_recovery_timeout;
1091         int                              obd_recovery_ir_factor;
1092
1093         /* new recovery stuff from CMD2 */
1094         struct target_recovery_data      obd_recovery_data;
1095         int                              obd_replayed_locks;
1096         cfs_atomic_t                     obd_req_replay_clients;
1097         cfs_atomic_t                     obd_lock_replay_clients;
1098         /* all lists are protected by obd_recovery_task_lock */
1099         cfs_list_t                       obd_req_replay_queue;
1100         cfs_list_t                       obd_lock_replay_queue;
1101         cfs_list_t                       obd_final_req_queue;
1102         int                              obd_recovery_stage;
1103
1104         union {
1105                 struct obd_device_target obt;
1106                 struct filter_obd filter;
1107                 struct client_obd cli;
1108                 struct ost_obd ost;
1109                 struct echo_client_obd echo_client;
1110                 struct echo_obd echo;
1111                 struct lov_obd lov;
1112                 struct lmv_obd lmv;
1113         } u;
1114         /* Fields used by LProcFS */
1115         unsigned int           obd_cntr_base;
1116         struct lprocfs_stats  *obd_stats;
1117
1118         unsigned int           md_cntr_base;
1119         struct lprocfs_stats  *md_stats;
1120
1121         cfs_proc_dir_entry_t  *obd_proc_entry;
1122         cfs_proc_dir_entry_t  *obd_proc_exports_entry;
1123         cfs_proc_dir_entry_t  *obd_svc_procroot;
1124         struct lprocfs_stats  *obd_svc_stats;
1125         cfs_atomic_t           obd_evict_inprogress;
1126         cfs_waitq_t            obd_evict_inprogress_waitq;
1127         cfs_list_t             obd_evict_list; /* protected with pet_lock */
1128
1129         /**
1130          * Ldlm pool part. Save last calculated SLV and Limit.
1131          */
1132         rwlock_t                obd_pool_lock;
1133         int                    obd_pool_limit;
1134         __u64                  obd_pool_slv;
1135
1136         /**
1137          * A list of outstanding class_incref()'s against this obd. For
1138          * debugging.
1139          */
1140         struct lu_ref          obd_reference;
1141
1142         int                    obd_conn_inprogress;
1143 };
1144
1145 #define OBD_LLOG_FL_SENDNOW     0x0001
1146 #define OBD_LLOG_FL_EXIT        0x0002
1147
1148 enum obd_cleanup_stage {
1149 /* Special case hack for MDS LOVs */
1150         OBD_CLEANUP_EARLY,
1151 /* can be directly mapped to .ldto_device_fini() */
1152         OBD_CLEANUP_EXPORTS,
1153 };
1154
1155 /* get/set_info keys */
1156 #define KEY_ASYNC               "async"
1157 #define KEY_BLOCKSIZE_BITS      "blocksize_bits"
1158 #define KEY_BLOCKSIZE           "blocksize"
1159 #define KEY_CAPA_KEY            "capa_key"
1160 #define KEY_CHANGELOG_CLEAR     "changelog_clear"
1161 #define KEY_FID2PATH            "fid2path"
1162 #define KEY_CHECKSUM            "checksum"
1163 #define KEY_CLEAR_FS            "clear_fs"
1164 #define KEY_CONN_DATA           "conn_data"
1165 #define KEY_EVICT_BY_NID        "evict_by_nid"
1166 #define KEY_FIEMAP              "fiemap"
1167 #define KEY_FLUSH_CTX           "flush_ctx"
1168 #define KEY_GRANT_SHRINK        "grant_shrink"
1169 #define KEY_HSM_COPYTOOL_SEND   "hsm_send"
1170 #define KEY_INIT_RECOV_BACKUP   "init_recov_bk"
1171 #define KEY_INIT_RECOV          "initial_recov"
1172 #define KEY_INTERMDS            "inter_mds"
1173 #define KEY_LAST_ID             "last_id"
1174 #define KEY_LOCK_TO_STRIPE      "lock_to_stripe"
1175 #define KEY_LOVDESC             "lovdesc"
1176 #define KEY_LOV_IDX             "lov_idx"
1177 #define KEY_MAX_EASIZE          "max_easize"
1178 #define KEY_MDS_CONN            "mds_conn"
1179 #define KEY_MGSSEC              "mgssec"
1180 #define KEY_NEXT_ID             "next_id"
1181 #define KEY_READ_ONLY           "read-only"
1182 #define KEY_REGISTER_TARGET     "register_target"
1183 #define KEY_SET_FS              "set_fs"
1184 #define KEY_TGT_COUNT           "tgt_count"
1185 /*      KEY_SET_INFO in lustre_idl.h */
1186 #define KEY_SPTLRPC_CONF        "sptlrpc_conf"
1187 #define KEY_CONNECT_FLAG        "connect_flags"
1188 #define KEY_SYNC_LOCK_CANCEL    "sync_lock_cancel"
1189
1190 #define KEY_CACHE_SET           "cache_set"
1191 #define KEY_CACHE_LRU_SHRINK    "cache_lru_shrink"
1192
1193 struct lu_context;
1194
1195 /* /!\ must be coherent with include/linux/namei.h on patched kernel */
1196 #define IT_OPEN     (1 << 0)
1197 #define IT_CREAT    (1 << 1)
1198 #define IT_READDIR  (1 << 2)
1199 #define IT_GETATTR  (1 << 3)
1200 #define IT_LOOKUP   (1 << 4)
1201 #define IT_UNLINK   (1 << 5)
1202 #define IT_TRUNC    (1 << 6)
1203 #define IT_GETXATTR (1 << 7)
1204 #define IT_EXEC     (1 << 8)
1205 #define IT_PIN      (1 << 9)
1206 #define IT_LAYOUT   (1 << 10)
1207 #define IT_QUOTA_DQACQ (1 << 11)
1208 #define IT_QUOTA_CONN  (1 << 12)
1209
1210 static inline int it_to_lock_mode(struct lookup_intent *it)
1211 {
1212         /* CREAT needs to be tested before open (both could be set) */
1213         if (it->it_op & IT_CREAT)
1214                 return LCK_CW;
1215         else if (it->it_op & (IT_READDIR | IT_GETATTR | IT_OPEN | IT_LOOKUP |
1216                               IT_LAYOUT))
1217                 return LCK_CR;
1218
1219         LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
1220         return -EINVAL;
1221 }
1222
1223 struct md_op_data {
1224         struct lu_fid           op_fid1; /* operation fid1 (usualy parent) */
1225         struct lu_fid           op_fid2; /* operation fid2 (usualy child) */
1226         struct lu_fid           op_fid3; /* 2 extra fids to find conflicting */
1227         struct lu_fid           op_fid4; /* to the operation locks. */
1228         mdsno_t                 op_mds;  /* what mds server open will go to */
1229         struct lustre_handle    op_handle;
1230         obd_time                op_mod_time;
1231         const char             *op_name;
1232         int                     op_namelen;
1233         __u32                   op_mode;
1234         struct lmv_stripe_md   *op_mea1;
1235         struct lmv_stripe_md   *op_mea2;
1236         __u32                   op_suppgids[2];
1237         __u32                   op_fsuid;
1238         __u32                   op_fsgid;
1239         cfs_cap_t               op_cap;
1240         void                   *op_data;
1241
1242         /* iattr fields and blocks. */
1243         struct iattr            op_attr;
1244 #ifdef __KERNEL__
1245         unsigned int            op_attr_flags;
1246 #endif
1247         __u64                   op_valid;
1248         loff_t                  op_attr_blocks;
1249
1250         /* Size-on-MDS epoch and flags. */
1251         __u64                   op_ioepoch;
1252         __u32                   op_flags;
1253
1254         /* Capa fields */
1255         struct obd_capa        *op_capa1;
1256         struct obd_capa        *op_capa2;
1257
1258         /* Various operation flags. */
1259         __u32                   op_bias;
1260
1261         /* Operation type */
1262         __u32                   op_opc;
1263
1264         /* Used by readdir */
1265         __u32                   op_npages;
1266         __u64                   op_offset;
1267 };
1268
1269 struct md_enqueue_info;
1270 /* metadata stat-ahead */
1271 typedef int (* md_enqueue_cb_t)(struct ptlrpc_request *req,
1272                                 struct md_enqueue_info *minfo,
1273                                 int rc);
1274
1275 struct md_enqueue_info {
1276         struct md_op_data       mi_data;
1277         struct lookup_intent    mi_it;
1278         struct lustre_handle    mi_lockh;
1279         struct inode           *mi_dir;
1280         md_enqueue_cb_t         mi_cb;
1281         __u64                   mi_cbdata;
1282         unsigned int            mi_generation;
1283 };
1284
1285 struct obd_ops {
1286         cfs_module_t *o_owner;
1287         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
1288                            void *karg, void *uarg);
1289         int (*o_get_info)(const struct lu_env *env, struct obd_export *,
1290                           __u32 keylen, void *key, __u32 *vallen, void *val,
1291                           struct lov_stripe_md *lsm);
1292         int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
1293                                 __u32 keylen, void *key,
1294                                 __u32 vallen, void *val,
1295                                 struct ptlrpc_request_set *set);
1296         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
1297         int (*o_detach)(struct obd_device *dev);
1298         int (*o_setup) (struct obd_device *dev, struct lustre_cfg *cfg);
1299         int (*o_precleanup)(struct obd_device *dev,
1300                             enum obd_cleanup_stage cleanup_stage);
1301         int (*o_cleanup)(struct obd_device *dev);
1302         int (*o_process_config)(struct obd_device *dev, obd_count len,
1303                                 void *data);
1304         int (*o_postrecov)(struct obd_device *dev);
1305         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
1306                           int priority);
1307         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
1308         /* connect to the target device with given connection
1309          * data. @ocd->ocd_connect_flags is modified to reflect flags actually
1310          * granted by the target, which are guaranteed to be a subset of flags
1311          * asked for. If @ocd == NULL, use default parameters. */
1312         int (*o_connect)(const struct lu_env *env,
1313                          struct obd_export **exp, struct obd_device *src,
1314                          struct obd_uuid *cluuid, struct obd_connect_data *ocd,
1315                          void *localdata);
1316         int (*o_reconnect)(const struct lu_env *env,
1317                            struct obd_export *exp, struct obd_device *src,
1318                            struct obd_uuid *cluuid,
1319                            struct obd_connect_data *ocd,
1320                            void *localdata);
1321         int (*o_disconnect)(struct obd_export *exp);
1322
1323         /* Initialize/finalize fids infrastructure. */
1324         int (*o_fid_init)(struct obd_export *exp);
1325         int (*o_fid_fini)(struct obd_export *exp);
1326
1327         /* Allocate new fid according to passed @hint. */
1328         int (*o_fid_alloc)(struct obd_export *exp, struct lu_fid *fid,
1329                            struct md_op_data *op_data);
1330
1331         /*
1332          * Object with @fid is getting deleted, we may want to do something
1333          * about this.
1334          */
1335         int (*o_fid_delete)(struct obd_export *exp, const struct lu_fid *fid);
1336
1337         int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
1338                         struct obd_statfs *osfs, __u64 max_age, __u32 flags);
1339         int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
1340                               __u64 max_age, struct ptlrpc_request_set *set);
1341         int (*o_packmd)(struct obd_export *exp, struct lov_mds_md **disk_tgt,
1342                         struct lov_stripe_md *mem_src);
1343         int (*o_unpackmd)(struct obd_export *exp,struct lov_stripe_md **mem_tgt,
1344                           struct lov_mds_md *disk_src, int disk_len);
1345         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
1346                              obd_id *ids);
1347         /* FIXME: add fid capability support for create & destroy! */
1348         int (*o_precreate)(struct obd_export *exp);
1349         int (*o_create)(const struct lu_env *env, struct obd_export *exp,
1350                         struct obdo *oa, struct lov_stripe_md **ea,
1351                         struct obd_trans_info *oti);
1352         int (*o_create_async)(struct obd_export *exp,  struct obd_info *oinfo,
1353                               struct lov_stripe_md **ea,
1354                               struct obd_trans_info *oti);
1355         int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
1356                          struct obdo *oa, struct lov_stripe_md *ea,
1357                          struct obd_trans_info *oti, struct obd_export *md_exp,
1358                          void *capa);
1359         int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
1360                          struct obd_info *oinfo, struct obd_trans_info *oti);
1361         int (*o_setattr_async)(struct obd_export *exp, struct obd_info *oinfo,
1362                                struct obd_trans_info *oti,
1363                                struct ptlrpc_request_set *rqset);
1364         int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
1365                          struct obd_info *oinfo);
1366         int (*o_getattr_async)(struct obd_export *exp, struct obd_info *oinfo,
1367                                struct ptlrpc_request_set *set);
1368         int (*o_brw)(int rw, struct obd_export *exp, struct obd_info *oinfo,
1369                      obd_count oa_bufs, struct brw_page *pgarr,
1370                      struct obd_trans_info *oti);
1371         int (*o_merge_lvb)(struct obd_export *exp, struct lov_stripe_md *lsm,
1372                            struct ost_lvb *lvb, int kms_only);
1373         int (*o_adjust_kms)(struct obd_export *exp, struct lov_stripe_md *lsm,
1374                             obd_off size, int shrink);
1375         int (*o_punch)(const struct lu_env *, struct obd_export *exp,
1376                        struct obd_info *oinfo, struct obd_trans_info *oti,
1377                        struct ptlrpc_request_set *rqset);
1378         int (*o_sync)(const struct lu_env *env, struct obd_export *exp,
1379                       struct obd_info *oinfo, obd_size start, obd_size end,
1380                       struct ptlrpc_request_set *set);
1381         int (*o_migrate)(struct lustre_handle *conn, struct lov_stripe_md *dst,
1382                          struct lov_stripe_md *src, obd_size start,
1383                          obd_size end, struct obd_trans_info *oti);
1384         int (*o_copy)(struct lustre_handle *dstconn, struct lov_stripe_md *dst,
1385                       struct lustre_handle *srconn, struct lov_stripe_md *src,
1386                       obd_size start, obd_size end, struct obd_trans_info *);
1387         int (*o_iterate)(struct lustre_handle *conn,
1388                          int (*)(obd_id, obd_seq, void *),
1389                          obd_id *startid, obd_seq seq, void *data);
1390         int (*o_preprw)(const struct lu_env *env, int cmd,
1391                         struct obd_export *exp, struct obdo *oa, int objcount,
1392                         struct obd_ioobj *obj, struct niobuf_remote *remote,
1393                         int *nr_pages, struct niobuf_local *local,
1394                         struct obd_trans_info *oti, struct lustre_capa *capa);
1395         int (*o_commitrw)(const struct lu_env *env, int cmd,
1396                           struct obd_export *exp, struct obdo *oa,
1397                           int objcount, struct obd_ioobj *obj,
1398                           struct niobuf_remote *remote, int pages,
1399                           struct niobuf_local *local,
1400                           struct obd_trans_info *oti, int rc);
1401         int (*o_enqueue)(struct obd_export *, struct obd_info *oinfo,
1402                          struct ldlm_enqueue_info *einfo,
1403                          struct ptlrpc_request_set *rqset);
1404         int (*o_change_cbdata)(struct obd_export *, struct lov_stripe_md *,
1405                                ldlm_iterator_t it, void *data);
1406         int (*o_find_cbdata)(struct obd_export *, struct lov_stripe_md *,
1407                              ldlm_iterator_t it, void *data);
1408         int (*o_cancel)(struct obd_export *, struct lov_stripe_md *md,
1409                         __u32 mode, struct lustre_handle *);
1410         int (*o_cancel_unused)(struct obd_export *, struct lov_stripe_md *,
1411                                ldlm_cancel_flags_t flags, void *opaque);
1412         int (*o_init_export)(struct obd_export *exp);
1413         int (*o_destroy_export)(struct obd_export *exp);
1414         int (*o_extent_calc)(struct obd_export *, struct lov_stripe_md *,
1415                              int cmd, obd_off *);
1416
1417         /* llog related obd_methods */
1418         int (*o_llog_init)(struct obd_device *obd, struct obd_llog_group *grp,
1419                            struct obd_device *disk_obd, int *idx);
1420         int (*o_llog_finish)(struct obd_device *obd, int count);
1421         int (*o_llog_connect)(struct obd_export *, struct llogd_conn_body *);
1422
1423         /* metadata-only methods */
1424         int (*o_pin)(struct obd_export *, const struct lu_fid *fid,
1425                      struct obd_capa *, struct obd_client_handle *, int flag);
1426         int (*o_unpin)(struct obd_export *, struct obd_client_handle *, int);
1427
1428         int (*o_import_event)(struct obd_device *, struct obd_import *,
1429                               enum obd_import_event);
1430
1431         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1432                         enum obd_notify_event ev, void *data);
1433
1434         int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1435         struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1436
1437         /* quota methods */
1438         int (*o_quotacheck)(struct obd_device *, struct obd_export *,
1439                             struct obd_quotactl *);
1440         int (*o_quotactl)(struct obd_device *, struct obd_export *,
1441                           struct obd_quotactl *);
1442
1443         int (*o_ping)(const struct lu_env *, struct obd_export *exp);
1444
1445         /* pools methods */
1446         int (*o_pool_new)(struct obd_device *obd, char *poolname);
1447         int (*o_pool_del)(struct obd_device *obd, char *poolname);
1448         int (*o_pool_add)(struct obd_device *obd, char *poolname,
1449                           char *ostname);
1450         int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1451                           char *ostname);
1452         void (*o_getref)(struct obd_device *obd);
1453         void (*o_putref)(struct obd_device *obd);
1454         /*
1455          * NOTE: If adding ops, add another LPROCFS_OBD_OP_INIT() line
1456          * to lprocfs_alloc_obd_stats() in obdclass/lprocfs_status.c.
1457          * Also, add a wrapper function in include/linux/obd_class.h. */
1458 };
1459
1460 enum {
1461         LUSTRE_OPC_MKDIR    = (1 << 0),
1462         LUSTRE_OPC_SYMLINK  = (1 << 1),
1463         LUSTRE_OPC_MKNOD    = (1 << 2),
1464         LUSTRE_OPC_CREATE   = (1 << 3),
1465         LUSTRE_OPC_ANY      = (1 << 4)
1466 };
1467
1468 /* lmv structures */
1469 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
1470 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
1471 #define MEA_MAGIC_HASH_SEGMENT   0xb222a11b
1472
1473 #define MAX_HASH_SIZE_32         0x7fffffffUL
1474 #define MAX_HASH_SIZE            0x7fffffffffffffffULL
1475 #define MAX_HASH_HIGHEST_BIT     0x1000000000000000ULL
1476
1477 struct lustre_md {
1478         struct mdt_body         *body;
1479         struct lov_stripe_md    *lsm;
1480         struct lmv_stripe_md    *mea;
1481 #ifdef CONFIG_FS_POSIX_ACL
1482         struct posix_acl        *posix_acl;
1483 #endif
1484         struct mdt_remote_perm  *remote_perm;
1485         struct obd_capa         *mds_capa;
1486         struct obd_capa         *oss_capa;
1487 };
1488
1489 struct md_open_data {
1490         struct obd_client_handle *mod_och;
1491         struct ptlrpc_request    *mod_open_req;
1492         struct ptlrpc_request    *mod_close_req;
1493         cfs_atomic_t              mod_refcount;
1494 };
1495
1496 struct lookup_intent;
1497
1498 struct md_ops {
1499         int (*m_getstatus)(struct obd_export *, struct lu_fid *,
1500                            struct obd_capa **);
1501         int (*m_change_cbdata)(struct obd_export *, const struct lu_fid *,
1502                                ldlm_iterator_t, void *);
1503         int (*m_find_cbdata)(struct obd_export *, const struct lu_fid *,
1504                              ldlm_iterator_t, void *);
1505         int (*m_close)(struct obd_export *, struct md_op_data *,
1506                        struct md_open_data *, struct ptlrpc_request **);
1507         int (*m_create)(struct obd_export *, struct md_op_data *,
1508                         const void *, int, int, __u32, __u32, cfs_cap_t,
1509                         __u64, struct ptlrpc_request **);
1510         int (*m_done_writing)(struct obd_export *, struct md_op_data  *,
1511                               struct md_open_data *);
1512         int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1513                          struct lookup_intent *, struct md_op_data *,
1514                          struct lustre_handle *, void *, int,
1515                          struct ptlrpc_request **, __u64);
1516         int (*m_getattr)(struct obd_export *, struct md_op_data *,
1517                          struct ptlrpc_request **);
1518         int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1519                               struct ptlrpc_request **);
1520         int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1521                              void *, int, struct lookup_intent *, int,
1522                              struct ptlrpc_request **,
1523                              ldlm_blocking_callback, __u64);
1524         int (*m_link)(struct obd_export *, struct md_op_data *,
1525                       struct ptlrpc_request **);
1526         int (*m_rename)(struct obd_export *, struct md_op_data *,
1527                         const char *, int, const char *, int,
1528                         struct ptlrpc_request **);
1529         int (*m_is_subdir)(struct obd_export *, const struct lu_fid *,
1530                            const struct lu_fid *,
1531                            struct ptlrpc_request **);
1532         int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1533                          int , void *, int, struct ptlrpc_request **,
1534                          struct md_open_data **mod);
1535         int (*m_sync)(struct obd_export *, const struct lu_fid *,
1536                       struct obd_capa *, struct ptlrpc_request **);
1537         int (*m_readpage)(struct obd_export *, struct md_op_data *,
1538                           struct page **, struct ptlrpc_request **);
1539
1540         int (*m_unlink)(struct obd_export *, struct md_op_data *,
1541                         struct ptlrpc_request **);
1542
1543         int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1544                           struct obd_capa *, obd_valid, const char *,
1545                           const char *, int, int, int, __u32,
1546                           struct ptlrpc_request **);
1547
1548         int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1549                           struct obd_capa *, obd_valid, const char *,
1550                           const char *, int, int, int,
1551                           struct ptlrpc_request **);
1552
1553         int (*m_init_ea_size)(struct obd_export *, int, int, int);
1554
1555         int (*m_get_lustre_md)(struct obd_export *, struct ptlrpc_request *,
1556                                struct obd_export *, struct obd_export *,
1557                                struct lustre_md *);
1558
1559         int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1560
1561         int (*m_set_open_replay_data)(struct obd_export *,
1562                                       struct obd_client_handle *,
1563                                       struct ptlrpc_request *);
1564         int (*m_clear_open_replay_data)(struct obd_export *,
1565                                         struct obd_client_handle *);
1566         int (*m_set_lock_data)(struct obd_export *, __u64 *, void *, __u64 *);
1567
1568         ldlm_mode_t (*m_lock_match)(struct obd_export *, __u64,
1569                                     const struct lu_fid *, ldlm_type_t,
1570                                     ldlm_policy_data_t *, ldlm_mode_t,
1571                                     struct lustre_handle *);
1572
1573         int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1574                                ldlm_policy_data_t *, ldlm_mode_t,
1575                                ldlm_cancel_flags_t flags, void *opaque);
1576         int (*m_renew_capa)(struct obd_export *, struct obd_capa *oc,
1577                             renew_capa_cb_t cb);
1578         int (*m_unpack_capa)(struct obd_export *, struct ptlrpc_request *,
1579                              const struct req_msg_field *, struct obd_capa **);
1580
1581         int (*m_get_remote_perm)(struct obd_export *, const struct lu_fid *,
1582                                  struct obd_capa *, __u32,
1583                                  struct ptlrpc_request **);
1584
1585         int (*m_intent_getattr_async)(struct obd_export *,
1586                                       struct md_enqueue_info *,
1587                                       struct ldlm_enqueue_info *);
1588
1589         int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1590                                  struct lu_fid *, __u64 *bits);
1591
1592         /*
1593          * NOTE: If adding ops, add another LPROCFS_MD_OP_INIT() line to
1594          * lprocfs_alloc_md_stats() in obdclass/lprocfs_status.c. Also, add a
1595          * wrapper function in include/linux/obd_class.h.
1596          */
1597 };
1598
1599 struct lsm_operations {
1600         void (*lsm_free)(struct lov_stripe_md *);
1601         int (*lsm_destroy)(struct lov_stripe_md *, struct obdo *oa,
1602                            struct obd_export *md_exp);
1603         void (*lsm_stripe_by_index)(struct lov_stripe_md *, int *, obd_off *,
1604                                     obd_off *);
1605         void (*lsm_stripe_by_offset)(struct lov_stripe_md *, int *, obd_off *,
1606                                      obd_off *);
1607         int (*lsm_lmm_verify) (struct lov_mds_md *lmm, int lmm_bytes,
1608                                __u16 *stripe_count);
1609         int (*lsm_unpackmd) (struct lov_obd *lov, struct lov_stripe_md *lsm,
1610                              struct lov_mds_md *lmm);
1611 };
1612
1613 extern const struct lsm_operations lsm_v1_ops;
1614 extern const struct lsm_operations lsm_v3_ops;
1615 static inline const struct lsm_operations *lsm_op_find(int magic)
1616 {
1617         switch(magic) {
1618         case LOV_MAGIC_V1:
1619                return &lsm_v1_ops;
1620         case LOV_MAGIC_V3:
1621                return &lsm_v3_ops;
1622         default:
1623                CERROR("Cannot recognize lsm_magic %08x\n", magic);
1624                return NULL;
1625         }
1626 }
1627
1628 int lvfs_check_io_health(struct obd_device *obd, struct file *file);
1629
1630 /* Requests for obd_extent_calc() */
1631 #define OBD_CALC_STRIPE_START   1
1632 #define OBD_CALC_STRIPE_END     2
1633
1634 static inline struct lustre_capa *oinfo_capa(struct obd_info *oinfo)
1635 {
1636         return oinfo->oi_capa;
1637 }
1638
1639 static inline struct md_open_data *obd_mod_alloc(void)
1640 {
1641         struct md_open_data *mod;
1642         OBD_ALLOC_PTR(mod);
1643         if (mod == NULL)
1644                 return NULL;
1645         cfs_atomic_set(&mod->mod_refcount, 1);
1646         return mod;
1647 }
1648
1649 #define obd_mod_get(mod) cfs_atomic_inc(&(mod)->mod_refcount)
1650 #define obd_mod_put(mod)                                        \
1651 ({                                                              \
1652         if (cfs_atomic_dec_and_test(&(mod)->mod_refcount)) {          \
1653                 if ((mod)->mod_open_req)                          \
1654                         ptlrpc_req_finished((mod)->mod_open_req);   \
1655                 OBD_FREE_PTR(mod);                              \
1656         }                                                       \
1657 })
1658
1659 void obdo_from_inode(struct obdo *dst, struct inode *src, obd_flag valid);
1660 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1661
1662 /* return 1 if client should be resend request */
1663 static inline int client_should_resend(int resend, struct client_obd *cli)
1664 {
1665         return cfs_atomic_read(&cli->cl_resends) ?
1666                cfs_atomic_read(&cli->cl_resends) > resend : 1;
1667 }
1668
1669 /**
1670  * Return device name for this device
1671  *
1672  * XXX: lu_device is declared before obd_device, while a pointer pointing
1673  * back to obd_device in lu_device, so this helper function defines here
1674  * instead of in lu_object.h
1675  */
1676 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1677 {
1678         return lu_dev->ld_obd->obd_name;
1679 }
1680
1681 #endif /* __OBD_H */