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