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