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