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