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