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