Whamcloud - gitweb
b=7356
[fs/lustre-release.git] / lustre / include / linux / obd.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
5  *
6  * This code is issued under the GNU General Public License.
7  * See the file COPYING in this distribution
8  */
9
10 #ifndef __OBD_H
11 #define __OBD_H
12
13 #define IOC_OSC_TYPE         'h'
14 #define IOC_OSC_MIN_NR       20
15 #define IOC_OSC_SET_ACTIVE   _IOWR(IOC_OSC_TYPE, 21, struct obd_device *)
16 #define IOC_OSC_CTL_RECOVERY _IOWR(IOC_OSC_TYPE, 22, struct obd_device *)
17 #define IOC_OSC_MAX_NR       50
18
19 #define IOC_MDC_TYPE         'i'
20 #define IOC_MDC_MIN_NR       20
21 #define IOC_MDC_LOOKUP       _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
22 /* Moved to lustre_user.h
23 #define IOC_MDC_GETSTRIPE    _IOWR(IOC_MDC_TYPE, 21, struct lov_mds_md *) */
24 #define IOC_MDC_MAX_NR       50
25
26 #ifdef __KERNEL__
27 # include <linux/fs.h>
28 # include <linux/list.h>
29 # include <linux/sched.h> /* for struct task_struct, for current.h */
30 # include <asm/current.h> /* for smp_lock.h */
31 # include <linux/smp_lock.h>
32 # include <linux/proc_fs.h>
33 # include <linux/mount.h>
34 #endif
35
36 #define OBD_MDS_DEVICENAME         "mds"
37 #define OBD_MDT_DEVICENAME         "mdt"
38 #define OBD_MDC_DEVICENAME         "mdc"
39 #define OBD_LMV_DEVICENAME         "lmv"
40 #define OBD_LOV_DEVICENAME         "lov"
41 #define OBD_OST_DEVICENAME         "ost"
42 #define OBD_OSC_DEVICENAME         "osc"
43
44 #define OBD_LDLM_DEVICENAME        "ldlm"
45 #define OBD_CACHE_DEVICENAME       "cobd"
46 #define OBD_CMOBD_DEVICENAME       "cmobd"
47 #define OBD_CONF_DEVICENAME        "confobd"
48
49 #define OBD_SANOSC_DEVICENAME      "sanosc"
50 #define OBD_SANOST_DEVICENAME      "sanost"
51
52 #define OBD_ECHO_DEVICENAME        "obdecho"
53 #define OBD_ECHO_CLIENT_DEVICENAME "echo_client"
54
55 #define OBD_FILTER_DEVICENAME      "obdfilter"
56 #define OBD_FILTER_SAN_DEVICENAME  "sanobdfilter"
57
58 #define OBD_MGMTCLI_DEVICENAME     "mgmt_cli"
59 #define OBD_PTLBD_SV_DEVICENAME    "ptlbd_server"
60 #define OBD_PTLBD_CL_DEVICENAME    "ptlbd_client"
61
62 #include <linux/lvfs.h>
63 #include <linux/lustre_lib.h>
64 #include <linux/lustre_idl.h>
65 #include <linux/lustre_export.h>
66 #include <linux/lustre_sec.h>
67
68 /* this is really local to the OSC */
69 struct loi_oap_pages {
70         struct list_head        lop_pending;
71         int                     lop_num_pending;
72         struct list_head        lop_urgent;
73         struct list_head        lop_pending_group;
74 };
75
76 struct lov_oinfo {                 /* per-stripe data structure */
77         __u64 loi_id;              /* object ID on the target OST */
78         __u64 loi_gr;              /* object group on the target OST */
79         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
80         int loi_ost_gen;           /* generation of this loi_ost_idx */
81
82         /* used by the osc to keep track of what objects to build into rpcs */
83         struct loi_oap_pages loi_read_lop;
84         struct loi_oap_pages loi_write_lop;
85         /* _cli_ is poorly named, it should be _ready_ */
86         struct list_head loi_cli_item;
87         struct list_head loi_write_item;
88         struct list_head loi_read_item;
89
90         unsigned loi_kms_valid:1;
91         __u64 loi_kms;             /* known minimum size */
92         __u64 loi_rss;             /* recently seen size */
93         __u64 loi_mtime;           /* recently seen mtime */
94         __u64 loi_blocks;          /* recently seen blocks */
95 };
96
97 static inline void loi_init(struct lov_oinfo *loi)
98 {
99         INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending);
100         INIT_LIST_HEAD(&loi->loi_read_lop.lop_urgent);
101         INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending_group);
102         INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending);
103         INIT_LIST_HEAD(&loi->loi_write_lop.lop_urgent);
104         INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending_group);
105         INIT_LIST_HEAD(&loi->loi_cli_item);
106         INIT_LIST_HEAD(&loi->loi_write_item);
107         INIT_LIST_HEAD(&loi->loi_read_item);
108 }
109
110 struct lov_stripe_md {
111         /* Public members. */
112         __u64 lsm_object_id;        /* lov object id */
113         __u64 lsm_object_gr;        /* lov object id */
114         __u64 lsm_maxbytes;         /* maximum possible file size */
115         unsigned long lsm_xfersize; /* optimal transfer size */
116
117         /* LOV-private members start here -- only for use in lov/. */
118         __u32 lsm_magic;
119         __u32 lsm_stripe_size;      /* size of the stripe */
120         __u32 lsm_pattern;          /* striping pattern (RAID0, RAID1) */
121         unsigned lsm_stripe_count;  /* number of objects being striped over */
122         struct lov_oinfo lsm_oinfo[0];
123 };
124
125 static inline void dump_lsm(int level, struct lov_stripe_md *lsm)
126 {
127         int i;
128         CDEBUG(level, "objid "LPX64"/"LPU64", maxbytes "LPX64", magic 0x%08X, "
129                "stripe_size %u, stripe_count %u\n",
130                lsm->lsm_object_id, lsm->lsm_object_gr, lsm->lsm_maxbytes,
131                lsm->lsm_magic, lsm->lsm_stripe_size, lsm->lsm_stripe_count);
132         for (i = 0; i < lsm->lsm_stripe_count; i++)
133                 CDEBUG(level, "idx %u ostidx %u/%u object "LPU64"/"LPU64"\n",
134                        i, lsm->lsm_oinfo[i].loi_ost_idx,
135                        lsm->lsm_oinfo[i].loi_ost_gen,
136                        lsm->lsm_oinfo[i].loi_id, lsm->lsm_oinfo[i].loi_gr);
137 }
138
139 struct obd_type {
140         struct list_head typ_chain;
141         struct obd_ops *typ_ops;
142         struct md_ops *typ_md_ops;
143         struct proc_dir_entry *typ_procroot;
144         char *typ_name;
145         int  typ_refcnt;
146 };
147
148 struct brw_page {
149         obd_off disk_offset; /* modulo PAGE_SIZE */
150         obd_off page_offset; /* modulo PAGE_SIZE (obviously) */
151         struct page *pg;
152         int count;
153         obd_flags flag;
154 };
155
156 enum async_flags {
157         ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
158                               page is added to an rpc */
159         ASYNC_URGENT = 0x2,
160         ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
161                                      to give the caller a chance to update
162                                      or cancel the size of the io */
163         ASYNC_GROUP_SYNC = 0x8,  /* ap_completion will not be called, instead
164                                     the page is accounted for in the
165                                     obd_io_group given to 
166                                     obd_queue_group_io */
167 };
168
169 struct obd_async_page_ops {
170         int  (*ap_make_ready)(void *data, int cmd);
171         int  (*ap_refresh_count)(void *data, int cmd);
172         void (*ap_fill_obdo)(void *data, int cmd, struct obdo *oa);
173         void (*ap_completion)(void *data, int cmd, struct obdo *oa, int rc);
174 };
175
176 /* the `oig' is passed down from a caller of obd rw methods.  the callee
177  * records enough state such that the caller can sleep on the oig and
178  * be woken when all the callees have finished their work */
179 struct obd_io_group {
180         spinlock_t      oig_lock;
181         atomic_t        oig_refcount;
182         int             oig_pending;
183         int             oig_rc;
184         struct list_head oig_occ_list;
185         wait_queue_head_t oig_waitq;
186 };
187
188 /* the oig callback context lets the callee of obd rw methods register
189  * for callbacks from the caller. */
190 struct oig_callback_context {
191         struct list_head occ_oig_item;
192         /* called when the caller has received a signal while sleeping.
193          * callees of this method are encouraged to abort their state 
194          * in the oig.  This may be called multiple times. */
195         void (*occ_interrupted)(struct oig_callback_context *occ);
196         int interrupted;
197 };
198
199 /* if we find more consumers this could be generalized */
200 #define OBD_HIST_MAX 32
201 struct obd_histogram {
202         spinlock_t      oh_lock;
203         unsigned long   oh_buckets[OBD_HIST_MAX];
204 };
205
206 /* reports average service time with the help of lprocfs_status.c */
207 struct obd_service_time {
208         __u32           st_num;
209         __u64           st_total_us;
210 };
211
212 struct ost_server_data;
213
214 #define FILTER_SUBDIR_COUNT      32            /* set to zero for no subdirs */
215
216 #define FILTER_GROUP_LLOG 1
217 #define FILTER_GROUP_ECHO 2
218 #define FILTER_GROUP_FIRST_MDS 3
219
220 struct filter_subdirs {
221         struct dentry *dentry[FILTER_SUBDIR_COUNT];
222 };
223
224 struct filter_group_llog {
225         struct list_head list;
226         int group;
227         struct obd_llogs *llogs;
228         struct obd_export *exp;
229 };
230
231 struct filter_obd {
232         const char          *fo_fstype;
233         struct super_block  *fo_sb;
234         struct vfsmount     *fo_vfsmnt;
235         struct lvfs_obd_ctxt *fo_lvfs_ctxt;
236
237         int                    fo_group_count;
238         struct dentry         *fo_dentry_O;     /* the "O"bject directory dentry */
239         struct dentry         **fo_groups;      /* dentries for each group dir */
240         struct filter_subdirs *fo_subdirs;      /* subdir array per group */
241         __u64                 *fo_last_objids;  /* per-group last created objid */
242         struct file          **fo_last_objid_files;
243         struct semaphore     fo_init_lock;      /* group initialization lock */
244         int                  fo_committed_group;
245
246         spinlock_t           fo_objidlock;      /* protect fo_lastobjid increment */
247         spinlock_t           fo_lastidlock;     /* protect last_id increment */
248         spinlock_t           fo_translock;      /* protect fsd_last_rcvd increment */
249         struct file         *fo_rcvd_filp;
250         struct filter_server_data *fo_fsd;
251         unsigned long       *fo_last_rcvd_slots;
252         __u64                fo_mount_count;
253
254         unsigned long        fo_destroys_in_progress;
255         struct semaphore     fo_create_locks[32];
256
257         struct file_operations *fo_fop;
258         struct inode_operations *fo_iop;
259         struct address_space_operations *fo_aops;
260
261         struct list_head     fo_export_list;
262         int                  fo_subdir_count;
263
264         obd_size             fo_tot_dirty;      /* protected by obd_osfs_lock */
265         obd_size             fo_tot_granted;    /* all values in bytes */
266         obd_size             fo_tot_pending;
267
268         obd_size             fo_readcache_max_filesize;
269
270         struct obd_import   *fo_mdc_imp;
271         struct obd_uuid      fo_mdc_uuid;
272         struct lustre_handle fo_mdc_conn;
273
274         struct semaphore     fo_alloc_lock;
275
276         struct obd_histogram     fo_r_pages;
277         struct obd_histogram     fo_w_pages;
278         struct obd_histogram     fo_r_discont_pages;
279         struct obd_histogram     fo_w_discont_pages;
280         struct obd_histogram     fo_r_discont_blocks;
281         struct obd_histogram     fo_w_discont_blocks;
282
283         struct list_head         fo_llog_list;
284         spinlock_t               fo_llog_list_lock;
285
286         /* which secure flavor from remote is denied */
287         spinlock_t               fo_denylist_lock;
288         struct list_head         fo_denylist;
289
290         /* capability related */
291         int                      fo_capa_stat;
292         struct crypto_tfm       *fo_capa_hmac;
293         spinlock_t               fo_capa_lock;
294
295         struct list_head         fo_capa_keys;
296 };
297
298 struct mds_server_data;
299
300 #define OSC_MAX_RIF_DEFAULT      16
301 #define OSC_MAX_RIF_MAX          64
302 #define OSC_MAX_DIRTY_DEFAULT    (4*OSC_MAX_RIF_DEFAULT*PTLRPC_MAX_BRW_SIZE>>20)
303 #define OSC_MAX_DIRTY_MB_MAX     512     /* totally arbitrary */
304
305 struct mdc_rpc_lock;
306 struct client_obd {
307         struct obd_import       *cl_import;
308         struct semaphore         cl_sem;
309         int                      cl_conn_count;
310         /* max_mds_easize is purely a performance thing so we don't have to
311          * call obd_size_wiremd() all the time. */
312         int                      cl_max_mds_easize;
313         int                      cl_max_mds_cookiesize;
314         kdev_t                   cl_sandev;
315
316         /* security flavors */
317         __u32                    cl_sec_flavor;
318         unsigned long            cl_sec_flags;
319
320         //struct llog_canceld_ctxt *cl_llcd; /* it's included by obd_llog_ctxt */
321         void                    *cl_llcd_offset;
322
323         struct obd_device       *cl_mgmtcli_obd;
324
325         /* the grant values are protected by loi_list_lock below */
326         long                     cl_dirty;         /* all _dirty_ in bytes */
327         long                     cl_dirty_max;     /* allowed w/o rpc */
328         long                     cl_avail_grant;   /* bytes of credit for ost */
329         long                     cl_lost_grant;    /* lost credits (trunc) */
330         struct list_head         cl_cache_waiters; /* waiting for cache/grant */
331
332         /* keep track of objects that have lois that contain pages which
333          * have been queued for async brw.  this lock also protects the
334          * lists of osc_client_pages that hang off of the loi */
335         spinlock_t               cl_loi_list_lock;
336         struct list_head         cl_loi_ready_list;
337         struct list_head         cl_loi_write_list;
338         struct list_head         cl_loi_read_list;
339         int                      cl_r_in_flight;
340         int                      cl_w_in_flight;
341         /* just a sum of the loi/lop pending numbers to be exported by /proc */
342         int                      cl_pending_w_pages;
343         int                      cl_pending_r_pages;
344         int                      cl_max_pages_per_rpc;
345         int                      cl_max_rpcs_in_flight;
346         struct obd_histogram     cl_read_rpc_hist;
347         struct obd_histogram     cl_write_rpc_hist;
348         struct obd_histogram     cl_read_page_hist;
349         struct obd_histogram     cl_write_page_hist;
350         struct obd_service_time  cl_read_stime;
351         struct obd_service_time  cl_write_stime;
352         struct obd_service_time  cl_enter_stime;
353
354         struct mdc_rpc_lock     *cl_rpc_lock;
355         struct mdc_rpc_lock     *cl_setattr_lock; 
356         struct mdc_rpc_lock     *cl_close_lock;
357         struct osc_creator       cl_oscc;
358         int                      cl_async:1;
359
360         /* debug stuff */
361         struct timeval           cl_last_write_time;
362         unsigned long            cl_write_gap_sum;
363         unsigned long            cl_write_gaps;
364         unsigned long            cl_write_num;
365         unsigned long            cl_read_num;
366         unsigned long            cl_cache_wait_num;
367         unsigned long            cl_cache_wait_sum;
368
369         unsigned long            cl_dirty_num;
370         unsigned long            cl_dirty_sum;
371         unsigned long            cl_dirty_av;
372         
373         unsigned long            cl_dirty_dmax;
374         unsigned long            cl_dirty_dmin;
375
376         unsigned long            cl_sync_rpcs;
377 };
378
379 /* Like a client, with some hangers-on.  Keep mc_client_obd first so that we
380  * can reuse the various client setup/connect functions. */
381 struct mgmtcli_obd {
382         struct client_obd        mc_client_obd; /* nested */
383         struct ptlrpc_thread    *mc_ping_thread;
384         struct obd_export       *mc_ping_exp; /* XXX single-target */
385         struct list_head         mc_registered;
386         void                    *mc_hammer;
387 };
388
389 #define mc_import mc_client_obd.cl_import
390
391 struct mds_obd {
392         struct ptlrpc_service           *mds_service;
393         struct ptlrpc_service           *mds_setattr_service;
394         struct ptlrpc_service           *mds_readpage_service;
395         struct ptlrpc_service           *mds_close_service;
396         struct super_block              *mds_sb;
397         struct vfsmount                 *mds_vfsmnt;
398         struct dentry                   *mds_id_de;
399         struct lvfs_obd_ctxt            *mds_lvfs_ctxt;
400         int                              mds_max_mdsize;
401         int                              mds_max_cookiesize;
402         struct file                     *mds_rcvd_filp;
403         struct file                     *mds_fid_filp;
404         struct file                     *mds_virtid_filp;
405         spinlock_t                       mds_transno_lock;
406         __u64                            mds_last_transno;
407         __u64                            mds_mount_count;
408         __u64                            mds_io_epoch;
409         
410         __u64                            mds_last_fid;
411         __u64                            mds_virtid_fid;
412         spinlock_t                       mds_last_fid_lock;
413         
414         struct semaphore                 mds_epoch_sem;
415         struct lustre_id                 mds_rootid;
416         struct mds_server_data          *mds_server_data;
417         struct dentry                   *mds_pending_dir;
418         struct dentry                   *mds_logs_dir;
419         struct dentry                   *mds_objects_dir;
420         struct llog_handle              *mds_cfg_llh;
421         char                            *mds_profile;
422         struct obd_device               *mds_dt_obd;
423         struct obd_uuid                  mds_dt_uuid;
424         struct obd_export               *mds_dt_exp;
425         int                              mds_has_dt_desc;
426         struct lov_desc                  mds_dt_desc;
427
428         spinlock_t                       mds_dt_lock;
429         obd_id                          *mds_dt_objids;
430         struct file                     *mds_dt_objid_filp;
431         int                              mds_dt_objids_valid;
432
433         unsigned long                   *mds_client_bitmap;
434         struct semaphore                 mds_orphan_recovery_sem;
435         
436         int                              mds_num;
437         int                              mds_config_version;
438
439         char                            *mds_md_name;
440         struct obd_device               *mds_md_obd;
441         struct obd_export               *mds_md_exp;
442         struct semaphore                 mds_md_sem;
443         struct obd_uuid                  mds_md_uuid;
444         int                              mds_md_connected;
445
446         struct ptlrpc_service           *mds_create_service;
447         uid_t                            mds_squash_uid;
448         gid_t                            mds_squash_gid;
449         ptl_nid_t                        mds_nosquash_nid;
450         atomic_t                         mds_real_clients;
451         atomic_t                         mds_open_count;
452         struct dentry                   *mds_id_dir;
453         int                              mds_obd_type;
454         struct dentry                   *mds_unnamed_dir; /* for mdt_obd_create only */
455
456         /* security related */
457         char                            *mds_mds_sec;
458         char                            *mds_ost_sec;
459
460         /* which secure flavor from remote to this mds is denied */
461         spinlock_t                      mds_denylist_lock;
462         struct list_head                mds_denylist;
463
464         /* fid->ino mapping related fields */
465         spinlock_t                      mds_fidmap_lock;
466         struct hlist_head              *mds_fidmap_table;
467         unsigned long                   mds_fidmap_size;
468
469         /* cache fid extents stuff */
470         spinlock_t                      mds_fidext_lock;
471         __u64                           mds_fidext_thumb;
472         int                             mds_crypto_type;
473
474         /* capability related */
475         int                              mds_capa_stat;     /* 1: on, 0: off */
476         struct crypto_tfm               *mds_capa_hmac;
477         unsigned long                    mds_capa_timeout;  /* sec */
478
479         struct mds_capa_key              mds_capa_keys[2];  /* red & black key */
480         int                              mds_capa_key_idx;  /* the red key index */
481         struct file                     *mds_capa_keys_filp;
482         unsigned long                    mds_capa_key_timeout; /* sec */
483 };
484
485 struct echo_obd {
486         struct obdo          eo_oa;
487         spinlock_t           eo_lock;
488         __u64                eo_lastino;
489         struct lustre_handle eo_nl_lock;
490         atomic_t             eo_prep;
491 };
492
493 /*
494  * this struct does double-duty acting as either a client or
495  * server instance .. maybe not wise.
496  */
497 struct ptlbd_obd {
498         /* server's */
499         struct ptlrpc_service *ptlbd_service;
500         struct file *filp;
501         /* client's */
502         struct ptlrpc_client    bd_client;
503         struct obd_import       *bd_import;
504         struct obd_uuid         bd_server_uuid;
505         struct obd_export       *bd_exp;
506         int refcount; /* XXX sigh */
507 };
508
509 struct recovd_obd {
510         spinlock_t            recovd_lock;
511         struct list_head      recovd_managed_items; /* items managed  */
512         struct list_head      recovd_troubled_items; /* items in recovery */
513
514         wait_queue_head_t     recovd_recovery_waitq;
515         wait_queue_head_t     recovd_ctl_waitq;
516         wait_queue_head_t     recovd_waitq;
517         struct task_struct   *recovd_thread;
518         __u32                 recovd_state;
519 };
520
521 struct ost_obd {
522         spinlock_t             ost_lock;
523         struct ptlrpc_service *ost_service;
524         struct ptlrpc_service *ost_create_service;
525         struct ptlrpc_service *ost_destroy_service;
526         struct obd_service_time ost_stimes[6];
527 };
528
529 struct echo_client_obd {
530         struct obd_export      *ec_exp;     /* the local connection to osc/lov */
531         spinlock_t              ec_lock;
532         struct list_head        ec_objects;
533         int                     ec_nstripes;
534         __u64                   ec_unique;
535 };
536
537 struct cache_obd {
538         struct obd_export      *master_exp; /* local connection to master obd */
539         struct obd_export      *cache_exp;  /* local connection to cache obd */
540         struct obd_export      *cache_real_exp;
541         struct obd_export      *master_real_exp;
542         struct obd_device      *master;
543         struct obd_device      *cache;
544         char                   *master_name;
545         char                   *cache_name;
546         int                     refcount;
547         int                     cache_on;
548         struct semaphore        sem;
549         struct lov_desc         dt_desc; /* data lovdesc */
550 };
551
552 struct cm_obd {
553         struct obd_export      *cache_exp;  /* local connection to cache obd */
554         struct obd_export      *master_exp;
555         struct obd_device      *cache_obd;
556         struct obd_device      *master_obd;
557         int                     master_group;
558         struct cmobd_write_service *write_srv;
559         struct lov_desc         master_desc; /* master device lovdesc */
560 };
561
562 struct conf_obd {
563         struct super_block      *cfobd_sb;
564         struct vfsmount         *cfobd_vfsmnt;
565         struct dentry           *cfobd_logs_dir;
566         struct dentry           *cfobd_objects_dir;
567         struct dentry           *cfobd_pending_dir;
568         struct llog_handle      *cfobd_cfg_llh;
569         struct lvfs_obd_ctxt    *cfobd_lvfs_ctxt;
570 };
571
572 enum lov_tgt_flags {
573         LTD_ACTIVE      = 0x1, /* is this target up for requests   */
574         LTD_DEL_PENDING = 0x2, /* delete event pending for this tgt */
575 };
576
577 struct lov_tgt_desc {
578         struct obd_uuid         uuid;
579         __u32                   ltd_gen;
580         struct obd_export      *ltd_exp;
581         unsigned int            ltd_flags;
582         int                     ltd_refcount;
583 };
584
585 struct lov_obd {
586         spinlock_t              lov_lock;
587         struct lov_desc         desc;
588         int                     bufsize;
589         int                     refcount;
590         int                     lo_catalog_loaded:1, async:1;
591         struct semaphore        lov_llog_sem;
592         unsigned long           lov_connect_flags;
593         wait_queue_head_t       lov_tgt_waitq;
594         struct lov_tgt_desc    *tgts;
595 };
596
597 struct lmv_tgt_desc {
598         struct obd_uuid         uuid;
599         struct obd_export      *ltd_exp;
600         int                     active;   /* is this target up for requests */
601 };
602
603 struct lmv_obd {
604         int                     refcount;
605         spinlock_t              lmv_lock;
606         struct lmv_desc         desc;
607         struct lmv_tgt_desc     *tgts;
608         struct obd_uuid         cluuid;
609         struct obd_export       *exp;
610
611         int                     tgts_size;
612         int                     connected;
613         int                     max_easize;
614         int                     max_cookiesize;
615         int                     server_timeout;
616         int                     connect_flags;
617         struct semaphore        init_sem;
618         struct obd_connect_data conn_data;
619 };
620 struct gks_crypto_key {
621         char *key;
622         int   len; 
623 };
624 struct gks_obd {
625         struct ptlrpc_service    *gks_service;
626         struct crypto_tfm        *gks_mac_tfm;       
627         struct crypto_tfm        *gks_key_tfm;
628         struct gks_crypto_key    gks_key;
629 };
630
631 struct niobuf_local {
632         __u64 offset;
633         __u32 len;
634         __u32 flags;
635         struct page *page;
636         struct dentry *dentry;
637         int lnb_grant_used;
638         int rc;
639 };
640
641 #define OBD_MODE_ASYNC (1 << 0)
642 #define OBD_MODE_CROW  (1 << 1)
643
644 /* Don't conflict with on-wire flags OBD_BRW_WRITE, etc */
645 #define N_LOCAL_TEMP_PAGE 0x10000000
646
647 struct obd_trans_info {
648         __u64                    oti_transno;
649         __u64                   *oti_objid;
650
651         /* only used on the server side for tracking acks. */
652         struct oti_req_ack_lock {
653                 struct lustre_handle lock;
654                 __u32                mode;
655         }                        oti_ack_locks[4];
656         void                    *oti_handle;
657         struct llog_cookie       oti_onecookie;
658         struct llog_cookie      *oti_logcookies;
659         int                      oti_numcookies;
660         int                      oti_flags;
661         /* save nid for security purposes like audit */
662         __u64                    oti_nid; 
663 };
664
665 static inline void oti_alloc_cookies(struct obd_trans_info *oti,int num_cookies)
666 {
667         if (!oti)
668                 return;
669
670         if (num_cookies == 1)
671                 oti->oti_logcookies = &oti->oti_onecookie;
672         else
673                 OBD_ALLOC(oti->oti_logcookies,
674                           num_cookies * sizeof(oti->oti_onecookie));
675
676         oti->oti_numcookies = num_cookies;
677 }
678
679 static inline void oti_free_cookies(struct obd_trans_info *oti)
680 {
681         if (!oti || !oti->oti_logcookies)
682                 return;
683
684         if (oti->oti_logcookies == &oti->oti_onecookie)
685                 LASSERT(oti->oti_numcookies == 1);
686         else
687                 OBD_FREE(oti->oti_logcookies,
688                          oti->oti_numcookies * sizeof(oti->oti_onecookie));
689         oti->oti_logcookies = NULL;
690         oti->oti_numcookies = 0;
691 }
692
693 /* llog contexts */
694 enum llog_ctxt_id {
695         LLOG_CONFIG_ORIG_CTXT =  0,
696         LLOG_CONFIG_REPL_CTXT =  1,
697         LLOG_UNLINK_ORIG_CTXT =  2,
698         LLOG_UNLINK_REPL_CTXT =  3,
699         LLOG_SIZE_ORIG_CTXT   =  4,
700         LLOG_SIZE_REPL_CTXT   =  5,
701         LLOG_MD_ORIG_CTXT     =  6,
702         LLOG_MD_REPL_CTXT     =  7,
703         LLOG_RD1_ORIG_CTXT    =  8,
704         LLOG_RD1_REPL_CTXT    =  9,
705         LLOG_TEST_ORIG_CTXT   = 10,
706         LLOG_TEST_REPL_CTXT   = 11,
707         LLOG_REINT_ORIG_CTXT  = 12,
708         LLOG_AUDIT_ORIG_CTXT  = 13,
709         LLOG_MAX_CTXTS
710 };
711
712 struct obd_llogs {
713         struct llog_ctxt        *llog_ctxt[LLOG_MAX_CTXTS];
714 };
715
716 struct target_recovery_data {
717         svc_handler_t     trd_recovery_handler;
718         pid_t             trd_processing_task;
719         struct completion trd_starting;
720         struct completion trd_finishing;
721 };
722
723 /* corresponds to one of the obd's */
724 struct obd_device {
725         struct obd_type *obd_type;
726
727         /* common and UUID name of this device */
728         char *obd_name;
729         struct obd_uuid obd_uuid;
730
731         int obd_minor;
732         unsigned int obd_attached:1, obd_set_up:1, obd_recovering:1,
733                 obd_abort_recovery:1, obd_replayable:1, obd_no_transno:1,
734                 obd_no_recov:1, obd_stopping:1, obd_req_replaying:1;
735         atomic_t obd_refcount;
736         wait_queue_head_t obd_refcount_waitq;
737         struct proc_dir_entry *obd_proc_entry;
738         struct list_head       obd_exports;
739         int                    obd_num_exports;
740         struct ldlm_namespace *obd_namespace;
741         struct ptlrpc_client   obd_ldlm_client; /* XXX OST/MDS only */
742         /* a spinlock is OK for what we do now, may need a semaphore later */
743         spinlock_t             obd_dev_lock;
744         __u64                  obd_last_committed;
745         struct fsfilt_operations *obd_fsops;
746         spinlock_t              obd_osfs_lock;
747         struct obd_statfs       obd_osfs;
748         unsigned long           obd_osfs_age;
749         struct lvfs_run_ctxt    obd_lvfs_ctxt;
750         struct obd_llogs        obd_llogs;
751         struct llog_ctxt        *obd_llog_ctxt[LLOG_MAX_CTXTS];
752         struct obd_device       *obd_observer;
753         struct obd_export       *obd_self_export;
754
755         struct target_recovery_data      obd_recovery_data;
756         /* XXX encapsulate all this recovery data into target_recovery_data */
757         int                              obd_max_recoverable_clients;
758         int                              obd_connected_clients;
759         int                              obd_recoverable_clients;
760         spinlock_t                       obd_processing_task_lock;
761         __u64                            obd_next_recovery_transno;
762         int                              obd_replayed_requests;
763         int                              obd_replayed_locks;
764         int                              obd_requests_queued_for_recovery;
765         wait_queue_head_t                obd_next_transno_waitq;
766         struct list_head                 obd_uncommitted_replies;
767         spinlock_t                       obd_uncommitted_replies_lock;
768         struct timer_list                obd_recovery_timer;
769         time_t                           obd_recovery_start;
770         time_t                           obd_recovery_end;
771
772         atomic_t                         obd_req_replay_clients;
773         atomic_t                         obd_lock_replay_clients;
774
775         struct list_head                 obd_req_replay_queue;
776         struct list_head                 obd_lock_replay_queue;
777         struct list_head                 obd_final_req_queue;
778         int                              obd_recovery_stage;
779
780         union {
781                 struct filter_obd        filter;
782                 struct mds_obd           mds;
783                 struct client_obd        cli;
784                 struct ost_obd           ost;
785                 struct echo_client_obd   echocli;
786                 struct echo_obd          echo;
787                 struct recovd_obd        recovd;
788                 struct lov_obd           lov;
789                 struct cache_obd         cobd;
790                 struct ptlbd_obd         ptlbd;
791                 struct mgmtcli_obd       mgmtcli;
792                 struct lmv_obd           lmv;
793                 struct cm_obd            cm;
794                 struct conf_obd          conf;
795                 struct gks_obd           gks;
796         } u;
797         
798         /* fields used by LProcFS */
799         unsigned int           obd_cntr_base;
800         struct lprocfs_stats  *obd_stats;
801         unsigned int           md_cntr_base;
802         struct lprocfs_stats  *md_stats;
803
804         struct proc_dir_entry *obd_svc_procroot;
805         struct lprocfs_stats  *obd_svc_stats;
806 };
807
808 #define OBD_OPT_FORCE             (1 << 0)
809 #define OBD_OPT_FAILOVER          (1 << 1)
810 #define OBD_OPT_REAL_CLIENT       (1 << 2)
811 #define OBD_OPT_MDS_CONNECTION    (1 << 3)
812
813 #define OBD_LLOG_FL_SENDNOW       (1 << 0)
814 #define OBD_LLOG_FL_CREATE        (1 << 1)
815
816 struct mdc_op_data;
817
818 struct obd_ops {
819         struct module *o_owner;
820         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
821                            void *karg, void *uarg);
822         int (*o_get_info)(struct obd_export *, __u32 keylen, void *key,
823                           __u32 *vallen, void *val);
824         int (*o_set_info)(struct obd_export *, __u32 keylen, void *key,
825                           __u32 vallen, void *val);
826         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
827         int (*o_detach)(struct obd_device *dev);
828         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
829         int (*o_precleanup)(struct obd_device *dev, int flags);
830         int (*o_cleanup)(struct obd_device *dev, int flags);
831         int (*o_process_config)(struct obd_device *dev, obd_count len,
832                                 void *data);
833         int (*o_postrecov)(struct obd_device *dev);
834         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
835                           int priority);
836         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
837         int (*o_connect)(struct lustre_handle *conn, struct obd_device *src,
838                          struct obd_uuid *cluuid, struct obd_connect_data *data,
839                          unsigned long flags);
840         int (*o_connect_post)(struct obd_export *exp, unsigned, unsigned long);
841         int (*o_disconnect)(struct obd_export *exp, unsigned long flags);
842
843         int (*o_statfs)(struct obd_device *obd, struct obd_statfs *osfs,
844                         unsigned long max_age);
845         int (*o_packmd)(struct obd_export *exp, struct lov_mds_md **disk_tgt,
846                         struct lov_stripe_md *mem_src);
847         int (*o_unpackmd)(struct obd_export *exp,struct lov_stripe_md **mem_tgt,
848                           struct lov_mds_md *disk_src, int disk_len);
849         int (*o_revalidate_md)(struct obd_export *exp,  struct obdo *oa,
850                                struct lov_stripe_md *ea,
851                                struct obd_trans_info *oti);
852         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
853                              obd_id *ids);
854         int (*o_create)(struct obd_export *exp,  struct obdo *oa,
855                         void *acl, int acl_size,
856                         struct lov_stripe_md **ea, struct obd_trans_info *oti);
857         int (*o_destroy)(struct obd_export *exp, struct obdo *oa,
858                          struct lov_stripe_md *ea, struct obd_trans_info *oti);
859         int (*o_setattr)(struct obd_export *exp, struct obdo *oa,
860                          struct lov_stripe_md *ea, struct obd_trans_info *oti,
861                          struct lustre_capa *capa);
862         int (*o_getattr)(struct obd_export *exp, struct obdo *oa,
863                          struct lov_stripe_md *ea);
864         int (*o_getattr_async)(struct obd_export *exp, struct obdo *oa,
865                                struct lov_stripe_md *ea,
866                                struct ptlrpc_request_set *set);
867         int (*o_brw)(int rw, struct obd_export *exp, struct obdo *oa,
868                      struct lov_stripe_md *ea, obd_count oa_bufs,
869                      struct brw_page *pgarr, struct obd_trans_info *oti);
870         int (*o_brw_async)(int rw, struct obd_export *exp, struct obdo *oa,
871                            struct lov_stripe_md *ea, obd_count oa_bufs,
872                            struct brw_page *pgarr, struct ptlrpc_request_set *,
873                            struct obd_trans_info *oti);
874         int (*o_prep_async_page)(struct obd_export *exp, 
875                                  struct lov_stripe_md *lsm,
876                                  struct lov_oinfo *loi, 
877                                  struct page *page, obd_off offset, 
878                                  struct obd_async_page_ops *ops, void *data,
879                                  void **res);
880         int (*o_queue_async_io)(struct obd_export *exp, 
881                                 struct lov_stripe_md *lsm, 
882                                 struct lov_oinfo *loi, void *cookie, 
883                                 int cmd, obd_off off, int count, 
884                                 obd_flags brw_flags, obd_flags async_flags);
885         int (*o_queue_group_io)(struct obd_export *exp, 
886                                 struct lov_stripe_md *lsm, 
887                                 struct lov_oinfo *loi, 
888                                 struct obd_io_group *oig, 
889                                 void *cookie, int cmd, obd_off off, int count, 
890                                 obd_flags brw_flags, obd_flags async_flags);
891         int (*o_trigger_group_io)(struct obd_export *exp, 
892                                   struct lov_stripe_md *lsm, 
893                                   struct lov_oinfo *loi, 
894                                   struct obd_io_group *oig);
895         int (*o_set_async_flags)(struct obd_export *exp,
896                                 struct lov_stripe_md *lsm,
897                                 struct lov_oinfo *loi, void *cookie,
898                                 obd_flags async_flags);
899         int (*o_teardown_async_page)(struct obd_export *exp,
900                                      struct lov_stripe_md *lsm,
901                                      struct lov_oinfo *loi, void *cookie);
902         int (*o_adjust_kms)(struct obd_export *exp, struct lov_stripe_md *lsm,
903                             obd_off size, int shrink);
904         int (*o_punch)(struct obd_export *exp, struct obdo *oa,
905                        struct lov_stripe_md *ea, obd_size start,
906                        obd_size end, struct obd_trans_info *oti,
907                        struct lustre_capa *capa);
908         int (*o_sync)(struct obd_export *exp, struct obdo *oa,
909                       struct lov_stripe_md *ea, obd_size start, obd_size end);
910         int (*o_migrate)(struct lustre_handle *conn, struct lov_stripe_md *dst,
911                          struct lov_stripe_md *src, obd_size start,
912                          obd_size end, struct obd_trans_info *oti);
913         int (*o_copy)(struct lustre_handle *dstconn, struct lov_stripe_md *dst,
914                       struct lustre_handle *srconn, struct lov_stripe_md *src,
915                       obd_size start, obd_size end, struct obd_trans_info *);
916         int (*o_iterate)(struct lustre_handle *conn,
917                          int (*)(obd_id, obd_gr, void *),
918                          obd_id *startid, obd_gr group, void *data);
919         int (*o_preprw)(int cmd, struct obd_export *exp, struct obdo *oa,
920                         int objcount, struct obd_ioobj *obj,
921                         int niocount, struct niobuf_remote *remote,
922                         struct niobuf_local *local, struct obd_trans_info *oti,
923                         struct lustre_capa *capa);
924         int (*o_commitrw)(int cmd, struct obd_export *exp, struct obdo *oa,
925                           int objcount, struct obd_ioobj *obj,
926                           int niocount, struct niobuf_local *local,
927                           struct obd_trans_info *oti, int rc);
928         int (*o_do_cow)(struct obd_export *exp, struct obd_ioobj *obj, 
929                         int objcount, struct niobuf_remote *rnb);
930         int (*o_write_extents)(struct obd_export *exp, struct obd_ioobj *obj,
931                                int objcount, int niocount, 
932                                struct niobuf_local *local,int rc);
933         int (*o_enqueue)(struct obd_export *, struct lov_stripe_md *,
934                          __u32 type, ldlm_policy_data_t *, __u32 mode,
935                          int *flags, void *bl_cb, void *cp_cb, void *gl_cb,
936                          void *data, __u32 lvb_len, void *lvb_swabber,
937                          struct lustre_handle *lockh);
938         int (*o_match)(struct obd_export *, struct lov_stripe_md *, __u32 type,
939                        ldlm_policy_data_t *, __u32 mode, int *flags, void *data,
940                        struct lustre_handle *lockh);
941         int (*o_change_cbdata)(struct obd_export *, struct lov_stripe_md *,
942                                ldlm_iterator_t it, void *data);
943         int (*o_cancel)(struct obd_export *, struct lov_stripe_md *md,
944                         __u32 mode, struct lustre_handle *);
945         int (*o_cancel_unused)(struct obd_export *, struct lov_stripe_md *,
946                                int flags, void *opaque);
947         int (*o_san_preprw)(int cmd, struct obd_export *exp,
948                             struct obdo *oa, int objcount,
949                             struct obd_ioobj *obj, int niocount,
950                             struct niobuf_remote *remote);
951         int (*o_init_export)(struct obd_export *exp);
952         int (*o_destroy_export)(struct obd_export *exp);
953
954         /* llog related obd_methods */
955         int (*o_llog_init)(struct obd_device *, struct obd_llogs *,
956                            struct obd_device *, int, struct llog_catid *);
957         int (*o_llog_finish)(struct obd_device *, struct obd_llogs *, int);
958         int (*o_llog_connect)(struct obd_export *, struct llogd_conn_body *);
959
960        
961         /* metadata-only methods */
962         int (*o_pin)(struct obd_export *, obd_id ino, __u32 gen, int type,
963                      struct obd_client_handle *, int flag);
964         int (*o_unpin)(struct obd_export *, struct obd_client_handle *, int);
965
966         int (*o_import_event)(struct obd_device *, struct obd_import *,
967                               enum obd_import_event);
968
969         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
970                         int active, void *data);
971
972         int (*o_init_ea_size)(struct obd_export *, int, int);
973
974         /* 
975          * NOTE: If adding ops, add another LPROCFS_OBD_OP_INIT() line
976          * to lprocfs_alloc_obd_stats() in obdclass/lprocfs_status.c.
977          * Also, add a wrapper function in include/linux/obd_class.h.
978          */
979 };
980
981 struct md_ops {
982         int (*m_getstatus)(struct obd_export *, struct lustre_id *);
983         int (*m_change_cbdata)(struct obd_export *, struct lustre_id *,
984                                ldlm_iterator_t, void *);
985         int (*m_change_cbdata_name)(struct obd_export *, struct lustre_id *,
986                                     char *, int, struct lustre_id *,
987                                     ldlm_iterator_t, void *);
988         int (*m_close)(struct obd_export *, struct mdc_op_data *,
989                        struct obd_client_handle *, struct ptlrpc_request **);
990         int (*m_create)(struct obd_export *, struct mdc_op_data *,
991                         const void *, int, int, __u32, __u32,
992                         __u64, struct ptlrpc_request **);
993         int (*m_done_writing)(struct obd_export *, struct obdo *);
994         int (*m_enqueue)(struct obd_export *, int, struct lookup_intent *,
995                          int, struct mdc_op_data *, struct lustre_handle *,
996                          void *, int, ldlm_completion_callback,
997                          ldlm_blocking_callback, void *);
998         int (*m_getattr)(struct obd_export *, struct lustre_id *,
999                          __u64, const char *, const void *, unsigned int,
1000                          unsigned int, struct obd_capa *,
1001                          struct ptlrpc_request **);
1002         int (*m_access_check)(struct obd_export *, struct lustre_id *,
1003                               struct ptlrpc_request **);
1004         int (*m_getattr_lock)(struct obd_export *, struct lustre_id *,
1005                               char *, int, __u64,
1006                               unsigned int, struct ptlrpc_request **);
1007         int (*m_intent_lock)(struct obd_export *,
1008                              struct lustre_id *, const char *, int,
1009                              void *, int, struct lustre_id *,
1010                              struct lookup_intent *, int,
1011                              struct ptlrpc_request **,
1012                              ldlm_blocking_callback);
1013         int (*m_link)(struct obd_export *, struct mdc_op_data *,
1014                       struct ptlrpc_request **);
1015         int (*m_rename)(struct obd_export *, struct mdc_op_data *,
1016                         const char *, int, const char *, int,
1017                         struct ptlrpc_request **);
1018         int (*m_setattr)(struct obd_export *, struct mdc_op_data *,
1019                          struct iattr *, void *, int , void *, int,
1020                          void *, int, struct ptlrpc_request **);
1021         int (*m_sync)(struct obd_export *, struct lustre_id *,
1022                       struct ptlrpc_request **);
1023         int (*m_readpage)(struct obd_export *, struct lustre_id *,
1024                           __u64, struct page *, struct ptlrpc_request **);
1025         int (*m_unlink)(struct obd_export *, struct mdc_op_data *,
1026                         struct ptlrpc_request **);
1027         int (*m_valid_attrs)(struct obd_export *, struct lustre_id *);
1028         
1029         struct obd_device *(*m_get_real_obd)(struct obd_export *, struct lustre_id *);
1030         
1031         int (*m_req2lustre_md)(struct obd_export *exp, 
1032                                struct ptlrpc_request *req, unsigned int offset,
1033                                struct obd_export *osc_exp, struct lustre_md *md);
1034         int (*m_set_open_replay_data)(struct obd_export *exp,
1035                                       struct obd_client_handle *och,
1036                                       struct ptlrpc_request *open_req);
1037         int (*m_clear_open_replay_data)(struct obd_export *exp,
1038                                         struct obd_client_handle *och);
1039         int (*m_store_inode_generation)(struct obd_export *exp, 
1040                                         struct ptlrpc_request *req, int reqoff,
1041                                         int repoff);
1042         int (*m_set_lock_data)(struct obd_export *exp, __u64 *l, void *data);
1043
1044         int (*m_delete_inode)(struct obd_export *, struct lustre_id *);
1045
1046         /*
1047          * NOTE: If adding ops, add another LPROCFS_MD_OP_INIT() line to
1048          * lprocfs_alloc_md_stats() in obdclass/lprocfs_status.c. Also, add a
1049          * wrapper function in include/linux/obd_class.h.
1050          */
1051 };
1052
1053 static inline void obd_transno_commit_cb(struct obd_device *obd,
1054                                          __u64 transno, int error)
1055 {
1056         if (error) {
1057                 CERROR("%s: transno "LPD64" commit error: %d\n",
1058                        obd->obd_name, transno, error);
1059                 return;
1060         }
1061         
1062         CDEBUG(D_HA, "%s: transno "LPD64" committed\n",
1063                obd->obd_name, transno);
1064
1065         if (transno > obd->obd_last_committed) {
1066                 obd->obd_last_committed = transno;
1067                 ptlrpc_commit_replies (obd);
1068         }
1069 }
1070
1071 static inline int obd_md_type(struct obd_device *obd)
1072 {
1073         if (!strcmp(obd->obd_type->typ_name, OBD_MDC_DEVICENAME) ||
1074             !strcmp(obd->obd_type->typ_name, OBD_LMV_DEVICENAME))
1075                 return 1;
1076
1077         return 0;
1078 }
1079
1080 static inline int obd_dt_type(struct obd_device *obd)
1081 {
1082         if (!strcmp(obd->obd_type->typ_name, OBD_LOV_DEVICENAME) ||
1083             !strcmp(obd->obd_type->typ_name, OBD_OSC_DEVICENAME))
1084                 return 1;
1085
1086         return 0;
1087 }
1088
1089 #endif /* __OBD_H */