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