2 * nilfs.h - NILFS local header file.
4 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Written by Koji Sato <koji@osrg.net>
21 * Ryusuke Konishi <ryusuke@osrg.net>
27 #include <linux/kernel.h>
28 #include <linux/buffer_head.h>
29 #include <linux/spinlock.h>
30 #include <linux/blkdev.h>
31 #include <linux/nilfs2_fs.h>
32 #include "the_nilfs.h"
37 * nilfs inode data in memory
39 struct nilfs_inode_info {
41 unsigned long i_state; /* Dynamic state flags */
42 struct nilfs_bmap *i_bmap;
43 struct nilfs_bmap i_bmap_data;
44 __u64 i_xattr; /* sector_t ??? */
45 __u32 i_dir_start_lookup;
46 __u64 i_cno; /* check point number for GC inode */
47 struct address_space i_btnode_cache;
48 struct list_head i_dirty; /* List for connecting dirty files */
50 #ifdef CONFIG_NILFS_XATTR
52 * Extended attributes can be read independently of the main file
53 * data. Taking i_sem even when reading would cause contention
54 * between readers of EAs and writers of regular file data, so
55 * instead we synchronize on xattr_sem when reading or changing
58 struct rw_semaphore xattr_sem;
60 struct buffer_head *i_bh; /* i_bh contains a new or dirty
62 struct nilfs_root *i_root;
63 struct inode vfs_inode;
66 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
68 return container_of(inode, struct nilfs_inode_info, vfs_inode);
71 static inline struct nilfs_inode_info *
72 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
74 return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
77 static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
79 struct nilfs_inode_info *ii =
80 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
81 return &ii->vfs_inode;
84 static inline struct inode *NILFS_AS_I(struct address_space *mapping)
86 return (mapping->host) ? :
87 container_of(mapping, struct inode, i_data);
91 * Dynamic state flags of NILFS on-memory inode (i_state)
94 NILFS_I_NEW = 0, /* Inode is newly created */
95 NILFS_I_DIRTY, /* The file is dirty */
96 NILFS_I_QUEUED, /* inode is in dirty_files list */
97 NILFS_I_BUSY, /* inode is grabbed by a segment
99 NILFS_I_COLLECTED, /* All dirty blocks are collected */
100 NILFS_I_UPDATED, /* The file has been written back */
101 NILFS_I_INODE_DIRTY, /* write_inode is requested */
102 NILFS_I_BMAP, /* has bmap and btnode_cache */
103 NILFS_I_GCINODE, /* inode for GC, on memory only */
107 * commit flags for nilfs_commit_super and nilfs_sync_super
110 NILFS_SB_COMMIT = 0, /* Commit a super block alternately */
111 NILFS_SB_COMMIT_ALL /* Commit both super blocks */
115 * Macros to check inode numbers
117 #define NILFS_MDT_INO_BITS \
118 ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO | \
119 1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO | \
120 1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO))
122 #define NILFS_SYS_INO_BITS \
123 ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
125 #define NILFS_FIRST_INO(sb) (NILFS_SB(sb)->s_nilfs->ns_first_ino)
127 #define NILFS_MDT_INODE(sb, ino) \
128 ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino))))
129 #define NILFS_VALID_INODE(sb, ino) \
130 ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino))))
133 * struct nilfs_transaction_info: context information for synchronization
134 * @ti_magic: Magic number
135 * @ti_save: Backup of journal_info field of task_struct
137 * @ti_count: Nest level
138 * @ti_garbage: List of inode to be put when releasing semaphore
140 struct nilfs_transaction_info {
143 /* This should never used. If this happens,
144 one of other filesystems has a bug. */
145 unsigned short ti_flags;
146 unsigned short ti_count;
147 struct list_head ti_garbage;
151 #define NILFS_TI_MAGIC 0xd9e392fb
154 #define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */
155 #define NILFS_TI_SYNC 0x0002 /* Force to construct segment at the
156 end of transaction. */
157 #define NILFS_TI_GC 0x0004 /* GC context */
158 #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */
159 #define NILFS_TI_WRITER 0x0010 /* Constructor context */
162 int nilfs_transaction_begin(struct super_block *,
163 struct nilfs_transaction_info *, int);
164 int nilfs_transaction_commit(struct super_block *);
165 void nilfs_transaction_abort(struct super_block *);
167 static inline void nilfs_set_transaction_flag(unsigned int flag)
169 struct nilfs_transaction_info *ti = current->journal_info;
171 ti->ti_flags |= flag;
174 static inline int nilfs_test_transaction_flag(unsigned int flag)
176 struct nilfs_transaction_info *ti = current->journal_info;
178 if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
180 return !!(ti->ti_flags & flag);
183 static inline int nilfs_doing_gc(void)
185 return nilfs_test_transaction_flag(NILFS_TI_GC);
188 static inline int nilfs_doing_construction(void)
190 return nilfs_test_transaction_flag(NILFS_TI_WRITER);
196 #ifdef CONFIG_NILFS_POSIX_ACL
197 #error "NILFS: not yet supported POSIX ACL"
198 extern int nilfs_acl_chmod(struct inode *);
199 extern int nilfs_init_acl(struct inode *, struct inode *);
201 static inline int nilfs_acl_chmod(struct inode *inode)
206 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
208 inode->i_mode &= ~current_umask();
213 #define NILFS_ATIME_DISABLE
215 /* Flags that should be inherited by new inodes from their parent. */
216 #define NILFS_FL_INHERITED \
217 (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL | \
218 FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
219 FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
221 /* Mask out flags that are inappropriate for the given type of inode. */
222 static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
226 else if (S_ISREG(mode))
227 return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
229 return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
233 extern int nilfs_add_link(struct dentry *, struct inode *);
234 extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
235 extern int nilfs_make_empty(struct inode *, struct inode *);
236 extern struct nilfs_dir_entry *
237 nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
238 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
239 extern int nilfs_empty_dir(struct inode *);
240 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
241 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
242 struct page *, struct inode *);
245 extern int nilfs_sync_file(struct file *, int);
248 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
249 long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
250 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
254 extern struct inode *nilfs_new_inode(struct inode *, int);
255 extern void nilfs_free_inode(struct inode *);
256 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
257 extern void nilfs_set_inode_flags(struct inode *);
258 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
259 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
260 struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
262 struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
264 struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
266 extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
267 unsigned long ino, __u64 cno);
268 extern void nilfs_update_inode(struct inode *, struct buffer_head *);
269 extern void nilfs_truncate(struct inode *);
270 extern void nilfs_evict_inode(struct inode *);
271 extern int nilfs_setattr(struct dentry *, struct iattr *);
272 int nilfs_permission(struct inode *inode, int mask, unsigned int flags);
273 int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
274 extern int nilfs_inode_dirty(struct inode *);
275 int nilfs_set_file_dirty(struct inode *inode, unsigned nr_dirty);
276 extern int nilfs_mark_inode_dirty(struct inode *);
277 extern void nilfs_dirty_inode(struct inode *);
278 int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
279 __u64 start, __u64 len);
282 extern struct inode *nilfs_alloc_inode(struct super_block *);
283 extern void nilfs_destroy_inode(struct inode *);
284 extern void nilfs_error(struct super_block *, const char *, const char *, ...)
285 __attribute__ ((format (printf, 3, 4)));
286 extern void nilfs_warning(struct super_block *, const char *, const char *, ...)
287 __attribute__ ((format (printf, 3, 4)));
288 extern struct nilfs_super_block *
289 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
290 extern int nilfs_store_magic_and_option(struct super_block *,
291 struct nilfs_super_block *, char *);
292 extern int nilfs_check_feature_compatibility(struct super_block *,
293 struct nilfs_super_block *);
294 extern void nilfs_set_log_cursor(struct nilfs_super_block *,
296 extern struct nilfs_super_block **nilfs_prepare_super(struct nilfs_sb_info *,
298 extern int nilfs_commit_super(struct nilfs_sb_info *, int);
299 extern int nilfs_cleanup_super(struct nilfs_sb_info *);
300 int nilfs_attach_checkpoint(struct nilfs_sb_info *sbi, __u64 cno, int curr_mnt,
301 struct nilfs_root **root);
302 int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
305 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
306 struct buffer_head **);
307 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
308 struct buffer_head **);
309 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
310 int nilfs_init_gcinode(struct inode *inode);
311 void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
314 * Inodes and files operations
316 extern const struct file_operations nilfs_dir_operations;
317 extern const struct inode_operations nilfs_file_inode_operations;
318 extern const struct file_operations nilfs_file_operations;
319 extern const struct address_space_operations nilfs_aops;
320 extern const struct inode_operations nilfs_dir_inode_operations;
321 extern const struct inode_operations nilfs_special_inode_operations;
322 extern const struct inode_operations nilfs_symlink_inode_operations;
327 extern struct file_system_type nilfs_fs_type;
330 #endif /* _NILFS_H */