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