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