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