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         int sn_index;           /*the inode snap_index*/
  33         ino_t sn_root_ino;        /*the root ino of this snap*/
  34 };
  35 struct smfs_inode_info {
  36         /* this first part of struct should be the same as in mds_info_info */
  37         struct lustre_id smi_id;
  38
  39         /* smfs part. */
  40         struct inode *smi_inode;
  41         __u32  smi_flags;
  42         struct snap_inode_info sm_sninfo;
  43 };
  44
  45 struct journal_operations {
  46         void *(*tr_start)(struct inode *, int op);
  47         void (*tr_commit)(void *handle);
  48 };
  49
  50 struct sm_operations {
  51         /* operations on the file store */
  52         struct super_operations sm_sb_ops;
  53         struct inode_operations sm_dir_iops;
  54         struct inode_operations sm_file_iops;
  55         struct inode_operations sm_sym_iops;
  56         struct file_operations sm_dir_fops;
  57         struct file_operations sm_file_fops;
  58         struct file_operations sm_sym_fops;
  59         struct dentry_operations sm_dentry_ops;
  60         struct journal_operations sm_journal_ops;
  61 };
  62
  63 /*smfs rec*/
  64 typedef int (*smfs_pack_rec_func)(char *buffer, struct dentry *dentry,
  65                                   struct inode *dir, void *data1,
  66                                   void *data2, int op);
  67 typedef enum {
  68         PACK_NORMAL = 0,
  69         PACK_OST = 1,
  70         PACK_MDS = 2,
  71         PACK_MAX = 3,
  72 } pack_func_t;
  73
  74 struct mds_kml_pack_info {
  75         int mpi_bufcount;
  76         int mpi_size[4];
  77         int mpi_total_size;
  78 };
  79
  80 struct smfs_super_info {
  81         struct super_block       *smsi_sb;
  82         struct vfsmount          *smsi_mnt;         /* mount the cache kern */
  83         struct fsfilt_operations *sm_cache_fsfilt;  /* fsfilt operations */
  84         struct fsfilt_operations *sm_fsfilt;        /* fsfilt operations */
  85         struct sm_operations     *sm_ops;           /* cache ops */
  86         struct lvfs_run_ctxt     *smsi_ctxt;
  87         struct llog_ctxt         *smsi_kml_log;     /* smfs kml llog */
  88         struct dentry            *smsi_logs_dir;
  89         struct dentry            *smsi_objects_dir;
  90         char                     *smsi_cache_ftype; /* cache file system type */
  91         char                     *smsi_ftype;       /* file system type */
  92         struct obd_export        *smsi_exp;         /* file system obd exp */
  93         struct snap_super_info   *smsi_snap_info;   /* snap table cow */
  94         smfs_pack_rec_func       smsi_pack_rec[PACK_MAX]; /* sm_pack_rec type ops */
  95         __u32                    plg_flags;        /* flags */
  96         __u32                    smsi_flags;
  97         __u32                    smsi_ops_check;
  98         struct list_head         smsi_plg_list;
  99         kmem_cache_t *           smsi_inode_cachep;  /*inode_cachep*/
 100 };
 101
 102
 103 #define SMFS_FILE_TYPE         "smfs"
 104 #define SMFS_FILE_MAGIC        0x19760218
 105
 106 struct smfs_file_info {
 107         struct file        *c_file;
 108         int                 magic;
 109 };
 110
 111 struct smfs_proc_args {
 112         struct super_block *sr_sb;
 113         int                 sr_count;
 114         int                 sr_flags;
 115         void               *sr_data;
 116 };
 117 struct fs_extent{
 118         __u32   e_block;        /* first logical block extent covers */
 119         __u32   e_start;        /* first physical block extents lives */
 120         __u32   e_num;          /* number of blocks covered by extent */
 121 };
 122
 123 #define I2SMI(inode)  ((struct smfs_inode_info *) ((inode->u.generic_ip)))
 124 #define I2FSI(inode)  (((inode->u.generic_ip)))
 125
 126 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 127 #define S2FSI(sb)   (((sb->u.generic_sbp)))
 128 #define S2SMI(sb)   ((struct smfs_super_info *) ((sb->u.generic_sbp)))
 129 #define S2CSB(sb)   (((struct smfs_super_info *)((sb->u.generic_sbp)))->smsi_sb)
 130 #else
 131 #define S2FSI(sb)   ((sb->s_fs_info))
 132 #define S2SMI(sb)   ((struct smfs_super_info *) (sb->s_fs_info))
 133 #define S2CSB(sb)   (((struct smfs_super_info *) (sb->s_fs_info))->smsi_sb)
 134 #endif
 135
 136 #define I2CI(inode) (((struct smfs_inode_info*) ((inode->u.generic_ip)))->smi_inode)
 137
 138 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 139 #define I2CSB(inode) ((struct smfs_super_info *) ((inode->i_sb->u.generic_sbp)))
 140 #else
 141 #define I2CSB(inode) ((struct smfs_super_info *) (inode->i_sb->s_fs_info))
 142 #endif
 143
 144 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 145 #define I2FOPS(inode) (((struct smfs_super_info *) \
 146                         ((inode->i_sb->u.generic_sbp)))->sm_cache_fsfilt)
 147 #else
 148 #define I2FOPS(inode) (((struct smfs_super_info *) \
 149                         (inode->i_sb->s_fs_info))->sm_cache_fsfilt)
 150 #endif
 151
 152 #define I2SNAPI(inode) (&(I2SMI(inode)->sm_sninfo))
 153 #define I2SNAPCOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_cache_fsfilt)
 154 #define I2SNAPOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_fsfilt)
 155
 156 #define S2SNAPI(sb) (S2SMI(sb)->smsi_snap_info)
 157 #define F2SMFI(file) ((struct smfs_file_info *)((file->private_data)))
 158 #define F2CF(file) (((struct smfs_file_info *) ((file->private_data)))->c_file)
 159 #define SIZE2BLKS(size, inode) ((size + (I2CI(inode)->i_blksize)) >> (I2CI(inode)->i_blkbits))
 160 #define OFF2BLKS(off, inode) (off >> (I2CI(inode)->i_blkbits))
 161
 162 /* SMFS external flags and methods */
 163 #define SM_ALL_PLG      0x80L
 164 #define SM_PRECREATE    0x100L
 165
 166 #define SM_DO_REC               0x1
 167 #define SM_INIT_REC             0x2
 168 #define SM_CACHE_HOOK           0x4
 169 #define SM_OVER_WRITE           0x8
 170 #define SM_DIRTY_WRITE          0x10
 171 #define SM_DO_COW               0x20
 172 #define SM_DO_COWED             0x40
 173
 174 #define SMFS_DO_REC(smfs_info) (smfs_info->smsi_flags & SM_DO_REC)
 175 #define SMFS_SET_REC(smfs_info) (smfs_info->smsi_flags |= SM_DO_REC)
 176 #define SMFS_CLEAN_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_REC)
 177
 178 #define SMFS_INIT_REC(smfs_info) (smfs_info->smsi_flags & SM_INIT_REC)
 179 #define SMFS_SET_INIT_REC(smfs_info) (smfs_info->smsi_flags |= SM_INIT_REC)
 180 #define SMFS_CLEAN_INIT_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_INIT_REC)
 181
 182 #define SMFS_SET_INODE_REC(inode) (I2SMI(inode)->smi_flags |= SM_DO_REC)
 183 #define SMFS_DO_INODE_REC(inode) (I2SMI(inode)->smi_flags & SM_DO_REC)
 184 #define SMFS_CLEAN_INODE_REC(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_REC)
 185
 186 #define SMFS_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags & SM_CACHE_HOOK)
 187 #define SMFS_SET_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags |= SM_CACHE_HOOK)
 188 #define SMFS_CLEAN_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags &= ~SM_CACHE_HOOK)
 189
 190 #define SMFS_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags & SM_CACHE_HOOK)
 191 #define SMFS_SET_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags |= SM_CACHE_HOOK)
 192 #define SMFS_CLEAN_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags &= ~SM_CACHE_HOOK)
 193
 194 #define SMFS_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags & SM_OVER_WRITE)
 195 #define SMFS_SET_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_OVER_WRITE)
 196 #define SMFS_CLEAN_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_OVER_WRITE)
 197
 198 #define SMFS_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags & SM_DIRTY_WRITE)
 199 #define SMFS_SET_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_DIRTY_WRITE)
 200 #define SMFS_CLEAN_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_DIRTY_WRITE)
 201
 202 #define SMFS_DO_COW(smfs_info) (smfs_info->smsi_flags & SM_DO_COW)
 203 #define SMFS_SET_COW(smfs_info) (smfs_info->smsi_flags |= SM_DO_COW)
 204 #define SMFS_CLEAN_COW(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_COW)
 205
 206 #define SMFS_SET_INODE_COW(inode) (I2SMI(inode)->smi_flags |= SM_DO_COW)
 207 #define SMFS_DO_INODE_COW(inode) (I2SMI(inode)->smi_flags & SM_DO_COW)
 208 #define SMFS_CLEAN_INODE_COW(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COW)
 209
 210 #define SMFS_SET_INODE_COWED(inode) (I2SMI(inode)->smi_flags |= SM_DO_COWED)
 211 #define SMFS_DO_INODE_COWED(inode) (I2SMI(inode)->smi_flags & SM_DO_COWED)
 212 #define SMFS_CLEAN_INODE_COWED(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COWED)
 213
 214
 215 #define LVFS_SMFS_BACK_ATTR "lvfs_back_attr"
 216
 217
 218 #define REC_COUNT_BIT       0
 219 #define REC_COUNT_MASK      0x01 /*0001*/
 220 #define REC_OP_BIT          1
 221 #define REC_OP_MASK         0x06 /*0110*/
 222 #define REC_WRITE_KML_BIT   3
 223 #define REC_WRITE_KML_MASK  0x08 /*1000*/
 224 #define REC_DEC_LINK_BIT    4
 225 #define REC_DEC_LINK_MASK   0x10 /*10000* different with unlink*/
 226 #define REC_GET_OID_BIT     5
 227 #define REC_GET_OID_MASK    0x20 /*100000*/
 228
 229 #define REC_PACK_TYPE_BIT   6
 230 #define REC_PACK_TYPE_MASK  0x1C0 /*111000000*/
 231
 232 #define SET_REC_COUNT_FLAGS(flag, count_flag) \
 233                 (flag |= count_flag << REC_COUNT_BIT)
 234 #define GET_REC_COUNT_FLAGS(flag) \
 235                 ((flag & REC_COUNT_MASK) >> REC_COUNT_BIT)
 236
 237 #define SET_REC_OP_FLAGS(flag, op_flag) \
 238                 (flag |= op_flag << REC_OP_BIT)
 239 #define GET_REC_OP_FLAGS(flag) \
 240                 ((flag & REC_OP_MASK) >> REC_OP_BIT)
 241
 242 #define SET_REC_WRITE_KML_FLAGS(flag, op_flag) \
 243                 (flag |= op_flag << REC_OP_BIT)
 244 #define GET_REC_WRITE_KML_FLAGS(flag) \
 245                 ((flag & REC_WRITE_KML_MASK) >> REC_WRITE_KML_BIT)
 246
 247 #define SET_REC_DEC_LINK_FLAGS(flag, op_flag) \
 248                 (flag |= op_flag << REC_DEC_LINK_BIT)
 249 #define GET_REC_DEC_LINK_FLAGS(flag) \
 250                 ((flag & REC_DEC_LINK_MASK) >> REC_DEC_LINK_BIT)
 251
 252 #define SET_REC_GET_ID_FLAGS(flag, op_flag) \
 253                 (flag |= op_flag << REC_GET_OID_BIT)
 254 #define GET_REC_GET_OID_FLAGS(flag) \
 255                 ((flag & REC_GET_OID_MASK) >> REC_GET_OID_BIT)
 256
 257 #define SET_REC_PACK_TYPE_INDEX(flag, op_flag) \
 258                 (flag |= op_flag << REC_PACK_TYPE_BIT)
 259 #define GET_REC_PACK_TYPE_INDEX(flag) \
 260                 ((flag & REC_PACK_TYPE_MASK) >> REC_PACK_TYPE_BIT)
 261
 262 #define SMFS_REC_ALL             0x1
 263 #define SMFS_REC_BY_COUNT        0x0
 264
 265 #define SMFS_REINT_REC           0x1
 266 #define SMFS_UNDO_REC            0x2
 267
 268 #define SMFS_WRITE_KML           0x1
 269 #define SMFS_DEC_LINK            0x1
 270 #define SMFS_GET_OID             0x1
 271
 272 #define SMFS_DO_REINT_REC(flag) \
 273          (GET_REC_OP_FLAGS(flag) == SMFS_REINT_REC)
 274 #define SMFS_DO_UNDO_REC(flag) \
 275          (GET_REC_OP_FLAGS(flag) == SMFS_UNDO_REC)
 276 #define SMFS_DO_REC_ALL(flag) \
 277         (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_ALL)
 278 #define SMFS_DO_REC_BY_COUNT(flag) \
 279         (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_BY_COUNT)
 280 #define SMFS_DO_WRITE_KML(flag) \
 281         (GET_REC_WRITE_KML_FLAGS(flag) == SMFS_WRITE_KML)
 282 #define SMFS_DO_DEC_LINK(flag) \
 283         (GET_REC_DEC_LINK_FLAGS(flag) == SMFS_DEC_LINK)
 284
 285 #define SMFS_DO_GET_OID(flag) \
 286         (GET_REC_GET_OID_FLAGS(flag) == SMFS_GET_OID)
 287
 288 /*DIRTY flags of write ops*/
 289 #define REINT_EXTENTS_FLAGS         "replay_flags"
 290 #define SMFS_DIRTY_WRITE        0x01
 291 #define SMFS_OVER_WRITE         0x02
 292
 293
 294 static inline void duplicate_inode(struct inode *dst_inode,
 295                                    struct inode *src_inode)
 296 {
 297         dst_inode->i_mode = src_inode->i_mode;
 298         dst_inode->i_uid = src_inode->i_uid;
 299         dst_inode->i_gid = src_inode->i_gid;
 300         dst_inode->i_nlink = src_inode->i_nlink;
 301         dst_inode->i_size = src_inode->i_size;
 302         dst_inode->i_atime = src_inode->i_atime;
 303         dst_inode->i_ctime = src_inode->i_ctime;
 304         dst_inode->i_mtime = src_inode->i_mtime;
 305         dst_inode->i_blksize = src_inode->i_blksize;
 306         dst_inode->i_version = src_inode->i_version;
 307         //dst_inode->i_state = src_inode->i_state;
 308         dst_inode->i_generation = src_inode->i_generation;
 309         dst_inode->i_flags = src_inode->i_flags;
 310
 311         /* This is to make creating special files working. */
 312         dst_inode->i_rdev = src_inode->i_rdev;
 313 }
 314
 315 static inline void post_smfs_inode(struct inode *inode,
 316                                    struct inode *cache_inode)
 317 {
 318         if (inode && cache_inode) {
 319                 duplicate_inode(inode, cache_inode);
 320
 321                 /*
 322                  * here we must release the cache_inode, otherwise we will have
 323                  * no chance to do it later.
 324                  */
 325                 //cache_inode->i_state &=~I_LOCK;
 326                 inode->i_blocks = cache_inode->i_blocks;
 327         }
 328 }
 329
 330 static inline void pre_smfs_inode(struct inode *inode,
 331                                   struct inode *cache_inode)
 332 {
 333         if (inode && cache_inode) {
 334                 cache_inode->i_flags = inode->i_flags;
 335                 //cache_inode->i_state = inode->i_state;
 336                 if (S_ISDIR(inode->i_mode)) {
 337                         cache_inode->i_nlink = inode->i_nlink;
 338                 }
 339                 cache_inode->i_generation = inode->i_generation;
 340         }
 341 }
 342
 343 /* instantiate a file handle to the cache file */
 344 static inline void duplicate_file(struct file *dst_file, struct file *src_file)
 345 {
 346         if (dst_file && src_file) {
 347                 dst_file->f_pos = src_file->f_pos;
 348                 dst_file->f_mode = src_file->f_mode;
 349                 dst_file->f_flags = src_file->f_flags;
 350                 dst_file->f_owner  = src_file->f_owner;
 351                 dst_file->f_vfsmnt = src_file->f_vfsmnt;
 352
 353         #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 354                 dst_file->f_reada = src_file->f_reada;
 355                 dst_file->f_ramax = src_file->f_ramax;
 356                 dst_file->f_raend = src_file->f_raend;
 357                 dst_file->f_ralen = src_file->f_ralen;
 358                 dst_file->f_rawin = src_file->f_rawin;
 359         #else
 360                 dst_file->f_ra = src_file->f_ra;
 361         #endif
 362         }
 363 }
 364
 365 static inline void duplicate_sb(struct super_block *dst_sb,
 366                                 struct super_block *src_sb)
 367 {
 368         dst_sb->s_blocksize = src_sb->s_blocksize;
 369         dst_sb->s_magic = src_sb->s_magic;
 370         dst_sb->s_blocksize_bits = src_sb->s_blocksize_bits;
 371         dst_sb->s_maxbytes = src_sb->s_maxbytes;
 372         dst_sb->s_flags = src_sb->s_flags;
 373 }
 374
 375 static inline int smfs_get_dentry_name_index(struct dentry *dentry,
 376                                              struct qstr  *str,
 377                                              int *index)
 378 {
 379         char *name = (char *)dentry->d_name.name;
 380         unsigned long hash;
 381         unsigned char c;
 382         char *str_name;
 383         int len = 0, name_len = 0;
 384
 385         name_len = dentry->d_name.len;
 386         if (!name_len)
 387                 return 0;
 388         hash = init_name_hash();
 389         while (name_len--) {
 390                 c = *(const unsigned char *)name++;
 391                 if (c == ':' || c == '\0')
 392                         break;
 393                 hash = partial_name_hash(c, hash);
 394                 len ++;
 395         }
 396         str->hash = end_name_hash(hash);
 397         OBD_ALLOC(str_name, len + 1);
 398         memcpy(str_name, dentry->d_name.name, len);
 399         str->len = len;
 400         str->name = str_name;
 401         if (index && c == ':') {
 402                 *index = simple_strtoul(name, 0, 0);
 403         }
 404         return 0;
 405 }
 406
 407 static inline void smfs_free_dentry_name(struct qstr *str)
 408 {
 409         char *name = (char*)str->name;
 410         OBD_FREE(name, str->len + 1);
 411 }
 412
 413 static int smfs_d_delete(struct dentry * dentry)
 414 {
 415         return 1;
 416 }
 417
 418 static struct dentry_operations sm_dop = {
 419         .d_delete = smfs_d_delete,
 420 };
 421
 422
 423 static inline void smfs_update_dentry(struct dentry *dentry,
 424                                       struct dentry *cache_dentry)
 425 {
 426         if (DCACHE_CROSS_REF & cache_dentry->d_flags) {
 427                 dentry->d_flags |= DCACHE_CROSS_REF;
 428                 dentry->d_generation = cache_dentry->d_generation;
 429                 dentry->d_mdsnum = cache_dentry->d_mdsnum;
 430                 dentry->d_fid = cache_dentry->d_fid;
 431                 dentry->d_inum = cache_dentry->d_inum;
 432         }
 433 }
 434
 435 static inline struct dentry *pre_smfs_dentry(struct dentry *parent_dentry,
 436                                              struct inode *cache_inode,
 437                                              struct dentry *dentry)
 438 {
 439         struct dentry *cache_dentry = NULL;
 440
 441         cache_dentry = d_alloc(parent_dentry, &dentry->d_name);
 442         if (!cache_dentry)
 443                 RETURN(NULL);
 444
 445         //wantedi support
 446         cache_dentry->d_fsdata = dentry->d_fsdata;
 447
 448         //cmd support
 449         smfs_update_dentry(cache_dentry, dentry);
 450
 451         if (!parent_dentry)
 452                 cache_dentry->d_parent = cache_dentry;
 453
 454         if (cache_inode) {
 455                 atomic_inc(&cache_inode->i_count); //d_instantiate suppose that
 456                 d_add(cache_dentry, cache_inode);
 457         }
 458         //defines d_delete op to force killing dentry
 459         cache_dentry->d_op = &sm_dop;
 460
 461         RETURN(cache_dentry);
 462 }
 463
 464 static inline void post_smfs_dentry(struct dentry *cache_dentry)
 465 {
 466         if (cache_dentry)
 467                 dput(cache_dentry);
 468
 469 }
 470
 471 static inline int smfs_do_cow(struct inode *inode)
 472 {
 473         struct super_block *sb = inode->i_sb;
 474         struct smfs_super_info *smfs_info = S2SMI(sb);
 475
 476         if (SMFS_DO_COW(smfs_info) && SMFS_DO_INODE_COW(inode))
 477                 return 1;
 478         return 0;
 479 }
 480
 481
 482 extern int smfs_write_extents(struct inode *dir, struct dentry *dentry,
 483                               unsigned long from, unsigned long num);
 484 extern int smfs_rec_precreate(struct dentry *dentry, int *num, struct obdo *oa);
 485 extern int smfs_rec_unpack(struct smfs_proc_args *args, char *record,
 486                            char **pbuf, int *opcode);
 487 #endif /* _LUSTRE_SMFS_H */