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