1 /*
2 * nilfs.h - NILFS local header file.
3 *
4 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
5 *
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.
10 *
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.
15 *
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
19 *
20 * Written by Koji Sato <koji@osrg.net>
21 * Ryusuke Konishi <ryusuke@osrg.net>
22 */
23
24 #ifndef _NILFS_H
25 #define _NILFS_H
26
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"
33 #include "bmap.h"
34
35 /*
36 * nilfs inode data in memory
37 */
38 struct nilfs_inode_info {
39 __u32 i_flags;
40 unsigned long i_state; /* Dynamic state flags */
41 struct nilfs_bmap *i_bmap;
42 struct nilfs_bmap i_bmap_data;
43 __u64 i_xattr; /* sector_t ??? */
44 __u32 i_dir_start_lookup;
45 __u64 i_cno; /* check point number for GC inode */
46 struct address_space i_btnode_cache;
47 struct list_head i_dirty; /* List for connecting dirty files */
48
49 #ifdef CONFIG_NILFS_XATTR
50 /*
51 * Extended attributes can be read independently of the main file
52 * data. Taking i_sem even when reading would cause contention
53 * between readers of EAs and writers of regular file data, so
54 * instead we synchronize on xattr_sem when reading or changing
55 * EAs.
56 */
57 struct rw_semaphore xattr_sem;
58 #endif
59 struct buffer_head *i_bh; /* i_bh contains a new or dirty
60 disk inode */
61 struct nilfs_root *i_root;
62 struct inode vfs_inode;
63 };
64
NILFS_I(const struct inode * inode)65 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
66 {
67 return container_of(inode, struct nilfs_inode_info, vfs_inode);
68 }
69
70 static inline struct nilfs_inode_info *
NILFS_BMAP_I(const struct nilfs_bmap * bmap)71 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
72 {
73 return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
74 }
75
NILFS_BTNC_I(struct address_space * btnc)76 static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
77 {
78 struct nilfs_inode_info *ii =
79 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
80 return &ii->vfs_inode;
81 }
82
NILFS_AS_I(struct address_space * mapping)83 static inline struct inode *NILFS_AS_I(struct address_space *mapping)
84 {
85 return (mapping->host) ? :
86 container_of(mapping, struct inode, i_data);
87 }
88
89 /*
90 * Dynamic state flags of NILFS on-memory inode (i_state)
91 */
92 enum {
93 NILFS_I_NEW = 0, /* Inode is newly created */
94 NILFS_I_DIRTY, /* The file is dirty */
95 NILFS_I_QUEUED, /* inode is in dirty_files list */
96 NILFS_I_BUSY, /* inode is grabbed by a segment
97 constructor */
98 NILFS_I_COLLECTED, /* All dirty blocks are collected */
99 NILFS_I_UPDATED, /* The file has been written back */
100 NILFS_I_INODE_DIRTY, /* write_inode is requested */
101 NILFS_I_BMAP, /* has bmap and btnode_cache */
102 NILFS_I_GCINODE, /* inode for GC, on memory only */
103 };
104
105 /*
106 * commit flags for nilfs_commit_super and nilfs_sync_super
107 */
108 enum {
109 NILFS_SB_COMMIT = 0, /* Commit a super block alternately */
110 NILFS_SB_COMMIT_ALL /* Commit both super blocks */
111 };
112
113 /*
114 * Macros to check inode numbers
115 */
116 #define NILFS_MDT_INO_BITS \
117 ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO | \
118 1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO | \
119 1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO))
120
121 #define NILFS_SYS_INO_BITS \
122 ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
123
124 #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
125
126 #define NILFS_MDT_INODE(sb, ino) \
127 ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino))))
128 #define NILFS_VALID_INODE(sb, ino) \
129 ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino))))
130
131 /**
132 * struct nilfs_transaction_info: context information for synchronization
133 * @ti_magic: Magic number
134 * @ti_save: Backup of journal_info field of task_struct
135 * @ti_flags: Flags
136 * @ti_count: Nest level
137 * @ti_garbage: List of inode to be put when releasing semaphore
138 */
139 struct nilfs_transaction_info {
140 u32 ti_magic;
141 void *ti_save;
142 /* This should never used. If this happens,
143 one of other filesystems has a bug. */
144 unsigned short ti_flags;
145 unsigned short ti_count;
146 struct list_head ti_garbage;
147 };
148
149 /* ti_magic */
150 #define NILFS_TI_MAGIC 0xd9e392fb
151
152 /* ti_flags */
153 #define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */
154 #define NILFS_TI_SYNC 0x0002 /* Force to construct segment at the
155 end of transaction. */
156 #define NILFS_TI_GC 0x0004 /* GC context */
157 #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */
158 #define NILFS_TI_WRITER 0x0010 /* Constructor context */
159
160
161 int nilfs_transaction_begin(struct super_block *,
162 struct nilfs_transaction_info *, int);
163 int nilfs_transaction_commit(struct super_block *);
164 void nilfs_transaction_abort(struct super_block *);
165
nilfs_set_transaction_flag(unsigned int flag)166 static inline void nilfs_set_transaction_flag(unsigned int flag)
167 {
168 struct nilfs_transaction_info *ti = current->journal_info;
169
170 ti->ti_flags |= flag;
171 }
172
nilfs_test_transaction_flag(unsigned int flag)173 static inline int nilfs_test_transaction_flag(unsigned int flag)
174 {
175 struct nilfs_transaction_info *ti = current->journal_info;
176
177 if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
178 return 0;
179 return !!(ti->ti_flags & flag);
180 }
181
nilfs_doing_gc(void)182 static inline int nilfs_doing_gc(void)
183 {
184 return nilfs_test_transaction_flag(NILFS_TI_GC);
185 }
186
nilfs_doing_construction(void)187 static inline int nilfs_doing_construction(void)
188 {
189 return nilfs_test_transaction_flag(NILFS_TI_WRITER);
190 }
191
192 /*
193 * function prototype
194 */
195 #ifdef CONFIG_NILFS_POSIX_ACL
196 #error "NILFS: not yet supported POSIX ACL"
197 extern int nilfs_acl_chmod(struct inode *);
198 extern int nilfs_init_acl(struct inode *, struct inode *);
199 #else
nilfs_acl_chmod(struct inode * inode)200 static inline int nilfs_acl_chmod(struct inode *inode)
201 {
202 return 0;
203 }
204
nilfs_init_acl(struct inode * inode,struct inode * dir)205 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
206 {
207 inode->i_mode &= ~current_umask();
208 return 0;
209 }
210 #endif
211
212 #define NILFS_ATIME_DISABLE
213
214 /* Flags that should be inherited by new inodes from their parent. */
215 #define NILFS_FL_INHERITED \
216 (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL | \
217 FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
218 FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
219
220 /* Mask out flags that are inappropriate for the given type of inode. */
nilfs_mask_flags(umode_t mode,__u32 flags)221 static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
222 {
223 if (S_ISDIR(mode))
224 return flags;
225 else if (S_ISREG(mode))
226 return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
227 else
228 return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
229 }
230
231 /* dir.c */
232 extern int nilfs_add_link(struct dentry *, struct inode *);
233 extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
234 extern int nilfs_make_empty(struct inode *, struct inode *);
235 extern struct nilfs_dir_entry *
236 nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
237 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
238 extern int nilfs_empty_dir(struct inode *);
239 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
240 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
241 struct page *, struct inode *);
242
243 /* file.c */
244 extern int nilfs_sync_file(struct file *, int);
245
246 /* ioctl.c */
247 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
248 long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
249 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
250 void **);
251
252 /* inode.c */
253 void nilfs_inode_add_blocks(struct inode *inode, int n);
254 void nilfs_inode_sub_blocks(struct inode *inode, int n);
255 extern struct inode *nilfs_new_inode(struct inode *, int);
256 extern void nilfs_free_inode(struct inode *);
257 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
258 extern void nilfs_set_inode_flags(struct inode *);
259 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
260 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
261 struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
262 unsigned long ino);
263 struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
264 unsigned long ino);
265 struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
266 unsigned long ino);
267 extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
268 unsigned long ino, __u64 cno);
269 extern void nilfs_update_inode(struct inode *, struct buffer_head *);
270 extern void nilfs_truncate(struct inode *);
271 extern void nilfs_evict_inode(struct inode *);
272 extern int nilfs_setattr(struct dentry *, struct iattr *);
273 int nilfs_permission(struct inode *inode, int mask, unsigned int flags);
274 int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
275 extern int nilfs_inode_dirty(struct inode *);
276 int nilfs_set_file_dirty(struct inode *inode, unsigned nr_dirty);
277 extern int nilfs_mark_inode_dirty(struct inode *);
278 extern void nilfs_dirty_inode(struct inode *);
279 int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
280 __u64 start, __u64 len);
281
282 /* super.c */
283 extern struct inode *nilfs_alloc_inode(struct super_block *);
284 extern void nilfs_destroy_inode(struct inode *);
285 extern void nilfs_error(struct super_block *, const char *, const char *, ...)
286 __attribute__ ((format (printf, 3, 4)));
287 extern void nilfs_warning(struct super_block *, const char *, const char *, ...)
288 __attribute__ ((format (printf, 3, 4)));
289 extern struct nilfs_super_block *
290 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
291 extern int nilfs_store_magic_and_option(struct super_block *,
292 struct nilfs_super_block *, char *);
293 extern int nilfs_check_feature_compatibility(struct super_block *,
294 struct nilfs_super_block *);
295 extern void nilfs_set_log_cursor(struct nilfs_super_block *,
296 struct the_nilfs *);
297 struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
298 int flip);
299 int nilfs_commit_super(struct super_block *sb, int flag);
300 int nilfs_cleanup_super(struct super_block *sb);
301 int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
302 struct nilfs_root **root);
303 int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
304
305 /* gcinode.c */
306 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
307 struct buffer_head **);
308 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
309 struct buffer_head **);
310 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
311 int nilfs_init_gcinode(struct inode *inode);
312 void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
313
314 /*
315 * Inodes and files operations
316 */
317 extern const struct file_operations nilfs_dir_operations;
318 extern const struct inode_operations nilfs_file_inode_operations;
319 extern const struct file_operations nilfs_file_operations;
320 extern const struct address_space_operations nilfs_aops;
321 extern const struct inode_operations nilfs_dir_inode_operations;
322 extern const struct inode_operations nilfs_special_inode_operations;
323 extern const struct inode_operations nilfs_symlink_inode_operations;
324
325 /*
326 * filesystem type
327 */
328 extern struct file_system_type nilfs_fs_type;
329
330
331 #endif /* _NILFS_H */
332