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