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