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