Whamcloud - gitweb
land clio.
[fs/lustre-release.git] / lustre / include / obd.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 /* Moved to lustre_user.h
58 #define IOC_MDC_LOOKUP       _IOWR(IOC_MDC_TYPE, 20, struct obd_ioctl_data *)
59 #define IOC_MDC_GETSTRIPE    _IOWR(IOC_MDC_TYPE, 21, struct lov_mds_md *) */
60 #define IOC_MDC_MAX_NR       50
61
62 #include <lustre/lustre_idl.h>
63 #include <lu_object.h>
64 #include <lu_ref.h>
65 #include <lustre_lib.h>
66 #include <lustre_export.h>
67 #include <lustre_quota.h>
68 #include <lustre_fld.h>
69 #include <lustre_capa.h>
70 #include <class_hash.h>
71
72 #include <libcfs/bitmap.h>
73
74
75 #define MAX_OBD_DEVICES 8192
76
77 /* this is really local to the OSC */
78 struct loi_oap_pages {
79         struct list_head        lop_pending;
80         struct list_head        lop_urgent;
81         struct list_head        lop_pending_group;
82         int                     lop_num_pending;
83 };
84
85 struct osc_async_rc {
86         int     ar_rc;
87         int     ar_force_sync;
88         __u64   ar_min_xid;
89 };
90
91 struct lov_oinfo {                 /* per-stripe data structure */
92         __u64 loi_id;              /* object ID on the target OST */
93         __u64 loi_gr;              /* object group on the target OST */
94         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
95         int loi_ost_gen;           /* generation of this loi_ost_idx */
96
97         /* used by the osc to keep track of what objects to build into rpcs */
98         struct loi_oap_pages loi_read_lop;
99         struct loi_oap_pages loi_write_lop;
100         /* _cli_ is poorly named, it should be _ready_ */
101         struct list_head loi_cli_item;
102         struct list_head loi_write_item;
103         struct list_head loi_read_item;
104
105         unsigned long loi_kms_valid:1;
106         __u64 loi_kms;             /* known minimum size */
107         struct ost_lvb loi_lvb;
108         struct osc_async_rc     loi_ar;
109 };
110
111 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
112 {
113         oinfo->loi_kms = kms;
114         oinfo->loi_kms_valid = 1;
115 }
116
117 static inline void loi_init(struct lov_oinfo *loi)
118 {
119         CFS_INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending);
120         CFS_INIT_LIST_HEAD(&loi->loi_read_lop.lop_urgent);
121         CFS_INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending_group);
122         CFS_INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending);
123         CFS_INIT_LIST_HEAD(&loi->loi_write_lop.lop_urgent);
124         CFS_INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending_group);
125         CFS_INIT_LIST_HEAD(&loi->loi_cli_item);
126         CFS_INIT_LIST_HEAD(&loi->loi_write_item);
127         CFS_INIT_LIST_HEAD(&loi->loi_read_item);
128 }
129
130 /*extent array item for describing the joined file extent info*/
131 struct lov_extent {
132         __u64 le_start;            /* extent start */
133         __u64 le_len;              /* extent length */
134         int   le_loi_idx;          /* extent #1 loi's index in lsm loi array */
135         int   le_stripe_count;     /* extent stripe count*/
136 };
137
138 /*Lov array info for describing joined file array EA info*/
139 struct lov_array_info {
140         struct llog_logid    lai_array_id;    /* MDS med llog object id */
141         unsigned             lai_ext_count; /* number of extent count */
142         struct lov_extent    *lai_ext_array; /* extent desc array */
143 };
144
145 struct lov_stripe_md {
146         spinlock_t       lsm_lock;
147         pid_t            lsm_lock_owner; /* debugging */
148
149         struct {
150                 /* Public members. */
151                 __u64 lw_object_id;        /* lov object id */
152                 __u64 lw_object_gr;        /* lov object group */
153                 __u64 lw_maxbytes;         /* maximum possible file size */
154
155                 /* LOV-private members start here -- only for use in lov/. */
156                 __u32 lw_magic;
157                 __u32 lw_stripe_size;      /* size of the stripe */
158                 __u32 lw_pattern;          /* striping pattern (RAID0, RAID1) */
159                 unsigned lw_stripe_count;  /* number of objects being striped over */
160                 char  lw_pool_name[LOV_MAXPOOLNAME]; /* pool name */
161         } lsm_wire;
162
163         struct lov_array_info *lsm_array; /*Only for joined file array info*/
164         struct lov_oinfo *lsm_oinfo[0];
165 };
166
167 #define lsm_object_id    lsm_wire.lw_object_id
168 #define lsm_object_gr    lsm_wire.lw_object_gr
169 #define lsm_maxbytes     lsm_wire.lw_maxbytes
170 #define lsm_magic        lsm_wire.lw_magic
171 #define lsm_stripe_size  lsm_wire.lw_stripe_size
172 #define lsm_pattern      lsm_wire.lw_pattern
173 #define lsm_stripe_count lsm_wire.lw_stripe_count
174 #define lsm_pool_name    lsm_wire.lw_pool_name
175
176 struct obd_info;
177
178 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
179
180 /* obd info for a particular level (lov, osc). */
181 struct obd_info {
182         /* Lock policy. It keeps an extent which is specific for a particular
183          * OSC. (e.g. lov_prep_enqueue_set initialises extent of the policy,
184          * and osc_enqueue passes it into ldlm_lock_match & ldlm_cli_enqueue. */
185         ldlm_policy_data_t      oi_policy;
186         /* Flags used for set request specific flags:
187            - while lock handling, the flags obtained on the enqueue
188            request are set here.
189            - while stats, the flags used for control delay/resend.
190          */
191         int                     oi_flags;
192         /* Lock handle specific for every OSC lock. */
193         struct lustre_handle   *oi_lockh;
194         /* lsm data specific for every OSC. */
195         struct lov_stripe_md   *oi_md;
196         /* obdo data specific for every OSC, if needed at all. */
197         struct obdo            *oi_oa;
198         /* statfs data specific for every OSC, if needed at all. */
199         struct obd_statfs      *oi_osfs;
200         /* An update callback which is called to update some data on upper
201          * level. E.g. it is used for update lsm->lsm_oinfo at every recieved
202          * request in osc level for enqueue requests. It is also possible to
203          * update some caller data from LOV layer if needed. */
204         obd_enqueue_update_f    oi_cb_up;
205         /* oss capability, its type is obd_capa in client to avoid copy.
206          * in contrary its type is lustre_capa in OSS. */
207         void                   *oi_capa;
208 };
209
210 /* compare all relevant fields. */
211 static inline int lov_stripe_md_cmp(struct lov_stripe_md *m1,
212                                     struct lov_stripe_md *m2)
213 {
214         /*
215          * ->lsm_wire contains padding, but it should be zeroed out during
216          * allocation.
217          */
218         return memcmp(&m1->lsm_wire, &m2->lsm_wire, sizeof m1->lsm_wire);
219 }
220
221 void lov_stripe_lock(struct lov_stripe_md *md);
222 void lov_stripe_unlock(struct lov_stripe_md *md);
223
224 struct obd_type {
225         struct list_head typ_chain;
226         struct obd_ops *typ_dt_ops;
227         struct md_ops *typ_md_ops;
228         cfs_proc_dir_entry_t *typ_procroot;
229         char *typ_name;
230         int  typ_refcnt;
231         struct lu_device_type *typ_lu;
232         spinlock_t obd_type_lock;
233 };
234
235 struct brw_page {
236         obd_off  off;
237         cfs_page_t *pg;
238         int count;
239         obd_flag flag;
240 };
241
242 /* Individual type definitions */
243
244 struct ost_server_data;
245
246 /* hold common fields for "target" device */
247 struct obd_device_target {
248         struct super_block       *obt_sb;
249         atomic_t                  obt_quotachecking;
250         struct lustre_quota_ctxt  obt_qctxt;
251 };
252
253 /* llog contexts */
254 enum llog_ctxt_id {
255         LLOG_CONFIG_ORIG_CTXT  =  0,
256         LLOG_CONFIG_REPL_CTXT,
257         LLOG_MDS_OST_ORIG_CTXT,
258         LLOG_MDS_OST_REPL_CTXT,
259         LLOG_SIZE_ORIG_CTXT,
260         LLOG_SIZE_REPL_CTXT,
261         LLOG_RD1_ORIG_CTXT,
262         LLOG_RD1_REPL_CTXT,
263         LLOG_TEST_ORIG_CTXT,
264         LLOG_TEST_REPL_CTXT,
265         LLOG_LOVEA_ORIG_CTXT,
266         LLOG_LOVEA_REPL_CTXT,
267         LLOG_MAX_CTXTS
268 };
269
270 #define FILTER_SUBDIR_COUNT      32            /* set to zero for no subdirs */
271
272 struct filter_subdirs {
273        cfs_dentry_t *dentry[FILTER_SUBDIR_COUNT];
274 };
275
276
277 struct filter_ext {
278         __u64                fe_start;
279         __u64                fe_end;
280 };
281
282 struct filter_obd {
283         /* NB this field MUST be first */
284         struct obd_device_target fo_obt;
285         const char          *fo_fstype;
286         struct vfsmount     *fo_vfsmnt;
287
288         int                  fo_group_count;
289         cfs_dentry_t        *fo_dentry_O;
290         cfs_dentry_t       **fo_dentry_O_groups;
291         struct filter_subdirs   *fo_dentry_O_sub;
292         struct semaphore     fo_init_lock;      /* group initialization lock */
293         int                  fo_committed_group;
294
295
296         spinlock_t           fo_objidlock;      /* protect fo_lastobjid */
297         spinlock_t           fo_translock;      /* protect fsd_last_transno */
298         struct file         *fo_rcvd_filp;
299         struct file         *fo_health_check_filp;
300         struct lr_server_data *fo_fsd;
301         unsigned long       *fo_last_rcvd_slots;
302         __u64                fo_mount_count;
303
304         unsigned long        fo_destroys_in_progress;
305         struct semaphore     fo_create_locks[FILTER_SUBDIR_COUNT];
306
307         struct list_head     fo_export_list;
308         int                  fo_subdir_count;
309
310         obd_size             fo_tot_dirty;      /* protected by obd_osfs_lock */
311         obd_size             fo_tot_granted;    /* all values in bytes */
312         obd_size             fo_tot_pending;
313
314         obd_size             fo_readcache_max_filesize;
315         int                  fo_read_cache;
316         int                  fo_writethrough_cache;
317
318         struct obd_import   *fo_mdc_imp;
319         struct obd_uuid      fo_mdc_uuid;
320         struct lustre_handle fo_mdc_conn;
321         struct file        **fo_last_objid_files;
322         __u64               *fo_last_objids; /* last created objid for groups,
323                                               * protected by fo_objidlock */
324
325         struct semaphore     fo_alloc_lock;
326
327         atomic_t             fo_r_in_flight;
328         atomic_t             fo_w_in_flight;
329
330         /*
331          * per-filter pool of kiobuf's allocated by filter_common_setup() and
332          * torn down by filter_cleanup(). Contains OST_NUM_THREADS elements of
333          * which ->fo_iobuf_count were allocated.
334          *
335          * This pool contains kiobuf used by
336          * filter_{prep,commit}rw_{read,write}() and is shared by all OST
337          * threads.
338          *
339          * Locking: none, each OST thread uses only one element, determined by
340          * its "ordinal number", ->t_id.
341          */
342         struct filter_iobuf    **fo_iobuf_pool;
343         int                      fo_iobuf_count;
344
345         struct list_head         fo_llog_list;
346         spinlock_t               fo_llog_list_lock;
347
348         struct brw_stats         fo_filter_stats;
349         struct lustre_quota_ctxt fo_quota_ctxt;
350         spinlock_t               fo_quotacheck_lock;
351         atomic_t                 fo_quotachecking;
352
353         int                      fo_fmd_max_num; /* per exp filter_mod_data */
354         int                      fo_fmd_max_age; /* jiffies to fmd expiry */
355
356         /* sptlrpc stuff */
357         rwlock_t                 fo_sptlrpc_lock;
358         struct sptlrpc_rule_set  fo_sptlrpc_rset;
359
360         /* capability related */
361         unsigned int             fo_fl_oss_capa;
362         struct list_head         fo_capa_keys;
363         struct hlist_head       *fo_capa_hash;
364         struct llog_commit_master *fo_lcm;
365 };
366
367 #define OSC_MAX_RIF_DEFAULT       8
368 #define OSC_MAX_RIF_MAX         256
369 #define OSC_MAX_DIRTY_DEFAULT  (OSC_MAX_RIF_DEFAULT * 4)
370 #define OSC_MAX_DIRTY_MB_MAX   2048     /* arbitrary, but < MAX_LONG bytes */
371 #define OSC_DEFAULT_RESENDS      10
372
373 #define MDC_MAX_RIF_DEFAULT       8
374 #define MDC_MAX_RIF_MAX         512
375
376 struct mdc_rpc_lock;
377 struct obd_import;
378 struct client_obd {
379         struct rw_semaphore      cl_sem;
380         struct obd_uuid          cl_target_uuid;
381         struct obd_import       *cl_import; /* ptlrpc connection state */
382         int                      cl_conn_count;
383         /* max_mds_easize is purely a performance thing so we don't have to
384          * call obd_size_diskmd() all the time. */
385         int                      cl_default_mds_easize;
386         int                      cl_max_mds_easize;
387         int                      cl_max_mds_cookiesize;
388
389         /* security configuration */
390         struct sptlrpc_rule_set  cl_sptlrpc_rset;
391         enum lustre_sec_part     cl_sec_part;
392
393         //struct llog_canceld_ctxt *cl_llcd; /* it's included by obd_llog_ctxt */
394         void                    *cl_llcd_offset;
395
396         /* the grant values are protected by loi_list_lock below */
397         long                     cl_dirty;         /* all _dirty_ in bytes */
398         long                     cl_dirty_max;     /* allowed w/o rpc */
399         long                     cl_dirty_transit; /* dirty synchronous */
400         long                     cl_avail_grant;   /* bytes of credit for ost */
401         long                     cl_lost_grant;    /* lost credits (trunc) */
402         struct list_head         cl_cache_waiters; /* waiting for cache/grant */
403
404         /* keep track of objects that have lois that contain pages which
405          * have been queued for async brw.  this lock also protects the
406          * lists of osc_client_pages that hang off of the loi */
407         /*
408          * ->cl_loi_list_lock protects consistency of
409          * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
410          * ->ap_completion() call-backs are executed under this lock. As we
411          * cannot guarantee that these call-backs never block on all platforms
412          * (as a matter of fact they do block on Mac OS X), type of
413          * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
414          * and blocking mutex on Mac OS X. (Alternative is to make this lock
415          * blocking everywhere, but we don't want to slow down fast-path of
416          * our main platform.)
417          *
418          * Exact type of ->cl_loi_list_lock is defined in arch/obd.h together
419          * with client_obd_list_{un,}lock() and
420          * client_obd_list_lock_{init,done}() functions.
421          */
422         client_obd_lock_t        cl_loi_list_lock;
423         struct list_head         cl_loi_ready_list;
424         struct list_head         cl_loi_write_list;
425         struct list_head         cl_loi_read_list;
426         int                      cl_r_in_flight;
427         int                      cl_w_in_flight;
428         /* just a sum of the loi/lop pending numbers to be exported by /proc */
429         int                      cl_pending_w_pages;
430         int                      cl_pending_r_pages;
431         int                      cl_max_pages_per_rpc;
432         int                      cl_max_rpcs_in_flight;
433         struct obd_histogram     cl_read_rpc_hist;
434         struct obd_histogram     cl_write_rpc_hist;
435         struct obd_histogram     cl_read_page_hist;
436         struct obd_histogram     cl_write_page_hist;
437         struct obd_histogram     cl_read_offset_hist;
438         struct obd_histogram     cl_write_offset_hist;
439
440         /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
441         atomic_t                 cl_destroy_in_flight;
442         cfs_waitq_t              cl_destroy_waitq;
443
444         struct mdc_rpc_lock     *cl_rpc_lock;
445         struct mdc_rpc_lock     *cl_setattr_lock;
446         struct mdc_rpc_lock     *cl_close_lock;
447         struct osc_creator       cl_oscc;
448
449         /* mgc datastruct */
450         struct semaphore         cl_mgc_sem;
451         struct vfsmount         *cl_mgc_vfsmnt;
452         struct dentry           *cl_mgc_configs_dir;
453         atomic_t                 cl_mgc_refcount;
454         struct obd_export       *cl_mgc_mgsexp;
455
456         /* checksumming for data sent over the network */
457         unsigned int             cl_checksum:1; /* 0 = disabled, 1 = enabled */
458         /* supported checksum types that are worked out at connect time */
459         __u32                    cl_supp_cksum_types;
460         /* checksum algorithm to be used */
461         cksum_type_t             cl_cksum_type;
462
463         /* also protected by the poorly named _loi_list_lock lock above */
464         struct osc_async_rc      cl_ar;
465
466         /* used by quotacheck */
467         int                      cl_qchk_stat; /* quotacheck stat of the peer */
468
469         /* sequence manager */
470         struct lu_client_seq    *cl_seq;
471
472         atomic_t                 cl_resends; /* resend count */
473 };
474 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
475
476 #define CL_NOT_QUOTACHECKED 1   /* client->cl_qchk_stat init value */
477
478 struct mgs_obd {
479         struct ptlrpc_service           *mgs_service;
480         struct vfsmount                 *mgs_vfsmnt;
481         struct super_block              *mgs_sb;
482         struct dentry                   *mgs_configs_dir;
483         struct dentry                   *mgs_fid_de;
484         struct list_head                 mgs_fs_db_list;
485         struct semaphore                 mgs_sem;
486         cfs_proc_dir_entry_t            *mgs_proc_live;
487 };
488
489 struct mds_obd {
490         /* NB this field MUST be first */
491         struct obd_device_target         mds_obt;
492         struct ptlrpc_service           *mds_service;
493         struct ptlrpc_service           *mds_setattr_service;
494         struct ptlrpc_service           *mds_readpage_service;
495         struct vfsmount                 *mds_vfsmnt;
496         cfs_dentry_t                    *mds_fid_de;
497         int                              mds_max_mdsize;
498         int                              mds_max_cookiesize;
499         struct file                     *mds_rcvd_filp;
500         spinlock_t                       mds_transno_lock;
501         __u64                            mds_last_transno;
502         __u64                            mds_mount_count;
503         __u64                            mds_io_epoch;
504         unsigned long                    mds_atime_diff;
505         struct semaphore                 mds_epoch_sem;
506         struct ll_fid                    mds_rootfid;
507         struct lr_server_data           *mds_server_data;
508         cfs_dentry_t                    *mds_pending_dir;
509         cfs_dentry_t                    *mds_logs_dir;
510         cfs_dentry_t                    *mds_objects_dir;
511         struct llog_handle              *mds_cfg_llh;
512         struct obd_device               *mds_osc_obd; /* XXX lov_obd */
513         struct obd_uuid                  mds_lov_uuid;
514         char                            *mds_profile;
515         struct obd_export               *mds_osc_exp; /* XXX lov_exp */
516         struct lov_desc                  mds_lov_desc;
517         __u32                            mds_id;
518
519         /* mark pages dirty for write. */
520         bitmap_t                         *mds_lov_page_dirty;
521         /* array for store pages with obd_id */
522         void                            **mds_lov_page_array;
523         /* file for store objid */
524         struct file                     *mds_lov_objid_filp;
525         __u32                            mds_lov_objid_count;
526         __u32                            mds_lov_objid_lastpage;
527         __u32                            mds_lov_objid_lastidx;
528
529         struct file                     *mds_health_check_filp;
530         unsigned long                   *mds_client_bitmap;
531 //        struct upcall_cache             *mds_group_hash;
532
533         struct lustre_quota_info         mds_quota_info;
534         struct semaphore                 mds_qonoff_sem;
535         struct semaphore                 mds_health_sem;
536         unsigned long                    mds_fl_user_xattr:1,
537                                          mds_fl_acl:1,
538                                          mds_evict_ost_nids:1,
539                                          mds_fl_cfglog:1,
540                                          mds_fl_synced:1;
541
542         struct upcall_cache             *mds_identity_cache;
543
544         /* for capability keys update */
545         struct lustre_capa_key          *mds_capa_keys;
546         struct rw_semaphore             mds_notify_lock;
547 };
548
549 /* lov objid */
550 extern __u32 mds_max_ost_index;
551
552 #define MDS_LOV_ALLOC_SIZE (CFS_PAGE_SIZE)
553
554 #define OBJID_PER_PAGE() (MDS_LOV_ALLOC_SIZE / sizeof(obd_id))
555
556 #define MDS_LOV_OBJID_PAGES_COUNT (mds_max_ost_index/OBJID_PER_PAGE())
557
558 extern int mds_lov_init_objids(struct obd_device *obd);
559 extern void mds_lov_destroy_objids(struct obd_device *obd);
560
561 struct obd_id_info {
562         __u32   idx;
563         obd_id  *data;
564 };
565
566 /* */
567
568 struct echo_obd {
569         struct obdo          eo_oa;
570         spinlock_t           eo_lock;
571         __u64                eo_lastino;
572         struct lustre_handle eo_nl_lock;
573         atomic_t             eo_prep;
574 };
575
576 struct ost_obd {
577         struct ptlrpc_service *ost_service;
578         struct ptlrpc_service *ost_create_service;
579         struct ptlrpc_service *ost_io_service;
580         struct semaphore       ost_health_sem;
581 };
582
583 struct echo_client_obd {
584         struct obd_export   *ec_exp;   /* the local connection to osc/lov */
585         spinlock_t           ec_lock;
586         struct list_head     ec_objects;
587         struct list_head     ec_locks;
588         int                  ec_nstripes;
589         __u64                ec_unique;
590 };
591
592 struct lov_qos_oss {
593         struct obd_uuid     lqo_uuid;       /* ptlrpc's c_remote_uuid */
594         struct list_head    lqo_oss_list;   /* link to lov_qos */
595         __u32               lqo_ost_count;  /* number of osts on this oss */
596         __u64               lqo_bavail;     /* total bytes avail on OSS */
597         __u64               lqo_penalty;    /* current penalty */
598         __u64               lqo_penalty_per_obj; /* penalty decrease every obj*/
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         unsigned int        ltq_usable:1;    /* usable for striping */
607 };
608
609 /* Generic subset of OSTs */
610 struct ost_pool {
611         __u32              *op_array;        /* array of index of
612                                                 lov_obd->lov_tgts */
613         unsigned int        op_count;        /* number of OSTs in the array */
614         unsigned int        op_size;         /* allocated size of lp_array */
615         rwlock_t            op_rwlock;       /* to protect lov_pool use */
616 };
617
618 /* Round-robin allocator data */
619 struct lov_qos_rr {
620         __u32               lqr_start_idx;   /* start index of new inode */
621         __u32               lqr_offset_idx;  /* aliasing for start_idx  */
622         int                 lqr_start_count; /* reseed counter */
623         struct ost_pool     lqr_pool;        /* round-robin optimized list */
624         unsigned long       lqr_dirty:1;     /* recalc round-robin list */
625 };
626
627 /* Stripe placement optimization */
628 struct lov_qos {
629         struct list_head    lq_oss_list;    /* list of OSSs that targets use */
630         struct rw_semaphore lq_rw_sem;
631         __u32               lq_active_oss_count;
632         unsigned int        lq_prio_free;   /* priority for free space */
633         struct lov_qos_rr   lq_rr;          /* round robin qos data */
634         unsigned long       lq_dirty:1,     /* recalc qos data */
635                             lq_same_space:1,/* the ost's all have approx.
636                                                the same space avail */
637                             lq_reset:1;     /* zero current penalties */
638 };
639
640 struct lov_tgt_desc {
641         struct obd_uuid     ltd_uuid;
642         struct obd_export  *ltd_exp;
643         struct ltd_qos      ltd_qos;     /* qos info per target */
644         __u32               ltd_gen;
645         __u32               ltd_index;   /* index in lov_obd->tgts */
646         unsigned long       ltd_active:1,/* is this target up for requests */
647                             ltd_activate:1,/* should this target be activated */
648                             ltd_reap:1;  /* should this target be deleted */
649 };
650
651 /* Pool metadata */
652 #define pool_tgt_size(_p)   _p->pool_obds.op_size
653 #define pool_tgt_count(_p)  _p->pool_obds.op_count
654 #define pool_tgt_array(_p)  _p->pool_obds.op_array
655 #define pool_tgt_rwlock(_p) _p->pool_obds.op_rwlock
656 #define pool_tgt(_p, _i)    _p->pool_lov->lov_tgts[_p->pool_obds.op_array[_i]]
657
658 struct pool_desc {
659         char                  pool_name[LOV_MAXPOOLNAME + 1]; /* name of pool */
660         struct ost_pool       pool_obds;              /* pool members */
661         struct lov_qos_rr     pool_rr;                /* round robin qos */
662         struct hlist_node     pool_hash;              /* access by poolname */
663         struct list_head      pool_list;              /* serial access */
664         cfs_proc_dir_entry_t *pool_proc_entry;        /* file in /proc */
665         struct lov_obd       *pool_lov;               /* lov obd to which this
666                                                          pool belong */
667 };
668
669 struct lov_obd {
670         struct lov_desc         desc;
671         struct lov_tgt_desc   **lov_tgts;              /* sparse array */
672         struct ost_pool         lov_packed;            /* all OSTs in a packed
673                                                           array */
674         struct semaphore        lov_lock;
675         struct obd_connect_data lov_ocd;
676         struct lov_qos          lov_qos;               /* qos info per lov */
677         atomic_t                lov_refcount;
678         __u32                   lov_tgt_count;         /* how many OBD's */
679         __u32                   lov_active_tgt_count;  /* how many active */
680         __u32                   lov_death_row;/* tgts scheduled to be deleted */
681         __u32                   lov_tgt_size;   /* size of tgts array */
682         int                     lov_connects;
683         int                     lov_pool_count;
684         lustre_hash_t          *lov_pools_hash_body; /* used for key access */
685         struct list_head        lov_pool_list; /* used for sequential access */
686         cfs_proc_dir_entry_t   *lov_pool_proc_entry;
687 };
688
689 struct lmv_tgt_desc {
690         struct obd_uuid         ltd_uuid;
691         struct obd_export      *ltd_exp;
692         int                     ltd_active;   /* is this target up for requests */
693         int                     ltd_idx;
694         struct semaphore        ltd_fid_sem;
695 };
696
697 enum placement_policy {
698         PLACEMENT_CHAR_POLICY   = 0,
699         PLACEMENT_NID_POLICY    = 1,
700         PLACEMENT_INVAL_POLICY  = 2,
701         PLACEMENT_MAX_POLICY
702 };
703
704 typedef enum placement_policy placement_policy_t;
705
706 struct lmv_obd {
707         int                     refcount;
708         struct lu_client_fld    lmv_fld;
709         spinlock_t              lmv_lock;
710         placement_policy_t      lmv_placement;
711         struct lmv_desc         desc;
712         struct obd_uuid         cluuid;
713         struct obd_export       *exp;
714
715         int                     connected;
716         int                     max_easize;
717         int                     max_def_easize;
718         int                     max_cookiesize;
719         int                     server_timeout;
720         struct semaphore        init_sem;
721
722         struct lmv_tgt_desc     *tgts;
723         int                     tgts_size;
724
725         struct obd_connect_data *datas;
726         int                     datas_size;
727
728         struct obd_connect_data conn_data;
729 };
730
731 struct niobuf_local {
732         __u64 offset;
733         __u32 len;
734         __u32 flags;
735         cfs_page_t    *page;
736         cfs_dentry_t  *dentry;
737         int lnb_grant_used;
738         int rc;
739 };
740
741 #define LUSTRE_FLD_NAME         "fld"
742 #define LUSTRE_SEQ_NAME         "seq"
743
744 #define LUSTRE_CMM_NAME         "cmm"
745 #define LUSTRE_MDD_NAME         "mdd"
746 #define LUSTRE_OSD_NAME         "osd"
747 #define LUSTRE_VVP_NAME         "vvp"
748 #define LUSTRE_LMV_NAME         "lmv"
749 #define LUSTRE_CMM_MDC_NAME     "cmm-mdc"
750 #define LUSTRE_SLP_NAME         "slp"
751
752 /* obd device type names */
753  /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
754 #define LUSTRE_MDS_NAME         "mds"
755 #define LUSTRE_MDT_NAME         "mdt"
756 #define LUSTRE_MDC_NAME         "mdc"
757 #define LUSTRE_OSS_NAME         "ost"       /* FIXME change name to oss */
758 #define LUSTRE_OST_NAME         "obdfilter" /* FIXME change name to ost */
759 #define LUSTRE_OSC_NAME         "osc"
760 #define LUSTRE_LOV_NAME         "lov"
761 #define LUSTRE_MGS_NAME         "mgs"
762 #define LUSTRE_MGC_NAME         "mgc"
763
764 #define LUSTRE_CACHEOBD_NAME    "cobd"
765 #define LUSTRE_ECHO_NAME        "obdecho"
766 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
767
768 /* Constant obd names (post-rename) */
769 #define LUSTRE_MDS_OBDNAME "MDS"
770 #define LUSTRE_OSS_OBDNAME "OSS"
771 #define LUSTRE_MGS_OBDNAME "MGS"
772 #define LUSTRE_MGC_OBDNAME "MGC"
773
774 /* Don't conflict with on-wire flags OBD_BRW_WRITE, etc */
775 #define N_LOCAL_TEMP_PAGE 0x10000000
776
777 struct obd_trans_info {
778         __u64                    oti_transno;
779         __u64                    oti_xid;
780         /* Only used on the server side for tracking acks. */
781         struct oti_req_ack_lock {
782                 struct lustre_handle lock;
783                 __u32                mode;
784         }                        oti_ack_locks[4];
785         void                    *oti_handle;
786         struct llog_cookie       oti_onecookie;
787         struct llog_cookie      *oti_logcookies;
788         int                      oti_numcookies;
789
790         /* initial thread handling transaction */
791         int                      oti_thread_id;
792         __u32                    oti_conn_cnt;
793
794         struct obd_uuid         *oti_ost_uuid;
795 };
796
797 static inline void oti_init(struct obd_trans_info *oti,
798                             struct ptlrpc_request *req)
799 {
800         if (oti == NULL)
801                 return;
802         memset(oti, 0, sizeof(*oti));
803
804         if (req == NULL)
805                 return;
806
807         oti->oti_xid = req->rq_xid;
808
809         if (req->rq_repmsg != NULL)
810                 oti->oti_transno = lustre_msg_get_transno(req->rq_repmsg);
811         oti->oti_thread_id = req->rq_svc_thread ? req->rq_svc_thread->t_id : -1;
812         if (req->rq_reqmsg != NULL)
813                 oti->oti_conn_cnt = lustre_msg_get_conn_cnt(req->rq_reqmsg);
814 }
815
816 static inline void oti_alloc_cookies(struct obd_trans_info *oti,int num_cookies)
817 {
818         if (!oti)
819                 return;
820
821         if (num_cookies == 1)
822                 oti->oti_logcookies = &oti->oti_onecookie;
823         else
824                 OBD_ALLOC(oti->oti_logcookies,
825                           num_cookies * sizeof(oti->oti_onecookie));
826
827         oti->oti_numcookies = num_cookies;
828 }
829
830 static inline void oti_free_cookies(struct obd_trans_info *oti)
831 {
832         if (!oti || !oti->oti_logcookies)
833                 return;
834
835         if (oti->oti_logcookies == &oti->oti_onecookie)
836                 LASSERT(oti->oti_numcookies == 1);
837         else
838                 OBD_FREE(oti->oti_logcookies,
839                          oti->oti_numcookies * sizeof(oti->oti_onecookie));
840         oti->oti_logcookies = NULL;
841         oti->oti_numcookies = 0;
842 }
843
844 /*
845  * Events signalled through obd_notify() upcall-chain.
846  */
847 enum obd_notify_event {
848         /* Device activated */
849         OBD_NOTIFY_ACTIVE,
850         /* Device deactivated */
851         OBD_NOTIFY_INACTIVE,
852         /* Device disconnected */
853         OBD_NOTIFY_DISCON,
854         /* Connect data for import were changed */
855         OBD_NOTIFY_OCD,
856         /* Sync request */
857         OBD_NOTIFY_SYNC_NONBLOCK,
858         OBD_NOTIFY_SYNC,
859         /* Configuration event */
860         OBD_NOTIFY_CONFIG
861 };
862
863 /* bit-mask flags for config events */
864 enum config_flags {
865         CONFIG_LOG = 0x1,  /* finished processing config log */
866         CONFIG_SYNC = 0x2  /* mdt synced 1 ost */
867 };
868
869 /*
870  * Data structure used to pass obd_notify()-event to non-obd listeners (llite
871  * and liblustre being main examples).
872  */
873 struct obd_notify_upcall {
874         int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
875                           enum obd_notify_event ev, void *owner);
876         /* Opaque datum supplied by upper layer listener */
877         void *onu_owner;
878 };
879
880 struct target_recovery_data {
881         svc_handler_t     trd_recovery_handler;
882         pid_t             trd_processing_task;
883         struct completion trd_starting;
884         struct completion trd_finishing;
885 };
886
887 enum filter_groups {
888         FILTER_GROUP_LLOG = 1,
889         FILTER_GROUP_ECHO,
890         FILTER_GROUP_MDS0
891 };
892
893 struct obd_llog_group {
894         struct list_head   olg_list;
895         int                olg_group;
896         struct llog_ctxt  *olg_ctxts[LLOG_MAX_CTXTS];
897         cfs_waitq_t        olg_waitq;
898         spinlock_t         olg_lock;
899         struct obd_export *olg_exp;
900         int                olg_initializing;
901         struct semaphore   olg_cat_processing;
902 };
903
904 /* corresponds to one of the obd's */
905 #define MAX_OBD_NAME 128
906 #define OBD_DEVICE_MAGIC        0XAB5CD6EF
907 struct obd_device {
908         struct obd_type        *obd_type;
909         __u32                   obd_magic;
910
911         /* common and UUID name of this device */
912         char                    obd_name[MAX_OBD_NAME];
913         struct obd_uuid         obd_uuid;
914
915         struct lu_device       *obd_lu_dev;
916
917         int                     obd_minor;
918         unsigned long obd_attached:1,      /* finished attach */
919                       obd_set_up:1,        /* finished setup */
920                       obd_recovering:1,    /* there are recoverable clients */
921                       obd_abort_recovery:1,/* somebody ioctl'ed us to abort */
922                       obd_replayable:1,    /* recovery is enabled; inform clients */
923                       obd_no_transno:1,    /* no committed-transno notification */
924                       obd_no_recov:1,      /* fail instead of retry messages */
925                       obd_req_replaying:1, /* replaying requests */
926                       obd_stopping:1,      /* started cleanup */
927                       obd_starting:1,      /* started setup */
928                       obd_force:1,         /* cleanup with > 0 obd refcount */
929                       obd_fail:1,          /* cleanup with failover */
930                       obd_async_recov:1,   /* allow asyncronous orphan cleanup */
931                       obd_no_conn:1,       /* deny new connections */
932                       obd_inactive:1;      /* device active/inactive
933                                            * (for /proc/status only!!) */
934         /* uuid-export hash body */
935         struct lustre_hash     *obd_uuid_hash;
936         /* nid-export hash body */
937         struct lustre_hash     *obd_nid_hash;
938         /* nid stats body */
939         struct lustre_hash     *obd_nid_stats_hash;
940         struct list_head        obd_nid_stats;
941         atomic_t                obd_refcount;
942         cfs_waitq_t             obd_refcount_waitq;
943         struct list_head        obd_exports;
944         int                     obd_num_exports;
945         spinlock_t              obd_nid_lock;
946         struct ldlm_namespace  *obd_namespace;
947         struct ptlrpc_client    obd_ldlm_client; /* XXX OST/MDS only */
948         /* a spinlock is OK for what we do now, may need a semaphore later */
949         spinlock_t              obd_dev_lock;
950         struct semaphore        obd_dev_sem;
951         __u64                   obd_last_committed;
952         struct fsfilt_operations *obd_fsops;
953         spinlock_t              obd_osfs_lock;
954         struct obd_statfs       obd_osfs;       /* locked by obd_osfs_lock */
955         __u64                   obd_osfs_age;
956         struct lvfs_run_ctxt    obd_lvfs_ctxt;
957         struct obd_llog_group   obd_olg; /* default llog group */
958         struct obd_device       *obd_observer;
959         struct obd_notify_upcall obd_upcall;
960         struct obd_export       *obd_self_export;
961         /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
962         struct list_head        obd_exports_timed;
963         time_t                  obd_eviction_timer; /* for ping evictor */
964
965         /* XXX encapsulate all this recovery data into one struct */
966         svc_handler_t                    obd_recovery_handler;
967         pid_t                            obd_processing_task;
968
969         int                              obd_max_recoverable_clients;
970         int                              obd_connected_clients;
971         int                              obd_recoverable_clients;
972         spinlock_t                       obd_processing_task_lock; /* BH lock (timer) */
973         __u64                            obd_next_recovery_transno;
974         int                              obd_replayed_requests;
975         int                              obd_requests_queued_for_recovery;
976         cfs_waitq_t                      obd_next_transno_waitq;
977         struct list_head                 obd_uncommitted_replies;
978         spinlock_t                       obd_uncommitted_replies_lock;
979         cfs_timer_t                      obd_recovery_timer;
980         time_t                           obd_recovery_start; /* seconds */
981         time_t                           obd_recovery_end; /* seconds, for lprocfs_status */
982         time_t                           obd_recovery_max_time; /* seconds, bz13079 */
983         int                              obd_recovery_timeout;
984
985         /* new recovery stuff from CMD2 */
986         struct target_recovery_data      obd_recovery_data;
987         int                              obd_replayed_locks;
988         atomic_t                         obd_req_replay_clients;
989         atomic_t                         obd_lock_replay_clients;
990         struct list_head                 obd_req_replay_queue;
991         struct list_head                 obd_lock_replay_queue;
992         struct list_head                 obd_final_req_queue;
993         int                              obd_recovery_stage;
994
995         union {
996                 struct obd_device_target obt;
997                 struct filter_obd filter;
998                 struct mds_obd mds;
999                 struct client_obd cli;
1000                 struct ost_obd ost;
1001                 struct echo_client_obd echo_client;
1002                 struct echo_obd echo;
1003                 struct lov_obd lov;
1004                 struct lmv_obd lmv;
1005                 struct mgs_obd mgs;
1006         } u;
1007         /* Fields used by LProcFS */
1008         unsigned int           obd_cntr_base;
1009         struct lprocfs_stats  *obd_stats;
1010
1011         unsigned int           md_cntr_base;
1012         struct lprocfs_stats  *md_stats;
1013
1014         cfs_proc_dir_entry_t  *obd_proc_entry;
1015         cfs_proc_dir_entry_t  *obd_proc_exports_entry;
1016         cfs_proc_dir_entry_t  *obd_svc_procroot;
1017         struct lprocfs_stats  *obd_svc_stats;
1018         atomic_t               obd_evict_inprogress;
1019         cfs_waitq_t            obd_evict_inprogress_waitq;
1020
1021         /**
1022          * Ldlm pool part. Save last calculated SLV and Limit.
1023          */
1024         rwlock_t               obd_pool_lock;
1025         int                    obd_pool_limit;
1026         __u64                  obd_pool_slv;
1027
1028         /**
1029          * A list of outstanding class_incref()'s against this obd. For
1030          * debugging.
1031          */
1032         struct lu_ref          obd_reference;
1033 };
1034
1035 #define OBD_OPT_FORCE           0x0001
1036 #define OBD_OPT_FAILOVER        0x0002
1037
1038 #define OBD_LLOG_FL_SENDNOW     0x0001
1039
1040 enum obd_cleanup_stage {
1041 /* Special case hack for MDS LOVs */
1042         OBD_CLEANUP_EARLY,
1043 /* can be directly mapped to .ldto_device_fini() */
1044         OBD_CLEANUP_EXPORTS,
1045 };
1046
1047 /* get/set_info keys */
1048 #define KEY_READ_ONLY           "read-only"
1049 #define KEY_MDS_CONN            "mds_conn"
1050 #define KEY_NEXT_ID             "next_id"
1051 #define KEY_LOVDESC             "lovdesc"
1052 #define KEY_INIT_RECOV          "initial_recov"
1053 #define KEY_INIT_RECOV_BACKUP   "init_recov_bk"
1054 #define KEY_FLUSH_CTX           "flush_ctx"
1055 #define KEY_CAPA_KEY            "capa_key"
1056 #define KEY_CONN_DATA           "conn_data"
1057 #define KEY_MAX_EASIZE          "max_easize"
1058 #define KEY_REVIMP_UPD          "revimp_update"
1059 #define KEY_LOV_IDX             "lov_idx"
1060 #define KEY_LAST_ID             "last_id"
1061 #define KEY_READONLY            "read-only"
1062 #define KEY_LOCK_TO_STRIPE      "lock_to_stripe"
1063 #define KEY_CHECKSUM            "checksum"
1064 #define KEY_UNLINKED            "unlinked"
1065 #define KEY_EVICT_BY_NID        "evict_by_nid"
1066 #define KEY_REGISTER_TARGET     "register_target"
1067 #define KEY_SET_FS              "set_fs"
1068 #define KEY_CLEAR_FS            "clear_fs"
1069 #define KEY_BLOCKSIZE           "blocksize"
1070 #define KEY_BLOCKSIZE_BITS      "blocksize_bits"
1071 #define KEY_FIEMAP              "FIEMAP"
1072 /* XXX unused ?*/
1073 #define KEY_INTERMDS            "inter_mds"
1074 #define KEY_ASYNC               "async"
1075
1076 struct lu_context;
1077
1078 static inline int it_to_lock_mode(struct lookup_intent *it)
1079 {
1080         /* CREAT needs to be tested before open (both could be set) */
1081         if (it->it_op & IT_CREAT)
1082                 return LCK_CW;
1083         else if (it->it_op & (IT_READDIR | IT_GETATTR | IT_OPEN | IT_LOOKUP))
1084                 return LCK_CR;
1085
1086         LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
1087         return -EINVAL;
1088 }
1089
1090 struct md_op_data {
1091         struct lu_fid           op_fid1; /* operation fid1 (usualy parent) */
1092         struct lu_fid           op_fid2; /* operation fid2 (usualy child) */
1093         struct lu_fid           op_fid3; /* 2 extra fids to find conflicting */
1094         struct lu_fid           op_fid4; /* to the operation locks. */
1095         mdsno_t                 op_mds;  /* what mds server open will go to */
1096         struct lustre_handle    op_handle;
1097         __u64                   op_mod_time;
1098         const char             *op_name;
1099         int                     op_namelen;
1100         __u32                   op_mode;
1101         struct lmv_stripe_md   *op_mea1;
1102         struct lmv_stripe_md   *op_mea2;
1103         __u32                   op_suppgids[2];
1104         __u32                   op_fsuid;
1105         __u32                   op_fsgid;
1106         cfs_cap_t               op_cap;
1107         void                   *op_data;
1108
1109         /* iattr fields and blocks. */
1110         struct iattr            op_attr;
1111 #ifdef __KERNEL__
1112 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,14)
1113         unsigned int            op_attr_flags;
1114 #endif
1115 #endif
1116         loff_t                  op_attr_blocks;
1117
1118         /* Size-on-MDS epoch and flags. */
1119         __u64                   op_ioepoch;
1120         __u32                   op_flags;
1121
1122         /* Capa fields */
1123         struct obd_capa        *op_capa1;
1124         struct obd_capa        *op_capa2;
1125
1126         /* Various operation flags. */
1127         __u32                   op_bias;
1128
1129         /* Operation type */
1130         __u32                   op_opc;
1131 };
1132
1133 struct md_enqueue_info;
1134 /* metadata stat-ahead */
1135 typedef int (* md_enqueue_cb_t)(struct ptlrpc_request *req,
1136                                 struct md_enqueue_info *minfo,
1137                                 int rc);
1138
1139 struct md_enqueue_info {
1140         struct md_op_data       mi_data;
1141         struct lookup_intent    mi_it;
1142         struct lustre_handle    mi_lockh;
1143         struct dentry          *mi_dentry;
1144         md_enqueue_cb_t         mi_cb;
1145         unsigned int            mi_generation;
1146         void                   *mi_cbdata;
1147 };
1148
1149 struct obd_ops {
1150         struct module *o_owner;
1151         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
1152                            void *karg, void *uarg);
1153         int (*o_get_info)(struct obd_export *, __u32 keylen, void *key,
1154                           __u32 *vallen, void *val, struct lov_stripe_md *lsm);
1155         int (*o_set_info_async)(struct obd_export *, __u32 keylen, void *key,
1156                                 __u32 vallen, void *val,
1157                                 struct ptlrpc_request_set *set);
1158         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
1159         int (*o_detach)(struct obd_device *dev);
1160         int (*o_setup) (struct obd_device *dev, struct lustre_cfg *cfg);
1161         int (*o_precleanup)(struct obd_device *dev,
1162                             enum obd_cleanup_stage cleanup_stage);
1163         int (*o_cleanup)(struct obd_device *dev);
1164         int (*o_process_config)(struct obd_device *dev, obd_count len,
1165                                 void *data);
1166         int (*o_postrecov)(struct obd_device *dev);
1167         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
1168                           int priority);
1169         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
1170         /* connect to the target device with given connection
1171          * data. @ocd->ocd_connect_flags is modified to reflect flags actually
1172          * granted by the target, which are guaranteed to be a subset of flags
1173          * asked for. If @ocd == NULL, use default parameters. */
1174         int (*o_connect)(const struct lu_env *env,
1175                          struct lustre_handle *conn, struct obd_device *src,
1176                          struct obd_uuid *cluuid, struct obd_connect_data *ocd,
1177                          void *localdata);
1178         int (*o_reconnect)(const struct lu_env *env,
1179                            struct obd_export *exp, struct obd_device *src,
1180                            struct obd_uuid *cluuid,
1181                            struct obd_connect_data *ocd,
1182                            void *localdata);
1183         int (*o_disconnect)(struct obd_export *exp);
1184
1185         /* Initialize/finalize fids infrastructure. */
1186         int (*o_fid_init)(struct obd_export *exp);
1187         int (*o_fid_fini)(struct obd_export *exp);
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_fid_delete)(struct obd_export *exp, const struct lu_fid *fid);
1198
1199         int (*o_statfs)(struct obd_device *obd, struct obd_statfs *osfs,
1200                         __u64 max_age, __u32 flags);
1201         int (*o_statfs_async)(struct obd_device *obd, struct obd_info *oinfo,
1202                               __u64 max_age, struct ptlrpc_request_set *set);
1203         int (*o_packmd)(struct obd_export *exp, struct lov_mds_md **disk_tgt,
1204                         struct lov_stripe_md *mem_src);
1205         int (*o_unpackmd)(struct obd_export *exp,struct lov_stripe_md **mem_tgt,
1206                           struct lov_mds_md *disk_src, int disk_len);
1207         int (*o_checkmd)(struct obd_export *exp, struct obd_export *md_exp,
1208                          struct lov_stripe_md *mem_tgt);
1209         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
1210                              obd_id *ids);
1211         /* FIXME: add fid capability support for create & destroy! */
1212         int (*o_precreate)(struct obd_export *exp);
1213         int (*o_create)(struct obd_export *exp,  struct obdo *oa,
1214                         struct lov_stripe_md **ea, struct obd_trans_info *oti);
1215         int (*o_destroy)(struct obd_export *exp, struct obdo *oa,
1216                          struct lov_stripe_md *ea, struct obd_trans_info *oti,
1217                          struct obd_export *md_exp);
1218         int (*o_setattr)(struct obd_export *exp, struct obd_info *oinfo,
1219                          struct obd_trans_info *oti);
1220         int (*o_setattr_async)(struct obd_export *exp, struct obd_info *oinfo,
1221                                struct obd_trans_info *oti,
1222                                struct ptlrpc_request_set *rqset);
1223         int (*o_getattr)(struct obd_export *exp, struct obd_info *oinfo);
1224         int (*o_getattr_async)(struct obd_export *exp, struct obd_info *oinfo,
1225                                struct ptlrpc_request_set *set);
1226         int (*o_brw)(int rw, struct obd_export *exp, struct obd_info *oinfo,
1227                      obd_count oa_bufs, struct brw_page *pgarr,
1228                      struct obd_trans_info *oti);
1229         int (*o_merge_lvb)(struct obd_export *exp, struct lov_stripe_md *lsm,
1230                            struct ost_lvb *lvb, int kms_only);
1231         int (*o_adjust_kms)(struct obd_export *exp, struct lov_stripe_md *lsm,
1232                             obd_off size, int shrink);
1233         int (*o_punch)(struct obd_export *exp, struct obd_info *oinfo,
1234                        struct obd_trans_info *oti,
1235                        struct ptlrpc_request_set *rqset);
1236         int (*o_sync)(struct obd_export *exp, struct obdo *oa,
1237                       struct lov_stripe_md *ea, obd_size start, obd_size end,
1238                       void *capa);
1239         int (*o_migrate)(struct lustre_handle *conn, struct lov_stripe_md *dst,
1240                          struct lov_stripe_md *src, obd_size start,
1241                          obd_size end, struct obd_trans_info *oti);
1242         int (*o_copy)(struct lustre_handle *dstconn, struct lov_stripe_md *dst,
1243                       struct lustre_handle *srconn, struct lov_stripe_md *src,
1244                       obd_size start, obd_size end, struct obd_trans_info *);
1245         int (*o_iterate)(struct lustre_handle *conn,
1246                          int (*)(obd_id, obd_gr, void *),
1247                          obd_id *startid, obd_gr group, void *data);
1248         int (*o_preprw)(int cmd, struct obd_export *exp, struct obdo *oa,
1249                         int objcount, struct obd_ioobj *obj,
1250                         struct niobuf_remote *remote, int *nr_pages,
1251                         struct niobuf_local *local,
1252                         struct obd_trans_info *oti,
1253                         struct lustre_capa *capa);
1254         int (*o_commitrw)(int cmd, struct obd_export *exp, struct obdo *oa,
1255                           int objcount, struct obd_ioobj *obj,
1256                           struct niobuf_remote *remote, int pages,
1257                           struct niobuf_local *local,
1258                           struct obd_trans_info *oti, int rc);
1259         int (*o_enqueue)(struct obd_export *, struct obd_info *oinfo,
1260                          struct ldlm_enqueue_info *einfo,
1261                          struct ptlrpc_request_set *rqset);
1262         int (*o_change_cbdata)(struct obd_export *, struct lov_stripe_md *,
1263                                ldlm_iterator_t it, void *data);
1264         int (*o_cancel)(struct obd_export *, struct lov_stripe_md *md,
1265                         __u32 mode, struct lustre_handle *);
1266         int (*o_cancel_unused)(struct obd_export *, struct lov_stripe_md *,
1267                                int flags, void *opaque);
1268         int (*o_init_export)(struct obd_export *exp);
1269         int (*o_destroy_export)(struct obd_export *exp);
1270         int (*o_extent_calc)(struct obd_export *, struct lov_stripe_md *,
1271                              int cmd, obd_off *);
1272
1273         /* llog related obd_methods */
1274         int (*o_llog_init)(struct obd_device *obd, struct obd_llog_group *grp,
1275                            struct obd_device *disk_obd, int count,
1276                            struct llog_catid *logid, struct obd_uuid *uuid);
1277         int (*o_llog_finish)(struct obd_device *obd, int count);
1278         int (*o_llog_connect)(struct obd_export *, struct llogd_conn_body *);
1279
1280         /* metadata-only methods */
1281         int (*o_pin)(struct obd_export *, const struct lu_fid *fid,
1282                      struct obd_capa *, struct obd_client_handle *, int flag);
1283         int (*o_unpin)(struct obd_export *, struct obd_client_handle *, int);
1284
1285         int (*o_import_event)(struct obd_device *, struct obd_import *,
1286                               enum obd_import_event);
1287
1288         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1289                         enum obd_notify_event ev, void *data);
1290
1291         int (*o_health_check)(struct obd_device *);
1292         struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1293
1294         /* quota methods */
1295         int (*o_quotacheck)(struct obd_export *, struct obd_quotactl *);
1296         int (*o_quotactl)(struct obd_export *, struct obd_quotactl *);
1297
1298         int (*o_ping)(struct obd_export *exp);
1299
1300         /* pools methods */
1301         int (*o_pool_new)(struct obd_device *obd, char *poolname);
1302         int (*o_pool_del)(struct obd_device *obd, char *poolname);
1303         int (*o_pool_add)(struct obd_device *obd, char *poolname,
1304                           char *ostname);
1305         int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1306                           char *ostname);
1307         /*
1308          * NOTE: If adding ops, add another LPROCFS_OBD_OP_INIT() line
1309          * to lprocfs_alloc_obd_stats() in obdclass/lprocfs_status.c.
1310          * Also, add a wrapper function in include/linux/obd_class.h. */
1311 };
1312
1313 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
1314 struct lmv_stripe_md {
1315         __u32         mea_magic;
1316         __u32         mea_count;
1317         __u32         mea_master;
1318         __u32         mea_padding;
1319         struct lu_fid mea_ids[0];
1320 };
1321
1322 enum {
1323         LUSTRE_OPC_MKDIR    = (1 << 0),
1324         LUSTRE_OPC_SYMLINK  = (1 << 1),
1325         LUSTRE_OPC_MKNOD    = (1 << 2),
1326         LUSTRE_OPC_CREATE   = (1 << 3),
1327         LUSTRE_OPC_ANY      = (1 << 4)
1328 };
1329
1330 /* lmv structures */
1331 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
1332 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
1333 #define MEA_MAGIC_HASH_SEGMENT   0xb222a11b
1334
1335 #define MAX_HASH_SIZE_32         0x7fffffffUL
1336 #define MAX_HASH_SIZE            0x7fffffffffffffffULL
1337 #define MAX_HASH_HIGHEST_BIT     0x1000000000000000ULL
1338
1339 struct lustre_md {
1340         struct mdt_body         *body;
1341         struct lov_stripe_md    *lsm;
1342         struct lmv_stripe_md    *mea;
1343 #ifdef CONFIG_FS_POSIX_ACL
1344         struct posix_acl        *posix_acl;
1345 #endif
1346         struct mdt_remote_perm  *remote_perm;
1347         struct obd_capa         *mds_capa;
1348         struct obd_capa         *oss_capa;
1349 };
1350
1351 struct md_open_data {
1352         struct obd_client_handle *mod_och;
1353         struct list_head          mod_replay_list;
1354 };
1355
1356 struct lookup_intent;
1357
1358 struct md_ops {
1359         int (*m_getstatus)(struct obd_export *, struct lu_fid *,
1360                            struct obd_capa **);
1361         int (*m_change_cbdata)(struct obd_export *, const struct lu_fid *,
1362                                ldlm_iterator_t, void *);
1363         int (*m_close)(struct obd_export *, struct md_op_data *,
1364                        struct md_open_data *, struct ptlrpc_request **);
1365         int (*m_create)(struct obd_export *, struct md_op_data *,
1366                         const void *, int, int, __u32, __u32, cfs_cap_t,
1367                         __u64, struct ptlrpc_request **);
1368         int (*m_done_writing)(struct obd_export *, struct md_op_data  *,
1369                               struct md_open_data *);
1370         int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1371                          struct lookup_intent *, struct md_op_data *,
1372                          struct lustre_handle *, void *, int,
1373                          struct ptlrpc_request **, int);
1374         int (*m_getattr)(struct obd_export *, const struct lu_fid *,
1375                          struct obd_capa *, obd_valid, int,
1376                          struct ptlrpc_request **);
1377         int (*m_getattr_name)(struct obd_export *, const struct lu_fid *,
1378                               struct obd_capa *, const char *, int, obd_valid,
1379                               int, __u32, struct ptlrpc_request **);
1380         int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1381                              void *, int, struct lookup_intent *, int,
1382                              struct ptlrpc_request **,
1383                              ldlm_blocking_callback, int);
1384         int (*m_link)(struct obd_export *, struct md_op_data *,
1385                       struct ptlrpc_request **);
1386         int (*m_rename)(struct obd_export *, struct md_op_data *,
1387                         const char *, int, const char *, int,
1388                         struct ptlrpc_request **);
1389         int (*m_is_subdir)(struct obd_export *, const struct lu_fid *,
1390                            const struct lu_fid *,
1391                            struct ptlrpc_request **);
1392         int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1393                          int , void *, int, struct ptlrpc_request **,
1394                          struct md_open_data **mod);
1395         int (*m_sync)(struct obd_export *, const struct lu_fid *,
1396                       struct obd_capa *, struct ptlrpc_request **);
1397         int (*m_readpage)(struct obd_export *, const struct lu_fid *,
1398                           struct obd_capa *, __u64, struct page *,
1399                           struct ptlrpc_request **);
1400
1401         int (*m_unlink)(struct obd_export *, struct md_op_data *,
1402                         struct ptlrpc_request **);
1403
1404         int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1405                           struct obd_capa *, obd_valid, const char *,
1406                           const char *, int, int, int, __u32,
1407                           struct ptlrpc_request **);
1408
1409         int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1410                           struct obd_capa *, obd_valid, const char *,
1411                           const char *, int, int, int,
1412                           struct ptlrpc_request **);
1413
1414         int (*m_init_ea_size)(struct obd_export *, int, int, int);
1415
1416         int (*m_get_lustre_md)(struct obd_export *, struct ptlrpc_request *,
1417                                struct obd_export *, struct obd_export *,
1418                                struct lustre_md *);
1419
1420         int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1421
1422         int (*m_set_open_replay_data)(struct obd_export *,
1423                                       struct obd_client_handle *,
1424                                       struct ptlrpc_request *);
1425         int (*m_clear_open_replay_data)(struct obd_export *,
1426                                         struct obd_client_handle *);
1427         int (*m_set_lock_data)(struct obd_export *, __u64 *, void *);
1428
1429         ldlm_mode_t (*m_lock_match)(struct obd_export *, int,
1430                                     const struct lu_fid *, ldlm_type_t,
1431                                     ldlm_policy_data_t *, ldlm_mode_t,
1432                                     struct lustre_handle *);
1433
1434         int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1435                                ldlm_policy_data_t *, ldlm_mode_t, int flags,
1436                                void *opaque);
1437         int (*m_renew_capa)(struct obd_export *, struct obd_capa *oc,
1438                             renew_capa_cb_t cb);
1439
1440         int (*m_get_remote_perm)(struct obd_export *, const struct lu_fid *,
1441                                  struct obd_capa *, __u32,
1442                                  struct ptlrpc_request **);
1443
1444         int (*m_intent_getattr_async)(struct obd_export *,
1445                                       struct md_enqueue_info *,
1446                                       struct ldlm_enqueue_info *);
1447
1448         int (*m_revalidate_lock)(struct obd_export *,
1449                                  struct lookup_intent *,
1450                                  struct lu_fid *);
1451
1452         /*
1453          * NOTE: If adding ops, add another LPROCFS_MD_OP_INIT() line to
1454          * lprocfs_alloc_md_stats() in obdclass/lprocfs_status.c. Also, add a
1455          * wrapper function in include/linux/obd_class.h.
1456          */
1457 };
1458
1459 struct lsm_operations {
1460         void (*lsm_free)(struct lov_stripe_md *);
1461         int (*lsm_destroy)(struct lov_stripe_md *, struct obdo *oa,
1462                            struct obd_export *md_exp);
1463         void (*lsm_stripe_by_index)(struct lov_stripe_md *, int *, obd_off *,
1464                                      unsigned long *);
1465         void (*lsm_stripe_by_offset)(struct lov_stripe_md *, int *, obd_off *,
1466                                      unsigned long *);
1467         obd_off (*lsm_stripe_offset_by_index)(struct lov_stripe_md *, int);
1468         obd_off (*lsm_stripe_offset_by_offset)(struct lov_stripe_md *, obd_off);
1469         int (*lsm_stripe_index_by_offset)(struct lov_stripe_md *, obd_off);
1470         int (*lsm_revalidate) (struct lov_stripe_md *, struct obd_device *obd);
1471         int (*lsm_lmm_verify) (struct lov_mds_md *lmm, int lmm_bytes,
1472                                int *stripe_count);
1473         int (*lsm_unpackmd) (struct lov_obd *lov, struct lov_stripe_md *lsm,
1474                              struct lov_mds_md *lmm);
1475 };
1476
1477 extern const struct lsm_operations lsm_v1_ops;
1478 extern const struct lsm_operations lsm_join_ops;
1479 extern const struct lsm_operations lsm_v3_ops;
1480 static inline const struct lsm_operations *lsm_op_find(int magic)
1481 {
1482         switch(magic) {
1483         case LOV_MAGIC_V1:
1484                return &lsm_v1_ops;
1485         case LOV_MAGIC_JOIN:
1486                return &lsm_join_ops;
1487         case LOV_MAGIC_V3:
1488                return &lsm_v3_ops;
1489         default:
1490                CERROR("Cannot recognize lsm_magic %d\n", magic);
1491                return NULL;
1492         }
1493 }
1494
1495 int lvfs_check_io_health(struct obd_device *obd, struct file *file);
1496
1497 /* Requests for obd_extent_calc() */
1498 #define OBD_CALC_STRIPE_START   1
1499 #define OBD_CALC_STRIPE_END     2
1500
1501 static inline void obd_transno_commit_cb(struct obd_device *obd, __u64 transno,
1502                                          int error)
1503 {
1504         if (error) {
1505                 CERROR("%s: transno "LPU64" commit error: %d\n",
1506                        obd->obd_name, transno, error);
1507                 return;
1508         }
1509         if (transno > obd->obd_last_committed) {
1510                 CDEBUG(D_HA, "%s: transno "LPD64" committed\n",
1511                        obd->obd_name, transno);
1512                 obd->obd_last_committed = transno;
1513                 ptlrpc_commit_replies (obd);
1514         } else {
1515                 CDEBUG(D_INFO, "%s: transno "LPD64" committed\n",
1516                        obd->obd_name, transno);
1517         }
1518 }
1519
1520 static inline void init_obd_quota_ops(quota_interface_t *interface,
1521                                       struct obd_ops *obd_ops)
1522 {
1523         if (!interface)
1524                 return;
1525
1526         LASSERT(obd_ops);
1527         obd_ops->o_quotacheck = QUOTA_OP(interface, check);
1528         obd_ops->o_quotactl = QUOTA_OP(interface, ctl);
1529 }
1530
1531 static inline __u64 oinfo_mdsno(struct obd_info *oinfo)
1532 {
1533         return oinfo->oi_oa->o_gr - FILTER_GROUP_MDS0;
1534 }
1535
1536 static inline struct lustre_capa *oinfo_capa(struct obd_info *oinfo)
1537 {
1538         return oinfo->oi_capa;
1539 }
1540
1541 #endif /* __OBD_H */