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