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