Whamcloud - gitweb
include/obd_support.h: removed printk() of long long values (sometimes does
[fs/lustre-release.git] / lustre / include / linux / obd_class.h
1 #ifndef __LINUX_CLASS_OBD_H
2 #define __LINUX_CLASS_OBD_H
3
4 #include <linux/fs.h>
5 #include <linux/ext2_fs.h>
6 #include <linux/time.h>
7 #include <linux/obd.h>
8
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>
14
15
16 /*
17  *  ======== OBD type Declarations ===========
18  */
19
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;
32
33 #define OBD_FL_INLINEDATA       (1UL)  
34 #define OBD_FL_OBDMDEXISTS      (1UL << 1)
35
36 #define OBD_INLINESZ    60
37 #define OBD_OBDMDSZ     60
38 /* Note: 64-bit types are 64-bit aligned in structure */
39 struct obdo {
40         obd_id                  o_id;
41         obd_gr                  o_gr;
42         obd_time                o_atime;
43         obd_time                o_mtime;
44         obd_time                o_ctime;
45         obd_size                o_size;
46         obd_blocks              o_blocks;
47         obd_blksize             o_blksize;
48         obd_mode                o_mode;
49         obd_uid                 o_uid;
50         obd_gid                 o_gid;
51         obd_flag                o_flags;
52         obd_flag                o_obdflags;
53         obd_count               o_nlink;
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;
59         struct obd_ops          *o_op;
60 };
61
62 #define OBD_MD_FLALL    (~0UL)
63 #define OBD_MD_FLID     (0x0001UL)
64 #define OBD_MD_FLATIME  (0x0002UL)
65 #define OBD_MD_FLMTIME  (0x0004UL)
66 #define OBD_MD_FLCTIME  (0x0008UL)
67 #define OBD_MD_FLSIZE   (0x0010UL)
68 #define OBD_MD_FLBLOCKS (0x0020UL)
69 #define OBD_MD_FLBLKSZ  (0x0040UL)
70 #define OBD_MD_FLMODE   (0x0080UL)
71 #define OBD_MD_FLUID    (0x0100UL)
72 #define OBD_MD_FLGID    (0x0200UL)
73 #define OBD_MD_FLFLAGS  (0x0400UL)
74 #define OBD_MD_FLOBDFLG (0x0800UL)
75 #define OBD_MD_FLNLINK  (0x1000UL)
76 #define OBD_MD_FLGENER  (0x2000UL)
77 #define OBD_MD_FLINLINE (0x4000UL)
78 #define OBD_MD_FLOBDMD  (0x8000UL)
79 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG))
80
81 /*
82  *  ======== OBD Device Declarations ===========
83  */
84
85
86 #define OBD_PSDEV_MAJOR 186
87 #define MAX_OBD_DEVICES 8
88 #define MAX_MULTI       16
89
90
91 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
92
93
94 #define OBD_ATTACHED 0x1
95 #define OBD_SET_UP   0x2
96
97 struct obd_conn {
98         struct obd_device *oc_dev;
99         uint32_t oc_id;
100 };
101
102 /* corresponds to one of the obdx */
103 struct obd_device {
104         struct obd_type *obd_type;
105         int obd_minor;
106         int obd_flags;
107         int obd_refcnt; 
108         int obd_multi_count;
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;
113         union {
114                 struct ext2_obd ext2;
115                 struct raid1_obd raid1;
116                 struct snap_obd snap;
117                 struct rpc_obd rpc;
118                 /* struct fc_obd fc; */
119         } u;
120 };
121
122 /*
123  *  ======== OBD Operations Declarations ===========
124  */
125
126
127 struct obd_ops {
128         int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
129                            void *uarg);
130         int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
131                           obd_count *vallen, void **val);
132         int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
133                           obd_count vallen, void *val);
134         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
135         int (*o_detach)(struct obd_device *dev);
136         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
137         int (*o_cleanup)(struct obd_device *dev);
138         int (*o_connect)(struct obd_conn *conn);
139         int (*o_disconnect)(struct obd_conn *conn);
140         int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
141         int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
142         int (*o_create)(struct obd_conn *conn,  struct obdo *oa);
143         int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
144         int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
145         int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
146         int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
147                       obd_size *count, obd_off offset);
148         int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
149                        obd_size *count, obd_off offset);
150         int (*o_brw)(int rw, struct obd_conn *conn, struct obdo *oa,
151                      char *buf, obd_size *count, obd_off offset, obd_flag flags);
152         int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
153                        obd_off offset);
154         int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
155                       obd_off offset);
156         int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
157                          struct obdo *src, obd_size count, obd_off offset);
158         int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
159                       struct obd_conn *srconn, struct obdo *src,
160                       obd_size count, obd_off offset);
161         int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
162                          obd_id *startid, obd_gr group, void *data);
163 };
164
165 #define OBT(dev)        dev->obd_type->typ_ops
166 #define OBP(dev,op)     dev->obd_type->typ_ops->o_ ## op
167
168
169 /*
170  *  ======== OBD Metadata Support  ===========
171  */
172
173 extern int obd_init_obdo_cache(void);
174 extern void obd_cleanup_obdo_cache(void);
175
176
177 static inline int obdo_has_inline(struct obdo *obdo)
178 {
179         return (obdo->o_valid & OBD_MD_FLINLINE &&
180                 obdo->o_obdflags & OBD_FL_INLINEDATA);
181 };
182
183 static inline int obdo_has_obdmd(struct obdo *obdo)
184 {
185         return (obdo->o_valid & OBD_MD_FLOBDMD &&
186                 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
187 };
188
189 /* support routines */
190 extern kmem_cache_t *obdo_cachep;
191
192 static __inline__ struct obdo *obdo_alloc(void)
193 {
194         struct obdo *oa = NULL;
195
196         oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
197         memset(oa, 0, sizeof (*oa));
198
199         return oa;
200 }
201
202 static __inline__ void obdo_free(struct obdo *oa)
203 {
204         if ( !oa ) 
205                 return;
206         kmem_cache_free(obdo_cachep, oa);
207 }
208
209
210
211 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
212                                            obd_flag valid)
213 {
214         struct obdo *oa;
215         int err;
216
217         ENTRY;
218         oa = obdo_alloc();
219         if ( !oa ) {
220                 EXIT;
221                 return ERR_PTR(-ENOMEM);
222         }
223         memset(oa, 0, sizeof(*oa));
224         oa->o_id = id;
225         oa->o_valid = valid;
226         if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
227                 obdo_free(oa);
228                 EXIT;
229                 return ERR_PTR(err);
230         }
231         EXIT;
232         return oa;
233 }
234
235 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
236 {
237         unsigned int ia_valid = attr->ia_valid;
238
239         if (ia_valid & ATTR_ATIME) {
240                 oa->o_atime = attr->ia_atime;
241                 oa->o_valid |= OBD_MD_FLATIME;
242         }
243         if (ia_valid & ATTR_MTIME) {
244                 oa->o_mtime = attr->ia_mtime;
245                 oa->o_valid |= OBD_MD_FLMTIME;
246         }
247         if (ia_valid & ATTR_CTIME) {
248                 oa->o_ctime = attr->ia_ctime;
249                 oa->o_valid |= OBD_MD_FLCTIME;
250         }
251         if (ia_valid & ATTR_SIZE) {
252                 oa->o_size = attr->ia_size;
253                 oa->o_valid |= OBD_MD_FLSIZE;
254         }
255         if (ia_valid & ATTR_MODE) {
256                 oa->o_mode = attr->ia_mode;
257                 oa->o_valid |= OBD_MD_FLMODE;
258                 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
259                         oa->o_mode &= ~S_ISGID;
260         }
261         if (ia_valid & ATTR_UID)
262         {
263                 oa->o_uid = attr->ia_uid;
264                 oa->o_valid |= OBD_MD_FLUID;
265         }
266         if (ia_valid & ATTR_GID) {
267                 oa->o_gid = attr->ia_gid;
268                 oa->o_valid |= OBD_MD_FLGID;
269         }
270 }
271
272
273 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
274 {
275         CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
276                src->o_id, src->o_valid, dst->o_id);
277         if ( src->o_valid & OBD_MD_FLATIME ) 
278                 dst->o_atime = src->o_atime;
279         if ( src->o_valid & OBD_MD_FLMTIME ) 
280                 dst->o_mtime = src->o_mtime;
281         if ( src->o_valid & OBD_MD_FLCTIME ) 
282                 dst->o_ctime = src->o_ctime;
283         if ( src->o_valid & OBD_MD_FLSIZE ) 
284                 dst->o_size = src->o_size;
285         if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
286                 dst->o_blocks = src->o_blocks;
287         if ( src->o_valid & OBD_MD_FLBLKSZ )
288                 dst->o_blksize = src->o_blksize;
289         if ( src->o_valid & OBD_MD_FLMODE ) 
290                 dst->o_mode = src->o_mode;
291         if ( src->o_valid & OBD_MD_FLUID ) 
292                 dst->o_uid = src->o_uid;
293         if ( src->o_valid & OBD_MD_FLGID ) 
294                 dst->o_gid = src->o_gid;
295         if ( src->o_valid & OBD_MD_FLFLAGS ) 
296                 dst->o_flags = src->o_flags;
297         /*
298         if ( src->o_valid & OBD_MD_FLOBDFLG ) 
299                 dst->o_obdflags = src->o_obdflags;
300         */
301         if ( src->o_valid & OBD_MD_FLNLINK ) 
302                 dst->o_nlink = src->o_nlink;
303         if ( src->o_valid & OBD_MD_FLGENER ) 
304                 dst->o_generation = src->o_generation;
305         if ( src->o_valid & OBD_MD_FLINLINE &&
306              src->o_obdflags & OBD_FL_INLINEDATA) {
307                 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
308                 dst->o_obdflags |= OBD_FL_INLINEDATA;
309         }
310         if ( src->o_valid & OBD_MD_FLOBDMD &&
311              src->o_obdflags & OBD_FL_OBDMDEXISTS) {
312                 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
313                 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
314         }
315
316         dst->o_valid |= src->o_valid;
317 }
318
319 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
320 {
321         CDEBUG(D_INODE, "src inode %ld, dst obdo %Ld valid 0x%08x\n",
322                src->i_ino, dst->o_id, dst->o_valid);
323         if ( dst->o_valid & OBD_MD_FLID )
324                 dst->o_id = src->i_ino;
325         if ( dst->o_valid & OBD_MD_FLATIME )
326                 dst->o_atime = src->i_atime;
327         if ( dst->o_valid & OBD_MD_FLMTIME )
328                 dst->o_mtime = src->i_mtime;
329         if ( dst->o_valid & OBD_MD_FLCTIME )
330                 dst->o_ctime = src->i_ctime;
331         if ( dst->o_valid & OBD_MD_FLSIZE )
332                 dst->o_size = src->i_size;
333         if ( dst->o_valid & OBD_MD_FLBLOCKS )   /* allocation of space */
334                 dst->o_blocks = src->i_blocks;
335         if ( dst->o_valid & OBD_MD_FLBLKSZ )
336                 dst->o_blksize = src->i_blksize;
337         if ( dst->o_valid & OBD_MD_FLMODE )
338                 dst->o_mode = src->i_mode;
339         if ( dst->o_valid & OBD_MD_FLUID )
340                 dst->o_uid = src->i_uid;
341         if ( dst->o_valid & OBD_MD_FLGID )
342                 dst->o_gid = src->i_gid;
343         if ( dst->o_valid & OBD_MD_FLFLAGS )
344                 dst->o_flags = src->i_flags;
345         if ( dst->o_valid & OBD_MD_FLNLINK )
346                 dst->o_nlink = src->i_nlink;
347         if ( dst->o_valid & OBD_MD_FLGENER ) 
348                 dst->o_generation = src->i_generation;
349 }
350
351 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
352 {
353
354         CDEBUG(D_INODE, "src obdo %Ld valid 0x%08x, dst inode %ld\n",
355                src->o_id, src->o_valid, dst->i_ino);
356         if ( src->o_valid & OBD_MD_FLID )
357                 dst->i_ino = src->o_id;
358         if ( src->o_valid & OBD_MD_FLATIME ) 
359                 dst->i_atime = src->o_atime;
360         if ( src->o_valid & OBD_MD_FLMTIME ) 
361                 dst->i_mtime = src->o_mtime;
362         if ( src->o_valid & OBD_MD_FLCTIME ) 
363                 dst->i_ctime = src->o_ctime;
364         if ( src->o_valid & OBD_MD_FLSIZE ) 
365                 dst->i_size = src->o_size;
366         if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
367                 dst->i_blocks = src->o_blocks;
368         if ( src->o_valid & OBD_MD_FLBLKSZ )
369                 dst->i_blksize = src->o_blksize;
370         if ( src->o_valid & OBD_MD_FLMODE ) 
371                 dst->i_mode = src->o_mode;
372         if ( src->o_valid & OBD_MD_FLUID ) 
373                 dst->i_uid = src->o_uid;
374         if ( src->o_valid & OBD_MD_FLGID ) 
375                 dst->i_gid = src->o_gid;
376         if ( src->o_valid & OBD_MD_FLFLAGS ) 
377                 dst->i_flags = src->o_flags;
378         if ( src->o_valid & OBD_MD_FLNLINK )
379                 dst->i_nlink = src->o_nlink;
380         if ( src->o_valid & OBD_MD_FLGENER )
381                 dst->i_generation = src->o_generation;
382 }
383
384 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
385 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
386                                   obd_flag compare)
387 {
388         int res = 0;
389
390         if ( compare & OBD_MD_FLATIME )
391                 res = (res || (dst->o_atime != src->o_atime));
392         if ( compare & OBD_MD_FLMTIME )
393                 res = (res || (dst->o_mtime != src->o_mtime));
394         if ( compare & OBD_MD_FLCTIME )
395                 res = (res || (dst->o_ctime != src->o_ctime));
396         if ( compare & OBD_MD_FLSIZE )
397                 res = (res || (dst->o_size != src->o_size));
398         if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
399                 res = (res || (dst->o_blocks != src->o_blocks));
400         if ( compare & OBD_MD_FLBLKSZ )
401                 res = (res || (dst->o_blksize != src->o_blksize));
402         if ( compare & OBD_MD_FLMODE )
403                 res = (res || (dst->o_mode != src->o_mode));
404         if ( compare & OBD_MD_FLUID )
405                 res = (res || (dst->o_uid != src->o_uid));
406         if ( compare & OBD_MD_FLGID )
407                 res = (res || (dst->o_gid != src->o_gid));
408         if ( compare & OBD_MD_FLFLAGS ) 
409                 res = (res || (dst->o_flags != src->o_flags));
410         if ( compare & OBD_MD_FLNLINK )
411                 res = (res || (dst->o_nlink != src->o_nlink));
412         if ( compare & OBD_MD_FLGENER )
413                 res = (res || (dst->o_generation != src->o_generation));
414         /* XXX Don't know if thses should be included here - wasn't previously
415         if ( compare & OBD_MD_FLINLINE )
416                 res = (res || memcmp(dst->o_inline, src->o_inline));
417         if ( compare & OBD_MD_FLOBDMD )
418                 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
419         */
420         return res;
421 }
422
423
424
425 int obd_register_type(struct obd_ops *ops, char *nm);
426 int obd_unregister_type(char *nm);
427
428 struct obd_client {
429         struct list_head cli_chain;
430         struct obd_device *cli_obd;
431         unsigned int cli_id;
432         unsigned long cli_prealloc_quota;
433         struct list_head cli_prealloc_inodes;
434 };
435
436
437 struct obd_prealloc_inode {
438         struct list_head obd_prealloc_chain;
439         unsigned long inode;
440 };
441
442 /* generic operations shared by various OBD types */
443 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
444 int gen_multi_cleanup(struct obd_device *obddev);
445 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
446 int gen_multi_detach(struct obd_device *obddev);
447 int gen_connect (struct obd_conn *conn);
448 int gen_disconnect(struct obd_conn *conn);
449 struct obd_client *gen_client(struct obd_conn *);
450 int gen_cleanup(struct obd_device *obddev);
451 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
452                   struct obd_conn *src_conn, struct obdo *src,
453                   obd_size count, obd_off offset);
454
455
456
457 /*
458  *  ======== OBD IOCL Declarations ===========
459  */
460 struct oic_generic {
461         long     att_connid;
462         int      att_typelen;
463         void    *att_type;
464         int      att_datalen;
465         void    *att_data;
466 };
467
468
469 /* for preallocation */
470 struct oic_prealloc_s {
471         uint32_t cli_id;
472         uint32_t alloc; /* user sets it to the number of inodes
473                          * requesting to be preallocated.  kernel
474                          * sets it to the actual number of
475                          * succesfully preallocated inodes */
476         obd_id  ids[32]; /* actual inode numbers */
477 };
478
479 /* for getattr, setattr, create, destroy */
480 struct oic_attr_s {
481         uint32_t conn_id;
482         struct obdo  obdo;
483 };
484
485 /* for copy, migrate */
486 struct ioc_mv_s {
487         uint32_t src_conn_id;
488         struct obdo  src;
489         uint32_t dst_conn_id;
490         struct obdo  dst;
491 };
492
493 /* for read/write */
494 struct oic_rw_s {
495         uint32_t conn_id;
496         struct obdo obdo;
497         char * buf;
498         obd_size count;
499         obd_off offset;
500 };
501
502 /* for punch, sync */
503 struct oic_range_s {
504         uint32_t conn_id;
505         struct obdo obdo;
506         obd_size count;
507         obd_off offset;
508 };
509
510
511 #define OBD_IOC_CREATE                 _IOR ('f',  3, long)
512 #define OBD_IOC_SETUP                  _IOW ('f',  4, long)
513 #define OBD_IOC_CLEANUP                _IO  ('f',  5      )
514 #define OBD_IOC_DESTROY                _IOW ('f',  6, long)
515 #define OBD_IOC_PREALLOCATE            _IOWR('f',  7, long)
516 #define OBD_IOC_DEC_USE_COUNT          _IO  ('f',  8      )
517 #define OBD_IOC_SETATTR                _IOW ('f',  9, long)
518 #define OBD_IOC_GETATTR                _IOR ('f', 10, long)
519 #define OBD_IOC_READ                   _IOWR('f', 11, long)
520 #define OBD_IOC_WRITE                  _IOWR('f', 12, long)
521 #define OBD_IOC_CONNECT                _IOR ('f', 13, long)
522 #define OBD_IOC_DISCONNECT             _IOW ('f', 14, long)
523 #define OBD_IOC_STATFS                 _IOWR('f', 15, long)
524 #define OBD_IOC_SYNC                   _IOR ('f',  16, long)
525 #define OBD_IOC_READ2                  _IOWR('f', 17, long)
526 #define OBD_IOC_FORMAT                 _IOWR('f', 18, long)
527 #define OBD_IOC_PARTITION              _IOWR('f', 19, long)
528 #define OBD_IOC_ATTACH                 _IOWR('f', 20, long)
529 #define OBD_IOC_DETACH                 _IOWR('f', 21, long)
530 #define OBD_IOC_COPY                   _IOWR('f', 22, long)
531 #define OBD_IOC_MIGR                   _IOWR('f', 23, long)
532
533 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 32      )
534
535
536 /* sysctl.c */
537 extern void obd_sysctl_init (void);
538 extern void obd_sysctl_clean (void);
539
540 #define CHKCONN(conn)   do { if (!gen_client(conn)) {\
541                 printk("%s %d invalid client %u\n", __FILE__, __LINE__, \
542                        conn->oc_id);\
543                 return -EINVAL; }} while (0) 
544
545
546
547 #endif /* __LINUX_CLASS_OBD_H */