Whamcloud - gitweb
b=11691
[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
5 #ifndef __OBD_H
6 #define __OBD_H
7
8 #if defined(__linux__)
9 #include <linux/obd.h>
10 #elif defined(__APPLE__)
11 #include <darwin/obd.h>
12 #elif defined(__WINNT__)
13 #include <winnt/obd.h>
14 #else
15 #error Unsupported operating system.
16 #endif
17
18 #define IOC_OSC_TYPE         'h'
19 #define IOC_OSC_MIN_NR       20
20 #define IOC_OSC_SET_ACTIVE   _IOWR(IOC_OSC_TYPE, 21, struct obd_device *)
21 #define IOC_OSC_MAX_NR       50
22
23 #define IOC_MDC_TYPE         'i'
24 #define IOC_MDC_MIN_NR       20
25 /* Moved to lustre_user.h
26 #define IOC_MDC_LOOKUP       _IOWR(IOC_MDC_TYPE, 20, struct obd_ioctl_data *)
27 #define IOC_MDC_GETSTRIPE    _IOWR(IOC_MDC_TYPE, 21, struct lov_mds_md *) */
28 #define IOC_MDC_MAX_NR       50
29
30 #include <lustre_lib.h>
31 #include <lustre/lustre_idl.h>
32 #include <lustre_export.h>
33 #include <lustre_quota.h>
34
35 #define MAX_OBD_DEVICES 8192
36
37 /* this is really local to the OSC */
38 struct loi_oap_pages {
39         struct list_head        lop_pending;
40         struct list_head        lop_urgent;
41         struct list_head        lop_pending_group;
42         int                     lop_num_pending;
43 };
44
45 struct osc_async_rc {
46         int     ar_rc;
47         int     ar_force_sync;
48         int     ar_min_xid;
49 };
50
51 struct lov_oinfo {                 /* per-stripe data structure */
52         __u64 loi_id;              /* object ID on the target OST */
53         __u64 loi_gr;              /* object group on the target OST */
54         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
55         int loi_ost_gen;           /* generation of this loi_ost_idx */
56
57         /* used by the osc to keep track of what objects to build into rpcs */
58         struct loi_oap_pages loi_read_lop;
59         struct loi_oap_pages loi_write_lop;
60         /* _cli_ is poorly named, it should be _ready_ */
61         struct list_head loi_cli_item;
62         struct list_head loi_write_item;
63         struct list_head loi_read_item;
64
65         unsigned loi_kms_valid:1;
66         __u64 loi_kms;             /* known minimum size */
67         struct ost_lvb loi_lvb;
68         struct osc_async_rc     loi_ar;
69 };
70
71 static inline void loi_init(struct lov_oinfo *loi)
72 {
73         CFS_INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending);
74         CFS_INIT_LIST_HEAD(&loi->loi_read_lop.lop_urgent);
75         CFS_INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending_group);
76         CFS_INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending);
77         CFS_INIT_LIST_HEAD(&loi->loi_write_lop.lop_urgent);
78         CFS_INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending_group);
79         CFS_INIT_LIST_HEAD(&loi->loi_cli_item);
80         CFS_INIT_LIST_HEAD(&loi->loi_write_item);
81         CFS_INIT_LIST_HEAD(&loi->loi_read_item);
82 }
83
84 /*extent array item for describing the joined file extent info*/
85 struct lov_extent {
86         __u64 le_start;            /* extent start */
87         __u64 le_len;              /* extent length */
88         int   le_loi_idx;          /* extent #1 loi's index in lsm loi array */
89         int   le_stripe_count;     /* extent stripe count*/
90 };
91
92 /*Lov array info for describing joined file array EA info*/
93 struct lov_array_info {
94         struct llog_logid    lai_array_id;    /* MDS med llog object id */
95         unsigned             lai_ext_count; /* number of extent count */
96         struct lov_extent    *lai_ext_array; /* extent desc array */
97 };
98
99 struct lov_stripe_md {
100         spinlock_t       lsm_lock;
101         void            *lsm_lock_owner; /* debugging */
102
103         struct {
104                 /* Public members. */
105                 __u64 lw_object_id;        /* lov object id */
106                 __u64 lw_object_gr;        /* lov object group */
107                 __u64 lw_maxbytes;         /* maximum possible file size */
108
109                 /* LOV-private members start here -- only for use in lov/. */
110                 __u32 lw_magic;
111                 __u32 lw_stripe_size;      /* size of the stripe */
112                 __u32 lw_pattern;          /* striping pattern (RAID0, RAID1) */
113                 unsigned lw_stripe_count;  /* number of objects being striped over */
114         } lsm_wire;
115
116         struct lov_array_info *lsm_array; /*Only for joined file array info*/
117         struct lov_oinfo *lsm_oinfo[0];
118 };
119
120 #define lsm_object_id    lsm_wire.lw_object_id
121 #define lsm_object_gr    lsm_wire.lw_object_gr
122 #define lsm_maxbytes     lsm_wire.lw_maxbytes
123 #define lsm_magic        lsm_wire.lw_magic
124 #define lsm_stripe_size  lsm_wire.lw_stripe_size
125 #define lsm_pattern      lsm_wire.lw_pattern
126 #define lsm_stripe_count lsm_wire.lw_stripe_count
127
128 struct obd_info;
129
130 typedef int (*obd_enqueue_update_f)(struct obd_info *oinfo, int rc);
131
132 /* obd_enqueue parameters common for all levels (lov, osc). */
133 struct obd_enqueue_info {
134         /* Flags used while lock handling. */
135         int   ei_flags;
136         /* Type of the lock being enqueued. */
137         __u32 ei_type;
138         /* Mode of the lock being enqueued. */
139         __u32 ei_mode;
140         /* Different callbacks for lock handling (blocking, completion,
141            glimpse */
142         void *ei_cb_bl;
143         void *ei_cb_cp;
144         void *ei_cb_gl;
145         /* Data to be passed into callbacks. */
146         void *ei_cbdata;
147         /* Request set for OSC async requests. */
148         struct ptlrpc_request_set *ei_rqset;
149 };
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         /* Lock handle specific for every OSC lock. */
158         struct lustre_handle   *oi_lockh;
159         /* lsm data specific for every OSC. */
160         struct lov_stripe_md   *oi_md;
161         /* obdo data specific for every OSC, if needed at all. */
162         struct obdo            *oi_oa;
163         /* statfs data specific for every OSC, if needed at all. */
164         struct obd_statfs      *oi_osfs;
165         /* An update callback which is called to update some data on upper
166          * level. E.g. it is used for update lsm->lsm_oinfo at every recieved
167          * request in osc level for enqueue requests. It is also possible to
168          * update some caller data from LOV layer if needed. */
169         obd_enqueue_update_f     oi_cb_up;
170 };
171
172 /* compare all relevant fields. */
173 static inline int lov_stripe_md_cmp(struct lov_stripe_md *m1,
174                                     struct lov_stripe_md *m2)
175 {
176         /*
177          * ->lsm_wire contains padding, but it should be zeroed out during
178          * allocation.
179          */
180         return memcmp(&m1->lsm_wire, &m2->lsm_wire, sizeof m1->lsm_wire);
181 }
182
183 void lov_stripe_lock(struct lov_stripe_md *md);
184 void lov_stripe_unlock(struct lov_stripe_md *md);
185
186 struct obd_type {
187         struct list_head typ_chain;
188         struct obd_ops *typ_ops;
189         cfs_proc_dir_entry_t *typ_procroot;
190         char *typ_name;
191         int  typ_refcnt;
192         spinlock_t obd_type_lock;
193 };
194
195 struct brw_page {
196         obd_off  off;
197         cfs_page_t *pg;
198         int count;
199         obd_flag flag;
200 };
201
202 enum async_flags {
203         ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
204                               page is added to an rpc */
205         ASYNC_URGENT = 0x2, /* page must be put into an RPC before return */
206         ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
207                                      to give the caller a chance to update
208                                      or cancel the size of the io */
209         ASYNC_GROUP_SYNC = 0x8,  /* ap_completion will not be called, instead
210                                     the page is accounted for in the
211                                     obd_io_group given to
212                                     obd_queue_group_io */
213 };
214
215 struct obd_async_page_ops {
216         int  (*ap_make_ready)(void *data, int cmd);
217         int  (*ap_refresh_count)(void *data, int cmd);
218         void (*ap_fill_obdo)(void *data, int cmd, struct obdo *oa);
219         void (*ap_update_obdo)(void *data, int cmd, struct obdo *oa,
220                                obd_valid valid);
221         int  (*ap_completion)(void *data, int cmd, struct obdo *oa, int rc);
222 };
223
224 /* the `oig' is passed down from a caller of obd rw methods.  the callee
225  * records enough state such that the caller can sleep on the oig and
226  * be woken when all the callees have finished their work */
227 struct obd_io_group {
228         spinlock_t      oig_lock;
229         atomic_t        oig_refcount;
230         int             oig_pending;
231         int             oig_rc;
232         struct list_head oig_occ_list;
233         cfs_waitq_t     oig_waitq;
234 };
235
236 /* the oig callback context lets the callee of obd rw methods register
237  * for callbacks from the caller. */
238 struct oig_callback_context {
239         struct list_head occ_oig_item;
240         /* called when the caller has received a signal while sleeping.
241          * callees of this method are encouraged to abort their state
242          * in the oig.  This may be called multiple times. */
243         void (*occ_interrupted)(struct oig_callback_context *occ);
244         unsigned int interrupted:1;
245 };
246
247 /* Individual type definitions */
248
249 struct ost_server_data;
250
251 /* hold common fields for "target" device */
252 struct obd_device_target {
253         struct super_block       *obt_sb;
254         atomic_t                  obt_quotachecking;
255         struct lustre_quota_ctxt  obt_qctxt;
256 };
257
258 #define FILTER_GROUP_LLOG 1
259 #define FILTER_GROUP_ECHO 2
260
261 struct filter_ext {
262         __u64                fe_start;
263         __u64                fe_end;
264 };
265
266 struct filter_obd {
267         /* NB this field MUST be first */
268         struct obd_device_target fo_obt;
269         const char          *fo_fstype;
270         struct vfsmount     *fo_vfsmnt;
271         cfs_dentry_t        *fo_dentry_O;
272         cfs_dentry_t       **fo_dentry_O_groups;
273         cfs_dentry_t       **fo_dentry_O_sub;
274         spinlock_t           fo_objidlock;      /* protect fo_lastobjid */
275         spinlock_t           fo_translock;      /* protect fsd_last_transno */
276         struct file         *fo_rcvd_filp;
277         struct file         *fo_health_check_filp;
278         struct lr_server_data *fo_fsd;
279         unsigned long       *fo_last_rcvd_slots;
280         __u64                fo_mount_count;
281
282         int                  fo_destroy_in_progress;
283         struct semaphore     fo_create_lock;
284
285         struct list_head     fo_export_list;
286         int                  fo_subdir_count;
287
288         obd_size             fo_tot_dirty;      /* protected by obd_osfs_lock */
289         obd_size             fo_tot_granted;    /* all values in bytes */
290         obd_size             fo_tot_pending;
291
292         obd_size             fo_readcache_max_filesize;
293
294         struct obd_import   *fo_mdc_imp;
295         struct obd_uuid      fo_mdc_uuid;
296         struct lustre_handle fo_mdc_conn;
297         struct file        **fo_last_objid_files;
298         __u64               *fo_last_objids; /* last created objid for groups,
299                                               * protected by fo_objidlock */
300
301         struct semaphore     fo_alloc_lock;
302
303         atomic_t             fo_r_in_flight;
304         atomic_t             fo_w_in_flight;
305
306         /*
307          * per-filter pool of kiobuf's allocated by filter_common_setup() and
308          * torn down by filter_cleanup(). Contains OST_NUM_THREADS elements of
309          * which ->fo_iobuf_count were allocated.
310          *
311          * This pool contains kiobuf used by
312          * filter_{prep,commit}rw_{read,write}() and is shared by all OST
313          * threads.
314          *
315          * Locking: none, each OST thread uses only one element, determined by
316          * its "ordinal number", ->t_id.
317          */
318         struct filter_iobuf    **fo_iobuf_pool;
319         int                      fo_iobuf_count;
320
321         struct brw_stats         fo_filter_stats;
322         struct lustre_quota_ctxt fo_quota_ctxt;
323         spinlock_t               fo_quotacheck_lock;
324         atomic_t                 fo_quotachecking;
325
326         int                      fo_fmd_max_num; /* per exp filter_mod_data */
327         int                      fo_fmd_max_age; /* jiffies to fmd expiry */
328 };
329
330 #define OSC_MAX_RIF_DEFAULT       8
331 #define OSC_MAX_RIF_MAX         256
332 #define OSC_MAX_DIRTY_DEFAULT  (OSC_MAX_RIF_DEFAULT * 4)
333 #define OSC_MAX_DIRTY_MB_MAX   2048     /* arbitrary, but < MAX_LONG bytes */
334
335 #define MDC_MAX_RIF_DEFAULT       8
336 #define MDC_MAX_RIF_MAX         512
337
338 struct mdc_rpc_lock;
339 struct obd_import;
340 struct client_obd {
341         struct semaphore         cl_sem;
342         struct obd_uuid          cl_target_uuid;
343         struct obd_import       *cl_import; /* ptlrpc connection state */
344         int                      cl_conn_count;
345         /* max_mds_easize is purely a performance thing so we don't have to
346          * call obd_size_diskmd() all the time. */
347         int                      cl_default_mds_easize;
348         int                      cl_max_mds_easize;
349         int                      cl_max_mds_cookiesize;
350
351         //struct llog_canceld_ctxt *cl_llcd; /* it's included by obd_llog_ctxt */
352         void                    *cl_llcd_offset;
353
354         /* the grant values are protected by loi_list_lock below */
355         long                     cl_dirty;         /* all _dirty_ in bytes */
356         long                     cl_dirty_max;     /* allowed w/o rpc */
357         long                     cl_avail_grant;   /* bytes of credit for ost */
358         long                     cl_lost_grant;    /* lost credits (trunc) */
359         struct list_head         cl_cache_waiters; /* waiting for cache/grant */
360
361         /* keep track of objects that have lois that contain pages which
362          * have been queued for async brw.  this lock also protects the
363          * lists of osc_client_pages that hang off of the loi */
364         /*
365          * ->cl_loi_list_lock protects consistency of
366          * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
367          * ->ap_completion() call-backs are executed under this lock. As we
368          * cannot guarantee that these call-backs never block on all platforms
369          * (as a matter of fact they do block on Mac OS X), type of
370          * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
371          * and blocking mutex on Mac OS X. (Alternative is to make this lock
372          * blocking everywhere, but we don't want to slow down fast-path of
373          * our main platform.)
374          *
375          * Exact type of ->cl_loi_list_lock is defined in arch/obd.h together
376          * with client_obd_list_{un,}lock() and
377          * client_obd_list_lock_{init,done}() functions.
378          */
379         client_obd_lock_t        cl_loi_list_lock;
380         struct list_head         cl_loi_ready_list;
381         struct list_head         cl_loi_write_list;
382         struct list_head         cl_loi_read_list;
383         int                      cl_r_in_flight;
384         int                      cl_w_in_flight;
385         /* just a sum of the loi/lop pending numbers to be exported by /proc */
386         int                      cl_pending_w_pages;
387         int                      cl_pending_r_pages;
388         int                      cl_max_pages_per_rpc;
389         int                      cl_max_rpcs_in_flight;
390         struct obd_histogram     cl_read_rpc_hist;
391         struct obd_histogram     cl_write_rpc_hist;
392         struct obd_histogram     cl_read_page_hist;
393         struct obd_histogram     cl_write_page_hist;
394         struct obd_histogram     cl_read_offset_hist;
395         struct obd_histogram     cl_write_offset_hist;
396
397         struct mdc_rpc_lock     *cl_rpc_lock;
398         struct mdc_rpc_lock     *cl_setattr_lock;
399         struct mdc_rpc_lock     *cl_close_lock;
400         struct osc_creator       cl_oscc;
401
402         /* mgc datastruct */
403         struct semaphore         cl_mgc_sem;
404         struct vfsmount         *cl_mgc_vfsmnt;
405         struct dentry           *cl_mgc_configs_dir;
406         atomic_t                 cl_mgc_refcount;
407         struct obd_export       *cl_mgc_mgsexp;
408
409         /* Flags section */
410         unsigned int             cl_checksum:1; /* debug checksums */
411
412         /* also protected by the poorly named _loi_list_lock lock above */
413         struct osc_async_rc      cl_ar;
414
415         /* used by quotacheck */
416         int                      cl_qchk_stat; /* quotacheck stat of the peer */
417 };
418 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
419
420 #define CL_NOT_QUOTACHECKED 1   /* client->cl_qchk_stat init value */
421
422 struct mgs_obd {
423         struct ptlrpc_service           *mgs_service;
424         struct vfsmount                 *mgs_vfsmnt;
425         struct super_block              *mgs_sb;
426         struct dentry                   *mgs_configs_dir;
427         struct dentry                   *mgs_fid_de;
428         struct list_head                 mgs_fs_db_list;
429         struct semaphore                 mgs_sem;
430         cfs_proc_dir_entry_t            *mgs_proc_live;
431 };
432
433 struct mds_obd {
434         /* NB this field MUST be first */
435         struct obd_device_target         mds_obt;
436         struct ptlrpc_service           *mds_service;
437         struct ptlrpc_service           *mds_setattr_service;
438         struct ptlrpc_service           *mds_readpage_service;
439         struct vfsmount                 *mds_vfsmnt;
440         cfs_dentry_t                    *mds_fid_de;
441         int                              mds_max_mdsize;
442         int                              mds_max_cookiesize;
443         struct file                     *mds_rcvd_filp;
444         spinlock_t                       mds_transno_lock;
445         __u64                            mds_last_transno;
446         __u64                            mds_mount_count;
447         __u64                            mds_io_epoch;
448         unsigned long                    mds_atime_diff;
449         struct semaphore                 mds_epoch_sem;
450         struct ll_fid                    mds_rootfid;
451         struct lr_server_data           *mds_server_data;
452         cfs_dentry_t                    *mds_pending_dir;
453         cfs_dentry_t                    *mds_logs_dir;
454         cfs_dentry_t                    *mds_objects_dir;
455         struct llog_handle              *mds_cfg_llh;
456 //        struct llog_handle              *mds_catalog;
457         struct obd_device               *mds_osc_obd; /* XXX lov_obd */
458         struct obd_uuid                  mds_lov_uuid;
459         char                            *mds_profile;
460         struct obd_export               *mds_osc_exp; /* XXX lov_exp */
461         struct lov_desc                  mds_lov_desc;
462         obd_id                          *mds_lov_objids;
463         int                              mds_lov_objids_size;
464         __u32                            mds_lov_objids_in_file;
465         unsigned int                     mds_lov_objids_dirty:1;
466         int                              mds_lov_nextid_set;
467         struct file                     *mds_lov_objid_filp;
468         struct file                     *mds_health_check_filp;
469         unsigned long                   *mds_client_bitmap;
470         struct upcall_cache             *mds_group_hash;
471
472         struct lustre_quota_info         mds_quota_info;
473         struct semaphore                 mds_qonoff_sem;
474         struct semaphore                 mds_health_sem;
475         unsigned long                    mds_lov_objids_valid:1,
476                                          mds_fl_user_xattr:1,
477                                          mds_fl_acl:1;
478 };
479
480 struct echo_obd {
481         struct obdo          eo_oa;
482         spinlock_t           eo_lock;
483         __u64                eo_lastino;
484         struct lustre_handle eo_nl_lock;
485         atomic_t             eo_prep;
486 };
487
488 struct ost_obd {
489         struct ptlrpc_service *ost_service;
490         struct ptlrpc_service *ost_create_service;
491         struct ptlrpc_service *ost_io_service;
492         struct semaphore       ost_health_sem;
493 };
494
495 struct echo_client_obd {
496         struct obd_export   *ec_exp;   /* the local connection to osc/lov */
497         spinlock_t           ec_lock;
498         struct list_head     ec_objects;
499         int                  ec_nstripes;
500         __u64                ec_unique;
501 };
502
503 struct lov_qos_oss {
504         struct obd_uuid     lqo_uuid;       /* ptlrpc's c_remote_uuid */
505         struct list_head    lqo_oss_list;   /* link to lov_qos */
506         __u32               lqo_ost_count;  /* number of osts on this oss */
507         __u64               lqo_bavail;     /* total bytes avail on OSS */
508         __u64               lqo_penalty;    /* current penalty */
509         __u64               lqo_penalty_per_obj; /* penalty decrease every obj*/
510 };
511
512 struct ltd_qos {
513         struct lov_qos_oss *ltq_oss;         /* oss info */
514         __u64               ltq_penalty;     /* current penalty */
515         __u64               ltq_penalty_per_obj; /* penalty decrease every obj*/
516         __u64               ltq_weight;      /* net weighting */
517         unsigned int        ltq_usable:1;    /* usable for striping */
518 };
519
520 struct lov_qos {
521         struct list_head    lq_oss_list;    /* list of OSSs that targets use */
522         struct rw_semaphore lq_rw_sem;
523         __u32               lq_active_oss_count;
524         __u32              *lq_rr_array;    /* round-robin optimized list */
525         unsigned int        lq_rr_size;     /* rr array size */
526         unsigned int        lq_prio_free;   /* priority for free space */
527         unsigned int        lq_dirty:1,     /* recalc qos data */
528                             lq_dirty_rr:1,  /* recalc round-robin list */
529                             lq_same_space:1,/* the ost's all have approx.
530                                                the same space avail */
531                             lq_reset:1;     /* zero current penalties */
532 };
533
534 struct lov_tgt_desc {
535         struct obd_uuid     ltd_uuid;
536         struct obd_export  *ltd_exp;
537         struct ltd_qos      ltd_qos;     /* qos info per target */
538         __u32               ltd_gen;
539         __u32               ltd_index;   /* index in lov_obd->tgts */
540         unsigned int        ltd_active:1,/* is this target up for requests */
541                             ltd_activate:1,/* should this target be activated */
542                             ltd_reap:1;  /* should this target be deleted */
543 };
544
545 struct lov_obd {
546         struct lov_desc         desc;
547         struct lov_tgt_desc   **lov_tgts;
548         struct semaphore        lov_lock;
549         struct obd_connect_data lov_ocd;
550         struct lov_qos          lov_qos;               /* qos info per lov */
551         atomic_t                lov_refcount;
552         __u32                   lov_tgt_count;         /* how many OBD's */
553         __u32                   lov_active_tgt_count;  /* how many active */
554         __u32                   lov_death_row;/* tgts scheduled to be deleted */
555         __u32                   lov_tgt_size;   /* size of tgts array */
556         __u32                   lov_start_idx;  /* start index of new inode */
557         __u32                   lov_offset_idx; /* aliasing for start_idx  */
558         int                     lov_start_count;/* reseed counter */
559         int                     lov_connects;
560 };
561
562 struct niobuf_local {
563         __u64 offset;
564         __u32 len;
565         __u32 flags;
566         cfs_page_t    *page;
567         cfs_dentry_t  *dentry;
568         int lnb_grant_used;
569         int rc;
570 };
571
572 /* obd device type names */
573  /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
574 #define LUSTRE_MDS_NAME         "mds"
575 #define LUSTRE_MDT_NAME         "mdt"
576 #define LUSTRE_MDC_NAME         "mdc"
577 #define LUSTRE_OSS_NAME         "ost" /*FIXME change name to oss*/
578 #define LUSTRE_OST_NAME         "obdfilter" /* FIXME change name to ost*/
579 #define LUSTRE_OSC_NAME         "osc"
580 #define LUSTRE_LOV_NAME         "lov"
581 #define LUSTRE_MGS_NAME         "mgs"
582 #define LUSTRE_MGC_NAME         "mgc"
583
584 #define LUSTRE_CACHEOBD_NAME    "cobd"
585 #define LUSTRE_ECHO_NAME        "obdecho"
586 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
587
588 /* Constant obd names (post-rename) */
589 #define LUSTRE_MDS_OBDNAME "MDS"
590 #define LUSTRE_OSS_OBDNAME "OSS"
591 #define LUSTRE_MGS_OBDNAME "MGS"
592 #define LUSTRE_MGC_OBDNAME "MGC"
593
594 /* Don't conflict with on-wire flags OBD_BRW_WRITE, etc */
595 #define N_LOCAL_TEMP_PAGE 0x10000000
596
597 struct obd_trans_info {
598         __u64                    oti_transno;
599         __u64                    oti_xid;
600         __u64                   *oti_objid;
601         /* Only used on the server side for tracking acks. */
602         struct oti_req_ack_lock {
603                 struct lustre_handle lock;
604                 __u32                mode;
605         }                        oti_ack_locks[4];
606         void                    *oti_handle;
607         struct llog_cookie       oti_onecookie;
608         struct llog_cookie      *oti_logcookies;
609         int                      oti_numcookies;
610
611         /* initial thread handling transaction */
612         int                      oti_thread_id;
613         __u32                    oti_conn_cnt;
614 };
615
616 static inline void oti_init(struct obd_trans_info *oti,
617                             struct ptlrpc_request *req)
618 {
619         if (oti == NULL)
620                 return;
621         memset(oti, 0, sizeof *oti);
622
623         if (req == NULL)
624                 return;
625
626         oti->oti_xid = req->rq_xid;
627
628         if (req->rq_repmsg && req->rq_reqmsg != 0)
629                 oti->oti_transno = lustre_msg_get_transno(req->rq_repmsg);
630         oti->oti_thread_id = req->rq_svc_thread ? req->rq_svc_thread->t_id : -1;
631         oti->oti_conn_cnt = lustre_msg_get_conn_cnt(req->rq_reqmsg);
632 }
633
634 static inline void oti_alloc_cookies(struct obd_trans_info *oti,int num_cookies)
635 {
636         if (!oti)
637                 return;
638
639         if (num_cookies == 1)
640                 oti->oti_logcookies = &oti->oti_onecookie;
641         else
642                 OBD_ALLOC(oti->oti_logcookies,
643                           num_cookies * sizeof(oti->oti_onecookie));
644
645         oti->oti_numcookies = num_cookies;
646 }
647
648 static inline void oti_free_cookies(struct obd_trans_info *oti)
649 {
650         if (!oti || !oti->oti_logcookies)
651                 return;
652
653         if (oti->oti_logcookies == &oti->oti_onecookie)
654                 LASSERT(oti->oti_numcookies == 1);
655         else
656                 OBD_FREE(oti->oti_logcookies,
657                          oti->oti_numcookies * sizeof(oti->oti_onecookie));
658         oti->oti_logcookies = NULL;
659         oti->oti_numcookies = 0;
660 }
661
662 /* llog contexts */
663 enum llog_ctxt_id {
664         LLOG_CONFIG_ORIG_CTXT  =  0,
665         LLOG_CONFIG_REPL_CTXT  =  1,
666         LLOG_MDS_OST_ORIG_CTXT =  2,
667         LLOG_MDS_OST_REPL_CTXT =  3,
668         LLOG_SIZE_ORIG_CTXT    =  4,
669         LLOG_SIZE_REPL_CTXT    =  5,
670         LLOG_MD_ORIG_CTXT      =  6,
671         LLOG_MD_REPL_CTXT      =  7,
672         LLOG_RD1_ORIG_CTXT     =  8,
673         LLOG_RD1_REPL_CTXT     =  9,
674         LLOG_TEST_ORIG_CTXT    = 10,
675         LLOG_TEST_REPL_CTXT    = 11,
676         LLOG_LOVEA_ORIG_CTXT   = 12,
677         LLOG_LOVEA_REPL_CTXT   = 13,
678         LLOG_MAX_CTXTS
679 };
680
681 /*
682  * Events signalled through obd_notify() upcall-chain.
683  */
684 enum obd_notify_event {
685         /* Device activated */
686         OBD_NOTIFY_ACTIVE,
687         /* Device deactivated */
688         OBD_NOTIFY_INACTIVE,
689         /* Connect data for import were changed */
690         OBD_NOTIFY_OCD,
691         /* Sync request */
692         OBD_NOTIFY_SYNC_NONBLOCK,
693         OBD_NOTIFY_SYNC
694 };
695
696 /*
697  * Data structure used to pass obd_notify()-event to non-obd listeners (llite
698  * and liblustre being main examples).
699  */
700 struct obd_notify_upcall {
701         int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
702                           enum obd_notify_event ev, void *owner);
703         /* Opaque datum supplied by upper layer listener */
704         void *onu_owner;
705 };
706
707 /* corresponds to one of the obd's */
708 #define MAX_OBD_NAME 128
709 #define OBD_DEVICE_MAGIC        0XAB5CD6EF
710 struct obd_device {
711         struct obd_type        *obd_type;
712         __u32                   obd_magic;
713
714         /* common and UUID name of this device */
715         char                    obd_name[MAX_OBD_NAME];
716         struct obd_uuid         obd_uuid;
717
718         int                     obd_minor;
719         unsigned int obd_attached:1,      /* finished attach */
720                      obd_set_up:1,        /* finished setup */
721                      obd_recovering:1,    /* there are recoverable clients */
722                      obd_abort_recovery:1,/* somebody ioctl'ed us to abort */ 
723                      obd_replayable:1,    /* recovery is enabled; inform clients */
724                      obd_no_transno:1,    /* no committed-transno notification */
725                      obd_no_recov:1,      /* fail instead of retry messages */
726                      obd_stopping:1,      /* started cleanup */
727                      obd_starting:1,      /* started setup */
728                      obd_force:1,         /* cleanup with > 0 obd refcount */
729                      obd_fail:1,          /* cleanup with failover */
730                      obd_async_recov:1;   /* allow asyncronous orphan cleanup */
731         atomic_t obd_refcount;
732         cfs_waitq_t             obd_refcount_waitq;
733         struct list_head        obd_exports;
734         int                     obd_num_exports;
735         struct ldlm_namespace  *obd_namespace;
736         struct ptlrpc_client    obd_ldlm_client; /* XXX OST/MDS only */
737         /* a spinlock is OK for what we do now, may need a semaphore later */
738         spinlock_t              obd_dev_lock;
739         struct semaphore        obd_dev_sem;
740         __u64                   obd_last_committed;
741         struct fsfilt_operations *obd_fsops;
742         spinlock_t              obd_osfs_lock;
743         struct obd_statfs       obd_osfs;       /* locked by obd_osfs_lock */
744         __u64                   obd_osfs_age;   
745         struct lvfs_run_ctxt    obd_lvfs_ctxt;
746         struct llog_ctxt        *obd_llog_ctxt[LLOG_MAX_CTXTS];
747         struct obd_device       *obd_observer;
748         struct obd_notify_upcall obd_upcall;
749         struct obd_export       *obd_self_export;
750         /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
751         struct list_head        obd_exports_timed;
752         time_t                  obd_eviction_timer; /* for ping evictor */
753
754         /* XXX encapsulate all this recovery data into one struct */
755         svc_handler_t                    obd_recovery_handler;
756         int                              obd_max_recoverable_clients;
757         int                              obd_connected_clients;
758         int                              obd_recoverable_clients;
759         spinlock_t                       obd_processing_task_lock; /* BH lock (timer) */
760         pid_t                            obd_processing_task;
761         __u64                            obd_next_recovery_transno;
762         int                              obd_replayed_requests;
763         int                              obd_requests_queued_for_recovery;
764         cfs_waitq_t                      obd_next_transno_waitq;
765         struct list_head                 obd_uncommitted_replies;
766         spinlock_t                       obd_uncommitted_replies_lock;
767         cfs_timer_t                      obd_recovery_timer;
768         struct list_head                 obd_recovery_queue;
769         struct list_head                 obd_delayed_reply_queue;
770         time_t                           obd_recovery_start;
771         time_t                           obd_recovery_end;
772
773         union {
774                 struct obd_device_target obt;
775                 struct filter_obd filter;
776                 struct mds_obd mds;
777                 struct client_obd cli;
778                 struct ost_obd ost;
779                 struct echo_client_obd echo_client;
780                 struct echo_obd echo;
781                 struct lov_obd lov;
782                 struct mgs_obd mgs;
783         } u;
784         /* Fields used by LProcFS */
785         cfs_proc_dir_entry_t  *obd_proc_entry;
786         cfs_proc_dir_entry_t  *obd_proc_exports;
787         cfs_proc_dir_entry_t  *obd_svc_procroot;
788         struct lprocfs_stats  *obd_stats;
789         struct lprocfs_stats  *obd_svc_stats;
790         unsigned int           obd_cntr_base;
791         struct semaphore       obd_proc_exp_sem;
792 };
793
794 #define OBD_OPT_FORCE           0x0001
795 #define OBD_OPT_FAILOVER        0x0002
796
797 #define OBD_LLOG_FL_SENDNOW     0x0001
798
799 enum obd_cleanup_stage {
800 /* Special case hack for MDS LOVs */
801         OBD_CLEANUP_EARLY,
802 /* Precleanup stage 1, we must make sure all exports (other than the
803    self-export) get destroyed. */
804         OBD_CLEANUP_EXPORTS,
805 /* Precleanup stage 2,  do other type-specific cleanup requiring the
806    self-export. */
807         OBD_CLEANUP_SELF_EXP,
808 /* FIXME we should eliminate the "precleanup" function and make them stages
809    of the "cleanup" function. */
810         OBD_CLEANUP_OBD,
811 };
812
813 /* get/set_info keys */
814 #define KEY_MDS_CONN "mds_conn"
815 #define KEY_NEXT_ID  "next_id"
816 #define KEY_LOVDESC  "lovdesc"
817 #define KEY_INIT_RECOV "initial_recov"
818 #define KEY_INIT_RECOV_BACKUP "init_recov_bk"
819
820 struct obd_ops {
821         struct module *o_owner;
822         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
823                            void *karg, void *uarg);
824         int (*o_get_info)(struct obd_export *, __u32 keylen, void *key,
825                           __u32 *vallen, void *val);
826         int (*o_set_info_async)(struct obd_export *, __u32 keylen, void *key,
827                                 __u32 vallen, void *val,
828                                 struct ptlrpc_request_set *set);
829         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
830         int (*o_detach)(struct obd_device *dev);
831         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
832         int (*o_precleanup)(struct obd_device *dev,
833                             enum obd_cleanup_stage cleanup_stage);
834         int (*o_cleanup)(struct obd_device *dev);
835         int (*o_process_config)(struct obd_device *dev, obd_count len,
836                                 void *data);
837         int (*o_postrecov)(struct obd_device *dev);
838         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
839                           int priority);
840         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
841         /* connect to the target device with given connection
842          * data. @ocd->ocd_connect_flags is modified to reflect flags actually
843          * granted by the target, which are guaranteed to be a subset of flags
844          * asked for. If @ocd == NULL, use default parameters. */
845         int (*o_connect)(struct lustre_handle *conn, struct obd_device *src,
846                          struct obd_uuid *cluuid, struct obd_connect_data *ocd);
847         int (*o_reconnect)(struct obd_export *exp, struct obd_device *src,
848                            struct obd_uuid *cluuid,
849                            struct obd_connect_data *ocd);
850         int (*o_disconnect)(struct obd_export *exp);
851
852         int (*o_statfs)(struct obd_device *obd, struct obd_statfs *osfs,
853                         __u64 max_age);
854         int (*o_statfs_async)(struct obd_device *obd, struct obd_info *oinfo,
855                               __u64 max_age, struct ptlrpc_request_set *set);
856         int (*o_packmd)(struct obd_export *exp, struct lov_mds_md **disk_tgt,
857                         struct lov_stripe_md *mem_src);
858         int (*o_unpackmd)(struct obd_export *exp,struct lov_stripe_md **mem_tgt,
859                           struct lov_mds_md *disk_src, int disk_len);
860         int (*o_checkmd)(struct obd_export *exp, struct obd_export *md_exp,
861                          struct lov_stripe_md *mem_tgt);
862         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
863                              obd_id *ids);
864         int (*o_create)(struct obd_export *exp,  struct obdo *oa,
865                         struct lov_stripe_md **ea, struct obd_trans_info *oti);
866         int (*o_destroy)(struct obd_export *exp, struct obdo *oa,
867                          struct lov_stripe_md *ea, struct obd_trans_info *oti,
868                          struct obd_export *md_exp);
869         int (*o_setattr)(struct obd_export *exp, struct obd_info *oinfo,
870                          struct obd_trans_info *oti);
871         int (*o_setattr_async)(struct obd_export *exp, struct obd_info *oinfo,
872                                struct obd_trans_info *oti,
873                                struct ptlrpc_request_set *rqset);
874         int (*o_getattr)(struct obd_export *exp, struct obd_info *oinfo);
875         int (*o_getattr_async)(struct obd_export *exp, struct obd_info *oinfo,
876                                struct ptlrpc_request_set *set);
877         int (*o_brw)(int rw, struct obd_export *exp, struct obd_info *oinfo,
878                      obd_count oa_bufs, struct brw_page *pgarr,
879                      struct obd_trans_info *oti);
880         int (*o_brw_async)(int rw, struct obd_export *exp,
881                            struct obd_info *oinfo, obd_count oa_bufs,
882                            struct brw_page *pgarr, struct obd_trans_info *oti,
883                            struct ptlrpc_request_set *);
884         int (*o_prep_async_page)(struct obd_export *exp,
885                                  struct lov_stripe_md *lsm,
886                                  struct lov_oinfo *loi,
887                                  cfs_page_t *page, obd_off offset, 
888                                  struct obd_async_page_ops *ops, void *data,
889                                  void **res);
890         int (*o_queue_async_io)(struct obd_export *exp,
891                                 struct lov_stripe_md *lsm,
892                                 struct lov_oinfo *loi, void *cookie,
893                                 int cmd, obd_off off, int count,
894                                 obd_flag brw_flags, obd_flag async_flags);
895         int (*o_queue_group_io)(struct obd_export *exp,
896                                 struct lov_stripe_md *lsm,
897                                 struct lov_oinfo *loi,
898                                 struct obd_io_group *oig,
899                                 void *cookie, int cmd, obd_off off, int count,
900                                 obd_flag brw_flags, obd_flag async_flags);
901         int (*o_trigger_group_io)(struct obd_export *exp,
902                                   struct lov_stripe_md *lsm,
903                                   struct lov_oinfo *loi,
904                                   struct obd_io_group *oig);
905         int (*o_set_async_flags)(struct obd_export *exp,
906                                 struct lov_stripe_md *lsm,
907                                 struct lov_oinfo *loi, void *cookie,
908                                 obd_flag async_flags);
909         int (*o_teardown_async_page)(struct obd_export *exp,
910                                      struct lov_stripe_md *lsm,
911                                      struct lov_oinfo *loi, void *cookie);
912         int (*o_merge_lvb)(struct obd_export *exp, struct lov_stripe_md *lsm,
913                            struct ost_lvb *lvb, int kms_only);
914         int (*o_adjust_kms)(struct obd_export *exp, struct lov_stripe_md *lsm,
915                             obd_off size, int shrink);
916         int (*o_punch)(struct obd_export *exp, struct obd_info *oinfo,
917                        struct obd_trans_info *oti,
918                        struct ptlrpc_request_set *rqset);
919         int (*o_sync)(struct obd_export *exp, struct obdo *oa,
920                       struct lov_stripe_md *ea, obd_size start, obd_size end);
921         int (*o_migrate)(struct lustre_handle *conn, struct lov_stripe_md *dst,
922                          struct lov_stripe_md *src, obd_size start,
923                          obd_size end, struct obd_trans_info *oti);
924         int (*o_copy)(struct lustre_handle *dstconn, struct lov_stripe_md *dst,
925                       struct lustre_handle *srconn, struct lov_stripe_md *src,
926                       obd_size start, obd_size end, struct obd_trans_info *);
927         int (*o_iterate)(struct lustre_handle *conn,
928                          int (*)(obd_id, obd_gr, void *),
929                          obd_id *startid, obd_gr group, void *data);
930         int (*o_preprw)(int cmd, struct obd_export *exp, struct obdo *oa,
931                         int objcount, struct obd_ioobj *obj,
932                         int niocount, struct niobuf_remote *remote,
933                         struct niobuf_local *local, struct obd_trans_info *oti);
934         int (*o_commitrw)(int cmd, struct obd_export *exp, struct obdo *oa,
935                           int objcount, struct obd_ioobj *obj,
936                           int niocount, struct niobuf_local *local,
937                           struct obd_trans_info *oti, int rc);
938         int (*o_enqueue)(struct obd_export *, struct obd_info *oinfo,
939                          struct obd_enqueue_info *einfo);
940         int (*o_match)(struct obd_export *, struct lov_stripe_md *, __u32 type,
941                        ldlm_policy_data_t *, __u32 mode, int *flags, void *data,
942                        struct lustre_handle *lockh);
943         int (*o_change_cbdata)(struct obd_export *, struct lov_stripe_md *,
944                                ldlm_iterator_t it, void *data);
945         int (*o_cancel)(struct obd_export *, struct lov_stripe_md *md,
946                         __u32 mode, struct lustre_handle *);
947         int (*o_cancel_unused)(struct obd_export *, struct lov_stripe_md *,
948                                int flags, void *opaque);
949         int (*o_join_lru)(struct obd_export *, struct lov_stripe_md *,
950                          int join);
951         int (*o_init_export)(struct obd_export *exp);
952         int (*o_destroy_export)(struct obd_export *exp);
953         int (*o_extent_calc)(struct obd_export *, struct lov_stripe_md *,
954                              int cmd, obd_off *);
955
956         /* llog related obd_methods */
957         int (*o_llog_init)(struct obd_device *obd, struct obd_device *disk_obd,
958                            int count, struct llog_catid *logid, 
959                            struct obd_uuid *uuid);
960         int (*o_llog_finish)(struct obd_device *obd, int count);
961
962         /* metadata-only methods */
963         int (*o_pin)(struct obd_export *, obd_id ino, __u32 gen, int type,
964                      struct obd_client_handle *, int flag);
965         int (*o_unpin)(struct obd_export *, struct obd_client_handle *, int);
966
967         int (*o_import_event)(struct obd_device *, struct obd_import *,
968                               enum obd_import_event);
969
970         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
971                         enum obd_notify_event ev, void *data);
972
973         int (*o_health_check)(struct obd_device *);
974
975         /* quota methods */
976         int (*o_quotacheck)(struct obd_export *, struct obd_quotactl *);
977         int (*o_quotactl)(struct obd_export *, struct obd_quotactl *);
978
979         int (*o_ping)(struct obd_export *exp);
980         /*
981          * NOTE: If adding ops, add another LPROCFS_OBD_OP_INIT() line
982          * to lprocfs_alloc_obd_stats() in obdclass/lprocfs_status.c.
983          * Also, add a wrapper function in include/linux/obd_class.h. */
984 };
985
986 struct lsm_operations {
987         void (*lsm_free)(struct lov_stripe_md *);
988         int (*lsm_destroy)(struct lov_stripe_md *, struct obdo *oa,
989                            struct obd_export *md_exp);
990         void (*lsm_stripe_by_index)(struct lov_stripe_md *, int *, obd_off *,
991                                      unsigned long *);
992         void (*lsm_stripe_by_offset)(struct lov_stripe_md *, int *, obd_off *,
993                                      unsigned long *);
994         obd_off (*lsm_stripe_offset_by_index)(struct lov_stripe_md *, int);
995         obd_off (*lsm_stripe_offset_by_offset)(struct lov_stripe_md *, obd_off);
996         int (*lsm_stripe_index_by_offset)(struct lov_stripe_md *, obd_off);
997         int (*lsm_revalidate) (struct lov_stripe_md *, struct obd_device *obd);
998         int (*lsm_lmm_verify) (struct lov_mds_md *lmm, int lmm_bytes,
999                                int *stripe_count);
1000         int (*lsm_unpackmd) (struct lov_obd *lov, struct lov_stripe_md *lsm,
1001                              struct lov_mds_md *lmm);
1002 };
1003
1004 extern struct lsm_operations lsm_plain_ops;
1005 extern struct lsm_operations lsm_join_ops;
1006 static inline struct lsm_operations *lsm_op_find(int magic)
1007 {
1008         switch(magic) {
1009         case LOV_MAGIC:
1010                return &lsm_plain_ops;
1011         case LOV_MAGIC_JOIN:
1012                return &lsm_join_ops;
1013         default:
1014                CERROR("Cannot recognize lsm_magic %d", magic);
1015                return NULL;
1016         }
1017 }
1018
1019 int lvfs_check_io_health(struct obd_device *obd, struct file *file);
1020
1021 /* Requests for obd_extent_calc() */
1022 #define OBD_CALC_STRIPE_START   1
1023 #define OBD_CALC_STRIPE_END     2
1024
1025 static inline void obd_transno_commit_cb(struct obd_device *obd, __u64 transno,
1026                                          int error)
1027 {
1028         if (error) {
1029                 CERROR("%s: transno "LPD64" commit error: %d\n",
1030                        obd->obd_name, transno, error);
1031                 return;
1032         }
1033         CDEBUG(D_HA, "%s: transno "LPD64" committed\n",
1034                obd->obd_name, transno);
1035         if (transno > obd->obd_last_committed) {
1036                 obd->obd_last_committed = transno;
1037                 ptlrpc_commit_replies (obd);
1038         }
1039 }
1040
1041 static inline void init_obd_quota_ops(quota_interface_t *interface,
1042                                       struct obd_ops *obd_ops)
1043 {
1044         if (!interface)
1045                 return;
1046
1047         LASSERT(obd_ops);
1048         obd_ops->o_quotacheck = QUOTA_OP(interface, check);
1049         obd_ops->o_quotactl = QUOTA_OP(interface, ctl);
1050 }
1051
1052 #endif /* __OBD_H */