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         /* debug stuff */
 362         struct timeval           cl_last_write_time;
 363         long                     cl_write_gap_sum;
 364         long                     cl_write_gaps;
 365 };
 366
 367 /* Like a client, with some hangers-on.  Keep mc_client_obd first so that we
 368  * can reuse the various client setup/connect functions. */
 369 struct mgmtcli_obd {
 370         struct client_obd        mc_client_obd; /* nested */
 371         struct ptlrpc_thread    *mc_ping_thread;
 372         struct obd_export       *mc_ping_exp; /* XXX single-target */
 373         struct list_head         mc_registered;
 374         void                    *mc_hammer;
 375 };
 376
 377 #define mc_import mc_client_obd.cl_import
 378
 379 struct mds_obd {
 380         struct ptlrpc_service           *mds_service;
 381         struct ptlrpc_service           *mds_setattr_service;
 382         struct ptlrpc_service           *mds_readpage_service;
 383         struct ptlrpc_service           *mds_close_service;
 384         struct super_block              *mds_sb;
 385         struct vfsmount                 *mds_vfsmnt;
 386         struct dentry                   *mds_id_de;
 387         struct lvfs_obd_ctxt            *mds_lvfs_ctxt;
 388         int                              mds_max_mdsize;
 389         int                              mds_max_cookiesize;
 390         struct file                     *mds_rcvd_filp;
 391         struct file                     *mds_fid_filp;
 392         struct file                     *mds_virtid_filp;
 393         spinlock_t                       mds_transno_lock;
 394         __u64                            mds_last_transno;
 395         __u64                            mds_mount_count;
 396         __u64                            mds_io_epoch;
 397
 398         __u64                            mds_last_fid;
 399         __u64                            mds_virtid_fid;
 400         spinlock_t                       mds_last_fid_lock;
 401
 402         struct semaphore                 mds_epoch_sem;
 403         struct lustre_id                 mds_rootid;
 404         struct mds_server_data          *mds_server_data;
 405         struct dentry                   *mds_pending_dir;
 406         struct dentry                   *mds_logs_dir;
 407         struct dentry                   *mds_objects_dir;
 408         struct llog_handle              *mds_cfg_llh;
 409         char                            *mds_profile;
 410         struct obd_device               *mds_dt_obd;
 411         struct obd_uuid                  mds_dt_uuid;
 412         struct obd_export               *mds_dt_exp;
 413         int                              mds_has_dt_desc;
 414         struct lov_desc                  mds_dt_desc;
 415
 416         spinlock_t                       mds_dt_lock;
 417         obd_id                          *mds_dt_objids;
 418         struct file                     *mds_dt_objid_filp;
 419         int                              mds_dt_objids_valid;
 420
 421         unsigned long                   *mds_client_bitmap;
 422         struct semaphore                 mds_orphan_recovery_sem;
 423
 424         int                              mds_num;
 425         int                              mds_config_version;
 426
 427         char                            *mds_md_name;
 428         struct obd_device               *mds_md_obd;
 429         struct obd_export               *mds_md_exp;
 430         struct semaphore                 mds_md_sem;
 431         struct obd_uuid                  mds_md_uuid;
 432         int                              mds_md_connected;
 433
 434         struct ptlrpc_service           *mds_create_service;
 435         uid_t                            mds_squash_uid;
 436         gid_t                            mds_squash_gid;
 437         ptl_nid_t                        mds_nosquash_nid;
 438         atomic_t                         mds_real_clients;
 439         atomic_t                         mds_open_count;
 440         struct dentry                   *mds_id_dir;
 441         int                              mds_obd_type;
 442         struct dentry                   *mds_unnamed_dir; /* for mdt_obd_create only */
 443
 444         /* security related */
 445         char                            *mds_mds_sec;
 446         char                            *mds_ost_sec;
 447
 448         /* which secure flavor from remote to this mds is denied */
 449         spinlock_t                      mds_denylist_lock;
 450         struct list_head                mds_denylist;
 451
 452         /* fid->ino mapping related fields */
 453         spinlock_t                      mds_fidmap_lock;
 454         struct hlist_head              *mds_fidmap_table;
 455         unsigned long                   mds_fidmap_size;
 456
 457         /* cache fid extents stuff */
 458         spinlock_t                      mds_fidext_lock;
 459         __u64                           mds_fidext_thumb;
 460         int                             mds_crypto_type;
 461
 462         /* capability related */
 463         int                              mds_capa_stat;     /* 1: on, 0: off */
 464         struct crypto_tfm               *mds_capa_hmac;
 465         unsigned long                    mds_capa_timeout;  /* sec */
 466
 467         struct mds_capa_key              mds_capa_keys[2];  /* red & black key */
 468         int                              mds_capa_key_idx;  /* the red key index */
 469         struct file                     *mds_capa_keys_filp;
 470         unsigned long                    mds_capa_key_timeout; /* sec */
 471 };
 472
 473 struct echo_obd {
 474         struct obdo          eo_oa;
 475         spinlock_t           eo_lock;
 476         __u64                eo_lastino;
 477         struct lustre_handle eo_nl_lock;
 478         atomic_t             eo_prep;
 479 };
 480
 481 /*
 482  * this struct does double-duty acting as either a client or
 483  * server instance .. maybe not wise.
 484  */
 485 struct ptlbd_obd {
 486         /* server's */
 487         struct ptlrpc_service *ptlbd_service;
 488         struct file *filp;
 489         /* client's */
 490         struct ptlrpc_client    bd_client;
 491         struct obd_import       *bd_import;
 492         struct obd_uuid         bd_server_uuid;
 493         struct obd_export       *bd_exp;
 494         int refcount; /* XXX sigh */
 495 };
 496
 497 struct recovd_obd {
 498         spinlock_t            recovd_lock;
 499         struct list_head      recovd_managed_items; /* items managed  */
 500         struct list_head      recovd_troubled_items; /* items in recovery */
 501
 502         wait_queue_head_t     recovd_recovery_waitq;
 503         wait_queue_head_t     recovd_ctl_waitq;
 504         wait_queue_head_t     recovd_waitq;
 505         struct task_struct   *recovd_thread;
 506         __u32                 recovd_state;
 507 };
 508
 509 struct ost_obd {
 510         spinlock_t             ost_lock;
 511         struct ptlrpc_service *ost_service;
 512         struct ptlrpc_service *ost_create_service;
 513         struct ptlrpc_service *ost_destroy_service;
 514         struct obd_service_time ost_stimes[6];
 515 };
 516
 517 struct echo_client_obd {
 518         struct obd_export      *ec_exp;     /* the local connection to osc/lov */
 519         spinlock_t              ec_lock;
 520         struct list_head        ec_objects;
 521         int                     ec_nstripes;
 522         __u64                   ec_unique;
 523 };
 524
 525 struct cache_obd {
 526         struct obd_export      *master_exp; /* local connection to master obd */
 527         struct obd_export      *cache_exp;  /* local connection to cache obd */
 528         struct obd_export      *cache_real_exp;
 529         struct obd_export      *master_real_exp;
 530         struct obd_device      *master;
 531         struct obd_device      *cache;
 532         char                   *master_name;
 533         char                   *cache_name;
 534         int                     refcount;
 535         int                     cache_on;
 536         struct semaphore        sem;
 537         struct lov_desc         dt_desc; /* data lovdesc */
 538 };
 539
 540 struct cm_obd {
 541         struct obd_export      *cache_exp;  /* local connection to cache obd */
 542         struct obd_export      *master_exp;
 543         struct obd_device      *cache_obd;
 544         struct obd_device      *master_obd;
 545         int                     master_group;
 546         struct cmobd_write_service *write_srv;
 547         struct lov_desc         master_desc; /* master device lovdesc */
 548 };
 549
 550 struct conf_obd {
 551         struct super_block      *cfobd_sb;
 552         struct vfsmount         *cfobd_vfsmnt;
 553         struct dentry           *cfobd_logs_dir;
 554         struct dentry           *cfobd_objects_dir;
 555         struct dentry           *cfobd_pending_dir;
 556         struct llog_handle      *cfobd_cfg_llh;
 557         struct lvfs_obd_ctxt    *cfobd_lvfs_ctxt;
 558 };
 559
 560 struct lov_tgt_desc {
 561         struct obd_uuid         uuid;
 562         __u32                   ltd_gen;
 563         struct obd_export      *ltd_exp;
 564         int                     active;   /* is this target up for requests */
 565 };
 566
 567 struct lov_obd {
 568         spinlock_t              lov_lock;
 569         struct lov_desc         desc;
 570         int                     bufsize;
 571         int                     refcount;
 572         int                     lo_catalog_loaded:1, async:1;
 573         struct semaphore        lov_llog_sem;
 574         unsigned long           lov_connect_flags;
 575         struct lov_tgt_desc    *tgts;
 576 };
 577
 578 struct lmv_tgt_desc {
 579         struct obd_uuid         uuid;
 580         struct obd_export      *ltd_exp;
 581         int                     active;   /* is this target up for requests */
 582 };
 583
 584 struct lmv_obd {
 585         int                     refcount;
 586         spinlock_t              lmv_lock;
 587         struct lmv_desc         desc;
 588         struct lmv_tgt_desc     *tgts;
 589         struct obd_uuid         cluuid;
 590         struct obd_export       *exp;
 591
 592         int                     tgts_size;
 593         int                     connected;
 594         int                     max_easize;
 595         int                     max_cookiesize;
 596         int                     server_timeout;
 597         int                     connect_flags;
 598         struct semaphore        init_sem;
 599         struct obd_connect_data conn_data;
 600 };
 601 struct gks_crypto_key {
 602         char *key;
 603         int   len;
 604 };
 605 struct gks_obd {
 606         struct ptlrpc_service    *gks_service;
 607         struct crypto_tfm        *gks_mac_tfm;
 608         struct crypto_tfm        *gks_key_tfm;
 609         struct gks_crypto_key    gks_key;
 610 };
 611
 612 struct niobuf_local {
 613         __u64 offset;
 614         __u32 len;
 615         __u32 flags;
 616         struct page *page;
 617         struct dentry *dentry;
 618         int lnb_grant_used;
 619         int rc;
 620 };
 621
 622 #define OBD_MODE_ASYNC (1 << 0)
 623 #define OBD_MODE_CROW  (1 << 1)
 624
 625 /* Don't conflict with on-wire flags OBD_BRW_WRITE, etc */
 626 #define N_LOCAL_TEMP_PAGE 0x10000000
 627
 628 struct obd_trans_info {
 629         __u64                    oti_transno;
 630         __u64                   *oti_objid;
 631
 632         /* only used on the server side for tracking acks. */
 633         struct oti_req_ack_lock {
 634                 struct lustre_handle lock;
 635                 __u32                mode;
 636         }                        oti_ack_locks[4];
 637         void                    *oti_handle;
 638         struct llog_cookie       oti_onecookie;
 639         struct llog_cookie      *oti_logcookies;
 640         int                      oti_numcookies;
 641         int                      oti_flags;
 642         /* save nid for security purposes like audit */
 643         __u64                    oti_nid;
 644 };
 645
 646 static inline void oti_alloc_cookies(struct obd_trans_info *oti,int num_cookies)
 647 {
 648         if (!oti)
 649                 return;
 650
 651         if (num_cookies == 1)
 652                 oti->oti_logcookies = &oti->oti_onecookie;
 653         else
 654                 OBD_ALLOC(oti->oti_logcookies,
 655                           num_cookies * sizeof(oti->oti_onecookie));
 656
 657         oti->oti_numcookies = num_cookies;
 658 }
 659
 660 static inline void oti_free_cookies(struct obd_trans_info *oti)
 661 {
 662         if (!oti || !oti->oti_logcookies)
 663                 return;
 664
 665         if (oti->oti_logcookies == &oti->oti_onecookie)
 666                 LASSERT(oti->oti_numcookies == 1);
 667         else
 668                 OBD_FREE(oti->oti_logcookies,
 669                          oti->oti_numcookies * sizeof(oti->oti_onecookie));
 670         oti->oti_logcookies = NULL;
 671         oti->oti_numcookies = 0;
 672 }
 673
 674 /* llog contexts */
 675 enum llog_ctxt_id {
 676         LLOG_CONFIG_ORIG_CTXT =  0,
 677         LLOG_CONFIG_REPL_CTXT =  1,
 678         LLOG_UNLINK_ORIG_CTXT =  2,
 679         LLOG_UNLINK_REPL_CTXT =  3,
 680         LLOG_SIZE_ORIG_CTXT   =  4,
 681         LLOG_SIZE_REPL_CTXT   =  5,
 682         LLOG_MD_ORIG_CTXT     =  6,
 683         LLOG_MD_REPL_CTXT     =  7,
 684         LLOG_RD1_ORIG_CTXT    =  8,
 685         LLOG_RD1_REPL_CTXT    =  9,
 686         LLOG_TEST_ORIG_CTXT   = 10,
 687         LLOG_TEST_REPL_CTXT   = 11,
 688         LLOG_REINT_ORIG_CTXT  = 12,
 689         LLOG_AUDIT_ORIG_CTXT  = 13,
 690         LLOG_MAX_CTXTS
 691 };
 692
 693 struct obd_llogs {
 694         struct llog_ctxt        *llog_ctxt[LLOG_MAX_CTXTS];
 695 };
 696
 697 struct target_recovery_data {
 698         svc_handler_t     trd_recovery_handler;
 699         pid_t             trd_processing_task;
 700         struct completion trd_starting;
 701         struct completion trd_finishing;
 702 };
 703
 704 /* corresponds to one of the obd's */
 705 struct obd_device {
 706         struct obd_type *obd_type;
 707
 708         /* common and UUID name of this device */
 709         char *obd_name;
 710         struct obd_uuid obd_uuid;
 711
 712         int obd_minor;
 713         unsigned int obd_attached:1, obd_set_up:1, obd_recovering:1,
 714                 obd_abort_recovery:1, obd_replayable:1, obd_no_transno:1,
 715                 obd_no_recov:1, obd_stopping:1;
 716         atomic_t obd_refcount;
 717         wait_queue_head_t obd_refcount_waitq;
 718         struct proc_dir_entry *obd_proc_entry;
 719         struct list_head       obd_exports;
 720         int                    obd_num_exports;
 721         struct ldlm_namespace *obd_namespace;
 722         struct ptlrpc_client   obd_ldlm_client; /* XXX OST/MDS only */
 723         /* a spinlock is OK for what we do now, may need a semaphore later */
 724         spinlock_t             obd_dev_lock;
 725         __u64                  obd_last_committed;
 726         struct fsfilt_operations *obd_fsops;
 727         spinlock_t              obd_osfs_lock;
 728         struct obd_statfs       obd_osfs;
 729         unsigned long           obd_osfs_age;
 730         struct lvfs_run_ctxt    obd_lvfs_ctxt;
 731         struct obd_llogs        obd_llogs;
 732         struct llog_ctxt        *obd_llog_ctxt[LLOG_MAX_CTXTS];
 733         struct obd_device       *obd_observer;
 734         struct obd_export       *obd_self_export;
 735
 736         struct target_recovery_data      obd_recovery_data;
 737         /* XXX encapsulate all this recovery data into target_recovery_data */
 738         int                              obd_max_recoverable_clients;
 739         int                              obd_connected_clients;
 740         int                              obd_recoverable_clients;
 741         spinlock_t                       obd_processing_task_lock;
 742         __u64                            obd_next_recovery_transno;
 743         int                              obd_replayed_requests;
 744         int                              obd_replayed_locks;
 745         int                              obd_requests_queued_for_recovery;
 746         wait_queue_head_t                obd_next_transno_waitq;
 747         struct list_head                 obd_uncommitted_replies;
 748         spinlock_t                       obd_uncommitted_replies_lock;
 749         struct timer_list                obd_recovery_timer;
 750         time_t                           obd_recovery_start;
 751         time_t                           obd_recovery_end;
 752
 753         atomic_t                         obd_req_replay_clients;
 754         atomic_t                         obd_lock_replay_clients;
 755
 756         struct list_head                 obd_req_replay_queue;
 757         struct list_head                 obd_lock_replay_queue;
 758         struct list_head                 obd_final_req_queue;
 759         int                              obd_recovery_stage;
 760
 761         union {
 762                 struct filter_obd        filter;
 763                 struct mds_obd           mds;
 764                 struct client_obd        cli;
 765                 struct ost_obd           ost;
 766                 struct echo_client_obd   echocli;
 767                 struct echo_obd          echo;
 768                 struct recovd_obd        recovd;
 769                 struct lov_obd           lov;
 770                 struct cache_obd         cobd;
 771                 struct ptlbd_obd         ptlbd;
 772                 struct mgmtcli_obd       mgmtcli;
 773                 struct lmv_obd           lmv;
 774                 struct cm_obd            cm;
 775                 struct conf_obd          conf;
 776                 struct gks_obd           gks;
 777         } u;
 778
 779         /* fields used by LProcFS */
 780         unsigned int           obd_cntr_base;
 781         struct lprocfs_stats  *obd_stats;
 782         unsigned int           md_cntr_base;
 783         struct lprocfs_stats  *md_stats;
 784
 785         struct proc_dir_entry *obd_svc_procroot;
 786         struct lprocfs_stats  *obd_svc_stats;
 787 };
 788
 789 #define OBD_OPT_FORCE             (1 << 0)
 790 #define OBD_OPT_FAILOVER          (1 << 1)
 791 #define OBD_OPT_REAL_CLIENT       (1 << 2)
 792 #define OBD_OPT_MDS_CONNECTION    (1 << 3)
 793
 794 #define OBD_LLOG_FL_SENDNOW       (1 << 0)
 795 #define OBD_LLOG_FL_CREATE        (1 << 1)
 796
 797 struct mdc_op_data;
 798
 799 struct obd_ops {
 800         struct module *o_owner;
 801         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
 802                            void *karg, void *uarg);
 803         int (*o_get_info)(struct obd_export *, __u32 keylen, void *key,
 804                           __u32 *vallen, void *val);
 805         int (*o_set_info)(struct obd_export *, __u32 keylen, void *key,
 806                           __u32 vallen, void *val);
 807         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
 808         int (*o_detach)(struct obd_device *dev);
 809         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
 810         int (*o_precleanup)(struct obd_device *dev, int flags);
 811         int (*o_cleanup)(struct obd_device *dev, int flags);
 812         int (*o_process_config)(struct obd_device *dev, obd_count len,
 813                                 void *data);
 814         int (*o_postrecov)(struct obd_device *dev);
 815         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
 816                           int priority);
 817         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
 818         int (*o_connect)(struct lustre_handle *conn, struct obd_device *src,
 819                          struct obd_uuid *cluuid, struct obd_connect_data *data,
 820                          unsigned long flags);
 821         int (*o_connect_post)(struct obd_export *exp, unsigned, unsigned long);
 822         int (*o_disconnect)(struct obd_export *exp, unsigned long flags);
 823
 824         int (*o_statfs)(struct obd_device *obd, struct obd_statfs *osfs,
 825                         unsigned long max_age);
 826         int (*o_packmd)(struct obd_export *exp, struct lov_mds_md **disk_tgt,
 827                         struct lov_stripe_md *mem_src);
 828         int (*o_unpackmd)(struct obd_export *exp,struct lov_stripe_md **mem_tgt,
 829                           struct lov_mds_md *disk_src, int disk_len);
 830         int (*o_revalidate_md)(struct obd_export *exp,  struct obdo *oa,
 831                                struct lov_stripe_md *ea,
 832                                struct obd_trans_info *oti);
 833         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
 834                              obd_id *ids);
 835         int (*o_create)(struct obd_export *exp,  struct obdo *oa,
 836                         void *acl, int acl_size,
 837                         struct lov_stripe_md **ea, struct obd_trans_info *oti);
 838         int (*o_destroy)(struct obd_export *exp, struct obdo *oa,
 839                          struct lov_stripe_md *ea, struct obd_trans_info *oti);
 840         int (*o_setattr)(struct obd_export *exp, struct obdo *oa,
 841                          struct lov_stripe_md *ea, struct obd_trans_info *oti);
 842         int (*o_getattr)(struct obd_export *exp, struct obdo *oa,
 843                          struct lov_stripe_md *ea);
 844         int (*o_getattr_async)(struct obd_export *exp, struct obdo *oa,
 845                                struct lov_stripe_md *ea,
 846                                struct ptlrpc_request_set *set);
 847         int (*o_brw)(int rw, struct obd_export *exp, struct obdo *oa,
 848                      struct lov_stripe_md *ea, obd_count oa_bufs,
 849                      struct brw_page *pgarr, struct obd_trans_info *oti);
 850         int (*o_brw_async)(int rw, struct obd_export *exp, struct obdo *oa,
 851                            struct lov_stripe_md *ea, obd_count oa_bufs,
 852                            struct brw_page *pgarr, struct ptlrpc_request_set *,
 853                            struct obd_trans_info *oti);
 854         int (*o_prep_async_page)(struct obd_export *exp,
 855                                  struct lov_stripe_md *lsm,
 856                                  struct lov_oinfo *loi,
 857                                  struct page *page, obd_off offset,
 858                                  struct obd_async_page_ops *ops, void *data,
 859                                  void **res);
 860         int (*o_queue_async_io)(struct obd_export *exp,
 861                                 struct lov_stripe_md *lsm,
 862                                 struct lov_oinfo *loi, void *cookie,
 863                                 int cmd, obd_off off, int count,
 864                                 obd_flags brw_flags, obd_flags async_flags);
 865         int (*o_queue_group_io)(struct obd_export *exp,
 866                                 struct lov_stripe_md *lsm,
 867                                 struct lov_oinfo *loi,
 868                                 struct obd_io_group *oig,
 869                                 void *cookie, int cmd, obd_off off, int count,
 870                                 obd_flags brw_flags, obd_flags async_flags);
 871         int (*o_trigger_group_io)(struct obd_export *exp,
 872                                   struct lov_stripe_md *lsm,
 873                                   struct lov_oinfo *loi,
 874                                   struct obd_io_group *oig);
 875         int (*o_set_async_flags)(struct obd_export *exp,
 876                                 struct lov_stripe_md *lsm,
 877                                 struct lov_oinfo *loi, void *cookie,
 878                                 obd_flags async_flags);
 879         int (*o_teardown_async_page)(struct obd_export *exp,
 880                                      struct lov_stripe_md *lsm,
 881                                      struct lov_oinfo *loi, void *cookie);
 882         int (*o_adjust_kms)(struct obd_export *exp, struct lov_stripe_md *lsm,
 883                             obd_off size, int shrink);
 884         int (*o_punch)(struct obd_export *exp, struct obdo *oa,
 885                        struct lov_stripe_md *ea, obd_size start,
 886                        obd_size end, struct obd_trans_info *oti,
 887                        struct lustre_capa *capa);
 888         int (*o_sync)(struct obd_export *exp, struct obdo *oa,
 889                       struct lov_stripe_md *ea, obd_size start, obd_size end);
 890         int (*o_migrate)(struct lustre_handle *conn, struct lov_stripe_md *dst,
 891                          struct lov_stripe_md *src, obd_size start,
 892                          obd_size end, struct obd_trans_info *oti);
 893         int (*o_copy)(struct lustre_handle *dstconn, struct lov_stripe_md *dst,
 894                       struct lustre_handle *srconn, struct lov_stripe_md *src,
 895                       obd_size start, obd_size end, struct obd_trans_info *);
 896         int (*o_iterate)(struct lustre_handle *conn,
 897                          int (*)(obd_id, obd_gr, void *),
 898                          obd_id *startid, obd_gr group, void *data);
 899         int (*o_preprw)(int cmd, struct obd_export *exp, struct obdo *oa,
 900                         int objcount, struct obd_ioobj *obj,
 901                         int niocount, struct niobuf_remote *remote,
 902                         struct niobuf_local *local, struct obd_trans_info *oti,
 903                         struct lustre_capa *capa);
 904         int (*o_commitrw)(int cmd, struct obd_export *exp, struct obdo *oa,
 905                           int objcount, struct obd_ioobj *obj,
 906                           int niocount, struct niobuf_local *local,
 907                           struct obd_trans_info *oti, int rc);
 908         int (*o_do_cow)(struct obd_export *exp, struct obd_ioobj *obj,
 909                         int objcount, struct niobuf_remote *rnb);
 910         int (*o_write_extents)(struct obd_export *exp, struct obd_ioobj *obj,
 911                                int objcount, int niocount,
 912                                struct niobuf_local *local,int rc);
 913         int (*o_enqueue)(struct obd_export *, struct lov_stripe_md *,
 914                          __u32 type, ldlm_policy_data_t *, __u32 mode,
 915                          int *flags, void *bl_cb, void *cp_cb, void *gl_cb,
 916                          void *data, __u32 lvb_len, void *lvb_swabber,
 917                          struct lustre_handle *lockh);
 918         int (*o_match)(struct obd_export *, struct lov_stripe_md *, __u32 type,
 919                        ldlm_policy_data_t *, __u32 mode, int *flags, void *data,
 920                        struct lustre_handle *lockh);
 921         int (*o_change_cbdata)(struct obd_export *, struct lov_stripe_md *,
 922                                ldlm_iterator_t it, void *data);
 923         int (*o_cancel)(struct obd_export *, struct lov_stripe_md *md,
 924                         __u32 mode, struct lustre_handle *);
 925         int (*o_cancel_unused)(struct obd_export *, struct lov_stripe_md *,
 926                                int flags, void *opaque);
 927         int (*o_san_preprw)(int cmd, struct obd_export *exp,
 928                             struct obdo *oa, int objcount,
 929                             struct obd_ioobj *obj, int niocount,
 930                             struct niobuf_remote *remote);
 931         int (*o_init_export)(struct obd_export *exp);
 932         int (*o_destroy_export)(struct obd_export *exp);
 933
 934         /* llog related obd_methods */
 935         int (*o_llog_init)(struct obd_device *, struct obd_llogs *,
 936                            struct obd_device *, int, struct llog_catid *);
 937         int (*o_llog_finish)(struct obd_device *, struct obd_llogs *, int);
 938         int (*o_llog_connect)(struct obd_export *, struct llogd_conn_body *);
 939
 940
 941         /* metadata-only methods */
 942         int (*o_pin)(struct obd_export *, obd_id ino, __u32 gen, int type,
 943                      struct obd_client_handle *, int flag);
 944         int (*o_unpin)(struct obd_export *, struct obd_client_handle *, int);
 945
 946         int (*o_import_event)(struct obd_device *, struct obd_import *,
 947                               enum obd_import_event);
 948
 949         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
 950                         int active, void *data);
 951
 952         int (*o_init_ea_size)(struct obd_export *, int, int);
 953
 954         /*
 955          * NOTE: If adding ops, add another LPROCFS_OBD_OP_INIT() line
 956          * to lprocfs_alloc_obd_stats() in obdclass/lprocfs_status.c.
 957          * Also, add a wrapper function in include/linux/obd_class.h.
 958          */
 959 };
 960
 961 struct md_ops {
 962         int (*m_getstatus)(struct obd_export *, struct lustre_id *);
 963         int (*m_change_cbdata)(struct obd_export *, struct lustre_id *,
 964                                ldlm_iterator_t, void *);
 965         int (*m_change_cbdata_name)(struct obd_export *, struct lustre_id *,
 966                                     char *, int, struct lustre_id *,
 967                                     ldlm_iterator_t, void *);
 968         int (*m_close)(struct obd_export *, struct mdc_op_data *,
 969                        struct obd_client_handle *, struct ptlrpc_request **);
 970         int (*m_create)(struct obd_export *, struct mdc_op_data *,
 971                         const void *, int, int, __u32, __u32,
 972                         __u64, struct ptlrpc_request **);
 973         int (*m_done_writing)(struct obd_export *, struct obdo *);
 974         int (*m_enqueue)(struct obd_export *, int, struct lookup_intent *,
 975                          int, struct mdc_op_data *, struct lustre_handle *,
 976                          void *, int, ldlm_completion_callback,
 977                          ldlm_blocking_callback, void *);
 978         int (*m_getattr)(struct obd_export *, struct lustre_id *,
 979                          __u64, const char *, const void *, unsigned int,
 980                          unsigned int, struct obd_capa *,
 981                          struct ptlrpc_request **);
 982         int (*m_access_check)(struct obd_export *, struct lustre_id *,
 983                               struct ptlrpc_request **);
 984         int (*m_getattr_lock)(struct obd_export *, struct lustre_id *,
 985                               char *, int, __u64,
 986                               unsigned int, struct ptlrpc_request **);
 987         int (*m_intent_lock)(struct obd_export *,
 988                              struct lustre_id *, const char *, int,
 989                              void *, int, struct lustre_id *,
 990                              struct lookup_intent *, int,
 991                              struct ptlrpc_request **,
 992                              ldlm_blocking_callback);
 993         int (*m_link)(struct obd_export *, struct mdc_op_data *,
 994                       struct ptlrpc_request **);
 995         int (*m_rename)(struct obd_export *, struct mdc_op_data *,
 996                         const char *, int, const char *, int,
 997                         struct ptlrpc_request **);
 998         int (*m_setattr)(struct obd_export *, struct mdc_op_data *,
 999                          struct iattr *, void *, int , void *, int,
1000                          void *, int, struct ptlrpc_request **);
1001         int (*m_sync)(struct obd_export *, struct lustre_id *,
1002                       struct ptlrpc_request **);
1003         int (*m_readpage)(struct obd_export *, struct lustre_id *,
1004                           __u64, struct page *, struct ptlrpc_request **);
1005         int (*m_unlink)(struct obd_export *, struct mdc_op_data *,
1006                         struct ptlrpc_request **);
1007         int (*m_valid_attrs)(struct obd_export *, struct lustre_id *);
1008
1009         struct obd_device *(*m_get_real_obd)(struct obd_export *, struct lustre_id *);
1010
1011         int (*m_req2lustre_md)(struct obd_export *exp,
1012                                struct ptlrpc_request *req, unsigned int offset,
1013                                struct obd_export *osc_exp, struct lustre_md *md);
1014         int (*m_set_open_replay_data)(struct obd_export *exp,
1015                                       struct obd_client_handle *och,
1016                                       struct ptlrpc_request *open_req);
1017         int (*m_clear_open_replay_data)(struct obd_export *exp,
1018                                         struct obd_client_handle *och);
1019         int (*m_store_inode_generation)(struct obd_export *exp,
1020                                         struct ptlrpc_request *req, int reqoff,
1021                                         int repoff);
1022         int (*m_set_lock_data)(struct obd_export *exp, __u64 *l, void *data);
1023
1024         int (*m_delete_inode)(struct obd_export *, struct lustre_id *);
1025
1026         /*
1027          * NOTE: If adding ops, add another LPROCFS_MD_OP_INIT() line to
1028          * lprocfs_alloc_md_stats() in obdclass/lprocfs_status.c. Also, add a
1029          * wrapper function in include/linux/obd_class.h.
1030          */
1031 };
1032
1033 static inline void obd_transno_commit_cb(struct obd_device *obd,
1034                                          __u64 transno, int error)
1035 {
1036         if (error) {
1037                 CERROR("%s: transno "LPD64" commit error: %d\n",
1038                        obd->obd_name, transno, error);
1039                 return;
1040         }
1041
1042         CDEBUG(D_HA, "%s: transno "LPD64" committed\n",
1043                obd->obd_name, transno);
1044
1045         if (transno > obd->obd_last_committed) {
1046                 obd->obd_last_committed = transno;
1047                 ptlrpc_commit_replies (obd);
1048         }
1049 }
1050
1051 static inline int obd_md_type(struct obd_device *obd)
1052 {
1053         if (!strcmp(obd->obd_type->typ_name, OBD_MDC_DEVICENAME) ||
1054             !strcmp(obd->obd_type->typ_name, OBD_LMV_DEVICENAME))
1055                 return 1;
1056
1057         return 0;
1058 }
1059
1060 static inline int obd_dt_type(struct obd_device *obd)
1061 {
1062         if (!strcmp(obd->obd_type->typ_name, OBD_LOV_DEVICENAME) ||
1063             !strcmp(obd->obd_type->typ_name, OBD_OSC_DEVICENAME))
1064                 return 1;
1065
1066         return 0;
1067 }
1068
1069 #endif /* __OBD_H */