lustre/include/linux/obd.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
   5  *
   6  * This code is issued under the GNU General Public License.
   7  * See the file COPYING in this distribution
   8  */
   9
  10 #ifndef __OBD_H
  11 #define __OBD_H
  12
  13 #define IOC_OSC_TYPE         'h'
  14 #define IOC_OSC_MIN_NR       20
  15 #define IOC_OSC_SET_ACTIVE   _IOWR(IOC_OSC_TYPE, 21, struct obd_device *)
  16 #define IOC_OSC_CTL_RECOVERY _IOWR(IOC_OSC_TYPE, 22, struct obd_device *)
  17 #define IOC_OSC_MAX_NR       50
  18
  19 #define IOC_MDC_TYPE         'i'
  20 #define IOC_MDC_MIN_NR       20
  21 #define IOC_MDC_LOOKUP       _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
  22 /* Moved to lustre_user.h
  23 #define IOC_MDC_GETSTRIPE    _IOWR(IOC_MDC_TYPE, 21, struct lov_mds_md *) */
  24 #define IOC_MDC_MAX_NR       50
  25
  26 #ifdef __KERNEL__
  27 # include <linux/fs.h>
  28 # include <linux/list.h>
  29 # include <linux/sched.h> /* for struct task_struct, for current.h */
  30 # include <asm/current.h> /* for smp_lock.h */
  31 # include <linux/smp_lock.h>
  32 # include <linux/proc_fs.h>
  33 # include <linux/mount.h>
  34 #endif
  35
  36 #define OBD_MDS_DEVICENAME         "mds"
  37 #define OBD_MDT_DEVICENAME         "mdt"
  38 #define OBD_MDC_DEVICENAME         "mdc"
  39 #define OBD_LMV_DEVICENAME         "lmv"
  40 #define OBD_LOV_DEVICENAME         "lov"
  41 #define OBD_OST_DEVICENAME         "ost"
  42 #define OBD_OSC_DEVICENAME         "osc"
  43
  44 #define OBD_LDLM_DEVICENAME        "ldlm"
  45 #define OBD_CACHE_DEVICENAME       "cobd"
  46 #define OBD_CMOBD_DEVICENAME       "cmobd"
  47 #define OBD_CONF_DEVICENAME        "confobd"
  48
  49 #define OBD_SANOSC_DEVICENAME      "sanosc"
  50 #define OBD_SANOST_DEVICENAME      "sanost"
  51
  52 #define OBD_ECHO_DEVICENAME        "obdecho"
  53 #define OBD_ECHO_CLIENT_DEVICENAME "echo_client"
  54
  55 #define OBD_FILTER_DEVICENAME      "obdfilter"
  56 #define OBD_FILTER_SAN_DEVICENAME  "sanobdfilter"
  57
  58 #define OBD_MGMTCLI_DEVICENAME     "mgmt_cli"
  59 #define OBD_PTLBD_SV_DEVICENAME    "ptlbd_server"
  60 #define OBD_PTLBD_CL_DEVICENAME    "ptlbd_client"
  61
  62 #include <linux/lvfs.h>
  63 #include <linux/lustre_lib.h>
  64 #include <linux/lustre_idl.h>
  65 #include <linux/lustre_export.h>
  66 #include <linux/lustre_sec.h>
  67
  68 /* this is really local to the OSC */
  69 struct loi_oap_pages {
  70         struct list_head        lop_pending;
  71         int                     lop_num_pending;
  72         struct list_head        lop_urgent;
  73         struct list_head        lop_pending_group;
  74 };
  75
  76 struct lov_oinfo {                 /* per-stripe data structure */
  77         __u64 loi_id;              /* object ID on the target OST */
  78         __u64 loi_gr;              /* object group on the target OST */
  79         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
  80         int loi_ost_gen;           /* generation of this loi_ost_idx */
  81
  82         /* used by the osc to keep track of what objects to build into rpcs */
  83         struct loi_oap_pages loi_read_lop;
  84         struct loi_oap_pages loi_write_lop;
  85         /* _cli_ is poorly named, it should be _ready_ */
  86         struct list_head loi_cli_item;
  87         struct list_head loi_write_item;
  88         struct list_head loi_read_item;
  89
  90         unsigned loi_kms_valid:1;
  91         __u64 loi_kms;             /* known minimum size */
  92         __u64 loi_rss;             /* recently seen size */
  93         __u64 loi_mtime;           /* recently seen mtime */
  94         __u64 loi_blocks;          /* recently seen blocks */
  95 };
  96
  97 static inline void loi_init(struct lov_oinfo *loi)
  98 {
  99         INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending);
 100         INIT_LIST_HEAD(&loi->loi_read_lop.lop_urgent);
 101         INIT_LIST_HEAD(&loi->loi_read_lop.lop_pending_group);
 102         INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending);
 103         INIT_LIST_HEAD(&loi->loi_write_lop.lop_urgent);
 104         INIT_LIST_HEAD(&loi->loi_write_lop.lop_pending_group);
 105         INIT_LIST_HEAD(&loi->loi_cli_item);
 106         INIT_LIST_HEAD(&loi->loi_write_item);
 107         INIT_LIST_HEAD(&loi->loi_read_item);
 108 }
 109
 110 struct lov_stripe_md {
 111         /* Public members. */
 112         __u64 lsm_object_id;        /* lov object id */
 113         __u64 lsm_object_gr;        /* lov object id */
 114         __u64 lsm_maxbytes;         /* maximum possible file size */
 115         unsigned long lsm_xfersize; /* optimal transfer size */
 116
 117         /* LOV-private members start here -- only for use in lov/. */
 118         __u32 lsm_magic;
 119         __u32 lsm_stripe_size;      /* size of the stripe */
 120         __u32 lsm_pattern;          /* striping pattern (RAID0, RAID1) */
 121         unsigned lsm_stripe_count;  /* number of objects being striped over */
 122         struct lov_oinfo lsm_oinfo[0];
 123 };
 124
 125 static inline void dump_lsm(int level, struct lov_stripe_md *lsm)
 126 {
 127         int i;
 128         CDEBUG(level, "objid "LPX64"/"LPU64", maxbytes "LPX64", magic 0x%08X, "
 129                "stripe_size %u, stripe_count %u\n",
 130                lsm->lsm_object_id, lsm->lsm_object_gr, lsm->lsm_maxbytes,
 131                lsm->lsm_magic, lsm->lsm_stripe_size, lsm->lsm_stripe_count);
 132         for (i = 0; i < lsm->lsm_stripe_count; i++)
 133                 CDEBUG(level, "idx %u ostidx %u/%u object "LPU64"/"LPU64"\n",
 134                        i, lsm->lsm_oinfo[i].loi_ost_idx,
 135                        lsm->lsm_oinfo[i].loi_ost_gen,
 136                        lsm->lsm_oinfo[i].loi_id, lsm->lsm_oinfo[i].loi_gr);
 137 }
 138
 139 struct obd_type {
 140         struct list_head typ_chain;
 141         struct obd_ops *typ_ops;
 142         struct md_ops *typ_md_ops;
 143         struct proc_dir_entry *typ_procroot;
 144         char *typ_name;
 145         int  typ_refcnt;
 146 };
 147
 148 struct brw_page {
 149         obd_off disk_offset; /* modulo PAGE_SIZE */
 150         obd_off page_offset; /* modulo PAGE_SIZE (obviously) */
 151         struct page *pg;
 152         int count;
 153         obd_flags flag;
 154 };
 155
 156 enum async_flags {
 157         ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
 158                               page is added to an rpc */
 159         ASYNC_URGENT = 0x2,
 160         ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
 161                                      to give the caller a chance to update
 162                                      or cancel the size of the io */
 163         ASYNC_GROUP_SYNC = 0x8,  /* ap_completion will not be called, instead
 164                                     the page is accounted for in the
 165                                     obd_io_group given to
 166                                     obd_queue_group_io */
 167 };
 168
 169 struct obd_async_page_ops {
 170         int  (*ap_make_ready)(void *data, int cmd);
 171         int  (*ap_refresh_count)(void *data, int cmd);
 172         void (*ap_fill_obdo)(void *data, int cmd, struct obdo *oa);
 173         void (*ap_completion)(void *data, int cmd, struct obdo *oa, int rc);
 174 };
 175
 176 /* the `oig' is passed down from a caller of obd rw methods.  the callee
 177  * records enough state such that the caller can sleep on the oig and
 178  * be woken when all the callees have finished their work */
 179 struct obd_io_group {
 180         spinlock_t      oig_lock;
 181         atomic_t        oig_refcount;
 182         int             oig_pending;
 183         int             oig_rc;
 184         struct list_head oig_occ_list;
 185         wait_queue_head_t oig_waitq;
 186 };
 187
 188 /* the oig callback context lets the callee of obd rw methods register
 189  * for callbacks from the caller. */
 190 struct oig_callback_context {
 191         struct list_head occ_oig_item;
 192         /* called when the caller has received a signal while sleeping.
 193          * callees of this method are encouraged to abort their state
 194          * in the oig.  This may be called multiple times. */
 195         void (*occ_interrupted)(struct oig_callback_context *occ);
 196         int interrupted;
 197 };
 198
 199 /* if we find more consumers this could be generalized */
 200 #define OBD_HIST_MAX 32
 201 struct obd_histogram {
 202         spinlock_t      oh_lock;
 203         unsigned long   oh_buckets[OBD_HIST_MAX];
 204 };
 205
 206 /* reports average service time with the help of lprocfs_status.c */
 207 struct obd_service_time {
 208         __u32           st_num;
 209         __u64           st_total_us;
 210 };
 211
 212 struct ost_server_data;
 213
 214 #define FILTER_SUBDIR_COUNT      32            /* set to zero for no subdirs */
 215
 216 #define FILTER_GROUP_LLOG 1
 217 #define FILTER_GROUP_ECHO 2
 218 #define FILTER_GROUP_FIRST_MDS 3
 219
 220 struct filter_subdirs {
 221         struct dentry *dentry[FILTER_SUBDIR_COUNT];
 222 };
 223
 224 struct filter_group_llog {
 225         struct list_head list;
 226         int group;
 227         struct obd_llogs *llogs;
 228         struct obd_export *exp;
 229 };
 230
 231 struct filter_obd {
 232         const char          *fo_fstype;
 233         struct super_block  *fo_sb;
 234         struct vfsmount     *fo_vfsmnt;
 235         struct lvfs_obd_ctxt *fo_lvfs_ctxt;
 236
 237         int                    fo_group_count;
 238         struct dentry         *fo_dentry_O;     /* the "O"bject directory dentry */
 239         struct dentry         **fo_groups;      /* dentries for each group dir */
 240         struct filter_subdirs *fo_subdirs;      /* subdir array per group */
 241         __u64                 *fo_last_objids;  /* per-group last created objid */
 242         struct file          **fo_last_objid_files;
 243         struct semaphore     fo_init_lock;      /* group initialization lock */
 244         int                  fo_committed_group;
 245
 246         spinlock_t           fo_objidlock;      /* protect fo_lastobjid increment */
 247         spinlock_t           fo_lastidlock;     /* protect last_id increment */
 248         spinlock_t           fo_translock;      /* protect fsd_last_rcvd increment */
 249         struct file         *fo_rcvd_filp;
 250         struct filter_server_data *fo_fsd;
 251         unsigned long       *fo_last_rcvd_slots;
 252         __u64                fo_mount_count;
 253
 254         unsigned long        fo_destroys_in_progress;
 255         struct semaphore     fo_create_locks[32];
 256
 257         struct file_operations *fo_fop;
 258         struct inode_operations *fo_iop;
 259         struct address_space_operations *fo_aops;
 260
 261         struct list_head     fo_export_list;
 262         int                  fo_subdir_count;
 263
 264         obd_size             fo_tot_dirty;      /* protected by obd_osfs_lock */
 265         obd_size             fo_tot_granted;    /* all values in bytes */
 266         obd_size             fo_tot_pending;
 267
 268         obd_size             fo_readcache_max_filesize;
 269
 270         struct obd_import   *fo_mdc_imp;
 271         struct obd_uuid      fo_mdc_uuid;
 272         struct lustre_handle fo_mdc_conn;
 273
 274         struct semaphore     fo_alloc_lock;
 275
 276         struct obd_histogram     fo_r_pages;
 277         struct obd_histogram     fo_w_pages;
 278         struct obd_histogram     fo_r_discont_pages;
 279         struct obd_histogram     fo_w_discont_pages;
 280         struct obd_histogram     fo_r_discont_blocks;
 281         struct obd_histogram     fo_w_discont_blocks;
 282
 283         struct list_head         fo_llog_list;
 284         spinlock_t               fo_llog_list_lock;
 285
 286         /* which secure flavor from remote is denied */
 287         spinlock_t               fo_denylist_lock;
 288         struct list_head         fo_denylist;
 289
 290         /* capability related */
 291         int                      fo_capa_stat;
 292         struct crypto_tfm       *fo_capa_hmac;
 293         spinlock_t               fo_capa_lock;
 294
 295         struct list_head         fo_capa_keys;
 296 };
 297
 298 struct mds_server_data;
 299
 300 #define OSC_MAX_RIF_DEFAULT       8
 301 #define OSC_MAX_RIF_MAX          64
 302 #define OSC_MAX_DIRTY_DEFAULT   (4*OSC_MAX_RIF_DEFAULT*PTLRPC_MAX_BRW_SIZE>>20)
 303 #define OSC_MAX_DIRTY_MB_MAX    512     /* totally arbitrary */
 304
 305
 306 struct mdc_rpc_lock;
 307 struct client_obd {
 308         struct obd_import       *cl_import;
 309         struct semaphore         cl_sem;
 310         int                      cl_conn_count;
 311         /* max_mds_easize is purely a performance thing so we don't have to
 312          * call obd_size_wiremd() all the time. */
 313         int                      cl_max_mds_easize;
 314         int                      cl_max_mds_cookiesize;
 315         kdev_t                   cl_sandev;
 316
 317         /* security flavors */
 318         __u32                    cl_sec_flavor;
 319         unsigned long            cl_sec_flags;
 320
 321         //struct llog_canceld_ctxt *cl_llcd; /* it's included by obd_llog_ctxt */
 322         void                    *cl_llcd_offset;
 323
 324         struct obd_device       *cl_mgmtcli_obd;
 325
 326         /* the grant values are protected by loi_list_lock below */
 327         long                     cl_dirty;         /* all _dirty_ in bytes */
 328         long                     cl_dirty_max;     /* allowed w/o rpc */
 329         long                     cl_avail_grant;   /* bytes of credit for ost */
 330         long                     cl_lost_grant;    /* lost credits (trunc) */
 331         struct list_head         cl_cache_waiters; /* waiting for cache/grant */
 332
 333         /* keep track of objects that have lois that contain pages which
 334          * have been queued for async brw.  this lock also protects the
 335          * lists of osc_client_pages that hang off of the loi */
 336         spinlock_t               cl_loi_list_lock;
 337         struct list_head         cl_loi_ready_list;
 338         struct list_head         cl_loi_write_list;
 339         struct list_head         cl_loi_read_list;
 340         int                      cl_r_in_flight;
 341         int                      cl_w_in_flight;
 342         /* just a sum of the loi/lop pending numbers to be exported by /proc */
 343         int                      cl_pending_w_pages;
 344         int                      cl_pending_r_pages;
 345         int                      cl_max_pages_per_rpc;
 346         int                      cl_max_rpcs_in_flight;
 347         struct obd_histogram     cl_read_rpc_hist;
 348         struct obd_histogram     cl_write_rpc_hist;
 349         struct obd_histogram     cl_read_page_hist;
 350         struct obd_histogram     cl_write_page_hist;
 351         struct obd_service_time  cl_read_stime;
 352         struct obd_service_time  cl_write_stime;
 353         struct obd_service_time  cl_enter_stime;
 354
 355         struct mdc_rpc_lock     *cl_rpc_lock;
 356         struct mdc_rpc_lock     *cl_setattr_lock;
 357         struct mdc_rpc_lock     *cl_close_lock;
 358         struct osc_creator       cl_oscc;
 359         int                      cl_async:1;
 360 };
 361
 362 /* Like a client, with some hangers-on.  Keep mc_client_obd first so that we
 363  * can reuse the various client setup/connect functions. */
 364 struct mgmtcli_obd {
 365         struct client_obd        mc_client_obd; /* nested */
 366         struct ptlrpc_thread    *mc_ping_thread;
 367         struct obd_export       *mc_ping_exp; /* XXX single-target */
 368         struct list_head         mc_registered;
 369         void                    *mc_hammer;
 370 };
 371
 372 #define mc_import mc_client_obd.cl_import
 373
 374 struct mds_obd {
 375         struct ptlrpc_service           *mds_service;
 376         struct ptlrpc_service           *mds_setattr_service;
 377         struct ptlrpc_service           *mds_readpage_service;
 378         struct ptlrpc_service           *mds_close_service;
 379         struct super_block              *mds_sb;
 380         struct vfsmount                 *mds_vfsmnt;
 381         struct dentry                   *mds_id_de;
 382         struct lvfs_obd_ctxt            *mds_lvfs_ctxt;
 383         int                              mds_max_mdsize;
 384         int                              mds_max_cookiesize;
 385         struct file                     *mds_rcvd_filp;
 386         struct file                     *mds_fid_filp;
 387         struct file                     *mds_virtid_filp;
 388         spinlock_t                       mds_transno_lock;
 389         __u64                            mds_last_transno;
 390         __u64                            mds_mount_count;
 391         __u64                            mds_io_epoch;
 392
 393         __u64                            mds_last_fid;
 394         __u64                            mds_virtid_fid;
 395         spinlock_t                       mds_last_fid_lock;
 396
 397         struct semaphore                 mds_epoch_sem;
 398         struct lustre_id                 mds_rootid;
 399         struct mds_server_data          *mds_server_data;
 400         struct dentry                   *mds_pending_dir;
 401         struct dentry                   *mds_logs_dir;
 402         struct dentry                   *mds_objects_dir;
 403         struct llog_handle              *mds_cfg_llh;
 404         char                            *mds_profile;
 405         struct obd_device               *mds_dt_obd;
 406         struct obd_uuid                  mds_dt_uuid;
 407         struct obd_export               *mds_dt_exp;
 408         int                              mds_has_dt_desc;
 409         struct lov_desc                  mds_dt_desc;
 410
 411         spinlock_t                       mds_dt_lock;
 412         obd_id                          *mds_dt_objids;
 413         struct file                     *mds_dt_objid_filp;
 414         int                              mds_dt_objids_valid;
 415
 416         unsigned long                   *mds_client_bitmap;
 417         struct semaphore                 mds_orphan_recovery_sem;
 418
 419         int                              mds_num;
 420         int                              mds_config_version;
 421
 422         char                            *mds_md_name;
 423         struct obd_device               *mds_md_obd;
 424         struct obd_export               *mds_md_exp;
 425         struct semaphore                 mds_md_sem;
 426         struct obd_uuid                  mds_md_uuid;
 427         int                              mds_md_connected;
 428
 429         struct ptlrpc_service           *mds_create_service;
 430         uid_t                            mds_squash_uid;
 431         gid_t                            mds_squash_gid;
 432         ptl_nid_t                        mds_nosquash_nid;
 433         atomic_t                         mds_real_clients;
 434         atomic_t                         mds_open_count;
 435         struct dentry                   *mds_id_dir;
 436         int                              mds_obd_type;
 437         struct dentry                   *mds_unnamed_dir; /* for mdt_obd_create only */
 438
 439         /* security related */
 440         char                            *mds_mds_sec;
 441         char                            *mds_ost_sec;
 442
 443         /* which secure flavor from remote to this mds is denied */
 444         spinlock_t                      mds_denylist_lock;
 445         struct list_head                mds_denylist;
 446
 447         /* fid->ino mapping related fields */
 448         spinlock_t                      mds_fidmap_lock;
 449         struct hlist_head              *mds_fidmap_table;
 450         unsigned long                   mds_fidmap_size;
 451
 452         /* cache fid extents stuff */
 453         spinlock_t                      mds_fidext_lock;
 454         __u64                           mds_fidext_thumb;
 455         int                             mds_crypto_type;
 456
 457         /* capability related */
 458         int                              mds_capa_stat;     /* 1: on, 0: off */
 459         struct crypto_tfm               *mds_capa_hmac;
 460         unsigned long                    mds_capa_timeout;  /* sec */
 461
 462         struct mds_capa_key              mds_capa_keys[2];  /* red & black key */
 463         int                              mds_capa_key_idx;  /* the red key index */
 464         struct file                     *mds_capa_keys_filp;
 465         unsigned long                    mds_capa_key_timeout; /* sec */
 466 };
 467
 468 struct echo_obd {
 469         struct obdo          eo_oa;
 470         spinlock_t           eo_lock;
 471         __u64                eo_lastino;
 472         struct lustre_handle eo_nl_lock;
 473         atomic_t             eo_prep;
 474 };
 475
 476 /*
 477  * this struct does double-duty acting as either a client or
 478  * server instance .. maybe not wise.
 479  */
 480 struct ptlbd_obd {
 481         /* server's */
 482         struct ptlrpc_service *ptlbd_service;
 483         struct file *filp;
 484         /* client's */
 485         struct ptlrpc_client    bd_client;
 486         struct obd_import       *bd_import;
 487         struct obd_uuid         bd_server_uuid;
 488         struct obd_export       *bd_exp;
 489         int refcount; /* XXX sigh */
 490 };
 491
 492 struct recovd_obd {
 493         spinlock_t            recovd_lock;
 494         struct list_head      recovd_managed_items; /* items managed  */
 495         struct list_head      recovd_troubled_items; /* items in recovery */
 496
 497         wait_queue_head_t     recovd_recovery_waitq;
 498         wait_queue_head_t     recovd_ctl_waitq;
 499         wait_queue_head_t     recovd_waitq;
 500         struct task_struct   *recovd_thread;
 501         __u32                 recovd_state;
 502 };
 503
 504 struct ost_obd {
 505         spinlock_t             ost_lock;
 506         struct ptlrpc_service *ost_service;
 507         struct ptlrpc_service *ost_create_service;
 508         struct ptlrpc_service *ost_destroy_service;
 509         struct obd_service_time ost_stimes[6];
 510 };
 511
 512 struct echo_client_obd {
 513         struct obd_export      *ec_exp;     /* the local connection to osc/lov */
 514         spinlock_t              ec_lock;
 515         struct list_head        ec_objects;
 516         int                     ec_nstripes;
 517         __u64                   ec_unique;
 518 };
 519
 520 struct cache_obd {
 521         struct obd_export      *master_exp; /* local connection to master obd */
 522         struct obd_export      *cache_exp;  /* local connection to cache obd */
 523         struct obd_export      *cache_real_exp;
 524         struct obd_export      *master_real_exp;
 525         struct obd_device      *master;
 526         struct obd_device      *cache;
 527         char                   *master_name;
 528         char                   *cache_name;
 529         int                     refcount;
 530         int                     cache_on;
 531         struct semaphore        sem;
 532         struct lov_desc         dt_desc; /* data lovdesc */
 533 };
 534
 535 struct cm_obd {
 536         struct obd_export      *cache_exp;  /* local connection to cache obd */
 537         struct obd_export      *master_exp;
 538         struct obd_device      *cache_obd;
 539         struct obd_device      *master_obd;
 540         int                     master_group;
 541         struct cmobd_write_service *write_srv;
 542         struct lov_desc         master_desc; /* master device lovdesc */
 543 };
 544
 545 struct conf_obd {
 546         struct super_block      *cfobd_sb;
 547         struct vfsmount         *cfobd_vfsmnt;
 548         struct dentry           *cfobd_logs_dir;
 549         struct dentry           *cfobd_objects_dir;
 550         struct dentry           *cfobd_pending_dir;
 551         struct llog_handle      *cfobd_cfg_llh;
 552         struct lvfs_obd_ctxt    *cfobd_lvfs_ctxt;
 553 };
 554
 555 struct lov_tgt_desc {
 556         struct obd_uuid         uuid;
 557         __u32                   ltd_gen;
 558         struct obd_export      *ltd_exp;
 559         int                     active;   /* is this target up for requests */
 560 };
 561
 562 struct lov_obd {
 563         spinlock_t              lov_lock;
 564         struct lov_desc         desc;
 565         int                     bufsize;
 566         int                     refcount;
 567         int                     lo_catalog_loaded:1, async:1;
 568         struct semaphore        lov_llog_sem;
 569         unsigned long           lov_connect_flags;
 570         struct lov_tgt_desc    *tgts;
 571 };
 572
 573 struct lmv_tgt_desc {
 574         struct obd_uuid         uuid;
 575         struct obd_export      *ltd_exp;
 576         int                     active;   /* is this target up for requests */
 577 };
 578
 579 struct lmv_obd {
 580         int                     refcount;
 581         spinlock_t              lmv_lock;
 582         struct lmv_desc         desc;
 583         struct lmv_tgt_desc     *tgts;
 584         struct obd_uuid         cluuid;
 585         struct obd_export       *exp;
 586
 587         int                     tgts_size;
 588         int                     connected;
 589         int                     max_easize;
 590         int                     max_cookiesize;
 591         int                     server_timeout;
 592         int                     connect_flags;
 593         struct semaphore        init_sem;
 594         struct obd_connect_data conn_data;
 595 };
 596 struct gks_crypto_key {
 597         char *key;
 598         int   len;
 599 };
 600 struct gks_obd {
 601         struct ptlrpc_service    *gks_service;
 602         struct crypto_tfm        *gks_mac_tfm;
 603         struct crypto_tfm        *gks_key_tfm;
 604         struct gks_crypto_key    gks_key;
 605 };
 606
 607 struct niobuf_local {
 608         __u64 offset;
 609         __u32 len;
 610         __u32 flags;
 611         struct page *page;
 612         struct dentry *dentry;
 613         int lnb_grant_used;
 614         int rc;
 615 };
 616
 617 #define OBD_MODE_ASYNC (1 << 0)
 618 #define OBD_MODE_CROW  (1 << 1)
 619
 620 /* Don't conflict with on-wire flags OBD_BRW_WRITE, etc */
 621 #define N_LOCAL_TEMP_PAGE 0x10000000
 622
 623 struct obd_trans_info {
 624         __u64                    oti_transno;
 625         __u64                   *oti_objid;
 626
 627         /* only used on the server side for tracking acks. */
 628         struct oti_req_ack_lock {
 629                 struct lustre_handle lock;
 630                 __u32                mode;
 631         }                        oti_ack_locks[4];
 632         void                    *oti_handle;
 633         struct llog_cookie       oti_onecookie;
 634         struct llog_cookie      *oti_logcookies;
 635         int                      oti_numcookies;
 636         int                      oti_flags;
 637 };
 638
 639 static inline void oti_alloc_cookies(struct obd_trans_info *oti,int num_cookies)
 640 {
 641         if (!oti)
 642                 return;
 643
 644         if (num_cookies == 1)
 645                 oti->oti_logcookies = &oti->oti_onecookie;
 646         else
 647                 OBD_ALLOC(oti->oti_logcookies,
 648                           num_cookies * sizeof(oti->oti_onecookie));
 649
 650         oti->oti_numcookies = num_cookies;
 651 }
 652
 653 static inline void oti_free_cookies(struct obd_trans_info *oti)
 654 {
 655         if (!oti || !oti->oti_logcookies)
 656                 return;
 657
 658         if (oti->oti_logcookies == &oti->oti_onecookie)
 659                 LASSERT(oti->oti_numcookies == 1);
 660         else
 661                 OBD_FREE(oti->oti_logcookies,
 662                          oti->oti_numcookies * sizeof(oti->oti_onecookie));
 663         oti->oti_logcookies = NULL;
 664         oti->oti_numcookies = 0;
 665 }
 666
 667 /* llog contexts */
 668 enum llog_ctxt_id {
 669         LLOG_CONFIG_ORIG_CTXT =  0,
 670         LLOG_CONFIG_REPL_CTXT =  1,
 671         LLOG_UNLINK_ORIG_CTXT =  2,
 672         LLOG_UNLINK_REPL_CTXT =  3,
 673         LLOG_SIZE_ORIG_CTXT   =  4,
 674         LLOG_SIZE_REPL_CTXT   =  5,
 675         LLOG_MD_ORIG_CTXT     =  6,
 676         LLOG_MD_REPL_CTXT     =  7,
 677         LLOG_RD1_ORIG_CTXT    =  8,
 678         LLOG_RD1_REPL_CTXT    =  9,
 679         LLOG_TEST_ORIG_CTXT   = 10,
 680         LLOG_TEST_REPL_CTXT   = 11,
 681         LLOG_REINT_ORIG_CTXT  = 12,
 682         LLOG_AUDIT_ORIG_CTXT  = 13,
 683         LLOG_MAX_CTXTS
 684 };
 685
 686 struct obd_llogs {
 687         struct llog_ctxt        *llog_ctxt[LLOG_MAX_CTXTS];
 688 };
 689
 690 struct target_recovery_data {
 691         svc_handler_t     trd_recovery_handler;
 692         pid_t             trd_processing_task;
 693         struct completion trd_starting;
 694         struct completion trd_finishing;
 695 };
 696
 697 /* corresponds to one of the obd's */
 698 struct obd_device {
 699         struct obd_type *obd_type;
 700
 701         /* common and UUID name of this device */
 702         char *obd_name;
 703         struct obd_uuid obd_uuid;
 704
 705         int obd_minor;
 706         unsigned int obd_attached:1, obd_set_up:1, obd_recovering:1,
 707                 obd_abort_recovery:1, obd_replayable:1, obd_no_transno:1,
 708                 obd_no_recov:1, obd_stopping:1;
 709         atomic_t obd_refcount;
 710         wait_queue_head_t obd_refcount_waitq;
 711         struct proc_dir_entry *obd_proc_entry;
 712         struct list_head       obd_exports;
 713         int                    obd_num_exports;
 714         struct ldlm_namespace *obd_namespace;
 715         struct ptlrpc_client   obd_ldlm_client; /* XXX OST/MDS only */
 716         /* a spinlock is OK for what we do now, may need a semaphore later */
 717         spinlock_t             obd_dev_lock;
 718         __u64                  obd_last_committed;
 719         struct fsfilt_operations *obd_fsops;
 720         spinlock_t              obd_osfs_lock;
 721         struct obd_statfs       obd_osfs;
 722         unsigned long           obd_osfs_age;
 723         struct lvfs_run_ctxt    obd_lvfs_ctxt;
 724         struct obd_llogs        obd_llogs;
 725         struct llog_ctxt        *obd_llog_ctxt[LLOG_MAX_CTXTS];
 726         struct obd_device       *obd_observer;
 727         struct obd_export       *obd_self_export;
 728
 729         struct target_recovery_data      obd_recovery_data;
 730         /* XXX encapsulate all this recovery data into target_recovery_data */
 731         int                              obd_max_recoverable_clients;
 732         int                              obd_connected_clients;
 733         int                              obd_recoverable_clients;
 734         spinlock_t                       obd_processing_task_lock;
 735         __u64                            obd_next_recovery_transno;
 736         int                              obd_replayed_requests;
 737         int                              obd_replayed_locks;
 738         int                              obd_requests_queued_for_recovery;
 739         wait_queue_head_t                obd_next_transno_waitq;
 740         struct list_head                 obd_uncommitted_replies;
 741         spinlock_t                       obd_uncommitted_replies_lock;
 742         struct timer_list                obd_recovery_timer;
 743         time_t                           obd_recovery_start;
 744         time_t                           obd_recovery_end;
 745
 746         atomic_t                         obd_req_replay_clients;
 747         atomic_t                         obd_lock_replay_clients;
 748
 749         struct list_head                 obd_req_replay_queue;
 750         struct list_head                 obd_lock_replay_queue;
 751         struct list_head                 obd_final_req_queue;
 752         int                              obd_recovery_stage;
 753
 754         union {
 755                 struct filter_obd        filter;
 756                 struct mds_obd           mds;
 757                 struct client_obd        cli;
 758                 struct ost_obd           ost;
 759                 struct echo_client_obd   echocli;
 760                 struct echo_obd          echo;
 761                 struct recovd_obd        recovd;
 762                 struct lov_obd           lov;
 763                 struct cache_obd         cobd;
 764                 struct ptlbd_obd         ptlbd;
 765                 struct mgmtcli_obd       mgmtcli;
 766                 struct lmv_obd           lmv;
 767                 struct cm_obd            cm;
 768                 struct conf_obd          conf;
 769                 struct gks_obd           gks;
 770         } u;
 771
 772         /* fields used by LProcFS */
 773         unsigned int           obd_cntr_base;
 774         struct lprocfs_stats  *obd_stats;
 775         unsigned int           md_cntr_base;
 776         struct lprocfs_stats  *md_stats;
 777
 778         struct proc_dir_entry *obd_svc_procroot;
 779         struct lprocfs_stats  *obd_svc_stats;
 780 };
 781
 782 #define OBD_OPT_FORCE             (1 << 0)
 783 #define OBD_OPT_FAILOVER          (1 << 1)
 784 #define OBD_OPT_REAL_CLIENT       (1 << 2)
 785 #define OBD_OPT_MDS_CONNECTION    (1 << 3)
 786
 787 #define OBD_LLOG_FL_SENDNOW       (1 << 0)
 788 #define OBD_LLOG_FL_CREATE        (1 << 1)
 789
 790 struct mdc_op_data;
 791
 792 struct obd_ops {
 793         struct module *o_owner;
 794         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
 795                            void *karg, void *uarg);
 796         int (*o_get_info)(struct obd_export *, __u32 keylen, void *key,
 797                           __u32 *vallen, void *val);
 798         int (*o_set_info)(struct obd_export *, __u32 keylen, void *key,
 799                           __u32 vallen, void *val);
 800         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
 801         int (*o_detach)(struct obd_device *dev);
 802         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
 803         int (*o_precleanup)(struct obd_device *dev, int flags);
 804         int (*o_cleanup)(struct obd_device *dev, int flags);
 805         int (*o_process_config)(struct obd_device *dev, obd_count len,
 806                                 void *data);
 807         int (*o_postrecov)(struct obd_device *dev);
 808         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
 809                           int priority);
 810         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
 811         int (*o_connect)(struct lustre_handle *conn, struct obd_device *src,
 812                          struct obd_uuid *cluuid, struct obd_connect_data *data,
 813                          unsigned long flags);
 814         int (*o_connect_post)(struct obd_export *exp, unsigned, unsigned long);
 815         int (*o_disconnect)(struct obd_export *exp, unsigned long flags);
 816
 817         int (*o_statfs)(struct obd_device *obd, struct obd_statfs *osfs,
 818                         unsigned long max_age);
 819         int (*o_packmd)(struct obd_export *exp, struct lov_mds_md **disk_tgt,
 820                         struct lov_stripe_md *mem_src);
 821         int (*o_unpackmd)(struct obd_export *exp,struct lov_stripe_md **mem_tgt,
 822                           struct lov_mds_md *disk_src, int disk_len);
 823         int (*o_revalidate_md)(struct obd_export *exp,  struct obdo *oa,
 824                                struct lov_stripe_md *ea,
 825                                struct obd_trans_info *oti);
 826         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
 827                              obd_id *ids);
 828         int (*o_create)(struct obd_export *exp,  struct obdo *oa,
 829                         void *acl, int acl_size,
 830                         struct lov_stripe_md **ea, struct obd_trans_info *oti);
 831         int (*o_destroy)(struct obd_export *exp, struct obdo *oa,
 832                          struct lov_stripe_md *ea, struct obd_trans_info *oti);
 833         int (*o_setattr)(struct obd_export *exp, struct obdo *oa,
 834                          struct lov_stripe_md *ea, struct obd_trans_info *oti);
 835         int (*o_getattr)(struct obd_export *exp, struct obdo *oa,
 836                          struct lov_stripe_md *ea);
 837         int (*o_getattr_async)(struct obd_export *exp, struct obdo *oa,
 838                                struct lov_stripe_md *ea,
 839                                struct ptlrpc_request_set *set);
 840         int (*o_brw)(int rw, struct obd_export *exp, struct obdo *oa,
 841                      struct lov_stripe_md *ea, obd_count oa_bufs,
 842                      struct brw_page *pgarr, struct obd_trans_info *oti);
 843         int (*o_brw_async)(int rw, struct obd_export *exp, struct obdo *oa,
 844                            struct lov_stripe_md *ea, obd_count oa_bufs,
 845                            struct brw_page *pgarr, struct ptlrpc_request_set *,
 846                            struct obd_trans_info *oti);
 847         int (*o_prep_async_page)(struct obd_export *exp,
 848                                  struct lov_stripe_md *lsm,
 849                                  struct lov_oinfo *loi,
 850                                  struct page *page, obd_off offset,
 851                                  struct obd_async_page_ops *ops, void *data,
 852                                  void **res);
 853         int (*o_queue_async_io)(struct obd_export *exp,
 854                                 struct lov_stripe_md *lsm,
 855                                 struct lov_oinfo *loi, void *cookie,
 856                                 int cmd, obd_off off, int count,
 857                                 obd_flags brw_flags, obd_flags async_flags);
 858         int (*o_queue_group_io)(struct obd_export *exp,
 859                                 struct lov_stripe_md *lsm,
 860                                 struct lov_oinfo *loi,
 861                                 struct obd_io_group *oig,
 862                                 void *cookie, int cmd, obd_off off, int count,
 863                                 obd_flags brw_flags, obd_flags async_flags);
 864         int (*o_trigger_group_io)(struct obd_export *exp,
 865                                   struct lov_stripe_md *lsm,
 866                                   struct lov_oinfo *loi,
 867                                   struct obd_io_group *oig);
 868         int (*o_set_async_flags)(struct obd_export *exp,
 869                                 struct lov_stripe_md *lsm,
 870                                 struct lov_oinfo *loi, void *cookie,
 871                                 obd_flags async_flags);
 872         int (*o_teardown_async_page)(struct obd_export *exp,
 873                                      struct lov_stripe_md *lsm,
 874                                      struct lov_oinfo *loi, void *cookie);
 875         int (*o_adjust_kms)(struct obd_export *exp, struct lov_stripe_md *lsm,
 876                             obd_off size, int shrink);
 877         int (*o_punch)(struct obd_export *exp, struct obdo *oa,
 878                        struct lov_stripe_md *ea, obd_size start,
 879                        obd_size end, struct obd_trans_info *oti,
 880                        struct lustre_capa *capa);
 881         int (*o_sync)(struct obd_export *exp, struct obdo *oa,
 882                       struct lov_stripe_md *ea, obd_size start, obd_size end);
 883         int (*o_migrate)(struct lustre_handle *conn, struct lov_stripe_md *dst,
 884                          struct lov_stripe_md *src, obd_size start,
 885                          obd_size end, struct obd_trans_info *oti);
 886         int (*o_copy)(struct lustre_handle *dstconn, struct lov_stripe_md *dst,
 887                       struct lustre_handle *srconn, struct lov_stripe_md *src,
 888                       obd_size start, obd_size end, struct obd_trans_info *);
 889         int (*o_iterate)(struct lustre_handle *conn,
 890                          int (*)(obd_id, obd_gr, void *),
 891                          obd_id *startid, obd_gr group, void *data);
 892         int (*o_preprw)(int cmd, struct obd_export *exp, struct obdo *oa,
 893                         int objcount, struct obd_ioobj *obj,
 894                         int niocount, struct niobuf_remote *remote,
 895                         struct niobuf_local *local, struct obd_trans_info *oti,
 896                         struct lustre_capa *capa);
 897         int (*o_commitrw)(int cmd, struct obd_export *exp, struct obdo *oa,
 898                           int objcount, struct obd_ioobj *obj,
 899                           int niocount, struct niobuf_local *local,
 900                           struct obd_trans_info *oti, int rc);
 901         int (*o_do_cow)(struct obd_export *exp, struct obd_ioobj *obj,
 902                         int objcount, struct niobuf_remote *rnb);
 903         int (*o_write_extents)(struct obd_export *exp, struct obd_ioobj *obj,
 904                                int objcount, int niocount,
 905                                struct niobuf_local *local,int rc);
 906         int (*o_enqueue)(struct obd_export *, struct lov_stripe_md *,
 907                          __u32 type, ldlm_policy_data_t *, __u32 mode,
 908                          int *flags, void *bl_cb, void *cp_cb, void *gl_cb,
 909                          void *data, __u32 lvb_len, void *lvb_swabber,
 910                          struct lustre_handle *lockh);
 911         int (*o_match)(struct obd_export *, struct lov_stripe_md *, __u32 type,
 912                        ldlm_policy_data_t *, __u32 mode, int *flags, void *data,
 913                        struct lustre_handle *lockh);
 914         int (*o_change_cbdata)(struct obd_export *, struct lov_stripe_md *,
 915                                ldlm_iterator_t it, void *data);
 916         int (*o_cancel)(struct obd_export *, struct lov_stripe_md *md,
 917                         __u32 mode, struct lustre_handle *);
 918         int (*o_cancel_unused)(struct obd_export *, struct lov_stripe_md *,
 919                                int flags, void *opaque);
 920         int (*o_san_preprw)(int cmd, struct obd_export *exp,
 921                             struct obdo *oa, int objcount,
 922                             struct obd_ioobj *obj, int niocount,
 923                             struct niobuf_remote *remote);
 924         int (*o_init_export)(struct obd_export *exp);
 925         int (*o_destroy_export)(struct obd_export *exp);
 926
 927         /* llog related obd_methods */
 928         int (*o_llog_init)(struct obd_device *, struct obd_llogs *,
 929                            struct obd_device *, int, struct llog_catid *);
 930         int (*o_llog_finish)(struct obd_device *, struct obd_llogs *, int);
 931         int (*o_llog_connect)(struct obd_export *, struct llogd_conn_body *);
 932
 933
 934         /* metadata-only methods */
 935         int (*o_pin)(struct obd_export *, obd_id ino, __u32 gen, int type,
 936                      struct obd_client_handle *, int flag);
 937         int (*o_unpin)(struct obd_export *, struct obd_client_handle *, int);
 938
 939         int (*o_import_event)(struct obd_device *, struct obd_import *,
 940                               enum obd_import_event);
 941
 942         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
 943                         int active, void *data);
 944
 945         int (*o_init_ea_size)(struct obd_export *, int, int);
 946
 947         /*
 948          * NOTE: If adding ops, add another LPROCFS_OBD_OP_INIT() line
 949          * to lprocfs_alloc_obd_stats() in obdclass/lprocfs_status.c.
 950          * Also, add a wrapper function in include/linux/obd_class.h.
 951          */
 952 };
 953
 954 struct md_ops {
 955         int (*m_getstatus)(struct obd_export *, struct lustre_id *);
 956         int (*m_change_cbdata)(struct obd_export *, struct lustre_id *,
 957                                ldlm_iterator_t, void *);
 958         int (*m_change_cbdata_name)(struct obd_export *, struct lustre_id *,
 959                                     char *, int, struct lustre_id *,
 960                                     ldlm_iterator_t, void *);
 961         int (*m_close)(struct obd_export *, struct obdo *,
 962                        struct obd_client_handle *,
 963                        struct ptlrpc_request **);
 964         int (*m_create)(struct obd_export *, struct mdc_op_data *,
 965                         const void *, int, int, __u32, __u32,
 966                         __u64, struct ptlrpc_request **);
 967         int (*m_done_writing)(struct obd_export *, struct obdo *);
 968         int (*m_enqueue)(struct obd_export *, int, struct lookup_intent *,
 969                          int, struct mdc_op_data *, struct lustre_handle *,
 970                          void *, int, ldlm_completion_callback,
 971                          ldlm_blocking_callback, void *);
 972         int (*m_getattr)(struct obd_export *, struct lustre_id *,
 973                          __u64, const char *, const void *, unsigned int,
 974                          unsigned int, struct obd_capa *,
 975                          struct ptlrpc_request **);
 976         int (*m_access_check)(struct obd_export *, struct lustre_id *,
 977                               struct ptlrpc_request **);
 978         int (*m_getattr_lock)(struct obd_export *, struct lustre_id *,
 979                               char *, int, __u64,
 980                               unsigned int, struct ptlrpc_request **);
 981         int (*m_intent_lock)(struct obd_export *,
 982                              struct lustre_id *, const char *, int,
 983                              void *, int, struct lustre_id *,
 984                              struct lookup_intent *, int,
 985                              struct ptlrpc_request **,
 986                              ldlm_blocking_callback);
 987         int (*m_link)(struct obd_export *, struct mdc_op_data *,
 988                       struct ptlrpc_request **);
 989         int (*m_rename)(struct obd_export *, struct mdc_op_data *,
 990                         const char *, int, const char *, int,
 991                         struct ptlrpc_request **);
 992         int (*m_setattr)(struct obd_export *, struct mdc_op_data *,
 993                          struct iattr *, void *, int , void *, int,
 994                          void *, int, struct ptlrpc_request **);
 995         int (*m_sync)(struct obd_export *, struct lustre_id *,
 996                       struct ptlrpc_request **);
 997         int (*m_readpage)(struct obd_export *, struct lustre_id *,
 998                           __u64, struct page *, struct ptlrpc_request **);
 999         int (*m_unlink)(struct obd_export *, struct mdc_op_data *,
1000                         struct ptlrpc_request **);
1001         int (*m_valid_attrs)(struct obd_export *, struct lustre_id *);
1002
1003         struct obd_device *(*m_get_real_obd)(struct obd_export *, struct lustre_id *);
1004
1005         int (*m_req2lustre_md)(struct obd_export *exp,
1006                                struct ptlrpc_request *req, unsigned int offset,
1007                                struct obd_export *osc_exp, struct lustre_md *md);
1008         int (*m_set_open_replay_data)(struct obd_export *exp,
1009                                       struct obd_client_handle *och,
1010                                       struct ptlrpc_request *open_req);
1011         int (*m_clear_open_replay_data)(struct obd_export *exp,
1012                                         struct obd_client_handle *och);
1013         int (*m_store_inode_generation)(struct obd_export *exp,
1014                                         struct ptlrpc_request *req, int reqoff,
1015                                         int repoff);
1016         int (*m_set_lock_data)(struct obd_export *exp, __u64 *l, void *data);
1017
1018         int (*m_delete_inode)(struct obd_export *, struct lustre_id *);
1019
1020         /*
1021          * NOTE: If adding ops, add another LPROCFS_MD_OP_INIT() line to
1022          * lprocfs_alloc_md_stats() in obdclass/lprocfs_status.c. Also, add a
1023          * wrapper function in include/linux/obd_class.h.
1024          */
1025 };
1026
1027 static inline void obd_transno_commit_cb(struct obd_device *obd,
1028                                          __u64 transno, int error)
1029 {
1030         if (error) {
1031                 CERROR("%s: transno "LPD64" commit error: %d\n",
1032                        obd->obd_name, transno, error);
1033                 return;
1034         }
1035
1036         CDEBUG(D_HA, "%s: transno "LPD64" committed\n",
1037                obd->obd_name, transno);
1038
1039         if (transno > obd->obd_last_committed) {
1040                 obd->obd_last_committed = transno;
1041                 ptlrpc_commit_replies (obd);
1042         }
1043 }
1044
1045 static inline int obd_md_type(struct obd_device *obd)
1046 {
1047         if (!strcmp(obd->obd_type->typ_name, OBD_MDC_DEVICENAME) ||
1048             !strcmp(obd->obd_type->typ_name, OBD_LMV_DEVICENAME))
1049                 return 1;
1050
1051         return 0;
1052 }
1053
1054 static inline int obd_dt_type(struct obd_device *obd)
1055 {
1056         if (!strcmp(obd->obd_type->typ_name, OBD_LOV_DEVICENAME) ||
1057             !strcmp(obd->obd_type->typ_name, OBD_OSC_DEVICENAME))
1058                 return 1;
1059
1060         return 0;
1061 }
1062
1063 #endif /* __OBD_H */