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 #include <linux/lustre_fsfilt.h>
30 #include <linux/namei.h>
32 struct snap_inode_info {
33 int sn_flags; /*the flags indicated inode type */
34 int sn_gen; /*the inode generation*/
35 int sn_index; /*the inode snap_index*/
36 ino_t sn_root_ino; /*the root ino of this snap*/
38 struct smfs_inode_info {
39 /* this first part of struct should be the same as in mds_info_info */
40 struct lustre_id smi_id;
43 struct inode *smi_inode;
45 struct snap_inode_info sm_sninfo;
48 struct journal_operations {
49 void *(*tr_start)(struct inode *, int op);
50 void (*tr_commit)(void *handle);
53 struct sm_operations {
54 /* operations on the file store */
55 struct super_operations sm_sb_ops;
56 struct inode_operations sm_dir_iops;
57 struct inode_operations sm_file_iops;
58 struct inode_operations sm_sym_iops;
59 struct file_operations sm_dir_fops;
60 struct file_operations sm_file_fops;
61 struct file_operations sm_sym_fops;
62 struct dentry_operations sm_dentry_ops;
63 struct journal_operations sm_journal_ops;
67 typedef int (*smfs_pack_rec_func)(char *buffer, struct dentry *dentry,
68 struct inode *dir, void *data1,
77 struct mds_kml_pack_info {
82 typedef int (*smfs_hook_func)(struct inode *inode, void *dentry,
83 void *data1, void *data2, int op, void *handle);
84 struct smfs_hook_ops {
85 struct list_head smh_list;
87 smfs_hook_func smh_post_op;
88 smfs_hook_func smh_pre_op;
90 struct smfs_super_info {
91 struct super_block *smsi_sb;
92 struct vfsmount *smsi_mnt; /* mount the cache kern */
93 struct fsfilt_operations *sm_cache_fsfilt; /* fsfilt operations */
94 struct fsfilt_operations *sm_fsfilt; /* fsfilt operations */
95 struct sm_operations *sm_ops; /* cache ops */
96 struct lvfs_run_ctxt *smsi_ctxt;
97 struct llog_ctxt *smsi_rec_log; /* smfs kml llog */
98 struct dentry *smsi_logs_dir;
99 struct dentry *smsi_objects_dir;
100 struct dentry *smsi_delete_dir; /* for delete inode dir */
101 char *smsi_cache_ftype; /* cache file system type */
102 char *smsi_ftype; /* file system type */
103 struct obd_export *smsi_exp; /* file system obd exp */
104 struct snap_super_info *smsi_snap_info; /* snap table cow */
105 smfs_pack_rec_func smsi_pack_rec[PACK_MAX]; /* sm_pack_rec type ops */
106 __u32 smsi_flags; /* flags */
107 __u32 smsi_ops_check;
108 struct list_head smsi_plg_list;
109 struct list_head smsi_hook_list;
110 kmem_cache_t * smsi_inode_cachep; /*inode_cachep*/
114 #define SMFS_FILE_TYPE "smfs"
115 #define SMFS_FILE_MAGIC 0x19760218
117 struct smfs_file_info {
122 struct smfs_proc_args {
123 struct super_block *sr_sb;
129 __u32 e_block; /* first logical block extent covers */
130 __u32 e_start; /* first physical block extents lives */
131 __u32 e_num; /* number of blocks covered by extent */
134 #define I2SMI(inode) ((struct smfs_inode_info *) ((inode->u.generic_ip)))
135 #define I2FSI(inode) (((inode->u.generic_ip)))
137 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
138 #define S2FSI(sb) (((sb->u.generic_sbp)))
139 #define S2SMI(sb) ((struct smfs_super_info *) ((sb->u.generic_sbp)))
140 #define S2CSB(sb) (((struct smfs_super_info *)((sb->u.generic_sbp)))->smsi_sb)
142 #define S2FSI(sb) ((sb->s_fs_info))
143 #define S2SMI(sb) ((struct smfs_super_info *) (sb->s_fs_info))
144 #define S2CSB(sb) (((struct smfs_super_info *) (sb->s_fs_info))->smsi_sb)
147 #define I2CI(inode) (((struct smfs_inode_info*) ((inode->u.generic_ip)))->smi_inode)
149 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
150 #define I2CSB(inode) ((struct smfs_super_info *) ((inode->i_sb->u.generic_sbp)))
152 #define I2CSB(inode) ((struct smfs_super_info *) (inode->i_sb->s_fs_info))
155 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
156 #define I2FOPS(inode) (((struct smfs_super_info *) \
157 ((inode->i_sb->u.generic_sbp)))->sm_cache_fsfilt)
159 #define I2FOPS(inode) (((struct smfs_super_info *) \
160 (inode->i_sb->s_fs_info))->sm_cache_fsfilt)
163 #define I2SNAPI(inode) (&(I2SMI(inode)->sm_sninfo))
164 #define I2SNAPCOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_cache_fsfilt)
165 #define I2SNAPOPS(inode) ((S2SMI(inode->i_sb))->smsi_snap_info->snap_fsfilt)
167 #define S2SNAPI(sb) (S2SMI(sb)->smsi_snap_info)
168 #define F2SMFI(file) ((struct smfs_file_info *)((file->private_data)))
169 #define F2CF(file) (((struct smfs_file_info *) ((file->private_data)))->c_file)
170 #define SIZE2BLKS(size, inode) ((size + (I2CI(inode)->i_blksize)) >> (I2CI(inode)->i_blkbits))
171 #define OFF2BLKS(off, inode) (off >> (I2CI(inode)->i_blkbits))
173 #define SM_DO_REC 0x1
174 #define SM_INIT_REC 0x2
175 #define SM_CACHE_HOOK 0x4
176 #define SM_OVER_WRITE 0x8
177 #define SM_DIRTY_WRITE 0x10
178 #define SM_DO_COW 0x20
179 #define SM_DO_COWED 0x40
181 #define SMFS_DO_REC(smfs_info) (smfs_info->smsi_flags & SM_DO_REC)
182 #define SMFS_SET_REC(smfs_info) (smfs_info->smsi_flags |= SM_DO_REC)
183 #define SMFS_CLEAN_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_REC)
185 #define SMFS_INIT_REC(smfs_info) (smfs_info->smsi_flags & SM_INIT_REC)
186 #define SMFS_SET_INIT_REC(smfs_info) (smfs_info->smsi_flags |= SM_INIT_REC)
187 #define SMFS_CLEAN_INIT_REC(smfs_info) (smfs_info->smsi_flags &= ~SM_INIT_REC)
189 #define SMFS_SET_INODE_REC(inode) (I2SMI(inode)->smi_flags |= SM_DO_REC)
190 #define SMFS_DO_INODE_REC(inode) (I2SMI(inode)->smi_flags & SM_DO_REC)
191 #define SMFS_CLEAN_INODE_REC(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_REC)
193 #define SMFS_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags & SM_CACHE_HOOK)
194 #define SMFS_SET_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags |= SM_CACHE_HOOK)
195 #define SMFS_CLEAN_CACHE_HOOK(smfs_info) (smfs_info->smsi_flags &= ~SM_CACHE_HOOK)
197 #define SMFS_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags & SM_CACHE_HOOK)
198 #define SMFS_SET_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags |= SM_CACHE_HOOK)
199 #define SMFS_CLEAN_INODE_CACHE_HOOK(inode) (I2SMI(inode)->smi_flags &= ~SM_CACHE_HOOK)
201 #define SMFS_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags & SM_OVER_WRITE)
202 #define SMFS_SET_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_OVER_WRITE)
203 #define SMFS_CLEAN_INODE_OVER_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_OVER_WRITE)
205 #define SMFS_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags & SM_DIRTY_WRITE)
206 #define SMFS_SET_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags |= SM_DIRTY_WRITE)
207 #define SMFS_CLEAN_INODE_DIRTY_WRITE(inode) (I2SMI(inode)->smi_flags &= ~SM_DIRTY_WRITE)
209 #define SMFS_DO_COW(smfs_info) (smfs_info->smsi_flags & SM_DO_COW)
210 #define SMFS_SET_COW(smfs_info) (smfs_info->smsi_flags |= SM_DO_COW)
211 #define SMFS_CLEAN_COW(smfs_info) (smfs_info->smsi_flags &= ~SM_DO_COW)
213 #define SMFS_SET_INODE_COW(inode) (I2SMI(inode)->smi_flags |= SM_DO_COW)
214 #define SMFS_DO_INODE_COW(inode) (I2SMI(inode)->smi_flags & SM_DO_COW)
215 #define SMFS_CLEAN_INODE_COW(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COW)
217 #define SMFS_SET_INODE_COWED(inode) (I2SMI(inode)->smi_flags |= SM_DO_COWED)
218 #define SMFS_DO_INODE_COWED(inode) (I2SMI(inode)->smi_flags & SM_DO_COWED)
219 #define SMFS_CLEAN_INODE_COWED(inode) (I2SMI(inode)->smi_flags &= ~SM_DO_COWED)
222 #define LVFS_SMFS_BACK_ATTR "lvfs_back_attr"
225 #define REC_COUNT_BIT 0
226 #define REC_COUNT_MASK 0x01 /*0001*/
228 #define REC_OP_MASK 0x06 /*0110*/
229 #define REC_WRITE_KML_BIT 3
230 #define REC_WRITE_KML_MASK 0x08 /*1000*/
231 #define REC_DEC_LINK_BIT 4
232 #define REC_DEC_LINK_MASK 0x10 /*10000* different with unlink*/
233 #define REC_GET_OID_BIT 5
234 #define REC_GET_OID_MASK 0x20 /*100000*/
236 #define REC_PACK_TYPE_BIT 6
237 #define REC_PACK_TYPE_MASK 0x1C0 /*111000000*/
239 #define SET_REC_COUNT_FLAGS(flag, count_flag) \
240 (flag |= count_flag << REC_COUNT_BIT)
241 #define GET_REC_COUNT_FLAGS(flag) \
242 ((flag & REC_COUNT_MASK) >> REC_COUNT_BIT)
244 #define SET_REC_OP_FLAGS(flag, op_flag) \
245 (flag |= op_flag << REC_OP_BIT)
246 #define GET_REC_OP_FLAGS(flag) \
247 ((flag & REC_OP_MASK) >> REC_OP_BIT)
249 #define SET_REC_WRITE_KML_FLAGS(flag, op_flag) \
250 (flag |= op_flag << REC_OP_BIT)
251 #define GET_REC_WRITE_KML_FLAGS(flag) \
252 ((flag & REC_WRITE_KML_MASK) >> REC_WRITE_KML_BIT)
254 #define SET_REC_DEC_LINK_FLAGS(flag, op_flag) \
255 (flag |= op_flag << REC_DEC_LINK_BIT)
256 #define GET_REC_DEC_LINK_FLAGS(flag) \
257 ((flag & REC_DEC_LINK_MASK) >> REC_DEC_LINK_BIT)
259 #define SET_REC_GET_ID_FLAGS(flag, op_flag) \
260 (flag |= op_flag << REC_GET_OID_BIT)
261 #define GET_REC_GET_OID_FLAGS(flag) \
262 ((flag & REC_GET_OID_MASK) >> REC_GET_OID_BIT)
264 #define SET_REC_PACK_TYPE_INDEX(flag, op_flag) \
265 (flag |= op_flag << REC_PACK_TYPE_BIT)
266 #define GET_REC_PACK_TYPE_INDEX(flag) \
267 ((flag & REC_PACK_TYPE_MASK) >> REC_PACK_TYPE_BIT)
269 #define SMFS_REC_ALL 0x1
270 #define SMFS_REC_BY_COUNT 0x0
272 #define SMFS_REINT_REC 0x1
273 #define SMFS_UNDO_REC 0x2
275 #define SMFS_WRITE_KML 0x1
276 #define SMFS_DEC_LINK 0x1
277 #define SMFS_GET_OID 0x1
279 #define SMFS_DO_REINT_REC(flag) \
280 (GET_REC_OP_FLAGS(flag) == SMFS_REINT_REC)
281 #define SMFS_DO_UNDO_REC(flag) \
282 (GET_REC_OP_FLAGS(flag) == SMFS_UNDO_REC)
283 #define SMFS_DO_REC_ALL(flag) \
284 (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_ALL)
285 #define SMFS_DO_REC_BY_COUNT(flag) \
286 (GET_REC_COUNT_FLAGS(flag) == SMFS_REC_BY_COUNT)
287 #define SMFS_DO_WRITE_KML(flag) \
288 (GET_REC_WRITE_KML_FLAGS(flag) == SMFS_WRITE_KML)
289 #define SMFS_DO_DEC_LINK(flag) \
290 (GET_REC_DEC_LINK_FLAGS(flag) == SMFS_DEC_LINK)
292 #define SMFS_DO_GET_OID(flag) \
293 (GET_REC_GET_OID_FLAGS(flag) == SMFS_GET_OID)
295 /*DIRTY flags of write ops*/
296 #define REINT_EXTENTS_FLAGS "replay_flags"
297 #define SMFS_DIRTY_WRITE 0x01
298 #define SMFS_OVER_WRITE 0x02
301 static inline void duplicate_inode(struct inode *dst_inode,
302 struct inode *src_inode)
304 dst_inode->i_mode = src_inode->i_mode;
305 dst_inode->i_uid = src_inode->i_uid;
306 dst_inode->i_gid = src_inode->i_gid;
307 dst_inode->i_nlink = src_inode->i_nlink;
308 dst_inode->i_size = src_inode->i_size;
309 dst_inode->i_atime = src_inode->i_atime;
310 dst_inode->i_ctime = src_inode->i_ctime;
311 dst_inode->i_mtime = src_inode->i_mtime;
312 dst_inode->i_blksize = src_inode->i_blksize;
313 dst_inode->i_version = src_inode->i_version;
314 //dst_inode->i_state = src_inode->i_state;
315 dst_inode->i_generation = src_inode->i_generation;
316 dst_inode->i_flags = src_inode->i_flags;
318 /* This is to make creating special files working. */
319 dst_inode->i_rdev = src_inode->i_rdev;
322 static inline void post_smfs_inode(struct inode *inode,
323 struct inode *cache_inode)
325 if (inode && cache_inode) {
326 duplicate_inode(inode, cache_inode);
329 * here we must release the cache_inode, otherwise we will have
330 * no chance to do it later.
332 //cache_inode->i_state &=~I_LOCK;
333 inode->i_blocks = cache_inode->i_blocks;
337 static inline void pre_smfs_inode(struct inode *inode,
338 struct inode *cache_inode)
340 //if (inode && cache_inode) {
341 //cache_inode->i_state = inode->i_state;
345 /* instantiate a file handle to the cache file */
346 static inline void duplicate_file(struct file *dst_file, struct file *src_file)
348 if (dst_file && src_file) {
349 dst_file->f_pos = src_file->f_pos;
350 dst_file->f_mode = src_file->f_mode;
351 dst_file->f_flags = src_file->f_flags;
352 dst_file->f_owner = src_file->f_owner;
353 dst_file->f_vfsmnt = src_file->f_vfsmnt;
355 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
356 dst_file->f_reada = src_file->f_reada;
357 dst_file->f_ramax = src_file->f_ramax;
358 dst_file->f_raend = src_file->f_raend;
359 dst_file->f_ralen = src_file->f_ralen;
360 dst_file->f_rawin = src_file->f_rawin;
362 dst_file->f_ra = src_file->f_ra;
367 static inline void duplicate_sb(struct super_block *dst_sb,
368 struct super_block *src_sb)
370 dst_sb->s_blocksize = src_sb->s_blocksize;
371 dst_sb->s_magic = src_sb->s_magic;
372 dst_sb->s_blocksize_bits = src_sb->s_blocksize_bits;
373 dst_sb->s_maxbytes = src_sb->s_maxbytes;
374 dst_sb->s_flags = src_sb->s_flags;
377 static inline int smfs_get_dentry_name_index(struct dentry *dentry,
381 char *name = (char *)dentry->d_name.name;
385 int len = 0, name_len = 0;
387 name_len = dentry->d_name.len;
390 hash = init_name_hash();
392 c = *(const unsigned char *)name++;
393 if (c == ':' || c == '\0')
395 hash = partial_name_hash(c, hash);
398 str->hash = end_name_hash(hash);
399 OBD_ALLOC(str_name, len + 1);
400 memcpy(str_name, dentry->d_name.name, len);
402 str->name = str_name;
403 if (index && c == ':') {
404 *index = simple_strtoul(name, 0, 0);
409 static inline void smfs_free_dentry_name(struct qstr *str)
411 char *name = (char*)str->name;
412 OBD_FREE(name, str->len + 1);
415 static int smfs_d_delete(struct dentry * dentry)
420 static inline void d_unalloc(struct dentry *dentry)
422 struct dentry_operations dop = {
423 .d_delete = smfs_d_delete,
425 //this will invoke unhash and kill for dentry
427 dput(dentry); /* this will free the dentry memory */
430 static inline struct dentry *pre_smfs_dentry(struct dentry *parent_dentry,
431 struct inode *cache_inode,
432 struct dentry *dentry)
434 struct dentry *cache_dentry = NULL;
437 if (!parent_dentry) {
438 cache_dentry = d_find_alias(cache_inode);
440 RETURN(cache_dentry);
443 cache_dentry = d_alloc(parent_dentry, &dentry->d_name);
448 cache_dentry->d_parent = cache_dentry;
451 atomic_inc(&cache_inode->i_count); //d_instantiate suppose that
452 d_add(cache_dentry, cache_inode);
455 RETURN(cache_dentry);
458 static inline void post_smfs_dentry(struct dentry *cache_dentry)
461 d_unalloc(cache_dentry);
465 /*FIXME there should be more conditions in this check*/
466 static inline int smfs_do_rec(struct inode *inode)
468 struct super_block *sb = inode->i_sb;
469 struct smfs_super_info *smfs_info = S2SMI(sb);
471 if (SMFS_DO_REC(smfs_info) && SMFS_INIT_REC(smfs_info) &&
472 SMFS_DO_INODE_REC(inode))
477 static inline int smfs_cache_hook(struct inode *inode)
479 struct smfs_super_info *smfs_info = I2CSB(inode);
481 if (SMFS_CACHE_HOOK(smfs_info) && SMFS_INIT_REC(smfs_info) &&
482 SMFS_INODE_CACHE_HOOK(inode))
488 static inline int smfs_do_cow(struct inode *inode)
490 struct super_block *sb = inode->i_sb;
491 struct smfs_super_info *smfs_info = S2SMI(sb);
493 if (SMFS_DO_COW(smfs_info) && SMFS_DO_INODE_COW(inode))
499 /* XXX BUG 3188 -- must return to one set of opcodes */
500 #define SMFS_TRANS_OP(inode, op) \
502 if (smfs_do_rec(inode)) \
504 if (smfs_cache_hook(inode)) \
508 extern int smfs_start_rec(struct super_block *sb, struct vfsmount *mnt);
509 extern int smfs_stop_rec(struct super_block *sb);
510 extern int smfs_write_extents(struct inode *dir, struct dentry *dentry,
511 unsigned long from, unsigned long num);
512 extern int smfs_rec_setattr(struct inode *dir, struct dentry *dentry,
514 extern int smfs_rec_precreate(struct dentry *dentry, int *num,
516 extern int smfs_rec_md(struct inode *inode, void * lmm, int lmm_size,
518 extern int smfs_rec_unpack(struct smfs_proc_args *args, char *record,
519 char **pbuf, int *opcode);
522 extern int smfs_post_setup(struct super_block *sb, struct vfsmount *mnt);
523 extern int smfs_post_cleanup(struct super_block *sb);
524 extern struct inode *smfs_get_inode (struct super_block *sb, ino_t hash,
525 struct inode *dir, int index);
527 extern int is_smfs_sb(struct super_block *sb);
528 #endif /* _LUSTRE_SMFS_H */