1 #ifndef __LINUX_CLASS_OBD_H
2 #define __LINUX_CLASS_OBD_H
4 * Copyright (C) 2001 Cluster File Systems, Inc.
6 * This code is issued under the GNU General Public License.
7 * See the file COPYING in this distribution
11 #include <linux/time.h>
12 #include <linux/obd.h>
14 #include <linux/obd_ext2.h>
15 #include <linux/obd_snap.h>
16 #include <linux/obd_trace.h>
17 /* #include <linux/obd_fc.h> */
18 #include <linux/obd_raid1.h>
19 #include <linux/obd_rpc.h>
23 * ======== OBD type Declarations ===========
26 typedef uint64_t obd_id;
27 typedef uint64_t obd_gr;
28 typedef uint64_t obd_time;
29 typedef uint64_t obd_size;
30 typedef uint64_t obd_off;
31 typedef uint64_t obd_blocks;
32 typedef uint32_t obd_blksize;
33 typedef uint32_t obd_mode;
34 typedef uint32_t obd_uid;
35 typedef uint32_t obd_gid;
36 typedef uint32_t obd_rdev;
37 typedef uint32_t obd_flag;
38 typedef uint32_t obd_count;
40 #define OBD_FL_INLINEDATA (0x00000001UL)
41 #define OBD_FL_OBDMDEXISTS (0x00000002UL)
43 #define OBD_INLINESZ 60
44 #define OBD_OBDMDSZ 60
45 /* Note: 64-bit types are 64-bit aligned in structure */
54 obd_blksize o_blksize;
61 obd_count o_generation;
62 obd_flag o_valid; /* hot fields in this obdo */
63 char o_inline[OBD_INLINESZ];
64 char o_obdmd[OBD_OBDMDSZ];
65 struct list_head o_list;
69 #define OBD_MD_FLALL (~0UL)
70 #define OBD_MD_FLID (0x00000001UL)
71 #define OBD_MD_FLATIME (0x00000002UL)
72 #define OBD_MD_FLMTIME (0x00000004UL)
73 #define OBD_MD_FLCTIME (0x00000008UL)
74 #define OBD_MD_FLSIZE (0x00000010UL)
75 #define OBD_MD_FLBLOCKS (0x00000020UL)
76 #define OBD_MD_FLBLKSZ (0x00000040UL)
77 #define OBD_MD_FLMODE (0x00000080UL)
78 #define OBD_MD_FLUID (0x00000100UL)
79 #define OBD_MD_FLGID (0x00000200UL)
80 #define OBD_MD_FLFLAGS (0x00000400UL)
81 #define OBD_MD_FLOBDFLG (0x00000800UL)
82 #define OBD_MD_FLNLINK (0x00001000UL)
83 #define OBD_MD_FLGENER (0x00002000UL)
84 #define OBD_MD_FLINLINE (0x00004000UL)
85 #define OBD_MD_FLOBDMD (0x00008000UL)
86 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS))
89 * ======== OBD Device Declarations ===========
93 #define OBD_PSDEV_MAJOR 186
94 #define MAX_OBD_DEVICES 8
98 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
101 #define OBD_ATTACHED 0x1
102 #define OBD_SET_UP 0x2
105 struct obd_device *oc_dev;
112 struct dentry *dentry; /* file system obd device names */
113 __u8 _uuid[16]; /* uuid obd device names */
116 /* corresponds to one of the obdx */
118 struct obd_type *obd_type;
122 obd_devicename obd_fsname;
123 struct proc_dir_entry *obd_proc_entry;
125 struct obd_conn obd_multi_conn[MAX_MULTI];
126 unsigned int obd_gen_last_id;
127 unsigned long obd_gen_prealloc_quota;
128 struct list_head obd_gen_clients;
130 struct ext2_obd ext2;
131 struct raid1_obd raid1;
132 struct snap_obd snap;
133 struct trace_obd trace;
134 /* struct fc_obd fc; */
138 extern struct proc_dir_entry *proc_lustre_register_obd_device(struct obd_device *obd);
139 extern void proc_lustre_release_obd_device(struct obd_device *obd);
140 extern void proc_lustre_remove_obd_entry(const char* name, struct obd_device *obd);
144 * ======== OBD Operations Declarations ===========
147 #define OBD_BRW_READ (READ)
148 #define OBD_BRW_WRITE (WRITE)
149 #define OBD_BRW_RWMASK (READ | WRITE)
150 #define OBD_BRW_CREATE (0x00000010UL)
153 int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
155 int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
156 obd_count *vallen, void **val);
157 int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
158 obd_count vallen, void *val);
159 int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
160 int (*o_detach)(struct obd_device *dev);
161 int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
162 int (*o_cleanup)(struct obd_device *dev);
163 int (*o_connect)(struct obd_conn *conn);
164 int (*o_disconnect)(struct obd_conn *conn);
165 int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
166 int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
167 int (*o_create)(struct obd_conn *conn, struct obdo *oa);
168 int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
169 int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
170 int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
171 int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
172 obd_size *count, obd_off offset);
173 int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
174 obd_size *count, obd_off offset);
175 int (*o_brw)(int rw, struct obd_conn *conn, obd_count num_oa,
176 struct obdo **oa, obd_count *oa_bufs, struct page **buf,
177 obd_size *count, obd_off *offset, obd_flag *flags);
178 int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
180 int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
182 int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
183 struct obdo *src, obd_size count, obd_off offset);
184 int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
185 struct obd_conn *srconn, struct obdo *src,
186 obd_size count, obd_off offset);
187 int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
188 obd_id *startid, obd_gr group, void *data);
191 #define OBT(dev) dev->obd_type->typ_ops
192 #define OBP(dev,op) dev->obd_type->typ_ops->o_ ## op
194 /* This value is not arbitrarily chosen. KIO_STATIC_PAGES from linux/iobuf.h */
195 #define MAX_IOVEC (KIO_STATIC_PAGES - 1)
199 * ======== OBD Metadata Support ===========
202 extern int obd_init_obdo_cache(void);
203 extern void obd_cleanup_obdo_cache(void);
206 static inline int obdo_has_inline(struct obdo *obdo)
208 return (obdo->o_valid & OBD_MD_FLINLINE &&
209 obdo->o_obdflags & OBD_FL_INLINEDATA);
212 static inline int obdo_has_obdmd(struct obdo *obdo)
214 return (obdo->o_valid & OBD_MD_FLOBDMD &&
215 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
218 /* support routines */
219 extern kmem_cache_t *obdo_cachep;
221 static __inline__ struct obdo *obdo_alloc(void)
223 struct obdo *oa = NULL;
225 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
226 memset(oa, 0, sizeof (*oa));
231 static __inline__ void obdo_free(struct obdo *oa)
235 kmem_cache_free(obdo_cachep, oa);
240 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
250 return ERR_PTR(-ENOMEM);
255 if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
264 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
266 unsigned int ia_valid = attr->ia_valid;
268 if (ia_valid & ATTR_ATIME) {
269 oa->o_atime = attr->ia_atime;
270 oa->o_valid |= OBD_MD_FLATIME;
272 if (ia_valid & ATTR_MTIME) {
273 oa->o_mtime = attr->ia_mtime;
274 oa->o_valid |= OBD_MD_FLMTIME;
276 if (ia_valid & ATTR_CTIME) {
277 oa->o_ctime = attr->ia_ctime;
278 oa->o_valid |= OBD_MD_FLCTIME;
280 if (ia_valid & ATTR_SIZE) {
281 oa->o_size = attr->ia_size;
282 oa->o_valid |= OBD_MD_FLSIZE;
284 if (ia_valid & ATTR_MODE) {
285 oa->o_mode = attr->ia_mode;
286 oa->o_valid |= OBD_MD_FLMODE;
287 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
288 oa->o_mode &= ~S_ISGID;
290 if (ia_valid & ATTR_UID)
292 oa->o_uid = attr->ia_uid;
293 oa->o_valid |= OBD_MD_FLUID;
295 if (ia_valid & ATTR_GID) {
296 oa->o_gid = attr->ia_gid;
297 oa->o_valid |= OBD_MD_FLGID;
302 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
304 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
305 src->o_id, src->o_valid, dst->o_id);
306 if ( src->o_valid & OBD_MD_FLATIME )
307 dst->o_atime = src->o_atime;
308 if ( src->o_valid & OBD_MD_FLMTIME )
309 dst->o_mtime = src->o_mtime;
310 if ( src->o_valid & OBD_MD_FLCTIME )
311 dst->o_ctime = src->o_ctime;
312 if ( src->o_valid & OBD_MD_FLSIZE )
313 dst->o_size = src->o_size;
314 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
315 dst->o_blocks = src->o_blocks;
316 if ( src->o_valid & OBD_MD_FLBLKSZ )
317 dst->o_blksize = src->o_blksize;
318 if ( src->o_valid & OBD_MD_FLMODE )
319 dst->o_mode = src->o_mode;
320 if ( src->o_valid & OBD_MD_FLUID )
321 dst->o_uid = src->o_uid;
322 if ( src->o_valid & OBD_MD_FLGID )
323 dst->o_gid = src->o_gid;
324 if ( src->o_valid & OBD_MD_FLFLAGS )
325 dst->o_flags = src->o_flags;
327 if ( src->o_valid & OBD_MD_FLOBDFLG )
328 dst->o_obdflags = src->o_obdflags;
330 if ( src->o_valid & OBD_MD_FLNLINK )
331 dst->o_nlink = src->o_nlink;
332 if ( src->o_valid & OBD_MD_FLGENER )
333 dst->o_generation = src->o_generation;
334 if ( src->o_valid & OBD_MD_FLINLINE &&
335 src->o_obdflags & OBD_FL_INLINEDATA) {
336 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
337 dst->o_obdflags |= OBD_FL_INLINEDATA;
339 if ( src->o_valid & OBD_MD_FLOBDMD &&
340 src->o_obdflags & OBD_FL_OBDMDEXISTS) {
341 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
342 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
345 dst->o_valid |= src->o_valid;
348 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
350 if ( dst->o_valid & OBD_MD_FLID )
351 dst->o_id = src->i_ino;
352 if ( dst->o_valid & OBD_MD_FLATIME )
353 dst->o_atime = src->i_atime;
354 if ( dst->o_valid & OBD_MD_FLMTIME )
355 dst->o_mtime = src->i_mtime;
356 if ( dst->o_valid & OBD_MD_FLCTIME )
357 dst->o_ctime = src->i_ctime;
358 if ( dst->o_valid & OBD_MD_FLSIZE )
359 dst->o_size = src->i_size;
360 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
361 dst->o_blocks = src->i_blocks;
362 if ( dst->o_valid & OBD_MD_FLBLKSZ )
363 dst->o_blksize = src->i_blksize;
364 if ( dst->o_valid & OBD_MD_FLMODE )
365 dst->o_mode = src->i_mode;
366 if ( dst->o_valid & OBD_MD_FLUID )
367 dst->o_uid = src->i_uid;
368 if ( dst->o_valid & OBD_MD_FLGID )
369 dst->o_gid = src->i_gid;
370 if ( dst->o_valid & OBD_MD_FLFLAGS )
371 dst->o_flags = src->i_flags;
372 if ( dst->o_valid & OBD_MD_FLNLINK )
373 dst->o_nlink = src->i_nlink;
374 if ( dst->o_valid & OBD_MD_FLGENER )
375 dst->o_generation = src->i_generation;
378 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
381 if ( src->o_valid & OBD_MD_FLID )
382 dst->i_ino = src->o_id;
383 if ( src->o_valid & OBD_MD_FLATIME )
384 dst->i_atime = src->o_atime;
385 if ( src->o_valid & OBD_MD_FLMTIME )
386 dst->i_mtime = src->o_mtime;
387 if ( src->o_valid & OBD_MD_FLCTIME )
388 dst->i_ctime = src->o_ctime;
389 if ( src->o_valid & OBD_MD_FLSIZE )
390 dst->i_size = src->o_size;
391 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
392 dst->i_blocks = src->o_blocks;
393 if ( src->o_valid & OBD_MD_FLBLKSZ )
394 dst->i_blksize = src->o_blksize;
395 if ( src->o_valid & OBD_MD_FLMODE )
396 dst->i_mode = src->o_mode;
397 if ( src->o_valid & OBD_MD_FLUID )
398 dst->i_uid = src->o_uid;
399 if ( src->o_valid & OBD_MD_FLGID )
400 dst->i_gid = src->o_gid;
401 if ( src->o_valid & OBD_MD_FLFLAGS )
402 dst->i_flags = src->o_flags;
403 if ( src->o_valid & OBD_MD_FLNLINK )
404 dst->i_nlink = src->o_nlink;
405 if ( src->o_valid & OBD_MD_FLGENER )
406 dst->i_generation = src->o_generation;
409 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
410 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
415 if ( compare & OBD_MD_FLATIME )
416 res = (res || (dst->o_atime != src->o_atime));
417 if ( compare & OBD_MD_FLMTIME )
418 res = (res || (dst->o_mtime != src->o_mtime));
419 if ( compare & OBD_MD_FLCTIME )
420 res = (res || (dst->o_ctime != src->o_ctime));
421 if ( compare & OBD_MD_FLSIZE )
422 res = (res || (dst->o_size != src->o_size));
423 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
424 res = (res || (dst->o_blocks != src->o_blocks));
425 if ( compare & OBD_MD_FLBLKSZ )
426 res = (res || (dst->o_blksize != src->o_blksize));
427 if ( compare & OBD_MD_FLMODE )
428 res = (res || (dst->o_mode != src->o_mode));
429 if ( compare & OBD_MD_FLUID )
430 res = (res || (dst->o_uid != src->o_uid));
431 if ( compare & OBD_MD_FLGID )
432 res = (res || (dst->o_gid != src->o_gid));
433 if ( compare & OBD_MD_FLFLAGS )
434 res = (res || (dst->o_flags != src->o_flags));
435 if ( compare & OBD_MD_FLNLINK )
436 res = (res || (dst->o_nlink != src->o_nlink));
437 if ( compare & OBD_MD_FLGENER )
438 res = (res || (dst->o_generation != src->o_generation));
439 /* XXX Don't know if thses should be included here - wasn't previously
440 if ( compare & OBD_MD_FLINLINE )
441 res = (res || memcmp(dst->o_inline, src->o_inline));
442 if ( compare & OBD_MD_FLOBDMD )
443 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
450 int obd_register_type(struct obd_ops *ops, char *nm);
451 int obd_unregister_type(char *nm);
454 struct list_head cli_chain;
455 struct obd_device *cli_obd;
457 unsigned long cli_prealloc_quota;
458 struct list_head cli_prealloc_inodes;
462 struct obd_prealloc_inode {
463 struct list_head obd_prealloc_chain;
467 /* generic operations shared by various OBD types */
468 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
469 int gen_multi_cleanup(struct obd_device *obddev);
470 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
471 int gen_multi_detach(struct obd_device *obddev);
472 int gen_connect (struct obd_conn *conn);
473 int gen_disconnect(struct obd_conn *conn);
474 struct obd_client *gen_client(const struct obd_conn *);
475 int gen_cleanup(struct obd_device *obddev);
476 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
477 struct obd_conn *src_conn, struct obdo *src,
478 obd_size count, obd_off offset);
483 * ======== OBD IOCL Declarations ===========
494 /* for preallocation */
495 struct oic_prealloc_s {
497 uint32_t alloc; /* user sets it to the number of inodes
498 * requesting to be preallocated. kernel
499 * sets it to the actual number of
500 * succesfully preallocated inodes */
501 obd_id ids[32]; /* actual inode numbers */
504 /* for getattr, setattr, create, destroy */
510 /* for copy, migrate */
512 uint32_t src_conn_id;
514 uint32_t dst_conn_id;
527 /* for punch, sync */
536 #define OBD_IOC_CREATE _IOR ('f', 3, long)
537 #define OBD_IOC_SETUP _IOW ('f', 4, long)
538 #define OBD_IOC_CLEANUP _IO ('f', 5 )
539 #define OBD_IOC_DESTROY _IOW ('f', 6, long)
540 #define OBD_IOC_PREALLOCATE _IOWR('f', 7, long)
541 #define OBD_IOC_DEC_USE_COUNT _IO ('f', 8 )
542 #define OBD_IOC_SETATTR _IOW ('f', 9, long)
543 #define OBD_IOC_GETATTR _IOR ('f', 10, long)
544 #define OBD_IOC_READ _IOWR('f', 11, long)
545 #define OBD_IOC_WRITE _IOWR('f', 12, long)
546 #define OBD_IOC_CONNECT _IOR ('f', 13, long)
547 #define OBD_IOC_DISCONNECT _IOW ('f', 14, long)
548 #define OBD_IOC_STATFS _IOWR('f', 15, long)
549 #define OBD_IOC_SYNC _IOR ('f', 16, long)
550 #define OBD_IOC_READ2 _IOWR('f', 17, long)
551 #define OBD_IOC_FORMAT _IOWR('f', 18, long)
552 #define OBD_IOC_PARTITION _IOWR('f', 19, long)
553 #define OBD_IOC_ATTACH _IOWR('f', 20, long)
554 #define OBD_IOC_DETACH _IOWR('f', 21, long)
555 #define OBD_IOC_COPY _IOWR('f', 22, long)
556 #define OBD_IOC_MIGR _IOWR('f', 23, long)
557 #define OBD_IOC_PUNCH _IOWR('f', 24, long)
559 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 32 )
563 extern void obd_sysctl_init (void);
564 extern void obd_sysctl_clean (void);
566 #define CHKCONN(conn) do { if (!gen_client(conn)) {\
567 printk("%s %d invalid client %u\n", __FILE__, __LINE__, \
569 return -EINVAL; }} while (0)
573 #endif /* __LINUX_CLASS_OBD_H */