1 #ifndef __LINUX_CLASS_OBD_H
2 #define __LINUX_CLASS_OBD_H
5 #include <linux/ext2_fs.h>
6 #include <linux/time.h>
9 #include <linux/obd_ext2.h>
10 #include <linux/obd_snap.h>
11 /* #include <linux/obd_fc.h> */
12 #include <linux/obd_raid1.h>
13 #include <linux/obd_rpc.h>
17 * ======== OBD type Declarations ===========
20 typedef uint64_t obd_id;
21 typedef uint64_t obd_gr;
22 typedef uint64_t obd_time;
23 typedef uint64_t obd_size;
24 typedef uint64_t obd_off;
25 typedef uint64_t obd_blocks;
26 typedef uint32_t obd_blksize;
27 typedef uint32_t obd_mode;
28 typedef uint32_t obd_uid;
29 typedef uint32_t obd_gid;
30 typedef uint32_t obd_flag;
31 typedef uint32_t obd_count;
33 #define OBD_FL_INLINEDATA (0x00000001UL)
34 #define OBD_FL_OBDMDEXISTS (0x00000002UL)
36 #define OBD_INLINESZ 60
37 #define OBD_OBDMDSZ 60
38 /* Note: 64-bit types are 64-bit aligned in structure */
47 obd_blksize o_blksize;
54 obd_count o_generation;
55 obd_flag o_valid; /* hot fields in this obdo */
56 char o_inline[OBD_INLINESZ];
57 char o_obdmd[OBD_OBDMDSZ];
58 struct list_head o_list;
62 #define OBD_MD_FLALL (~0UL)
63 #define OBD_MD_FLID (0x00000001UL)
64 #define OBD_MD_FLATIME (0x00000002UL)
65 #define OBD_MD_FLMTIME (0x00000004UL)
66 #define OBD_MD_FLCTIME (0x00000008UL)
67 #define OBD_MD_FLSIZE (0x00000010UL)
68 #define OBD_MD_FLBLOCKS (0x00000020UL)
69 #define OBD_MD_FLBLKSZ (0x00000040UL)
70 #define OBD_MD_FLMODE (0x00000080UL)
71 #define OBD_MD_FLUID (0x00000100UL)
72 #define OBD_MD_FLGID (0x00000200UL)
73 #define OBD_MD_FLFLAGS (0x00000400UL)
74 #define OBD_MD_FLOBDFLG (0x00000800UL)
75 #define OBD_MD_FLNLINK (0x00001000UL)
76 #define OBD_MD_FLGENER (0x00002000UL)
77 #define OBD_MD_FLINLINE (0x00004000UL)
78 #define OBD_MD_FLOBDMD (0x00008000UL)
79 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG))
82 * ======== OBD Device Declarations ===========
86 #define OBD_PSDEV_MAJOR 186
87 #define MAX_OBD_DEVICES 8
91 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
94 #define OBD_ATTACHED 0x1
95 #define OBD_SET_UP 0x2
98 struct obd_device *oc_dev;
102 /* corresponds to one of the obdx */
104 struct obd_type *obd_type;
109 struct obd_conn obd_multi_conn[MAX_MULTI];
110 unsigned int obd_gen_last_id;
111 unsigned long obd_gen_prealloc_quota;
112 struct list_head obd_gen_clients;
114 struct ext2_obd ext2;
115 struct raid1_obd raid1;
116 struct snap_obd snap;
118 /* struct fc_obd fc; */
123 * ======== OBD Operations Declarations ===========
126 #define OBD_BRW_READ (READ)
127 #define OBD_BRW_WRITE (WRITE)
128 #define OBD_BRW_RWMASK (READ | WRITE)
129 #define OBD_BRW_CREATE (0x00000010UL)
132 int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
134 int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
135 obd_count *vallen, void **val);
136 int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
137 obd_count vallen, void *val);
138 int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
139 int (*o_detach)(struct obd_device *dev);
140 int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
141 int (*o_cleanup)(struct obd_device *dev);
142 int (*o_connect)(struct obd_conn *conn);
143 int (*o_disconnect)(struct obd_conn *conn);
144 int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
145 int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
146 int (*o_create)(struct obd_conn *conn, struct obdo *oa);
147 int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
148 int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
149 int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
150 int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
151 obd_size *count, obd_off offset);
152 int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
153 obd_size *count, obd_off offset);
154 int (*o_brw)(int rw, struct obd_conn *conn, obd_count *num_io,
155 struct obdo **oa, char **buf, obd_size *count,
156 obd_off *offset, obd_flag *flags);
157 int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
159 int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
161 int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
162 struct obdo *src, obd_size count, obd_off offset);
163 int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
164 struct obd_conn *srconn, struct obdo *src,
165 obd_size count, obd_off offset);
166 int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
167 obd_id *startid, obd_gr group, void *data);
170 #define OBT(dev) dev->obd_type->typ_ops
171 #define OBP(dev,op) dev->obd_type->typ_ops->o_ ## op
177 * ======== OBD Metadata Support ===========
180 extern int obd_init_obdo_cache(void);
181 extern void obd_cleanup_obdo_cache(void);
184 static inline int obdo_has_inline(struct obdo *obdo)
186 return (obdo->o_valid & OBD_MD_FLINLINE &&
187 obdo->o_obdflags & OBD_FL_INLINEDATA);
190 static inline int obdo_has_obdmd(struct obdo *obdo)
192 return (obdo->o_valid & OBD_MD_FLOBDMD &&
193 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
196 /* support routines */
197 extern kmem_cache_t *obdo_cachep;
199 static __inline__ struct obdo *obdo_alloc(void)
201 struct obdo *oa = NULL;
203 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
204 memset(oa, 0, sizeof (*oa));
209 static __inline__ void obdo_free(struct obdo *oa)
213 kmem_cache_free(obdo_cachep, oa);
218 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
228 return ERR_PTR(-ENOMEM);
230 memset(oa, 0, sizeof(*oa));
233 if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
242 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
244 unsigned int ia_valid = attr->ia_valid;
246 if (ia_valid & ATTR_ATIME) {
247 oa->o_atime = attr->ia_atime;
248 oa->o_valid |= OBD_MD_FLATIME;
250 if (ia_valid & ATTR_MTIME) {
251 oa->o_mtime = attr->ia_mtime;
252 oa->o_valid |= OBD_MD_FLMTIME;
254 if (ia_valid & ATTR_CTIME) {
255 oa->o_ctime = attr->ia_ctime;
256 oa->o_valid |= OBD_MD_FLCTIME;
258 if (ia_valid & ATTR_SIZE) {
259 oa->o_size = attr->ia_size;
260 oa->o_valid |= OBD_MD_FLSIZE;
262 if (ia_valid & ATTR_MODE) {
263 oa->o_mode = attr->ia_mode;
264 oa->o_valid |= OBD_MD_FLMODE;
265 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
266 oa->o_mode &= ~S_ISGID;
268 if (ia_valid & ATTR_UID)
270 oa->o_uid = attr->ia_uid;
271 oa->o_valid |= OBD_MD_FLUID;
273 if (ia_valid & ATTR_GID) {
274 oa->o_gid = attr->ia_gid;
275 oa->o_valid |= OBD_MD_FLGID;
280 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
282 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
283 src->o_id, src->o_valid, dst->o_id);
284 if ( src->o_valid & OBD_MD_FLATIME )
285 dst->o_atime = src->o_atime;
286 if ( src->o_valid & OBD_MD_FLMTIME )
287 dst->o_mtime = src->o_mtime;
288 if ( src->o_valid & OBD_MD_FLCTIME )
289 dst->o_ctime = src->o_ctime;
290 if ( src->o_valid & OBD_MD_FLSIZE )
291 dst->o_size = src->o_size;
292 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
293 dst->o_blocks = src->o_blocks;
294 if ( src->o_valid & OBD_MD_FLBLKSZ )
295 dst->o_blksize = src->o_blksize;
296 if ( src->o_valid & OBD_MD_FLMODE )
297 dst->o_mode = src->o_mode;
298 if ( src->o_valid & OBD_MD_FLUID )
299 dst->o_uid = src->o_uid;
300 if ( src->o_valid & OBD_MD_FLGID )
301 dst->o_gid = src->o_gid;
302 if ( src->o_valid & OBD_MD_FLFLAGS )
303 dst->o_flags = src->o_flags;
305 if ( src->o_valid & OBD_MD_FLOBDFLG )
306 dst->o_obdflags = src->o_obdflags;
308 if ( src->o_valid & OBD_MD_FLNLINK )
309 dst->o_nlink = src->o_nlink;
310 if ( src->o_valid & OBD_MD_FLGENER )
311 dst->o_generation = src->o_generation;
312 if ( src->o_valid & OBD_MD_FLINLINE &&
313 src->o_obdflags & OBD_FL_INLINEDATA) {
314 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
315 dst->o_obdflags |= OBD_FL_INLINEDATA;
317 if ( src->o_valid & OBD_MD_FLOBDMD &&
318 src->o_obdflags & OBD_FL_OBDMDEXISTS) {
319 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
320 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
323 dst->o_valid |= src->o_valid;
326 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
328 CDEBUG(D_INODE, "src inode %ld, dst obdo %Ld valid 0x%08x\n",
329 src->i_ino, dst->o_id, dst->o_valid);
330 if ( dst->o_valid & OBD_MD_FLID )
331 dst->o_id = src->i_ino;
332 if ( dst->o_valid & OBD_MD_FLATIME )
333 dst->o_atime = src->i_atime;
334 if ( dst->o_valid & OBD_MD_FLMTIME )
335 dst->o_mtime = src->i_mtime;
336 if ( dst->o_valid & OBD_MD_FLCTIME )
337 dst->o_ctime = src->i_ctime;
338 if ( dst->o_valid & OBD_MD_FLSIZE )
339 dst->o_size = src->i_size;
340 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
341 dst->o_blocks = src->i_blocks;
342 if ( dst->o_valid & OBD_MD_FLBLKSZ )
343 dst->o_blksize = src->i_blksize;
344 if ( dst->o_valid & OBD_MD_FLMODE )
345 dst->o_mode = src->i_mode;
346 if ( dst->o_valid & OBD_MD_FLUID )
347 dst->o_uid = src->i_uid;
348 if ( dst->o_valid & OBD_MD_FLGID )
349 dst->o_gid = src->i_gid;
350 if ( dst->o_valid & OBD_MD_FLFLAGS )
351 dst->o_flags = src->i_flags;
352 if ( dst->o_valid & OBD_MD_FLNLINK )
353 dst->o_nlink = src->i_nlink;
354 if ( dst->o_valid & OBD_MD_FLGENER )
355 dst->o_generation = src->i_generation;
358 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
361 CDEBUG(D_INODE, "src obdo %Ld valid 0x%08x, dst inode %ld\n",
362 src->o_id, src->o_valid, dst->i_ino);
363 if ( src->o_valid & OBD_MD_FLID )
364 dst->i_ino = src->o_id;
365 if ( src->o_valid & OBD_MD_FLATIME )
366 dst->i_atime = src->o_atime;
367 if ( src->o_valid & OBD_MD_FLMTIME )
368 dst->i_mtime = src->o_mtime;
369 if ( src->o_valid & OBD_MD_FLCTIME )
370 dst->i_ctime = src->o_ctime;
371 if ( src->o_valid & OBD_MD_FLSIZE )
372 dst->i_size = src->o_size;
373 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
374 dst->i_blocks = src->o_blocks;
375 if ( src->o_valid & OBD_MD_FLBLKSZ )
376 dst->i_blksize = src->o_blksize;
377 if ( src->o_valid & OBD_MD_FLMODE )
378 dst->i_mode = src->o_mode;
379 if ( src->o_valid & OBD_MD_FLUID )
380 dst->i_uid = src->o_uid;
381 if ( src->o_valid & OBD_MD_FLGID )
382 dst->i_gid = src->o_gid;
383 if ( src->o_valid & OBD_MD_FLFLAGS )
384 dst->i_flags = src->o_flags;
385 if ( src->o_valid & OBD_MD_FLNLINK )
386 dst->i_nlink = src->o_nlink;
387 if ( src->o_valid & OBD_MD_FLGENER )
388 dst->i_generation = src->o_generation;
391 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
392 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
397 if ( compare & OBD_MD_FLATIME )
398 res = (res || (dst->o_atime != src->o_atime));
399 if ( compare & OBD_MD_FLMTIME )
400 res = (res || (dst->o_mtime != src->o_mtime));
401 if ( compare & OBD_MD_FLCTIME )
402 res = (res || (dst->o_ctime != src->o_ctime));
403 if ( compare & OBD_MD_FLSIZE )
404 res = (res || (dst->o_size != src->o_size));
405 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
406 res = (res || (dst->o_blocks != src->o_blocks));
407 if ( compare & OBD_MD_FLBLKSZ )
408 res = (res || (dst->o_blksize != src->o_blksize));
409 if ( compare & OBD_MD_FLMODE )
410 res = (res || (dst->o_mode != src->o_mode));
411 if ( compare & OBD_MD_FLUID )
412 res = (res || (dst->o_uid != src->o_uid));
413 if ( compare & OBD_MD_FLGID )
414 res = (res || (dst->o_gid != src->o_gid));
415 if ( compare & OBD_MD_FLFLAGS )
416 res = (res || (dst->o_flags != src->o_flags));
417 if ( compare & OBD_MD_FLNLINK )
418 res = (res || (dst->o_nlink != src->o_nlink));
419 if ( compare & OBD_MD_FLGENER )
420 res = (res || (dst->o_generation != src->o_generation));
421 /* XXX Don't know if thses should be included here - wasn't previously
422 if ( compare & OBD_MD_FLINLINE )
423 res = (res || memcmp(dst->o_inline, src->o_inline));
424 if ( compare & OBD_MD_FLOBDMD )
425 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
432 int obd_register_type(struct obd_ops *ops, char *nm);
433 int obd_unregister_type(char *nm);
436 struct list_head cli_chain;
437 struct obd_device *cli_obd;
439 unsigned long cli_prealloc_quota;
440 struct list_head cli_prealloc_inodes;
444 struct obd_prealloc_inode {
445 struct list_head obd_prealloc_chain;
449 /* generic operations shared by various OBD types */
450 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
451 int gen_multi_cleanup(struct obd_device *obddev);
452 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
453 int gen_multi_detach(struct obd_device *obddev);
454 int gen_connect (struct obd_conn *conn);
455 int gen_disconnect(struct obd_conn *conn);
456 struct obd_client *gen_client(struct obd_conn *);
457 int gen_cleanup(struct obd_device *obddev);
458 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
459 struct obd_conn *src_conn, struct obdo *src,
460 obd_size count, obd_off offset);
465 * ======== OBD IOCL Declarations ===========
476 /* for preallocation */
477 struct oic_prealloc_s {
479 uint32_t alloc; /* user sets it to the number of inodes
480 * requesting to be preallocated. kernel
481 * sets it to the actual number of
482 * succesfully preallocated inodes */
483 obd_id ids[32]; /* actual inode numbers */
486 /* for getattr, setattr, create, destroy */
492 /* for copy, migrate */
494 uint32_t src_conn_id;
496 uint32_t dst_conn_id;
509 /* for punch, sync */
518 #define OBD_IOC_CREATE _IOR ('f', 3, long)
519 #define OBD_IOC_SETUP _IOW ('f', 4, long)
520 #define OBD_IOC_CLEANUP _IO ('f', 5 )
521 #define OBD_IOC_DESTROY _IOW ('f', 6, long)
522 #define OBD_IOC_PREALLOCATE _IOWR('f', 7, long)
523 #define OBD_IOC_DEC_USE_COUNT _IO ('f', 8 )
524 #define OBD_IOC_SETATTR _IOW ('f', 9, long)
525 #define OBD_IOC_GETATTR _IOR ('f', 10, long)
526 #define OBD_IOC_READ _IOWR('f', 11, long)
527 #define OBD_IOC_WRITE _IOWR('f', 12, long)
528 #define OBD_IOC_CONNECT _IOR ('f', 13, long)
529 #define OBD_IOC_DISCONNECT _IOW ('f', 14, long)
530 #define OBD_IOC_STATFS _IOWR('f', 15, long)
531 #define OBD_IOC_SYNC _IOR ('f', 16, long)
532 #define OBD_IOC_READ2 _IOWR('f', 17, long)
533 #define OBD_IOC_FORMAT _IOWR('f', 18, long)
534 #define OBD_IOC_PARTITION _IOWR('f', 19, long)
535 #define OBD_IOC_ATTACH _IOWR('f', 20, long)
536 #define OBD_IOC_DETACH _IOWR('f', 21, long)
537 #define OBD_IOC_COPY _IOWR('f', 22, long)
538 #define OBD_IOC_MIGR _IOWR('f', 23, long)
540 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 32 )
544 extern void obd_sysctl_init (void);
545 extern void obd_sysctl_clean (void);
547 #define CHKCONN(conn) do { if (!gen_client(conn)) {\
548 printk("%s %d invalid client %u\n", __FILE__, __LINE__, \
550 return -EINVAL; }} while (0)
554 #endif /* __LINUX_CLASS_OBD_H */