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