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