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  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
  16 #include <linux/lustre_idl.h>
  17
  18 struct obd_type {
  19         struct list_head typ_chain;
  20         struct obd_ops *typ_ops;
  21         char *typ_name;
  22         int  typ_refcnt;
  23 };
  24
  25 #define OBD_RUN_CTXT_MAGIC      0xC0FFEEAA
  26 #define OBD_CTXT_DEBUG          /* development-only debugging */
  27 struct obd_run_ctxt {
  28         struct vfsmount *pwdmnt;
  29         struct dentry   *pwd;
  30         mm_segment_t     fs;
  31 #ifdef OBD_CTXT_DEBUG
  32         __u32            magic;
  33 #endif
  34 };
  35
  36
  37
  38 struct obd_conn {
  39         __u64 addr;
  40         __u64 cookie;
  41         struct obd_device *oc_dev;
  42         uint32_t oc_id;
  43 };
  44
  45 /* Individual type definitions */
  46
  47 struct ext2_obd {
  48         struct super_block *e2_sb;
  49         struct vfsmount *e2_vfsmnt;
  50 };
  51
  52 struct filter_obd {
  53         char *fo_fstype;
  54         struct super_block *fo_sb;
  55         struct vfsmount *fo_vfsmnt;
  56         struct obd_run_ctxt fo_ctxt;
  57         struct dentry *fo_dentry_O;
  58         struct dentry *fo_dentry_O_mode[16];
  59         spinlock_t fo_lock;
  60         __u64 fo_lastino;
  61         struct file_operations *fo_fop;
  62         struct inode_operations *fo_iop;
  63         struct address_space_operations *fo_aops;
  64 };
  65
  66 struct mds_client_info;
  67 struct mds_server_data;
  68
  69 struct mdc_obd {
  70         struct lustre_handle mdc_connh;
  71         struct ptlrpc_client *mdc_client;
  72         struct ptlrpc_client *mdc_ldlm_client;
  73         struct ptlrpc_connection *mdc_conn;
  74         __u8 mdc_target_uuid[37];
  75 };
  76
  77 struct osc_obd {
  78         struct lustre_handle osc_connh;
  79         struct ptlrpc_client *osc_client;
  80         struct ptlrpc_client *osc_ldlm_client;
  81         struct ptlrpc_connection *osc_conn;
  82         __u8 osc_target_uuid[37];
  83 };
  84
  85 struct mds_obd {
  86         struct ldlm_namespace *mds_local_namespace;
  87         struct ptlrpc_service *mds_service;
  88         struct ptlrpc_client *mds_ldlm_client; /* to be an LDLM client */
  89         struct ptlrpc_connection *mds_ldlm_conn; /* to be an LDLM client */
  90
  91         char *mds_fstype;
  92         struct super_block *mds_sb;
  93         struct super_operations *mds_sop;
  94         struct vfsmount *mds_vfsmnt;
  95         struct obd_run_ctxt mds_ctxt;
  96         struct file_operations *mds_fop;
  97         struct inode_operations *mds_iop;
  98         struct address_space_operations *mds_aops;
  99         struct mds_fs_operations *mds_fsops;
 100         struct file *mds_rcvd_filp;
 101         __u64 mds_last_committed;
 102         __u64 mds_last_rcvd;
 103         __u64 mds_mount_count;
 104         struct ll_fid mds_rootfid;
 105         int mds_client_count;
 106         struct list_head mds_client_info;
 107         struct mds_server_data *mds_server_data;
 108 };
 109
 110 struct ldlm_obd {
 111         struct ptlrpc_service *ldlm_service;
 112         struct ptlrpc_client *ldlm_client;
 113         struct ptlrpc_connection *ldlm_server_conn;
 114 };
 115
 116 struct echo_obd {
 117         char *eo_fstype;
 118         struct super_block *eo_sb;
 119         struct vfsmount *eo_vfsmnt;
 120         struct obd_run_ctxt eo_ctxt;
 121         spinlock_t eo_lock;
 122         __u64 eo_lastino;
 123         struct file_operations *eo_fop;
 124         struct inode_operations *eo_iop;
 125         struct address_space_operations *eo_aops;
 126 };
 127
 128 struct recovd_obd {
 129         time_t                recovd_waketime;
 130         time_t                recovd_timeout;
 131         struct ptlrpc_service *recovd_service;
 132         struct ptlrpc_client  *recovd_client;
 133         __u32                  recovd_flags;
 134         __u32                  recovd_wakeup_flag;
 135         spinlock_t             recovd_lock;
 136         struct list_head      recovd_clients_lh; /* clients managed  */
 137         struct list_head      recovd_troubled_lh; /* clients in trouble */
 138         wait_queue_head_t     recovd_recovery_waitq;
 139         wait_queue_head_t     recovd_ctl_waitq;
 140         wait_queue_head_t     recovd_waitq;
 141         struct task_struct    *recovd_thread;
 142 };
 143
 144 struct trace_obd {
 145         struct obdtrace_opstats *stats;
 146 };
 147
 148 #if 0
 149 struct snap_obd {
 150         unsigned int snap_index;  /* which snapshot index are we accessing */
 151         int snap_tableno;
 152 };
 153
 154 #endif
 155
 156 struct ost_obd {
 157         struct ptlrpc_service *ost_service;
 158         struct obd_conn ost_conn;   /* the local connection to the OBD */
 159 };
 160
 161
 162 typedef __u8 uuid_t[37];
 163
 164 #define MAX_MULTI       16
 165 struct lov_obd {
 166         __u32 lov_default_count;
 167         __u32 lov_default_pattern;
 168         __u32 lov_default_size;
 169         uuid_t lov_service_uuids[MAX_MULTI];
 170
 171 #if 0
 172         int lov_count;
 173         struct obd_conn *lov_targets;
 174 #endif
 175 };
 176
 177 /* corresponds to one of the obd's */
 178 struct obd_device {
 179         struct obd_type *obd_type;
 180
 181         /* common and UUID name of this device */
 182         char *obd_name;
 183         __u8 obd_uuid[37];
 184
 185         int obd_minor;
 186         int obd_flags;
 187         struct proc_dir_entry *obd_proc_entry;
 188         int obd_multi_count;
 189         struct obd_conn obd_multi_conn[MAX_MULTI];
 190         unsigned int obd_gen_last_id;
 191         unsigned long obd_gen_prealloc_quota;
 192         //        struct obd_device *obd_target; /* for anything that simply layers */
 193         struct list_head obd_exports;
 194         struct list_head obd_imports;
 195         struct ldlm_namespace *obd_namespace;
 196         union {
 197                 struct ext2_obd ext2;
 198                 struct filter_obd filter;
 199                 struct mds_obd mds;
 200                 struct mdc_obd mdc;
 201                 struct ost_obd ost;
 202                 struct osc_obd osc;
 203                 struct ldlm_obd ldlm;
 204                 struct echo_obd echo;
 205                 struct recovd_obd recovd;
 206                 struct trace_obd trace;
 207                 struct lov_obd lov;
 208 #if 0
 209                 struct snap_obd snap;
 210 #endif
 211         } u;
 212 };
 213
 214 struct obd_ops {
 215         int (*o_iocontrol)(long cmd, struct obd_conn *, int len, void *karg,
 216                            void *uarg);
 217         int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
 218                           obd_count *vallen, void **val);
 219         int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
 220                           obd_count vallen, void *val);
 221         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
 222         int (*o_detach)(struct obd_device *dev);
 223         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
 224         int (*o_cleanup)(struct obd_device *dev);
 225         int (*o_connect)(struct obd_conn *conn, struct obd_device *src);
 226         int (*o_disconnect)(struct obd_conn *conn);
 227
 228
 229         int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
 230         int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
 231         int (*o_create)(struct obd_conn *conn,  struct obdo *oa);
 232         int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
 233         int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
 234         int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
 235         int (*o_open)(struct obd_conn *conn, struct obdo *oa);
 236         int (*o_close)(struct obd_conn *conn, struct obdo *oa);
 237         int (*o_brw)(int rw, struct obd_conn *conn, obd_count num_oa,
 238                      struct obdo **oa, obd_count *oa_bufs, struct page **buf,
 239                      obd_size *count, obd_off *offset, obd_flag *flags,
 240                      void *);
 241         int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
 242                        obd_off offset);
 243         int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
 244                       obd_off offset);
 245         int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
 246                          struct obdo *src, obd_size count, obd_off offset);
 247         int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
 248                       struct obd_conn *srconn, struct obdo *src,
 249                       obd_size count, obd_off offset);
 250         int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
 251                          obd_id *startid, obd_gr group, void *data);
 252         int (*o_preprw)(int cmd, struct obd_conn *conn,
 253                         int objcount, struct obd_ioobj *obj,
 254                         int niocount, struct niobuf_remote *remote,
 255                         struct niobuf_local *local, void **desc_private);
 256         int (*o_commitrw)(int cmd, struct obd_conn *conn,
 257                           int objcount, struct obd_ioobj *obj,
 258                           int niocount, struct niobuf_local *local,
 259                           void *desc_private);
 260         int (*o_enqueue)(struct obd_conn *conn,
 261                          struct lustre_handle *parent_lock, __u64 *res_id,
 262                          __u32 type, void *cookie, int cookielen, __u32 mode,
 263                          int *flags, void *cb, void *data, int datalen,
 264                          struct lustre_handle *lockh);
 265         int (*o_cancel)(struct obd_conn *, __u32 mode, struct lustre_handle *);
 266 };
 267
 268 #endif