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