Whamcloud - gitweb
- documentation update for MDS recovery
[fs/lustre-release.git] / 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_conn_info {
19         unsigned int conn_id;     /* handle */
20 };
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 obd_run_ctxt {
30         struct vfsmount *pwdmnt;
31         struct dentry   *pwd;
32         mm_segment_t     fs;
33 };
34
35 struct obd_conn {
36         struct obd_device *oc_dev;
37         uint32_t oc_id;
38 };
39
40 struct obd_devicename {
41         uint32_t len;
42         char *name;
43         struct dentry *dentry;   /* file system obd device names */
44         __u8 _uuid[16];          /* uuid obd device names */
45 };
46
47
48 /* Individual type definitions */
49
50 struct ext2_obd {
51         struct super_block *e2_sb;
52         struct vfsmount *e2_vfsmnt;
53 };
54
55 struct filter_obd {
56         char *fo_fstype;
57         struct super_block *fo_sb;
58         struct vfsmount *fo_vfsmnt;
59         struct obd_run_ctxt fo_ctxt;
60         spinlock_t fo_lock;
61         __u64 fo_lastino;
62         struct file_operations *fo_fop;
63         struct inode_operations *fo_iop;
64         struct address_space_operations *fo_aops;
65 };
66
67 struct mds_client_info;
68 struct mds_server_data;
69
70 struct mds_obd {
71         struct ptlrpc_service *mds_service;
72
73         char *mds_fstype;
74         struct super_block *mds_sb;
75         struct vfsmount *mds_vfsmnt;
76         struct obd_run_ctxt mds_ctxt;
77         struct file_operations *mds_fop;
78         struct inode_operations *mds_iop;
79         struct address_space_operations *mds_aops;
80         struct mds_fs_operations *mds_fsops;
81         struct file *mds_rcvd_filp;
82         __u64 mds_last_committed;
83         __u64 mds_last_rcvd;
84         __u64 mds_mount_count;
85         struct ll_fid mds_rootfid;
86         int mds_client_count;
87         struct list_head mds_client_info;
88         struct mds_server_data *mds_server_data;
89 };
90
91 struct ldlm_obd {
92         struct ptlrpc_service *ldlm_service;
93         struct ptlrpc_client *ldlm_client;
94         struct ptlrpc_connection *ldlm_server_conn;
95 };
96
97 struct echo_obd {
98         char *eo_fstype;
99         struct super_block *eo_sb;
100         struct vfsmount *eo_vfsmnt;
101         struct obd_run_ctxt eo_ctxt;
102         spinlock_t eo_lock;
103         __u64 eo_lastino;
104         struct file_operations *eo_fop;
105         struct inode_operations *eo_iop;
106         struct address_space_operations *eo_aops;
107 };
108
109 struct recovd_obd {
110         time_t                recovd_waketime;
111         time_t                recovd_timeout;
112         struct ptlrpc_service *recovd_service;
113         struct ptlrpc_client  *recovd_client;
114         __u32                  recovd_flags; 
115         __u32                  recovd_wakeup_flag; 
116         spinlock_t             recovd_lock;
117         struct list_head      recovd_clients_lh; /* clients managed  */
118         struct list_head      recovd_troubled_lh; /* clients in trouble */
119         wait_queue_head_t     recovd_recovery_waitq;
120         wait_queue_head_t     recovd_ctl_waitq;
121         wait_queue_head_t     recovd_waitq;
122         struct task_struct    *recovd_thread;
123 };
124
125 struct trace_obd {
126         struct obdtrace_opstats *stats;
127 };
128
129 #if 0
130 struct snap_obd {
131         unsigned int snap_index;  /* which snapshot index are we accessing */
132         int snap_tableno;
133 };
134
135 struct raid1_obd {
136         unsigned int raid1_count; /* how many replicas */
137         /* devices to replicate on */
138         struct obd_device *raid1_devlist[MAX_RAID1];
139         /* connections we make */
140         struct obd_conn_info raid1_connections[MAX_RAID1];
141         struct list_head raid1_clients;  /* clients we have */
142 };
143 #endif
144
145 struct ost_obd {
146         struct ptlrpc_service *ost_service;
147
148         struct obd_device *ost_tgt;
149         struct obd_conn ost_conn;
150 };
151
152 struct osc_obd {
153         struct obd_device *osc_tgt;
154         struct ptlrpc_client *osc_client;
155         struct ptlrpc_client *osc_ldlm_client;
156         struct ptlrpc_connection *osc_conn;
157 };
158
159 /* corresponds to one of the obd's */
160 #define MAX_MULTI       16
161 struct obd_device {
162         struct obd_type *obd_type;
163         char *obd_name;
164         __u8 obd_uuid[37];
165
166         int obd_minor;
167         int obd_flags;
168         int obd_refcnt;
169         struct obd_devicename obd_fsname;
170         struct proc_dir_entry *obd_proc_entry;
171         int obd_multi_count;
172         struct obd_conn obd_multi_conn[MAX_MULTI];
173         unsigned int obd_gen_last_id;
174         unsigned long obd_gen_prealloc_quota;
175         struct list_head obd_gen_clients;
176         struct list_head obd_req_list;
177         wait_queue_head_t obd_req_waitq;
178         union {
179                 struct ext2_obd ext2;
180                 struct filter_obd filter;
181                 struct mds_obd mds;
182                 struct ost_obd ost;
183                 struct osc_obd osc;
184                 struct ldlm_obd ldlm;
185                 struct echo_obd echo;
186                 struct recovd_obd recovd;
187                 struct trace_obd trace;
188 #if 0
189                 struct raid1_obd raid1;
190                 struct snap_obd snap;
191 #endif
192         } u;
193 };
194
195 struct obd_ops {
196         int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
197                            void *uarg);
198         int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
199                           obd_count *vallen, void **val);
200         int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
201                           obd_count vallen, void *val);
202         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
203         int (*o_detach)(struct obd_device *dev);
204         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
205         int (*o_cleanup)(struct obd_device *dev);
206         int (*o_connect)(struct obd_conn *conn);
207         int (*o_disconnect)(struct obd_conn *conn);
208
209
210         int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
211         int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
212         int (*o_create)(struct obd_conn *conn,  struct obdo *oa);
213         int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
214         int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
215         int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
216         int (*o_open)(struct obd_conn *conn, struct obdo *oa);
217         int (*o_close)(struct obd_conn *conn, struct obdo *oa);
218         int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
219                       obd_size *count, obd_off offset);
220         int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
221                        obd_size *count, obd_off offset);
222         int (*o_brw)(int rw, struct obd_conn *conn, obd_count num_oa,
223                      struct obdo **oa, obd_count *oa_bufs, struct page **buf,
224                      obd_size *count, obd_off *offset, obd_flag *flags);
225         int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
226                        obd_off offset);
227         int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
228                       obd_off offset);
229         int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
230                          struct obdo *src, obd_size count, obd_off offset);
231         int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
232                       struct obd_conn *srconn, struct obdo *src,
233                       obd_size count, obd_off offset);
234         int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
235                          obd_id *startid, obd_gr group, void *data);
236         int (*o_preprw)(int cmd, struct obd_conn *conn,
237                         int objcount, struct obd_ioobj *obj,
238                         int niocount, struct niobuf *nb,
239                         struct niobuf *res);
240         int (*o_commitrw)(int cmd, struct obd_conn *conn,
241                           int objcount, struct obd_ioobj *obj,
242                           int niocount, struct niobuf *res);
243 };
244
245 #endif