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