lustre/include/obd.h

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