lustre/include/obd.h

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