lustre/include/obd.h

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