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