drivers/staging/lustre/lustre/include/obd.h

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