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