lustre/include/linux/lustre_smfs.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001-2003 Cluster File Systems, Inc. <info@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  *   smfs data structures.
  22  *   See also lustre_idl.h for wire formats of requests.
  23  *
  24  */
  25
  26 #ifndef __LUSTRE_SMFS_H
  27 #define __LUSTRE_SMFS_H
  28
  29 struct snap_inode_info {
  30         int sn_flags;           /* the flags indicated inode type */
  31         int sn_gen;             /*the inode generation*/
  32 };
  33 struct smfs_inode_info {
  34         struct inode *smi_inode;
  35         __u32  smi_flags;
  36         struct snap_inode_info sm_sninfo;
  37 };
  38
  39 struct journal_operations {
  40         void *(*tr_start)(struct inode *, int op);
  41         void (*tr_commit)(void *handle);
  42 };
  43
  44 struct sm_operations {
  45         /* operations on the file store */
  46         struct super_operations sm_sb_ops;
  47         struct inode_operations sm_dir_iops;
  48         struct inode_operations sm_file_iops;
  49         struct inode_operations sm_sym_iops;
  50         struct file_operations sm_dir_fops;
  51         struct file_operations sm_file_fops;
  52         struct file_operations sm_sym_fops;
  53         struct dentry_operations sm_dentry_ops;
  54         struct journal_operations sm_journal_ops;
  55 };
  56
  57 /*smfs rec*/
  58 typedef int (*smfs_pack_rec_func)(char *buffer, struct dentry *dentry,
  59                                   struct inode *dir, void *data1,
  60                                   void *data2, int op);
  61 typedef enum {
  62         PACK_NORMAL = 0,
  63         PACK_OST = 1,
  64         PACK_MDS = 2,
  65         PACK_MAX = 3,
  66 } pack_func_t;
  67
  68 struct mds_kml_pack_info {
  69         int mpi_bufcount;
  70         int mpi_size[4];
  71         int mpi_total_size;
  72 };
  73
  74 struct smfs_super_info {
  75         struct super_block       *smsi_sb;
  76         struct vfsmount          *smsi_mnt;         /* mount the cache kern */
  77         struct fsfilt_operations *sm_cache_fsfilt;  /* fsfilt operations */
  78         struct fsfilt_operations *sm_fsfilt;        /* fsfilt operations */
  79         struct sm_operations     *sm_ops;           /* cache ops */
  80         struct lvfs_run_ctxt     *smsi_ctxt;
  81         struct llog_ctxt         *smsi_rec_log;     /* smfs kml llog */
  82         struct dentry            *smsi_logs_dir;
  83         struct dentry            *smsi_objects_dir;
  84         struct dentry            *smsi_delete_dir;  /* for delete inode dir */
  85         char                     *smsi_cache_ftype; /* cache file system type */
  86         char                     *smsi_ftype;       /* file system type */
  87         struct obd_export        *smsi_exp;         /* file system obd exp */
  88         struct snap_info         *smsi_snap_info;    /* snap table cow */
  89         smfs_pack_rec_func       smsi_pack_rec[PACK_MAX]; /* sm_pack_rec type ops */
  90         __u32                    smsi_flags;       /* flags */
  91         __u32                    smsi_ops_check;
  92 };
  93
  94 #define SMFS_FILE_TYPE "smfs"
  95 #define SMFS_FILE_MAGIC        0x19760218
  96
  97 struct smfs_file_info {
  98         struct file        *c_file;
  99         int                 magic;
 100 };
 101
 102 struct smfs_proc_args {
 103         struct super_block *sr_sb;
 104         int                 sr_count;
 105         int                 sr_flags;
 106         void               *sr_data;
 107 };
 108 struct fs_extent{
 109         __u32   e_block;        /* first logical block extent covers */
 110         __u32   e_start;        /* first physical block extents lives */
 111         __u32   e_num;          /* number of blocks covered by extent */
 112 };
 113
 114 #define I2SMI(inode)  ((struct smfs_inode_info *) (&(inode->u.generic_ip)))
 115 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 116 #define S2SMI(sb)   ((struct smfs_super_info *) (&(sb->u.generic_sbp)))
 117 #define S2CSB(sb)   (((struct smfs_super_info *) (&(sb->u.generic_sbp)))->smsi_sb)
 118 #else
 119 #define S2SMI(sb)   ((struct smfs_super_info *) (sb->s_fs_info))
 120 #define S2CSB(sb)   (((struct smfs_super_info *) (sb->s_fs_info))->smsi_sb)
 121 #endif
 122
 123 #define I2CI(inode) (((struct smfs_inode_info*) (&(inode->u.generic_ip)))->smi_inode)
 124
 125 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 126 #define I2CSB(inode) ((struct smfs_super_info *) (&(inode->i_sb->u.generic_sbp)))
 127 #else
 128 #define I2CSB(inode) ((struct smfs_super_info *) (inode->i_sb->s_fs_info))
 129 #endif
 130
 131 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 132 #define I2FOPS(inode) (((struct smfs_super_info *) \
 133                         (&(inode->i_sb->u.generic_sbp)))->sm_cache_fsfilt)
 134 #else
 135 #define I2FOPS(inode) (((struct smfs_super_info *) \
 136                         (inode->i_sb->s_fs_info))->sm_cache_fsfilt)
 137 #endif
 138
 139 #define I2SNAPI(inode) (&(I2SMI(inode)->sm_sninfo))
 140 #define I2SNAPCOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_cache_fsfilt)
 141 #define I2SNAPOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_fsfilt)
 142
 143 #define S2SNAPI(sb) (S2SMI(sb)->smsi_snap_info)
 144 #define F2SMFI(file) ((struct smfs_file_info *)((file->private_data)))
 145 #define F2CF(file) (((struct smfs_file_info *) ((file->private_data)))->c_file)
 146 #define SIZE2BLKS(size, inode) ((size + (I2CI(inode)->i_blksize)) >> (I2CI(inode)->i_blkbits))
 147 #define OFF2BLKS(off, inode) (off >> (I2CI(inode)->i_blkbits))
 148
 149 #define SM_DO_REC               0x1
 150 #define SM_INIT_REC             0x2
 151 #define SM_CACHE_HOOK           0x4
 152 #define SM_OVER_WRITE           0x8
 153 #define SM_DIRTY_WRITE          0x10
 154 #define SM_DO_COW               0x20
 155 #define SM_DO_COWED             0x40
 156
 157 #define SMFS_DO_REC(smfs_info) (smfs_info->smsi_flags & SM_DO_REC)
 158 #define SMFS_SET_REC(smfs_info) (smfs_info->smsi_flags |= SM_DO_REC)
 159 #define SMFS_CLEAN_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_REC)
 160
 161 #define SMFS_INIT_REC(smfs_info) (smfs_info->smsi_flags & SM_INIT_REC)
 162 #define SMFS_SET_INIT_REC(smfs_info) (smfs_info->smsi_flags |= SM_INIT_REC)
 163 #define SMFS_CLEAN_INIT_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_INIT_REC)
 164
 165 #define SMFS_SET_INODE_REC(inode) (I2SMI(inode)->smi_flags |= SM_DO_REC)
 166 #define SMFS_DO_INODE_REC(inode) (I2SMI(inode)->smi_flags & SM_DO_REC)
 167 #define SMFS_CLEAN_INODE_REC(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_REC)
 168
 169 #define SMFS_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags & SM_CACHE_HOOK)
 170 #define SMFS_SET_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags |= SM_CACHE_HOOK)
 171 #define SMFS_CLEAN_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags &= ~SM_CACHE_HOOK)
 172
 173 #define SMFS_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags & SM_CACHE_HOOK)
 174 #define SMFS_SET_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags |= SM_CACHE_HOOK)
 175 #define SMFS_CLEAN_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags &= ~SM_CACHE_HOOK)
 176
 177 #define SMFS_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags & SM_OVER_WRITE)
 178 #define SMFS_SET_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_OVER_WRITE)
 179 #define SMFS_CLEAN_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_OVER_WRITE)
 180
 181 #define SMFS_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags & SM_DIRTY_WRITE)
 182 #define SMFS_SET_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_DIRTY_WRITE)
 183 #define SMFS_CLEAN_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_DIRTY_WRITE)
 184
 185 #define SMFS_DO_COW(smfs_info) (smfs_info->smsi_flags & SM_DO_COW)
 186 #define SMFS_SET_COW(smfs_info) (smfs_info->smsi_flags |= SM_DO_COW)
 187 #define SMFS_CLEAN_COW(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_COW)
 188
 189 #define SMFS_SET_INODE_COW(inode) (I2SMI(inode)->smi_flags |= SM_DO_COW)
 190 #define SMFS_DO_INODE_COW(inode) (I2SMI(inode)->smi_flags & SM_DO_COW)
 191 #define SMFS_CLEAN_INODE_COW(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COW)
 192
 193 #define SMFS_SET_INODE_COWED(inode) (I2SMI(inode)->smi_flags |= SM_DO_COWED)
 194 #define SMFS_DO_INODE_COWED(inode) (I2SMI(inode)->smi_flags & SM_DO_COWED)
 195 #define SMFS_CLEAN_INODE_COWED(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COWED)
 196
 197
 198 #define LVFS_SMFS_BACK_ATTR "lvfs_back_attr"
 199
 200
 201 #define REC_COUNT_BIT       0
 202 #define REC_COUNT_MASK      0x01 /*0001*/
 203 #define REC_OP_BIT          1
 204 #define REC_OP_MASK         0x06 /*0110*/
 205 #define REC_WRITE_KML_BIT   3
 206 #define REC_WRITE_KML_MASK  0x08 /*1000*/
 207 #define REC_DEC_LINK_BIT    4
 208 #define REC_DEC_LINK_MASK   0x10 /*10000* different with unlink*/
 209 #define REC_GET_OID_BIT     5
 210 #define REC_GET_OID_MASK    0x20 /*100000*/
 211
 212 #define REC_PACK_TYPE_BIT   6
 213 #define REC_PACK_TYPE_MASK  0x1C0 /*111000000*/
 214
 215 #define SET_REC_COUNT_FLAGS(flag, count_flag) \
 216                 (flag |= count_flag << REC_COUNT_BIT)
 217 #define GET_REC_COUNT_FLAGS(flag) \
 218                 ((flag & REC_COUNT_MASK) >> REC_COUNT_BIT)
 219
 220 #define SET_REC_OP_FLAGS(flag, op_flag) \
 221                 (flag |= op_flag << REC_OP_BIT)
 222 #define GET_REC_OP_FLAGS(flag) \
 223                 ((flag & REC_OP_MASK) >> REC_OP_BIT)
 224
 225 #define SET_REC_WRITE_KML_FLAGS(flag, op_flag) \
 226                 (flag |= op_flag << REC_OP_BIT)
 227 #define GET_REC_WRITE_KML_FLAGS(flag) \
 228                 ((flag & REC_WRITE_KML_MASK) >> REC_WRITE_KML_BIT)
 229
 230 #define SET_REC_DEC_LINK_FLAGS(flag, op_flag) \
 231                 (flag |= op_flag << REC_DEC_LINK_BIT)
 232 #define GET_REC_DEC_LINK_FLAGS(flag) \
 233                 ((flag & REC_DEC_LINK_MASK) >> REC_DEC_LINK_BIT)
 234
 235 #define SET_REC_GET_ID_FLAGS(flag, op_flag) \
 236                 (flag |= op_flag << REC_GET_OID_BIT)
 237 #define GET_REC_GET_OID_FLAGS(flag) \
 238                 ((flag & REC_GET_OID_MASK) >> REC_GET_OID_BIT)
 239
 240 #define SET_REC_PACK_TYPE_INDEX(flag, op_flag) \
 241                 (flag |= op_flag << REC_PACK_TYPE_BIT)
 242 #define GET_REC_PACK_TYPE_INDEX(flag) \
 243                 ((flag & REC_PACK_TYPE_MASK) >> REC_PACK_TYPE_BIT)
 244
 245 #define SMFS_REC_ALL             0x1
 246 #define SMFS_REC_BY_COUNT        0x0
 247
 248 #define SMFS_REINT_REC           0x1
 249 #define SMFS_UNDO_REC            0x2
 250
 251 #define SMFS_WRITE_KML           0x1
 252 #define SMFS_DEC_LINK            0x1
 253 #define SMFS_GET_OID             0x1
 254
 255 #define SMFS_DO_REINT_REC(flag) \
 256          (GET_REC_OP_FLAGS(flag) == SMFS_REINT_REC)
 257 #define SMFS_DO_UNDO_REC(flag) \
 258          (GET_REC_OP_FLAGS(flag) == SMFS_UNDO_REC)
 259 #define SMFS_DO_REC_ALL(flag) \
 260         (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_ALL)
 261 #define SMFS_DO_REC_BY_COUNT(flag) \
 262         (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_BY_COUNT)
 263 #define SMFS_DO_WRITE_KML(flag) \
 264         (GET_REC_WRITE_KML_FLAGS(flag) == SMFS_WRITE_KML)
 265 #define SMFS_DO_DEC_LINK(flag) \
 266         (GET_REC_DEC_LINK_FLAGS(flag) == SMFS_DEC_LINK)
 267
 268 #define SMFS_DO_GET_OID(flag) \
 269         (GET_REC_GET_OID_FLAGS(flag) == SMFS_GET_OID)
 270
 271 /*DIRTY flags of write ops*/
 272 #define REINT_EXTENTS_FLAGS         "replay_flags"
 273 #define SMFS_DIRTY_WRITE        0x01
 274 #define SMFS_OVER_WRITE         0x02
 275
 276
 277 static inline void duplicate_inode(struct inode *dst_inode,
 278                                    struct inode *src_inode)
 279 {
 280         dst_inode->i_mode = src_inode->i_mode;
 281         dst_inode->i_uid = src_inode->i_uid;
 282         dst_inode->i_gid = src_inode->i_gid;
 283         dst_inode->i_nlink = src_inode->i_nlink;
 284         dst_inode->i_size = src_inode->i_size;
 285         dst_inode->i_atime = src_inode->i_atime;
 286         dst_inode->i_ctime = src_inode->i_ctime;
 287         dst_inode->i_mtime = src_inode->i_mtime;
 288         dst_inode->i_blksize = src_inode->i_blksize;
 289         dst_inode->i_version = src_inode->i_version;
 290         dst_inode->i_state = src_inode->i_state;
 291         dst_inode->i_generation = src_inode->i_generation;
 292
 293         /* This is to make creating special files working. */
 294         dst_inode->i_rdev = src_inode->i_rdev;
 295 }
 296
 297 static inline void post_smfs_inode(struct inode *inode,
 298                                    struct inode *cache_inode)
 299 {
 300         if (inode && cache_inode) {
 301                 duplicate_inode(inode, cache_inode);
 302                 /*Here we must release the cache_inode,
 303                  *Otherwise we will have no chance to
 304                  *do it
 305                  */
 306                 cache_inode->i_state &=~I_LOCK;
 307                 inode->i_blocks = cache_inode->i_blocks;
 308         }
 309 }
 310
 311 static inline void pre_smfs_inode(struct inode *inode,
 312                                   struct inode *cache_inode)
 313 {
 314         if (inode && cache_inode)
 315                 duplicate_inode(cache_inode, inode);
 316 }
 317
 318 /* instantiate a file handle to the cache file */
 319 static inline void duplicate_file(struct file *dst_file, struct file *src_file)
 320 {
 321         if (dst_file && src_file) {
 322                 dst_file->f_pos = src_file->f_pos;
 323                 dst_file->f_mode = src_file->f_mode;
 324                 dst_file->f_flags = src_file->f_flags;
 325                 dst_file->f_owner  = src_file->f_owner;
 326                 dst_file->f_vfsmnt = src_file->f_vfsmnt;
 327
 328         #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 329                 dst_file->f_reada = src_file->f_reada;
 330                 dst_file->f_ramax = src_file->f_ramax;
 331                 dst_file->f_raend = src_file->f_raend;
 332                 dst_file->f_ralen = src_file->f_ralen;
 333                 dst_file->f_rawin = src_file->f_rawin;
 334         #else
 335                 dst_file->f_ra = src_file->f_ra;
 336         #endif
 337         }
 338 }
 339
 340 static inline void duplicate_sb(struct super_block *dst_sb,
 341                                 struct super_block *src_sb)
 342 {
 343         dst_sb->s_blocksize = src_sb->s_blocksize;
 344         dst_sb->s_magic = src_sb->s_magic;
 345         dst_sb->s_blocksize_bits = src_sb->s_blocksize_bits;
 346         dst_sb->s_maxbytes = src_sb->s_maxbytes;
 347         dst_sb->s_flags = src_sb->s_flags;
 348 }
 349
 350 static inline void d_unalloc(struct dentry *dentry)
 351 {
 352 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 353         list_del(&dentry->d_hash);
 354         INIT_LIST_HEAD(&dentry->d_hash);
 355 #else
 356         hlist_del_init(&dentry->d_hash);
 357 #endif
 358         dput(dentry); /* this will free the dentry memory */
 359 }
 360
 361 static inline struct dentry *pre_smfs_dentry(struct dentry *parent_dentry,
 362                                              struct inode *cache_inode,
 363                                              struct dentry *dentry)
 364 {
 365         struct dentry *cache_dentry = NULL;
 366
 367         cache_dentry = d_alloc(parent_dentry, &dentry->d_name);
 368         if (!cache_dentry)
 369                 RETURN(NULL);
 370         if (!parent_dentry)
 371                 cache_dentry->d_parent = cache_dentry;
 372         if (cache_inode)
 373                 d_add(cache_dentry, cache_inode);
 374         RETURN(cache_dentry);
 375 }
 376
 377 static inline void post_smfs_dentry(struct dentry *cache_dentry)
 378 {
 379         if (!cache_dentry)
 380                 return;
 381         if (cache_dentry->d_inode)
 382                 igrab(cache_dentry->d_inode);
 383         d_unalloc(cache_dentry);
 384 }
 385
 386 static inline int lookup_by_path(char *path, int flags, struct nameidata *nd)
 387 {
 388         struct dentry *dentry = NULL;
 389         int rc = 0;
 390
 391 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 392         if (path_init(path, flags, nd)) {
 393 #else
 394         if (path_lookup(path, flags, nd)) {
 395 #endif
 396                 rc = path_walk(path, nd);
 397                 if (rc)
 398                         RETURN(rc);
 399         } else {
 400                 RETURN(-EINVAL);
 401         }
 402
 403         dentry = nd->dentry;
 404
 405         if (!dentry->d_inode || is_bad_inode(dentry->d_inode)) {
 406                 path_release(nd);
 407                 RETURN(-ENODEV);
 408         }
 409         RETURN(rc);
 410 }
 411
 412 /*FIXME there should be more conditions in this check*/
 413 static inline int smfs_do_rec(struct inode *inode)
 414 {
 415         struct super_block *sb = inode->i_sb;
 416         struct smfs_super_info *smfs_info = S2SMI(sb);
 417
 418         if (SMFS_DO_REC(smfs_info) && SMFS_INIT_REC(smfs_info) &&
 419             SMFS_DO_INODE_REC(inode))
 420                 return 1;
 421         return 0;
 422 }
 423
 424 static inline int smfs_cache_hook(struct inode *inode)
 425 {
 426         struct smfs_super_info  *smfs_info = I2CSB(inode);
 427
 428         if (SMFS_CACHE_HOOK(smfs_info) && SMFS_INIT_REC(smfs_info) &&
 429             SMFS_INODE_CACHE_HOOK(inode))
 430                 return 1;
 431         else
 432                 return 0;
 433 }
 434
 435 static inline int smfs_do_cow(struct inode *inode)
 436 {
 437         struct super_block *sb = inode->i_sb;
 438         struct smfs_super_info *smfs_info = S2SMI(sb);
 439
 440         if (SMFS_DO_COW(smfs_info) && SMFS_DO_INODE_COW(inode))
 441                 return 1;
 442         return 0;
 443 }
 444
 445 /* XXX BUG 3188 -- must return to one set of opcodes */
 446 #define SMFS_TRANS_OP(inode, op)                \
 447 {                                               \
 448         if (smfs_do_rec(inode))                 \
 449                 op = op | 0x10;                 \
 450         if (smfs_cache_hook(inode))             \
 451                 op = op | 0x20;                 \
 452 }
 453
 454 extern int smfs_start_rec(struct super_block *sb, struct vfsmount *mnt);
 455 extern int smfs_stop_rec(struct super_block *sb);
 456 extern int smfs_write_extents(struct inode *dir, struct dentry *dentry,
 457                               unsigned long from, unsigned long num);
 458 extern int smfs_rec_setattr(struct inode *dir, struct dentry *dentry,
 459                             struct iattr *attr);
 460 extern int smfs_rec_precreate(struct dentry *dentry, int *num, struct obdo *oa);
 461 extern int smfs_rec_md(struct inode *inode, void * lmm, int lmm_size);
 462 extern int smfs_rec_unpack(struct smfs_proc_args *args, char *record,
 463                            char **pbuf, int *opcode);
 464
 465
 466 extern int smfs_post_setup(struct super_block *sb, struct vfsmount *mnt);
 467 extern int smfs_post_cleanup(struct super_block *sb);
 468 #endif /* _LUSTRE_SMFS_H */