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