lustre/include/linux/obd_class.h

   1 #ifndef __LINUX_CLASS_OBD_H
   2 #define __LINUX_CLASS_OBD_H
   3 /*
   4  * Copyright (C) 2001  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 __KERNEL__
  11 #include <stdint.h>
  12 #define __KERNEL__
  13 #include <linux/list.h>
  14 #undef __KERNEL__
  15 #else
  16 #include <asm/segment.h>
  17 #include <asm/uaccess.h>
  18 #include <linux/types.h>
  19 #include <linux/fs.h>
  20 #include <linux/time.h>
  21
  22 #include <linux/lustre_lib.h>
  23 #include <linux/lustre_idl.h>
  24 #include <linux/obd.h>
  25 #endif
  26
  27 /*
  28  *  ======== OBD Device Declarations ===========
  29  */
  30 #define MAX_OBD_DEVICES 8
  31 #define MAX_MULTI       16
  32 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
  33
  34 #define OBD_ATTACHED 0x1
  35 #define OBD_SET_UP   0x2
  36
  37 struct obd_conn {
  38         struct obd_device *oc_dev;
  39         uint32_t oc_id;
  40 };
  41
  42 typedef struct {
  43         uint32_t len;
  44         char *   name;
  45         struct dentry *dentry;   /* file system obd device names */
  46         __u8           _uuid[16]; /* uuid obd device names */
  47 } obd_devicename;
  48
  49 #include <linux/obd_ext2.h>
  50 #include <linux/obd_filter.h>
  51 #include <linux/lustre_mds.h>
  52 #include <linux/obd_snap.h>
  53 #include <linux/obd_trace.h>
  54 /* #include <linux/obd_fc.h> */
  55 #include <linux/obd_raid1.h>
  56 #include <linux/obd_ost.h>
  57
  58 #ifdef __KERNEL__
  59 /* corresponds to one of the obdx */
  60 struct obd_device {
  61         struct obd_type *obd_type;
  62         int obd_minor;
  63         int obd_flags;
  64         int obd_refcnt;
  65         obd_devicename obd_fsname;
  66         struct proc_dir_entry *obd_proc_entry;
  67         int obd_multi_count;
  68         struct obd_conn obd_multi_conn[MAX_MULTI];
  69         unsigned int obd_gen_last_id;
  70         unsigned long obd_gen_prealloc_quota;
  71         struct list_head obd_gen_clients;
  72         union {
  73                 struct ext2_obd ext2;
  74                 struct filter_obd filter;
  75                 struct mds_obd mds;
  76                 struct raid1_obd raid1;
  77                 struct snap_obd snap;
  78                 struct trace_obd trace;
  79                 struct ost_obd ost;
  80                 struct osc_obd osc;
  81         } u;
  82 };
  83
  84 extern struct proc_dir_entry *proc_lustre_register_obd_device(struct obd_device *obd);
  85 extern void proc_lustre_release_obd_device(struct obd_device *obd);
  86 extern void proc_lustre_remove_obd_entry(const char* name, struct obd_device *obd);
  87
  88 /*
  89  *  ======== OBD Operations Declarations ===========
  90  */
  91
  92 #define OBD_BRW_READ    (READ)
  93 #define OBD_BRW_WRITE   (WRITE)
  94 #define OBD_BRW_RWMASK  (READ | WRITE)
  95 #define OBD_BRW_CREATE  (0x00000010UL)
  96
  97 struct obd_ops {
  98         int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
  99                            void *uarg);
 100         int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
 101                           obd_count *vallen, void **val);
 102         int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
 103                           obd_count vallen, void *val);
 104         int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
 105         int (*o_detach)(struct obd_device *dev);
 106         int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
 107         int (*o_cleanup)(struct obd_device *dev);
 108         int (*o_connect)(struct obd_conn *conn);
 109         int (*o_disconnect)(struct obd_conn *conn);
 110         int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
 111         int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
 112         int (*o_create)(struct obd_conn *conn,  struct obdo *oa);
 113         int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
 114         int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
 115         int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
 116         int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
 117                       obd_size *count, obd_off offset);
 118         int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
 119                        obd_size *count, obd_off offset);
 120         int (*o_brw)(int rw, struct obd_conn *conn, obd_count num_oa,
 121                      struct obdo **oa, obd_count *oa_bufs, struct page **buf,
 122                      obd_size *count, obd_off *offset, obd_flag *flags);
 123         int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
 124                        obd_off offset);
 125         int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
 126                       obd_off offset);
 127         int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
 128                          struct obdo *src, obd_size count, obd_off offset);
 129         int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
 130                       struct obd_conn *srconn, struct obdo *src,
 131                       obd_size count, obd_off offset);
 132         int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
 133                          obd_id *startid, obd_gr group, void *data);
 134         int (*o_dmaread)(struct obd_conn *conn, int count, struct obd_buf **dest,
 135                          struct obd_bufref **source);
 136         int (*o_pre_dmawrite)(struct obd_conn *conn, int count, struct obd_buf **dstbufs,
 137                          struct obd_bufref **dest);
 138         int (*o_dmawrite)(struct obd_conn *conn, int count, struct obd_buf **dstbufs,
 139                          struct obd_buf **dest);
 140 };
 141
 142 struct obd_request {
 143         struct obdo *oa;
 144         struct obd_conn *conn;
 145         __u32 plen1;
 146         char *pbuf1;
 147 };
 148
 149
 150
 151
 152 #define OBT(dev)        dev->obd_type->typ_ops
 153 #define OBP(dev,op)     dev->obd_type->typ_ops->o_ ## op
 154
 155 #endif
 156
 157 /* This value is not arbitrarily chosen.  KIO_STATIC_PAGES from linux/iobuf.h */
 158 #define MAX_IOVEC       (KIO_STATIC_PAGES - 1)
 159
 160
 161 /*
 162  *  ======== OBD Metadata Support  ===========
 163  */
 164
 165 extern int obd_init_obdo_cache(void);
 166 extern void obd_cleanup_obdo_cache(void);
 167
 168
 169 static inline int obdo_has_inline(struct obdo *obdo)
 170 {
 171         return (obdo->o_valid & OBD_MD_FLINLINE &&
 172                 obdo->o_obdflags & OBD_FL_INLINEDATA);
 173 };
 174
 175 static inline int obdo_has_obdmd(struct obdo *obdo)
 176 {
 177         return (obdo->o_valid & OBD_MD_FLOBDMD &&
 178                 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
 179 };
 180
 181 #ifdef __KERNEL__
 182 /* support routines */
 183 extern kmem_cache_t *obdo_cachep;
 184
 185 static __inline__ struct obdo *obdo_alloc(void)
 186 {
 187         struct obdo *oa = NULL;
 188
 189         oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
 190         memset(oa, 0, sizeof (*oa));
 191
 192         return oa;
 193 }
 194
 195 static __inline__ void obdo_free(struct obdo *oa)
 196 {
 197         if ( !oa )
 198                 return;
 199         kmem_cache_free(obdo_cachep, oa);
 200 }
 201
 202 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
 203                                            obd_mode mode, obd_flag valid)
 204 {
 205         struct obdo *oa;
 206         int err;
 207
 208         ENTRY;
 209         oa = obdo_alloc();
 210         if ( !oa ) {
 211                 EXIT;
 212                 return ERR_PTR(-ENOMEM);
 213         }
 214
 215         oa->o_id = id;
 216         oa->o_mode = mode;
 217         oa->o_valid = valid;
 218         if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
 219                 obdo_free(oa);
 220                 EXIT;
 221                 return ERR_PTR(err);
 222         }
 223         EXIT;
 224         return oa;
 225 }
 226
 227 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
 228 {
 229         unsigned int ia_valid = attr->ia_valid;
 230
 231         if (ia_valid & ATTR_ATIME) {
 232                 oa->o_atime = attr->ia_atime;
 233                 oa->o_valid |= OBD_MD_FLATIME;
 234         }
 235         if (ia_valid & ATTR_MTIME) {
 236                 oa->o_mtime = attr->ia_mtime;
 237                 oa->o_valid |= OBD_MD_FLMTIME;
 238         }
 239         if (ia_valid & ATTR_CTIME) {
 240                 oa->o_ctime = attr->ia_ctime;
 241                 oa->o_valid |= OBD_MD_FLCTIME;
 242         }
 243         if (ia_valid & ATTR_SIZE) {
 244                 oa->o_size = attr->ia_size;
 245                 oa->o_valid |= OBD_MD_FLSIZE;
 246         }
 247         if (ia_valid & ATTR_MODE) {
 248                 oa->o_mode = attr->ia_mode;
 249                 oa->o_valid |= OBD_MD_FLMODE;
 250                 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
 251                         oa->o_mode &= ~S_ISGID;
 252         }
 253         if (ia_valid & ATTR_UID)
 254         {
 255                 oa->o_uid = attr->ia_uid;
 256                 oa->o_valid |= OBD_MD_FLUID;
 257         }
 258         if (ia_valid & ATTR_GID) {
 259                 oa->o_gid = attr->ia_gid;
 260                 oa->o_valid |= OBD_MD_FLGID;
 261         }
 262 }
 263
 264
 265 static inline void iattr_from_obdo(struct iattr *attr, struct obdo *oa)
 266 {
 267         unsigned int ia_valid = oa->o_valid;
 268
 269         memset(attr, 0, sizeof(*attr));
 270         if (ia_valid & OBD_MD_FLATIME) {
 271                 attr->ia_atime = oa->o_atime;
 272                 attr->ia_valid |= ATTR_ATIME;
 273         }
 274         if (ia_valid & OBD_MD_FLMTIME) {
 275                 attr->ia_mtime = oa->o_mtime;
 276                 attr->ia_valid |= ATTR_MTIME;
 277         }
 278         if (ia_valid & OBD_MD_FLCTIME) {
 279                 attr->ia_ctime = oa->o_ctime;
 280                 attr->ia_valid |= ATTR_CTIME;
 281         }
 282         if (ia_valid & OBD_MD_FLSIZE) {
 283                 attr->ia_size = oa->o_size;
 284                 attr->ia_valid |= ATTR_SIZE;
 285         }
 286         if (ia_valid & OBD_MD_FLMODE) {
 287                 attr->ia_mode = oa->o_mode;
 288                 attr->ia_valid |= ATTR_MODE;
 289                 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
 290                         attr->ia_mode &= ~S_ISGID;
 291         }
 292         if (ia_valid & OBD_MD_FLUID)
 293         {
 294                 attr->ia_uid = oa->o_uid;
 295                 attr->ia_valid |= ATTR_UID;
 296         }
 297         if (ia_valid & OBD_MD_FLGID) {
 298                 attr->ia_gid = oa->o_gid;
 299                 attr->ia_valid |= ATTR_GID;
 300         }
 301 }
 302
 303
 304 /* WARNING: the file systems must take care not to tinker with
 305    attributes they don't manage (such as blocks). */
 306
 307 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
 308 {
 309         if ( dst->o_valid & OBD_MD_FLID )
 310                 dst->o_id = src->i_ino;
 311         if ( dst->o_valid & OBD_MD_FLATIME )
 312                 dst->o_atime = src->i_atime;
 313         if ( dst->o_valid & OBD_MD_FLMTIME )
 314                 dst->o_mtime = src->i_mtime;
 315         if ( dst->o_valid & OBD_MD_FLCTIME )
 316                 dst->o_ctime = src->i_ctime;
 317         if ( dst->o_valid & OBD_MD_FLSIZE )
 318                 dst->o_size = src->i_size;
 319         if ( dst->o_valid & OBD_MD_FLBLOCKS )   /* allocation of space */
 320                 dst->o_blocks = src->i_blocks;
 321         if ( dst->o_valid & OBD_MD_FLBLKSZ )
 322                 dst->o_blksize = src->i_blksize;
 323         if ( dst->o_valid & OBD_MD_FLMODE )
 324                 dst->o_mode = src->i_mode;
 325         if ( dst->o_valid & OBD_MD_FLUID )
 326                 dst->o_uid = src->i_uid;
 327         if ( dst->o_valid & OBD_MD_FLGID )
 328                 dst->o_gid = src->i_gid;
 329         if ( dst->o_valid & OBD_MD_FLFLAGS )
 330                 dst->o_flags = src->i_flags;
 331         if ( dst->o_valid & OBD_MD_FLNLINK )
 332                 dst->o_nlink = src->i_nlink;
 333         if ( dst->o_valid & OBD_MD_FLGENER )
 334                 dst->o_generation = src->i_generation;
 335 }
 336
 337 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
 338 {
 339
 340         if ( src->o_valid & OBD_MD_FLID )
 341                 dst->i_ino = src->o_id;
 342         if ( src->o_valid & OBD_MD_FLATIME )
 343                 dst->i_atime = src->o_atime;
 344         if ( src->o_valid & OBD_MD_FLMTIME )
 345                 dst->i_mtime = src->o_mtime;
 346         if ( src->o_valid & OBD_MD_FLCTIME )
 347                 dst->i_ctime = src->o_ctime;
 348         if ( src->o_valid & OBD_MD_FLSIZE )
 349                 dst->i_size = src->o_size;
 350         if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
 351                 dst->i_blocks = src->o_blocks;
 352         if ( src->o_valid & OBD_MD_FLBLKSZ )
 353                 dst->i_blksize = src->o_blksize;
 354         if ( src->o_valid & OBD_MD_FLMODE )
 355                 dst->i_mode = src->o_mode;
 356         if ( src->o_valid & OBD_MD_FLUID )
 357                 dst->i_uid = src->o_uid;
 358         if ( src->o_valid & OBD_MD_FLGID )
 359                 dst->i_gid = src->o_gid;
 360         if ( src->o_valid & OBD_MD_FLFLAGS )
 361                 dst->i_flags = src->o_flags;
 362         if ( src->o_valid & OBD_MD_FLNLINK )
 363                 dst->i_nlink = src->o_nlink;
 364         if ( src->o_valid & OBD_MD_FLGENER )
 365                 dst->i_generation = src->o_generation;
 366 }
 367
 368 #endif
 369
 370 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
 371 {
 372 #ifdef __KERNEL__
 373         CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
 374                src->o_id, src->o_valid, dst->o_id);
 375 #endif
 376         if ( src->o_valid & OBD_MD_FLATIME )
 377                 dst->o_atime = src->o_atime;
 378         if ( src->o_valid & OBD_MD_FLMTIME )
 379                 dst->o_mtime = src->o_mtime;
 380         if ( src->o_valid & OBD_MD_FLCTIME )
 381                 dst->o_ctime = src->o_ctime;
 382         if ( src->o_valid & OBD_MD_FLSIZE )
 383                 dst->o_size = src->o_size;
 384         if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
 385                 dst->o_blocks = src->o_blocks;
 386         if ( src->o_valid & OBD_MD_FLBLKSZ )
 387                 dst->o_blksize = src->o_blksize;
 388         if ( src->o_valid & OBD_MD_FLMODE )
 389                 dst->o_mode = src->o_mode;
 390         if ( src->o_valid & OBD_MD_FLUID )
 391                 dst->o_uid = src->o_uid;
 392         if ( src->o_valid & OBD_MD_FLGID )
 393                 dst->o_gid = src->o_gid;
 394         if ( src->o_valid & OBD_MD_FLFLAGS )
 395                 dst->o_flags = src->o_flags;
 396         /*
 397         if ( src->o_valid & OBD_MD_FLOBDFLG )
 398                 dst->o_obdflags = src->o_obdflags;
 399         */
 400         if ( src->o_valid & OBD_MD_FLNLINK )
 401                 dst->o_nlink = src->o_nlink;
 402         if ( src->o_valid & OBD_MD_FLGENER )
 403                 dst->o_generation = src->o_generation;
 404         if ( src->o_valid & OBD_MD_FLINLINE &&
 405              src->o_obdflags & OBD_FL_INLINEDATA) {
 406                 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
 407                 dst->o_obdflags |= OBD_FL_INLINEDATA;
 408         }
 409         if ( src->o_valid & OBD_MD_FLOBDMD &&
 410              src->o_obdflags & OBD_FL_OBDMDEXISTS) {
 411                 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
 412                 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
 413         }
 414
 415         dst->o_valid |= src->o_valid;
 416 }
 417
 418
 419 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
 420 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
 421                                   obd_flag compare)
 422 {
 423         int res = 0;
 424
 425         if ( compare & OBD_MD_FLATIME )
 426                 res = (res || (dst->o_atime != src->o_atime));
 427         if ( compare & OBD_MD_FLMTIME )
 428                 res = (res || (dst->o_mtime != src->o_mtime));
 429         if ( compare & OBD_MD_FLCTIME )
 430                 res = (res || (dst->o_ctime != src->o_ctime));
 431         if ( compare & OBD_MD_FLSIZE )
 432                 res = (res || (dst->o_size != src->o_size));
 433         if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
 434                 res = (res || (dst->o_blocks != src->o_blocks));
 435         if ( compare & OBD_MD_FLBLKSZ )
 436                 res = (res || (dst->o_blksize != src->o_blksize));
 437         if ( compare & OBD_MD_FLMODE )
 438                 res = (res || (dst->o_mode != src->o_mode));
 439         if ( compare & OBD_MD_FLUID )
 440                 res = (res || (dst->o_uid != src->o_uid));
 441         if ( compare & OBD_MD_FLGID )
 442                 res = (res || (dst->o_gid != src->o_gid));
 443         if ( compare & OBD_MD_FLFLAGS )
 444                 res = (res || (dst->o_flags != src->o_flags));
 445         if ( compare & OBD_MD_FLNLINK )
 446                 res = (res || (dst->o_nlink != src->o_nlink));
 447         if ( compare & OBD_MD_FLGENER )
 448                 res = (res || (dst->o_generation != src->o_generation));
 449         /* XXX Don't know if thses should be included here - wasn't previously
 450         if ( compare & OBD_MD_FLINLINE )
 451                 res = (res || memcmp(dst->o_inline, src->o_inline));
 452         if ( compare & OBD_MD_FLOBDMD )
 453                 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
 454         */
 455         return res;
 456 }
 457
 458
 459 #ifdef __KERNEL__
 460 int obd_register_type(struct obd_ops *ops, char *nm);
 461 int obd_unregister_type(char *nm);
 462
 463 struct obd_client {
 464         struct list_head cli_chain;
 465         struct obd_device *cli_obd;
 466         unsigned int cli_id;
 467         unsigned long cli_prealloc_quota;
 468         struct list_head cli_prealloc_inodes;
 469 };
 470
 471
 472 struct obd_prealloc_inode {
 473         struct list_head obd_prealloc_chain;
 474         unsigned long inode;
 475 };
 476
 477 /* generic operations shared by various OBD types */
 478 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
 479 int gen_multi_cleanup(struct obd_device *obddev);
 480 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
 481 int gen_multi_detach(struct obd_device *obddev);
 482 int gen_connect (struct obd_conn *conn);
 483 int gen_disconnect(struct obd_conn *conn);
 484 struct obd_client *gen_client(const struct obd_conn *);
 485 int gen_cleanup(struct obd_device *obddev);
 486 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
 487                   struct obd_conn *src_conn, struct obdo *src,
 488                   obd_size count, obd_off offset);
 489
 490 #endif
 491
 492 /* sysctl.c */
 493 extern void obd_sysctl_init (void);
 494 extern void obd_sysctl_clean (void);
 495
 496 #define CHKCONN(conn)   do { if (!gen_client(conn)) {\
 497                 printk("%s %d invalid client %u\n", __FILE__, __LINE__, \
 498                        conn->oc_id);\
 499                 return -EINVAL; }} while (0)
 500
 501
 502
 503 #endif /* __LINUX_CLASS_OBD_H */