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