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 #include <linux/fs.h>
  13 #include <linux/list.h>
  14 #include <linux/smp_lock.h>
  15 #include <linux/proc_fs.h>
  16
  17 #include <linux/lustre_lib.h>
  18 #include <linux/lustre_idl.h>
  19 #include <linux/lustre_mds.h>
  20 #include <linux/lustre_export.h>
  21
  22 struct obd_type {
  23         struct list_head typ_chain;
  24         struct obd_ops *typ_ops;
  25         char *typ_name;
  26         int  typ_refcnt;
  27 };
  28
  29 struct brw_page {
  30         struct page *pg;
  31         obd_size count;
  32         obd_off  off;
  33         obd_flag flag;
  34 };
  35
  36 struct lov_oinfo { /* per-child structure */
  37         __u64 loi_id;              /* object ID on the target OST */
  38         __u64 loi_size;            /* size of this object on the target OST */
  39         struct lustre_handle *loi_handle; /* handle for object on OST */
  40         int loi_ost_idx;           /* OST stripe index in lmd_objects array */
  41 };
  42
  43 struct lov_stripe_md {
  44         __u32 lsm_magic;
  45         __u32 lsm_mds_easize;      /* packed size for MDS of ea - KILL ME*/
  46         __u64 lsm_object_id;       /* lov object id */
  47         __u64 lsm_stripe_size;     /* size of the stripe */
  48         __u32 lsm_stripe_pattern;  /* per-lov object stripe pattern */
  49         int   lsm_stripe_offset;   /* offset of first stripe in lmd_objects */
  50         int   lsm_stripe_count;    /* how many objects are being striped on */
  51         int   lsm_ost_count;       /* how many OSTs are in this LOV - KILL ME */
  52         struct lov_oinfo lsm_oinfo[0];
  53 };
  54
  55 /* Individual type definitions */
  56
  57 struct ext2_obd {
  58         struct super_block *e2_sb;
  59         struct vfsmount *e2_vfsmnt;
  60 };
  61
  62 struct obd_ucred {
  63         __u32 ouc_fsuid;
  64         __u32 ouc_fsgid;
  65 };
  66
  67 #define OBD_RUN_CTXT_MAGIC      0xC0FFEEAA
  68 #define OBD_CTXT_DEBUG          /* development-only debugging */
  69 struct obd_run_ctxt {
  70         struct vfsmount *pwdmnt;
  71         struct dentry   *pwd;
  72         mm_segment_t     fs;
  73         __u32            fsuid;
  74         __u32            fsgid;
  75 #ifdef OBD_CTXT_DEBUG
  76         __u32            magic;
  77 #endif
  78 };
  79
  80
  81 #ifdef OBD_CTXT_DEBUG
  82 #define OBD_SET_CTXT_MAGIC(ctxt) (ctxt)->magic = OBD_RUN_CTXT_MAGIC
  83 #else
  84 #define OBD_SET_CTXT_MAGIC(ctxt) do {} while(0)
  85 #endif
  86
  87 struct filter_obd {
  88         char *fo_fstype;
  89         struct super_block *fo_sb;
  90         struct vfsmount *fo_vfsmnt;
  91         struct obd_run_ctxt fo_ctxt;
  92         struct dentry *fo_dentry_O;
  93         struct dentry *fo_dentry_O_mode[16];
  94         spinlock_t fo_lock;
  95         __u64 fo_lastino;
  96         struct file_operations *fo_fop;
  97         struct inode_operations *fo_iop;
  98         struct address_space_operations *fo_aops;
  99         struct list_head fo_export_list;
 100 };
 101
 102 struct mds_server_data;
 103
 104 struct client_obd {
 105         struct obd_import    cl_import;
 106         struct semaphore     cl_sem;
 107         int                  cl_conn_count;
 108         obd_uuid_t           cl_target_uuid; /* XXX -> lustre_name */
 109         int                  cl_max_mds_easize;
 110         int                  cl_max_ost_easize;
 111 };
 112
 113 struct mds_obd {
 114         struct ptlrpc_service *mds_service;
 115
 116         char *mds_fstype;
 117         struct super_block *mds_sb;
 118         struct super_operations *mds_sop;
 119         struct vfsmount *mds_vfsmnt;
 120         struct obd_run_ctxt mds_ctxt;
 121         struct file_operations *mds_fop;
 122         struct inode_operations *mds_iop;
 123         struct address_space_operations *mds_aops;
 124         struct mds_fs_operations *mds_fsops;
 125         int mds_max_mdsize;
 126         struct file *mds_rcvd_filp;
 127         spinlock_t mds_last_lock;
 128         __u64 mds_last_committed;
 129         __u64 mds_last_rcvd;
 130         __u64 mds_mount_count;
 131         struct ll_fid mds_rootfid;
 132         struct mds_server_data *mds_server_data;
 133 };
 134
 135 struct ldlm_obd {
 136         struct ptlrpc_service *ldlm_service;
 137         struct ptlrpc_client *ldlm_client;
 138         struct ptlrpc_connection *ldlm_server_conn;
 139 };
 140
 141 struct echo_obd {
 142         char *eo_fstype;
 143         struct obdo oa;
 144         spinlock_t eo_lock;
 145         __u64 eo_lastino;
 146         atomic_t eo_getattr;
 147         atomic_t eo_setattr;
 148         atomic_t eo_create;
 149         atomic_t eo_destroy;
 150         atomic_t eo_prep;
 151         atomic_t eo_read;
 152         atomic_t eo_write;
 153 };
 154
 155 struct recovd_obd {
 156         spinlock_t            recovd_lock;
 157         struct list_head      recovd_managed_items; /* items managed  */
 158         struct list_head      recovd_troubled_items; /* items in recovery */
 159
 160         wait_queue_head_t     recovd_recovery_waitq;
 161         wait_queue_head_t     recovd_ctl_waitq;
 162         wait_queue_head_t     recovd_waitq;
 163         struct task_struct   *recovd_thread;
 164         __u32                 recovd_state;
 165 };
 166
 167 struct trace_obd {
 168         struct obdtrace_opstats *stats;
 169 };
 170
 171 #if 0
 172 struct snap_obd {
 173         unsigned int snap_index;  /* which snapshot index are we accessing */
 174         int snap_tableno;
 175 };
 176
 177 #endif
 178
 179 struct ost_obd {
 180         struct ptlrpc_service *ost_service;
 181         struct lustre_handle ost_conn;   /* the local connection to the OBD */
 182 };
 183
 184
 185 struct lov_tgt_desc {
 186         obd_uuid_t uuid;
 187         struct lustre_handle conn;
 188 };
 189
 190 struct lov_obd {
 191         struct obd_device *mdcobd;
 192         struct lov_desc desc;
 193         int bufsize;
 194         struct lov_tgt_desc *tgts;
 195 };
 196
 197 struct niobuf_local {
 198         __u64 offset;
 199         __u32 len;
 200         __u32 xid;
 201         __u32 flags;
 202         void *addr;
 203         struct page *page;
 204         void *target_private;
 205         struct dentry *dentry;
 206 };
 207
 208 #define N_LOCAL_TEMP_PAGE 0x00000001
 209
 210 /* corresponds to one of the obd's */
 211 struct obd_device {
 212         struct obd_type *obd_type;
 213
 214         /* common and UUID name of this device */
 215         char *obd_name;
 216         obd_uuid_t obd_uuid;
 217
 218         int obd_minor;
 219         int obd_flags;
 220         struct proc_dir_entry *obd_proc_entry;
 221         struct list_head       obd_exports;
 222         struct list_head       obd_imports;
 223         struct ldlm_namespace *obd_namespace;
 224         struct ptlrpc_client   obd_ldlm_client; /* XXX OST/MDS only */
 225         /* a spinlock is OK for what we do now, may need a semaphore later */
 226         spinlock_t obd_dev_lock;
 227         union {
 228                 struct ext2_obd ext2;
 229                 struct filter_obd filter;
 230                 struct mds_obd mds;
 231                 struct client_obd cli;
 232                 struct ost_obd ost;
 233                 //                struct osc_obd osc;
 234                 struct ldlm_obd ldlm;
 235                 struct echo_obd echo;
 236                 struct recovd_obd recovd;
 237                 struct trace_obd trace;
 238                 struct lov_obd lov;
 239 #if 0
 240                 struct snap_obd snap;
 241 #endif
 242         } u;
 243        /* Fields used by LProcFS */
 244         unsigned int cntr_mem_size;
 245         void* counters;
 246 };
 247
 248 struct io_cb_data;
 249
 250 struct obd_ops {
 251         int (*o_iocontrol)(long cmd, struct lustre_handle *, int len,
 252                            void *karg, void *uarg);
 253         int (*o_get_info)(struct lustre_handle *, obd_count keylen, void *key,
 254                           obd_count *vallen, void **val);
 255         int (*o_set_info)(struct lustre_handle *, obd_count keylen, void *key,
 256                           obd_count vallen, void *val);
 257         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
 258         int (*o_detach)(struct obd_device *dev);
 259         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
 260         int (*o_cleanup)(struct obd_device *dev);
 261         int (*o_connect)(struct lustre_handle *conn, struct obd_device *src,
 262                          obd_uuid_t cluuid);
 263         int (*o_disconnect)(struct lustre_handle *conn);
 264
 265
 266         int (*o_statfs)(struct lustre_handle *conn, struct obd_statfs *osfs);
 267         int (*o_preallocate)(struct lustre_handle *, obd_count *req,
 268                              obd_id *ids);
 269         int (*o_create)(struct lustre_handle *conn,  struct obdo *oa,
 270                         struct lov_stripe_md **ea);
 271         int (*o_destroy)(struct lustre_handle *conn, struct obdo *oa,
 272                          struct lov_stripe_md *ea);
 273         int (*o_setattr)(struct lustre_handle *conn, struct obdo *oa,
 274                          struct lov_stripe_md *ea);
 275         int (*o_getattr)(struct lustre_handle *conn, struct obdo *oa,
 276                          struct lov_stripe_md *ea);
 277         int (*o_open)(struct lustre_handle *conn, struct obdo *oa,
 278                       struct lov_stripe_md *ea);
 279         int (*o_close)(struct lustre_handle *conn, struct obdo *oa,
 280                        struct lov_stripe_md *ea);
 281         int (*o_brw)(int rw, struct lustre_handle *conn,
 282                      struct lov_stripe_md *ea, obd_count oa_bufs,
 283                      struct brw_page *pgarr, brw_callback_t callback,
 284                      struct io_cb_data *data);
 285         int (*o_punch)(struct lustre_handle *conn, struct obdo *tgt,
 286                        struct lov_stripe_md *ea, obd_size count,
 287                        obd_off offset);
 288         int (*o_sync)(struct lustre_handle *conn, struct obdo *tgt,
 289                       obd_size count, obd_off offset);
 290         int (*o_migrate)(struct lustre_handle *conn, struct obdo *dst,
 291                          struct obdo *src, obd_size count, obd_off offset);
 292         int (*o_copy)(struct lustre_handle *dstconn, struct obdo *dst,
 293                       struct lustre_handle *srconn, struct obdo *src,
 294                       obd_size count, obd_off offset);
 295         int (*o_iterate)(struct lustre_handle *conn,
 296                          int (*)(obd_id, obd_gr, void *),
 297                          obd_id *startid, obd_gr group, void *data);
 298         int (*o_preprw)(int cmd, struct lustre_handle *conn,
 299                         int objcount, struct obd_ioobj *obj,
 300                         int niocount, struct niobuf_remote *remote,
 301                         struct niobuf_local *local, void **desc_private);
 302         int (*o_commitrw)(int cmd, struct lustre_handle *conn,
 303                           int objcount, struct obd_ioobj *obj,
 304                           int niocount, struct niobuf_local *local,
 305                           void *desc_private);
 306         int (*o_enqueue)(struct lustre_handle *conn, struct lov_stripe_md *md,
 307                          struct lustre_handle *parent_lock,
 308                          __u32 type, void *cookie, int cookielen, __u32 mode,
 309                          int *flags, void *cb, void *data, int datalen,
 310                          struct lustre_handle *lockh);
 311         int (*o_cancel)(struct lustre_handle *, struct lov_stripe_md *md,
 312                         __u32 mode, struct lustre_handle *);
 313         int (*o_cancel_unused)(struct lustre_handle *, struct lov_stripe_md *,
 314                                int local_only);
 315 };
 316
 317 static inline void *mds_fs_start(struct mds_obd *mds, struct inode *inode,
 318                                  int op)
 319 {
 320         return mds->mds_fsops->fs_start(inode, op);
 321 }
 322
 323 static inline int mds_fs_commit(struct mds_obd *mds, struct inode *inode,
 324                                 void *handle)
 325 {
 326         return mds->mds_fsops->fs_commit(inode, handle);
 327 }
 328
 329 static inline int mds_fs_setattr(struct mds_obd *mds, struct dentry *dentry,
 330                                  void *handle, struct iattr *iattr)
 331 {
 332         int rc;
 333         /*
 334          * NOTE: we probably don't need to take i_sem here when changing
 335          *       ATTR_SIZE because the MDS never needs to truncate a file.
 336          *       The ext2/ext3 code never truncates a directory, and files
 337          *       stored on the MDS are entirely sparse (no data blocks).
 338          *       If we do need to get it, we can do it here.
 339          */
 340         lock_kernel();
 341         rc = mds->mds_fsops->fs_setattr(dentry, handle, iattr);
 342         unlock_kernel();
 343
 344         return rc;
 345 }
 346
 347 static inline int mds_fs_set_md(struct mds_obd *mds, struct inode *inode,
 348                                   void *handle, struct lov_mds_md *md)
 349 {
 350         return mds->mds_fsops->fs_set_md(inode, handle, md);
 351 }
 352
 353 static inline int mds_fs_get_md(struct mds_obd *mds, struct inode *inode,
 354                                   struct lov_mds_md *md)
 355 {
 356         return mds->mds_fsops->fs_get_md(inode, md);
 357 }
 358
 359 static inline ssize_t mds_fs_readpage(struct mds_obd *mds, struct file *file,
 360                                       char *buf, size_t count, loff_t *offset)
 361 {
 362         return mds->mds_fsops->fs_readpage(file, buf, count, offset);
 363 }
 364
 365 /* Set up callback to update mds->mds_last_committed with the current
 366  * value of mds->mds_last_recieved when this transaction is on disk.
 367  */
 368 static inline int mds_fs_set_last_rcvd(struct mds_obd *mds, void *handle)
 369 {
 370         return mds->mds_fsops->fs_set_last_rcvd(mds, handle);
 371 }
 372
 373 /* Enable data journaling on the given file */
 374 static inline ssize_t mds_fs_journal_data(struct mds_obd *mds,
 375                                           struct file *file)
 376 {
 377         return mds->mds_fsops->fs_journal_data(file);
 378 }
 379
 380 static inline int mds_fs_statfs(struct mds_obd *mds, struct statfs *sfs)
 381 {
 382         if (mds->mds_fsops->fs_statfs)
 383                 return mds->mds_fsops->fs_statfs(mds->mds_sb, sfs);
 384
 385         return vfs_statfs(mds->mds_sb, sfs);
 386 }
 387
 388 #endif