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