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