1 #ifndef __LINUX_CLASS_OBD_H
2 #define __LINUX_CLASS_OBD_H
5 #include <linux/time.h>
8 #include <linux/obd_ext2.h>
9 #include <linux/obd_snap.h>
10 #include <linux/obd_trace.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 | OBD_MD_FLBLOCKS))
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;
103 struct dentry *dentry; /* file system obd device names */
104 __u8 _uuid[16]; /* uuid obd device names */
107 /* corresponds to one of the obdx */
109 struct obd_type *obd_type;
113 obd_devicename obd_fsname;
114 struct proc_dir_entry *obd_proc_entry;
116 struct obd_conn obd_multi_conn[MAX_MULTI];
117 unsigned int obd_gen_last_id;
118 unsigned long obd_gen_prealloc_quota;
119 struct list_head obd_gen_clients;
121 struct ext2_obd ext2;
122 struct raid1_obd raid1;
123 struct snap_obd snap;
124 struct trace_obd trace;
125 /* struct fc_obd fc; */
129 extern struct proc_dir_entry *proc_lustre_register_obd_device(struct obd_device *obd);
130 extern void proc_lustre_release_obd_device(struct obd_device *obd);
131 extern void proc_lustre_remove_obd_entry(const char* name, struct obd_device *obd);
135 * ======== OBD Operations Declarations ===========
138 #define OBD_BRW_READ (READ)
139 #define OBD_BRW_WRITE (WRITE)
140 #define OBD_BRW_RWMASK (READ | WRITE)
141 #define OBD_BRW_CREATE (0x00000010UL)
144 int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
146 int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
147 obd_count *vallen, void **val);
148 int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
149 obd_count vallen, void *val);
150 int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
151 int (*o_detach)(struct obd_device *dev);
152 int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
153 int (*o_cleanup)(struct obd_device *dev);
154 int (*o_connect)(struct obd_conn *conn);
155 int (*o_disconnect)(struct obd_conn *conn);
156 int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
157 int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
158 int (*o_create)(struct obd_conn *conn, struct obdo *oa);
159 int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
160 int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
161 int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
162 int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
163 obd_size *count, obd_off offset);
164 int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
165 obd_size *count, obd_off offset);
166 int (*o_brw)(int rw, struct obd_conn *conn, obd_count num_oa,
167 struct obdo **oa, obd_count *oa_bufs, char **buf,
168 obd_size *count, obd_off *offset, obd_flag *flags);
169 int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
171 int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
173 int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
174 struct obdo *src, obd_size count, obd_off offset);
175 int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
176 struct obd_conn *srconn, struct obdo *src,
177 obd_size count, obd_off offset);
178 int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
179 obd_id *startid, obd_gr group, void *data);
182 #define OBT(dev) dev->obd_type->typ_ops
183 #define OBP(dev,op) dev->obd_type->typ_ops->o_ ## op
185 /* This value is not arbitrarily chosen. KIO_STATIC_PAGES from linux/iobuf.h */
186 #define MAX_IOVEC (KIO_STATIC_PAGES - 1)
190 * ======== OBD Metadata Support ===========
193 extern int obd_init_obdo_cache(void);
194 extern void obd_cleanup_obdo_cache(void);
197 static inline int obdo_has_inline(struct obdo *obdo)
199 return (obdo->o_valid & OBD_MD_FLINLINE &&
200 obdo->o_obdflags & OBD_FL_INLINEDATA);
203 static inline int obdo_has_obdmd(struct obdo *obdo)
205 return (obdo->o_valid & OBD_MD_FLOBDMD &&
206 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
209 /* support routines */
210 extern kmem_cache_t *obdo_cachep;
212 static __inline__ struct obdo *obdo_alloc(void)
214 struct obdo *oa = NULL;
216 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
217 memset(oa, 0, sizeof (*oa));
222 static __inline__ void obdo_free(struct obdo *oa)
226 kmem_cache_free(obdo_cachep, oa);
231 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
241 return ERR_PTR(-ENOMEM);
243 memset(oa, 0, sizeof(*oa));
246 if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
255 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
257 unsigned int ia_valid = attr->ia_valid;
259 if (ia_valid & ATTR_ATIME) {
260 oa->o_atime = attr->ia_atime;
261 oa->o_valid |= OBD_MD_FLATIME;
263 if (ia_valid & ATTR_MTIME) {
264 oa->o_mtime = attr->ia_mtime;
265 oa->o_valid |= OBD_MD_FLMTIME;
267 if (ia_valid & ATTR_CTIME) {
268 oa->o_ctime = attr->ia_ctime;
269 oa->o_valid |= OBD_MD_FLCTIME;
271 if (ia_valid & ATTR_SIZE) {
272 oa->o_size = attr->ia_size;
273 oa->o_valid |= OBD_MD_FLSIZE;
275 if (ia_valid & ATTR_MODE) {
276 oa->o_mode = attr->ia_mode;
277 oa->o_valid |= OBD_MD_FLMODE;
278 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
279 oa->o_mode &= ~S_ISGID;
281 if (ia_valid & ATTR_UID)
283 oa->o_uid = attr->ia_uid;
284 oa->o_valid |= OBD_MD_FLUID;
286 if (ia_valid & ATTR_GID) {
287 oa->o_gid = attr->ia_gid;
288 oa->o_valid |= OBD_MD_FLGID;
293 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
295 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
296 src->o_id, src->o_valid, dst->o_id);
297 if ( src->o_valid & OBD_MD_FLATIME )
298 dst->o_atime = src->o_atime;
299 if ( src->o_valid & OBD_MD_FLMTIME )
300 dst->o_mtime = src->o_mtime;
301 if ( src->o_valid & OBD_MD_FLCTIME )
302 dst->o_ctime = src->o_ctime;
303 if ( src->o_valid & OBD_MD_FLSIZE )
304 dst->o_size = src->o_size;
305 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
306 dst->o_blocks = src->o_blocks;
307 if ( src->o_valid & OBD_MD_FLBLKSZ )
308 dst->o_blksize = src->o_blksize;
309 if ( src->o_valid & OBD_MD_FLMODE )
310 dst->o_mode = src->o_mode;
311 if ( src->o_valid & OBD_MD_FLUID )
312 dst->o_uid = src->o_uid;
313 if ( src->o_valid & OBD_MD_FLGID )
314 dst->o_gid = src->o_gid;
315 if ( src->o_valid & OBD_MD_FLFLAGS )
316 dst->o_flags = src->o_flags;
318 if ( src->o_valid & OBD_MD_FLOBDFLG )
319 dst->o_obdflags = src->o_obdflags;
321 if ( src->o_valid & OBD_MD_FLNLINK )
322 dst->o_nlink = src->o_nlink;
323 if ( src->o_valid & OBD_MD_FLGENER )
324 dst->o_generation = src->o_generation;
325 if ( src->o_valid & OBD_MD_FLINLINE &&
326 src->o_obdflags & OBD_FL_INLINEDATA) {
327 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
328 dst->o_obdflags |= OBD_FL_INLINEDATA;
330 if ( src->o_valid & OBD_MD_FLOBDMD &&
331 src->o_obdflags & OBD_FL_OBDMDEXISTS) {
332 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
333 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
336 dst->o_valid |= src->o_valid;
339 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
341 if ( dst->o_valid & OBD_MD_FLID )
342 dst->o_id = src->i_ino;
343 if ( dst->o_valid & OBD_MD_FLATIME )
344 dst->o_atime = src->i_atime;
345 if ( dst->o_valid & OBD_MD_FLMTIME )
346 dst->o_mtime = src->i_mtime;
347 if ( dst->o_valid & OBD_MD_FLCTIME )
348 dst->o_ctime = src->i_ctime;
349 if ( dst->o_valid & OBD_MD_FLSIZE )
350 dst->o_size = src->i_size;
351 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
352 dst->o_blocks = src->i_blocks;
353 if ( dst->o_valid & OBD_MD_FLBLKSZ )
354 dst->o_blksize = src->i_blksize;
355 if ( dst->o_valid & OBD_MD_FLMODE )
356 dst->o_mode = src->i_mode;
357 if ( dst->o_valid & OBD_MD_FLUID )
358 dst->o_uid = src->i_uid;
359 if ( dst->o_valid & OBD_MD_FLGID )
360 dst->o_gid = src->i_gid;
361 if ( dst->o_valid & OBD_MD_FLFLAGS )
362 dst->o_flags = src->i_flags;
363 if ( dst->o_valid & OBD_MD_FLNLINK )
364 dst->o_nlink = src->i_nlink;
365 if ( dst->o_valid & OBD_MD_FLGENER )
366 dst->o_generation = src->i_generation;
369 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
372 if ( src->o_valid & OBD_MD_FLID )
373 dst->i_ino = src->o_id;
374 if ( src->o_valid & OBD_MD_FLATIME )
375 dst->i_atime = src->o_atime;
376 if ( src->o_valid & OBD_MD_FLMTIME )
377 dst->i_mtime = src->o_mtime;
378 if ( src->o_valid & OBD_MD_FLCTIME )
379 dst->i_ctime = src->o_ctime;
380 if ( src->o_valid & OBD_MD_FLSIZE )
381 dst->i_size = src->o_size;
382 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
383 dst->i_blocks = src->o_blocks;
384 if ( src->o_valid & OBD_MD_FLBLKSZ )
385 dst->i_blksize = src->o_blksize;
386 if ( src->o_valid & OBD_MD_FLMODE )
387 dst->i_mode = src->o_mode;
388 if ( src->o_valid & OBD_MD_FLUID )
389 dst->i_uid = src->o_uid;
390 if ( src->o_valid & OBD_MD_FLGID )
391 dst->i_gid = src->o_gid;
392 if ( src->o_valid & OBD_MD_FLFLAGS )
393 dst->i_flags = src->o_flags;
394 if ( src->o_valid & OBD_MD_FLNLINK )
395 dst->i_nlink = src->o_nlink;
396 if ( src->o_valid & OBD_MD_FLGENER )
397 dst->i_generation = src->o_generation;
400 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
401 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
406 if ( compare & OBD_MD_FLATIME )
407 res = (res || (dst->o_atime != src->o_atime));
408 if ( compare & OBD_MD_FLMTIME )
409 res = (res || (dst->o_mtime != src->o_mtime));
410 if ( compare & OBD_MD_FLCTIME )
411 res = (res || (dst->o_ctime != src->o_ctime));
412 if ( compare & OBD_MD_FLSIZE )
413 res = (res || (dst->o_size != src->o_size));
414 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
415 res = (res || (dst->o_blocks != src->o_blocks));
416 if ( compare & OBD_MD_FLBLKSZ )
417 res = (res || (dst->o_blksize != src->o_blksize));
418 if ( compare & OBD_MD_FLMODE )
419 res = (res || (dst->o_mode != src->o_mode));
420 if ( compare & OBD_MD_FLUID )
421 res = (res || (dst->o_uid != src->o_uid));
422 if ( compare & OBD_MD_FLGID )
423 res = (res || (dst->o_gid != src->o_gid));
424 if ( compare & OBD_MD_FLFLAGS )
425 res = (res || (dst->o_flags != src->o_flags));
426 if ( compare & OBD_MD_FLNLINK )
427 res = (res || (dst->o_nlink != src->o_nlink));
428 if ( compare & OBD_MD_FLGENER )
429 res = (res || (dst->o_generation != src->o_generation));
430 /* XXX Don't know if thses should be included here - wasn't previously
431 if ( compare & OBD_MD_FLINLINE )
432 res = (res || memcmp(dst->o_inline, src->o_inline));
433 if ( compare & OBD_MD_FLOBDMD )
434 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
441 int obd_register_type(struct obd_ops *ops, char *nm);
442 int obd_unregister_type(char *nm);
445 struct list_head cli_chain;
446 struct obd_device *cli_obd;
448 unsigned long cli_prealloc_quota;
449 struct list_head cli_prealloc_inodes;
453 struct obd_prealloc_inode {
454 struct list_head obd_prealloc_chain;
458 /* generic operations shared by various OBD types */
459 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
460 int gen_multi_cleanup(struct obd_device *obddev);
461 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
462 int gen_multi_detach(struct obd_device *obddev);
463 int gen_connect (struct obd_conn *conn);
464 int gen_disconnect(struct obd_conn *conn);
465 struct obd_client *gen_client(const struct obd_conn *);
466 int gen_cleanup(struct obd_device *obddev);
467 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
468 struct obd_conn *src_conn, struct obdo *src,
469 obd_size count, obd_off offset);
474 * ======== OBD IOCL Declarations ===========
485 /* for preallocation */
486 struct oic_prealloc_s {
488 uint32_t alloc; /* user sets it to the number of inodes
489 * requesting to be preallocated. kernel
490 * sets it to the actual number of
491 * succesfully preallocated inodes */
492 obd_id ids[32]; /* actual inode numbers */
495 /* for getattr, setattr, create, destroy */
501 /* for copy, migrate */
503 uint32_t src_conn_id;
505 uint32_t dst_conn_id;
518 /* for punch, sync */
527 #define OBD_IOC_CREATE _IOR ('f', 3, long)
528 #define OBD_IOC_SETUP _IOW ('f', 4, long)
529 #define OBD_IOC_CLEANUP _IO ('f', 5 )
530 #define OBD_IOC_DESTROY _IOW ('f', 6, long)
531 #define OBD_IOC_PREALLOCATE _IOWR('f', 7, long)
532 #define OBD_IOC_DEC_USE_COUNT _IO ('f', 8 )
533 #define OBD_IOC_SETATTR _IOW ('f', 9, long)
534 #define OBD_IOC_GETATTR _IOR ('f', 10, long)
535 #define OBD_IOC_READ _IOWR('f', 11, long)
536 #define OBD_IOC_WRITE _IOWR('f', 12, long)
537 #define OBD_IOC_CONNECT _IOR ('f', 13, long)
538 #define OBD_IOC_DISCONNECT _IOW ('f', 14, long)
539 #define OBD_IOC_STATFS _IOWR('f', 15, long)
540 #define OBD_IOC_SYNC _IOR ('f', 16, long)
541 #define OBD_IOC_READ2 _IOWR('f', 17, long)
542 #define OBD_IOC_FORMAT _IOWR('f', 18, long)
543 #define OBD_IOC_PARTITION _IOWR('f', 19, long)
544 #define OBD_IOC_ATTACH _IOWR('f', 20, long)
545 #define OBD_IOC_DETACH _IOWR('f', 21, long)
546 #define OBD_IOC_COPY _IOWR('f', 22, long)
547 #define OBD_IOC_MIGR _IOWR('f', 23, long)
548 #define OBD_IOC_PUNCH _IOWR('f', 24, long)
550 #define OBD_IOC_DEC_FS_USE_COUNT _IO ('f', 32 )
554 extern void obd_sysctl_init (void);
555 extern void obd_sysctl_clean (void);
557 #define CHKCONN(conn) do { if (!gen_client(conn)) {\
558 printk("%s %d invalid client %u\n", __FILE__, __LINE__, \
560 return -EINVAL; }} while (0)
564 #endif /* __LINUX_CLASS_OBD_H */