1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001-2003 Cluster File Systems, Inc. <info@clusterfs.com>
6 * This file is part of Lustre, http://www.lustre.org.
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.
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.
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.
21 * smfs data structures.
22 * See also lustre_idl.h for wire formats of requests.
26 #ifndef __LUSTRE_SMFS_H
27 #define __LUSTRE_SMFS_H
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*/
34 struct smfs_inode_info {
35 struct inode *smi_inode;
37 struct snap_inode_info sm_sninfo;
40 struct journal_operations {
41 void *(*tr_start)(struct inode *, int op);
42 void (*tr_commit)(void *handle);
45 struct sm_operations {
46 /* operations on the file store */
47 struct super_operations sm_sb_ops;
48 struct inode_operations sm_dir_iops;
49 struct inode_operations sm_file_iops;
50 struct inode_operations sm_sym_iops;
51 struct file_operations sm_dir_fops;
52 struct file_operations sm_file_fops;
53 struct file_operations sm_sym_fops;
54 struct dentry_operations sm_dentry_ops;
55 struct journal_operations sm_journal_ops;
59 typedef int (*smfs_pack_rec_func)(char *buffer, struct dentry *dentry,
60 struct inode *dir, void *data1,
69 struct mds_kml_pack_info {
74 typedef int (*smfs_hook_func)(struct inode *inode, struct dentry *dentry,
75 void *data1, void *data2, int op, void *handle);
76 struct smfs_hook_ops {
77 struct list_head smh_list;
79 smfs_hook_func smh_post_op;
80 smfs_hook_func smh_pre_op;
82 struct smfs_super_info {
83 struct super_block *smsi_sb;
84 struct vfsmount *smsi_mnt; /* mount the cache kern */
85 struct fsfilt_operations *sm_cache_fsfilt; /* fsfilt operations */
86 struct fsfilt_operations *sm_fsfilt; /* fsfilt operations */
87 struct sm_operations *sm_ops; /* cache ops */
88 struct lvfs_run_ctxt *smsi_ctxt;
89 struct llog_ctxt *smsi_rec_log; /* smfs kml llog */
90 struct dentry *smsi_logs_dir;
91 struct dentry *smsi_objects_dir;
92 struct dentry *smsi_delete_dir; /* for delete inode dir */
93 char *smsi_cache_ftype; /* cache file system type */
94 char *smsi_ftype; /* file system type */
95 struct obd_export *smsi_exp; /* file system obd exp */
96 struct snap_info *smsi_snap_info; /* snap table cow */
97 smfs_pack_rec_func smsi_pack_rec[PACK_MAX]; /* sm_pack_rec type ops */
98 __u32 smsi_flags; /* flags */
100 struct list_head smsi_hook_list;
104 #define SMFS_FILE_TYPE "smfs"
105 #define SMFS_FILE_MAGIC 0x19760218
107 struct smfs_file_info {
112 struct smfs_proc_args {
113 struct super_block *sr_sb;
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 */
124 #define I2SMI(inode) ((struct smfs_inode_info *) (&(inode->u.generic_ip)))
125 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
126 #define S2SMI(sb) ((struct smfs_super_info *) (&(sb->u.generic_sbp)))
127 #define S2CSB(sb) (((struct smfs_super_info *) (&(sb->u.generic_sbp)))->smsi_sb)
129 #define S2SMI(sb) ((struct smfs_super_info *) (sb->s_fs_info))
130 #define S2CSB(sb) (((struct smfs_super_info *) (sb->s_fs_info))->smsi_sb)
133 #define I2CI(inode) (((struct smfs_inode_info*) (&(inode->u.generic_ip)))->smi_inode)
135 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
136 #define I2CSB(inode) ((struct smfs_super_info *) (&(inode->i_sb->u.generic_sbp)))
138 #define I2CSB(inode) ((struct smfs_super_info *) (inode->i_sb->s_fs_info))
141 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
142 #define I2FOPS(inode) (((struct smfs_super_info *) \
143 (&(inode->i_sb->u.generic_sbp)))->sm_cache_fsfilt)
145 #define I2FOPS(inode) (((struct smfs_super_info *) \
146 (inode->i_sb->s_fs_info))->sm_cache_fsfilt)
149 #define I2SNAPI(inode) (&(I2SMI(inode)->sm_sninfo))
150 #define I2SNAPCOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_cache_fsfilt)
151 #define I2SNAPOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_fsfilt)
153 #define S2SNAPI(sb) (S2SMI(sb)->smsi_snap_info)
154 #define F2SMFI(file) ((struct smfs_file_info *)((file->private_data)))
155 #define F2CF(file) (((struct smfs_file_info *) ((file->private_data)))->c_file)
156 #define SIZE2BLKS(size, inode) ((size + (I2CI(inode)->i_blksize)) >> (I2CI(inode)->i_blkbits))
157 #define OFF2BLKS(off, inode) (off >> (I2CI(inode)->i_blkbits))
159 #define SM_DO_REC 0x1
160 #define SM_INIT_REC 0x2
161 #define SM_CACHE_HOOK 0x4
162 #define SM_OVER_WRITE 0x8
163 #define SM_DIRTY_WRITE 0x10
164 #define SM_DO_COW 0x20
165 #define SM_DO_COWED 0x40
167 #define SMFS_DO_REC(smfs_info) (smfs_info->smsi_flags & SM_DO_REC)
168 #define SMFS_SET_REC(smfs_info) (smfs_info->smsi_flags |= SM_DO_REC)
169 #define SMFS_CLEAN_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_REC)
171 #define SMFS_INIT_REC(smfs_info) (smfs_info->smsi_flags & SM_INIT_REC)
172 #define SMFS_SET_INIT_REC(smfs_info) (smfs_info->smsi_flags |= SM_INIT_REC)
173 #define SMFS_CLEAN_INIT_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_INIT_REC)
175 #define SMFS_SET_INODE_REC(inode) (I2SMI(inode)->smi_flags |= SM_DO_REC)
176 #define SMFS_DO_INODE_REC(inode) (I2SMI(inode)->smi_flags & SM_DO_REC)
177 #define SMFS_CLEAN_INODE_REC(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_REC)
179 #define SMFS_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags & SM_CACHE_HOOK)
180 #define SMFS_SET_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags |= SM_CACHE_HOOK)
181 #define SMFS_CLEAN_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags &= ~SM_CACHE_HOOK)
183 #define SMFS_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags & SM_CACHE_HOOK)
184 #define SMFS_SET_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags |= SM_CACHE_HOOK)
185 #define SMFS_CLEAN_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags &= ~SM_CACHE_HOOK)
187 #define SMFS_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags & SM_OVER_WRITE)
188 #define SMFS_SET_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_OVER_WRITE)
189 #define SMFS_CLEAN_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_OVER_WRITE)
191 #define SMFS_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags & SM_DIRTY_WRITE)
192 #define SMFS_SET_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_DIRTY_WRITE)
193 #define SMFS_CLEAN_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_DIRTY_WRITE)
195 #define SMFS_DO_COW(smfs_info) (smfs_info->smsi_flags & SM_DO_COW)
196 #define SMFS_SET_COW(smfs_info) (smfs_info->smsi_flags |= SM_DO_COW)
197 #define SMFS_CLEAN_COW(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_COW)
199 #define SMFS_SET_INODE_COW(inode) (I2SMI(inode)->smi_flags |= SM_DO_COW)
200 #define SMFS_DO_INODE_COW(inode) (I2SMI(inode)->smi_flags & SM_DO_COW)
201 #define SMFS_CLEAN_INODE_COW(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COW)
203 #define SMFS_SET_INODE_COWED(inode) (I2SMI(inode)->smi_flags |= SM_DO_COWED)
204 #define SMFS_DO_INODE_COWED(inode) (I2SMI(inode)->smi_flags & SM_DO_COWED)
205 #define SMFS_CLEAN_INODE_COWED(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COWED)
208 #define LVFS_SMFS_BACK_ATTR "lvfs_back_attr"
211 #define REC_COUNT_BIT 0
212 #define REC_COUNT_MASK 0x01 /*0001*/
214 #define REC_OP_MASK 0x06 /*0110*/
215 #define REC_WRITE_KML_BIT 3
216 #define REC_WRITE_KML_MASK 0x08 /*1000*/
217 #define REC_DEC_LINK_BIT 4
218 #define REC_DEC_LINK_MASK 0x10 /*10000* different with unlink*/
219 #define REC_GET_OID_BIT 5
220 #define REC_GET_OID_MASK 0x20 /*100000*/
222 #define REC_PACK_TYPE_BIT 6
223 #define REC_PACK_TYPE_MASK 0x1C0 /*111000000*/
225 #define SET_REC_COUNT_FLAGS(flag, count_flag) \
226 (flag |= count_flag << REC_COUNT_BIT)
227 #define GET_REC_COUNT_FLAGS(flag) \
228 ((flag & REC_COUNT_MASK) >> REC_COUNT_BIT)
230 #define SET_REC_OP_FLAGS(flag, op_flag) \
231 (flag |= op_flag << REC_OP_BIT)
232 #define GET_REC_OP_FLAGS(flag) \
233 ((flag & REC_OP_MASK) >> REC_OP_BIT)
235 #define SET_REC_WRITE_KML_FLAGS(flag, op_flag) \
236 (flag |= op_flag << REC_OP_BIT)
237 #define GET_REC_WRITE_KML_FLAGS(flag) \
238 ((flag & REC_WRITE_KML_MASK) >> REC_WRITE_KML_BIT)
240 #define SET_REC_DEC_LINK_FLAGS(flag, op_flag) \
241 (flag |= op_flag << REC_DEC_LINK_BIT)
242 #define GET_REC_DEC_LINK_FLAGS(flag) \
243 ((flag & REC_DEC_LINK_MASK) >> REC_DEC_LINK_BIT)
245 #define SET_REC_GET_ID_FLAGS(flag, op_flag) \
246 (flag |= op_flag << REC_GET_OID_BIT)
247 #define GET_REC_GET_OID_FLAGS(flag) \
248 ((flag & REC_GET_OID_MASK) >> REC_GET_OID_BIT)
250 #define SET_REC_PACK_TYPE_INDEX(flag, op_flag) \
251 (flag |= op_flag << REC_PACK_TYPE_BIT)
252 #define GET_REC_PACK_TYPE_INDEX(flag) \
253 ((flag & REC_PACK_TYPE_MASK) >> REC_PACK_TYPE_BIT)
255 #define SMFS_REC_ALL 0x1
256 #define SMFS_REC_BY_COUNT 0x0
258 #define SMFS_REINT_REC 0x1
259 #define SMFS_UNDO_REC 0x2
261 #define SMFS_WRITE_KML 0x1
262 #define SMFS_DEC_LINK 0x1
263 #define SMFS_GET_OID 0x1
265 #define SMFS_DO_REINT_REC(flag) \
266 (GET_REC_OP_FLAGS(flag) == SMFS_REINT_REC)
267 #define SMFS_DO_UNDO_REC(flag) \
268 (GET_REC_OP_FLAGS(flag) == SMFS_UNDO_REC)
269 #define SMFS_DO_REC_ALL(flag) \
270 (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_ALL)
271 #define SMFS_DO_REC_BY_COUNT(flag) \
272 (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_BY_COUNT)
273 #define SMFS_DO_WRITE_KML(flag) \
274 (GET_REC_WRITE_KML_FLAGS(flag) == SMFS_WRITE_KML)
275 #define SMFS_DO_DEC_LINK(flag) \
276 (GET_REC_DEC_LINK_FLAGS(flag) == SMFS_DEC_LINK)
278 #define SMFS_DO_GET_OID(flag) \
279 (GET_REC_GET_OID_FLAGS(flag) == SMFS_GET_OID)
281 /*DIRTY flags of write ops*/
282 #define REINT_EXTENTS_FLAGS "replay_flags"
283 #define SMFS_DIRTY_WRITE 0x01
284 #define SMFS_OVER_WRITE 0x02
287 static inline void duplicate_inode(struct inode *dst_inode,
288 struct inode *src_inode)
290 dst_inode->i_mode = src_inode->i_mode;
291 dst_inode->i_uid = src_inode->i_uid;
292 dst_inode->i_gid = src_inode->i_gid;
293 dst_inode->i_nlink = src_inode->i_nlink;
294 dst_inode->i_size = src_inode->i_size;
295 dst_inode->i_atime = src_inode->i_atime;
296 dst_inode->i_ctime = src_inode->i_ctime;
297 dst_inode->i_mtime = src_inode->i_mtime;
298 dst_inode->i_blksize = src_inode->i_blksize;
299 dst_inode->i_version = src_inode->i_version;
300 dst_inode->i_state = src_inode->i_state;
301 dst_inode->i_generation = src_inode->i_generation;
303 /* This is to make creating special files working. */
304 dst_inode->i_rdev = src_inode->i_rdev;
307 static inline void post_smfs_inode(struct inode *inode,
308 struct inode *cache_inode)
310 if (inode && cache_inode) {
311 duplicate_inode(inode, cache_inode);
312 /*Here we must release the cache_inode,
313 *Otherwise we will have no chance to
316 cache_inode->i_state &=~I_LOCK;
317 inode->i_blocks = cache_inode->i_blocks;
321 static inline void pre_smfs_inode(struct inode *inode,
322 struct inode *cache_inode)
324 if (inode && cache_inode)
325 duplicate_inode(cache_inode, inode);
328 /* instantiate a file handle to the cache file */
329 static inline void duplicate_file(struct file *dst_file, struct file *src_file)
331 if (dst_file && src_file) {
332 dst_file->f_pos = src_file->f_pos;
333 dst_file->f_mode = src_file->f_mode;
334 dst_file->f_flags = src_file->f_flags;
335 dst_file->f_owner = src_file->f_owner;
336 dst_file->f_vfsmnt = src_file->f_vfsmnt;
338 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
339 dst_file->f_reada = src_file->f_reada;
340 dst_file->f_ramax = src_file->f_ramax;
341 dst_file->f_raend = src_file->f_raend;
342 dst_file->f_ralen = src_file->f_ralen;
343 dst_file->f_rawin = src_file->f_rawin;
345 dst_file->f_ra = src_file->f_ra;
350 static inline void duplicate_sb(struct super_block *dst_sb,
351 struct super_block *src_sb)
353 dst_sb->s_blocksize = src_sb->s_blocksize;
354 dst_sb->s_magic = src_sb->s_magic;
355 dst_sb->s_blocksize_bits = src_sb->s_blocksize_bits;
356 dst_sb->s_maxbytes = src_sb->s_maxbytes;
357 dst_sb->s_flags = src_sb->s_flags;
360 static inline void d_unalloc(struct dentry *dentry)
362 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
363 list_del(&dentry->d_hash);
364 INIT_LIST_HEAD(&dentry->d_hash);
366 hlist_del_init(&dentry->d_hash);
368 dput(dentry); /* this will free the dentry memory */
371 static inline int smfs_get_dentry_name_index(struct dentry *dentry,
375 char *name = (char *)dentry->d_name.name;
379 int len = 0, name_len = 0;
381 name_len = dentry->d_name.len;
384 hash = init_name_hash();
386 c = *(const unsigned char *)name++;
387 if (c == ':' || c == '\0')
389 hash = partial_name_hash(c, hash);
392 str->hash = end_name_hash(hash);
393 OBD_ALLOC(str_name, len + 1);
394 memcpy(str_name, dentry->d_name.name, len);
396 str->name = str_name;
397 if (index && c == ':') {
398 *index = simple_strtoul(name, 0, 0);
403 static inline void smfs_free_dentry_name(struct qstr *str)
405 char *name = (char*)str->name;
406 OBD_FREE(name, str->len + 1);
409 static inline struct dentry *pre_smfs_dentry(struct dentry *parent_dentry,
410 struct inode *cache_inode,
411 struct dentry *dentry,
414 struct dentry *cache_dentry = NULL;
417 smfs_get_dentry_name_index(dentry, &name, index);
418 cache_dentry = d_alloc(parent_dentry, &name);
419 smfs_free_dentry_name(&name);
423 cache_dentry->d_parent = cache_dentry;
425 d_add(cache_dentry, cache_inode);
426 RETURN(cache_dentry);
429 static inline void post_smfs_dentry(struct dentry *cache_dentry)
433 if (cache_dentry->d_inode)
434 igrab(cache_dentry->d_inode);
435 d_unalloc(cache_dentry);
438 static inline int lookup_by_path(char *path, int flags, struct nameidata *nd)
440 struct dentry *dentry = NULL;
443 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
444 if (path_init(path, flags, nd)) {
446 if (path_lookup(path, flags, nd)) {
448 rc = path_walk(path, nd);
457 if (!dentry->d_inode || is_bad_inode(dentry->d_inode)) {
464 /*FIXME there should be more conditions in this check*/
465 static inline int smfs_do_rec(struct inode *inode)
467 struct super_block *sb = inode->i_sb;
468 struct smfs_super_info *smfs_info = S2SMI(sb);
470 if (SMFS_DO_REC(smfs_info) && SMFS_INIT_REC(smfs_info) &&
471 SMFS_DO_INODE_REC(inode))
476 static inline int smfs_cache_hook(struct inode *inode)
478 struct smfs_super_info *smfs_info = I2CSB(inode);
480 if (SMFS_CACHE_HOOK(smfs_info) && SMFS_INIT_REC(smfs_info) &&
481 SMFS_INODE_CACHE_HOOK(inode))
487 static inline int smfs_do_cow(struct inode *inode)
489 struct super_block *sb = inode->i_sb;
490 struct smfs_super_info *smfs_info = S2SMI(sb);
492 if (SMFS_DO_COW(smfs_info) && SMFS_DO_INODE_COW(inode))
498 /* XXX BUG 3188 -- must return to one set of opcodes */
499 #define SMFS_TRANS_OP(inode, op) \
501 if (smfs_do_rec(inode)) \
503 if (smfs_cache_hook(inode)) \
507 extern int smfs_start_rec(struct super_block *sb, struct vfsmount *mnt);
508 extern int smfs_stop_rec(struct super_block *sb);
509 extern int smfs_write_extents(struct inode *dir, struct dentry *dentry,
510 unsigned long from, unsigned long num);
511 extern int smfs_rec_setattr(struct inode *dir, struct dentry *dentry,
513 extern int smfs_rec_precreate(struct dentry *dentry, int *num, struct obdo *oa);
514 extern int smfs_rec_md(struct inode *inode, void * lmm, int lmm_size);
515 extern int smfs_rec_unpack(struct smfs_proc_args *args, char *record,
516 char **pbuf, int *opcode);
519 extern int smfs_post_setup(struct super_block *sb, struct vfsmount *mnt);
520 extern int smfs_post_cleanup(struct super_block *sb);
521 extern struct inode *smfs_get_inode (struct super_block *sb, ino_t hash,
522 struct inode *dir, int index);
524 extern int is_smfs_sb(struct super_block *sb);
525 #endif /* _LUSTRE_SMFS_H */