Commit | Line | Data |
---|---|---|
65b4643d RK |
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 | * | |
4b420ab4 | 16 | * Written by Koji Sato and Ryusuke Konishi. |
65b4643d RK |
17 | */ |
18 | ||
19 | #ifndef _NILFS_H | |
20 | #define _NILFS_H | |
21 | ||
22 | #include <linux/kernel.h> | |
23 | #include <linux/buffer_head.h> | |
24 | #include <linux/spinlock.h> | |
25 | #include <linux/blkdev.h> | |
e63e88bc RK |
26 | #include <linux/nilfs2_api.h> |
27 | #include <linux/nilfs2_ondisk.h> | |
65b4643d | 28 | #include "the_nilfs.h" |
65b4643d | 29 | #include "bmap.h" |
65b4643d | 30 | |
f5974c8f VD |
31 | /** |
32 | * struct nilfs_inode_info - nilfs inode data in memory | |
33 | * @i_flags: inode flags | |
34 | * @i_state: dynamic state flags | |
35 | * @i_bmap: pointer on i_bmap_data | |
36 | * @i_bmap_data: raw block mapping | |
37 | * @i_xattr: <TODO> | |
38 | * @i_dir_start_lookup: page index of last successful search | |
39 | * @i_cno: checkpoint number for GC inode | |
40 | * @i_btnode_cache: cached pages of b-tree nodes | |
41 | * @i_dirty: list for connecting dirty files | |
42 | * @xattr_sem: semaphore for extended attributes processing | |
43 | * @i_bh: buffer contains disk inode | |
44 | * @i_root: root object of the current filesystem tree | |
45 | * @vfs_inode: VFS inode object | |
65b4643d RK |
46 | */ |
47 | struct nilfs_inode_info { | |
48 | __u32 i_flags; | |
49 | unsigned long i_state; /* Dynamic state flags */ | |
50 | struct nilfs_bmap *i_bmap; | |
05d0e94b | 51 | struct nilfs_bmap i_bmap_data; |
65b4643d | 52 | __u64 i_xattr; /* sector_t ??? */ |
65b4643d RK |
53 | __u32 i_dir_start_lookup; |
54 | __u64 i_cno; /* check point number for GC inode */ | |
55 | struct address_space i_btnode_cache; | |
56 | struct list_head i_dirty; /* List for connecting dirty files */ | |
57 | ||
58 | #ifdef CONFIG_NILFS_XATTR | |
59 | /* | |
60 | * Extended attributes can be read independently of the main file | |
61 | * data. Taking i_sem even when reading would cause contention | |
62 | * between readers of EAs and writers of regular file data, so | |
63 | * instead we synchronize on xattr_sem when reading or changing | |
64 | * EAs. | |
65 | */ | |
66 | struct rw_semaphore xattr_sem; | |
65b4643d | 67 | #endif |
076a378b RK |
68 | struct buffer_head *i_bh; /* |
69 | * i_bh contains a new or dirty | |
70 | * disk inode. | |
71 | */ | |
4d8d9293 | 72 | struct nilfs_root *i_root; |
65b4643d RK |
73 | struct inode vfs_inode; |
74 | }; | |
75 | ||
76 | static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode) | |
77 | { | |
78 | return container_of(inode, struct nilfs_inode_info, vfs_inode); | |
79 | } | |
80 | ||
81 | static inline struct nilfs_inode_info * | |
82 | NILFS_BMAP_I(const struct nilfs_bmap *bmap) | |
83 | { | |
05d0e94b | 84 | return container_of(bmap, struct nilfs_inode_info, i_bmap_data); |
65b4643d RK |
85 | } |
86 | ||
87 | static inline struct inode *NILFS_BTNC_I(struct address_space *btnc) | |
88 | { | |
89 | struct nilfs_inode_info *ii = | |
90 | container_of(btnc, struct nilfs_inode_info, i_btnode_cache); | |
91 | return &ii->vfs_inode; | |
92 | } | |
93 | ||
65b4643d RK |
94 | /* |
95 | * Dynamic state flags of NILFS on-memory inode (i_state) | |
96 | */ | |
97 | enum { | |
98 | NILFS_I_NEW = 0, /* Inode is newly created */ | |
99 | NILFS_I_DIRTY, /* The file is dirty */ | |
100 | NILFS_I_QUEUED, /* inode is in dirty_files list */ | |
076a378b RK |
101 | NILFS_I_BUSY, /* |
102 | * Inode is grabbed by a segment | |
103 | * constructor | |
104 | */ | |
65b4643d RK |
105 | NILFS_I_COLLECTED, /* All dirty blocks are collected */ |
106 | NILFS_I_UPDATED, /* The file has been written back */ | |
b9f66140 | 107 | NILFS_I_INODE_SYNC, /* dsync is not allowed for inode */ |
65b4643d RK |
108 | NILFS_I_BMAP, /* has bmap and btnode_cache */ |
109 | NILFS_I_GCINODE, /* inode for GC, on memory only */ | |
65b4643d RK |
110 | }; |
111 | ||
b2ac86e1 JS |
112 | /* |
113 | * commit flags for nilfs_commit_super and nilfs_sync_super | |
114 | */ | |
115 | enum { | |
116 | NILFS_SB_COMMIT = 0, /* Commit a super block alternately */ | |
117 | NILFS_SB_COMMIT_ALL /* Commit both super blocks */ | |
118 | }; | |
119 | ||
65b4643d RK |
120 | /* |
121 | * Macros to check inode numbers | |
122 | */ | |
4ce5c342 RK |
123 | #define NILFS_MDT_INO_BITS \ |
124 | (BIT(NILFS_DAT_INO) | BIT(NILFS_CPFILE_INO) | \ | |
125 | BIT(NILFS_SUFILE_INO) | BIT(NILFS_IFILE_INO) | \ | |
126 | BIT(NILFS_ATIME_INO) | BIT(NILFS_SKETCH_INO)) | |
65b4643d | 127 | |
4ce5c342 | 128 | #define NILFS_SYS_INO_BITS (BIT(NILFS_ROOT_INO) | NILFS_MDT_INO_BITS) |
65b4643d | 129 | |
e3154e97 | 130 | #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino) |
65b4643d RK |
131 | |
132 | #define NILFS_MDT_INODE(sb, ino) \ | |
4ce5c342 | 133 | ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & BIT(ino))) |
65b4643d | 134 | #define NILFS_VALID_INODE(sb, ino) \ |
4ce5c342 | 135 | ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & BIT(ino))) |
65b4643d RK |
136 | |
137 | /** | |
138 | * struct nilfs_transaction_info: context information for synchronization | |
139 | * @ti_magic: Magic number | |
140 | * @ti_save: Backup of journal_info field of task_struct | |
141 | * @ti_flags: Flags | |
142 | * @ti_count: Nest level | |
65b4643d RK |
143 | */ |
144 | struct nilfs_transaction_info { | |
145 | u32 ti_magic; | |
146 | void *ti_save; | |
076a378b RK |
147 | /* |
148 | * This should never be used. If it happens, | |
149 | * one of other filesystems has a bug. | |
150 | */ | |
65b4643d RK |
151 | unsigned short ti_flags; |
152 | unsigned short ti_count; | |
65b4643d RK |
153 | }; |
154 | ||
155 | /* ti_magic */ | |
156 | #define NILFS_TI_MAGIC 0xd9e392fb | |
157 | ||
158 | /* ti_flags */ | |
159 | #define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */ | |
076a378b RK |
160 | #define NILFS_TI_SYNC 0x0002 /* |
161 | * Force to construct segment at the | |
162 | * end of transaction. | |
163 | */ | |
65b4643d RK |
164 | #define NILFS_TI_GC 0x0004 /* GC context */ |
165 | #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */ | |
166 | #define NILFS_TI_WRITER 0x0010 /* Constructor context */ | |
167 | ||
168 | ||
169 | int nilfs_transaction_begin(struct super_block *, | |
170 | struct nilfs_transaction_info *, int); | |
47420c79 RK |
171 | int nilfs_transaction_commit(struct super_block *); |
172 | void nilfs_transaction_abort(struct super_block *); | |
65b4643d RK |
173 | |
174 | static inline void nilfs_set_transaction_flag(unsigned int flag) | |
175 | { | |
176 | struct nilfs_transaction_info *ti = current->journal_info; | |
177 | ||
65b4643d RK |
178 | ti->ti_flags |= flag; |
179 | } | |
180 | ||
181 | static inline int nilfs_test_transaction_flag(unsigned int flag) | |
182 | { | |
183 | struct nilfs_transaction_info *ti = current->journal_info; | |
184 | ||
185 | if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC) | |
186 | return 0; | |
187 | return !!(ti->ti_flags & flag); | |
188 | } | |
189 | ||
190 | static inline int nilfs_doing_gc(void) | |
191 | { | |
192 | return nilfs_test_transaction_flag(NILFS_TI_GC); | |
193 | } | |
194 | ||
195 | static inline int nilfs_doing_construction(void) | |
196 | { | |
197 | return nilfs_test_transaction_flag(NILFS_TI_WRITER); | |
198 | } | |
199 | ||
65b4643d RK |
200 | /* |
201 | * function prototype | |
202 | */ | |
203 | #ifdef CONFIG_NILFS_POSIX_ACL | |
204 | #error "NILFS: not yet supported POSIX ACL" | |
65b4643d RK |
205 | extern int nilfs_acl_chmod(struct inode *); |
206 | extern int nilfs_init_acl(struct inode *, struct inode *); | |
207 | #else | |
65b4643d RK |
208 | static inline int nilfs_acl_chmod(struct inode *inode) |
209 | { | |
210 | return 0; | |
211 | } | |
212 | ||
213 | static inline int nilfs_init_acl(struct inode *inode, struct inode *dir) | |
214 | { | |
215 | inode->i_mode &= ~current_umask(); | |
216 | return 0; | |
217 | } | |
218 | #endif | |
219 | ||
220 | #define NILFS_ATIME_DISABLE | |
221 | ||
b253a3e4 RK |
222 | /* Flags that should be inherited by new inodes from their parent. */ |
223 | #define NILFS_FL_INHERITED \ | |
224 | (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL | \ | |
225 | FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\ | |
226 | FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL) | |
227 | ||
228 | /* Mask out flags that are inappropriate for the given type of inode. */ | |
229 | static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags) | |
230 | { | |
231 | if (S_ISDIR(mode)) | |
232 | return flags; | |
233 | else if (S_ISREG(mode)) | |
234 | return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL); | |
235 | else | |
236 | return flags & (FS_NODUMP_FL | FS_NOATIME_FL); | |
237 | } | |
238 | ||
65b4643d RK |
239 | /* dir.c */ |
240 | extern int nilfs_add_link(struct dentry *, struct inode *); | |
0319003d | 241 | extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *); |
65b4643d RK |
242 | extern int nilfs_make_empty(struct inode *, struct inode *); |
243 | extern struct nilfs_dir_entry * | |
0319003d | 244 | nilfs_find_entry(struct inode *, const struct qstr *, struct page **); |
65b4643d RK |
245 | extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *); |
246 | extern int nilfs_empty_dir(struct inode *); | |
247 | extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **); | |
248 | extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *, | |
249 | struct page *, struct inode *); | |
250 | ||
251 | /* file.c */ | |
02c24a82 | 252 | extern int nilfs_sync_file(struct file *, loff_t, loff_t, int); |
65b4643d RK |
253 | |
254 | /* ioctl.c */ | |
7a946193 | 255 | long nilfs_ioctl(struct file *, unsigned int, unsigned long); |
828b1c50 | 256 | long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg); |
4f6b8288 RK |
257 | int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *, |
258 | void **); | |
65b4643d RK |
259 | |
260 | /* inode.c */ | |
be667377 RK |
261 | void nilfs_inode_add_blocks(struct inode *inode, int n); |
262 | void nilfs_inode_sub_blocks(struct inode *inode, int n); | |
c6e49e3f | 263 | extern struct inode *nilfs_new_inode(struct inode *, umode_t); |
65b4643d RK |
264 | extern void nilfs_free_inode(struct inode *); |
265 | extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int); | |
266 | extern void nilfs_set_inode_flags(struct inode *); | |
267 | extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *); | |
268 | extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int); | |
032dbb3b RK |
269 | struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root, |
270 | unsigned long ino); | |
f1e89c86 RK |
271 | struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root, |
272 | unsigned long ino); | |
4d8d9293 RK |
273 | struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root, |
274 | unsigned long ino); | |
263d90ce RK |
275 | extern struct inode *nilfs_iget_for_gc(struct super_block *sb, |
276 | unsigned long ino, __u64 cno); | |
b9f66140 | 277 | extern void nilfs_update_inode(struct inode *, struct buffer_head *, int); |
65b4643d | 278 | extern void nilfs_truncate(struct inode *); |
6fd1e5c9 | 279 | extern void nilfs_evict_inode(struct inode *); |
65b4643d | 280 | extern int nilfs_setattr(struct dentry *, struct iattr *); |
2d1b399b | 281 | extern void nilfs_write_failed(struct address_space *mapping, loff_t to); |
10556cb2 | 282 | int nilfs_permission(struct inode *inode, int mask); |
bcbc8c64 | 283 | int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh); |
65b4643d | 284 | extern int nilfs_inode_dirty(struct inode *); |
0c6c44cb | 285 | int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty); |
b9f66140 | 286 | extern int __nilfs_mark_inode_dirty(struct inode *, int); |
aa385729 | 287 | extern void nilfs_dirty_inode(struct inode *, int flags); |
622daaff RK |
288 | int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, |
289 | __u64 start, __u64 len); | |
b9f66140 AR |
290 | static inline int nilfs_mark_inode_dirty(struct inode *inode) |
291 | { | |
292 | return __nilfs_mark_inode_dirty(inode, I_DIRTY); | |
293 | } | |
294 | static inline int nilfs_mark_inode_dirty_sync(struct inode *inode) | |
295 | { | |
296 | return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC); | |
297 | } | |
65b4643d | 298 | |
65b4643d RK |
299 | /* super.c */ |
300 | extern struct inode *nilfs_alloc_inode(struct super_block *); | |
301 | extern void nilfs_destroy_inode(struct inode *); | |
cae3d4ca | 302 | |
a66dfb0a RK |
303 | extern __printf(3, 4) |
304 | void __nilfs_msg(struct super_block *sb, const char *level, | |
305 | const char *fmt, ...); | |
b9075fa9 | 306 | extern __printf(3, 4) |
cae3d4ca RK |
307 | void __nilfs_error(struct super_block *sb, const char *function, |
308 | const char *fmt, ...); | |
cae3d4ca RK |
309 | |
310 | #ifdef CONFIG_PRINTK | |
311 | ||
a66dfb0a RK |
312 | #define nilfs_msg(sb, level, fmt, ...) \ |
313 | __nilfs_msg(sb, level, fmt, ##__VA_ARGS__) | |
cae3d4ca RK |
314 | #define nilfs_error(sb, fmt, ...) \ |
315 | __nilfs_error(sb, __func__, fmt, ##__VA_ARGS__) | |
316 | ||
317 | #else | |
318 | ||
a66dfb0a | 319 | #define nilfs_msg(sb, level, fmt, ...) \ |
d6517deb RK |
320 | do { \ |
321 | no_printk(fmt, ##__VA_ARGS__); \ | |
322 | (void)(sb); \ | |
323 | } while (0) | |
cae3d4ca RK |
324 | #define nilfs_error(sb, fmt, ...) \ |
325 | do { \ | |
326 | no_printk(fmt, ##__VA_ARGS__); \ | |
327 | __nilfs_error(sb, "", " "); \ | |
328 | } while (0) | |
329 | ||
330 | #endif /* CONFIG_PRINTK */ | |
331 | ||
65b4643d | 332 | extern struct nilfs_super_block * |
e339ad31 | 333 | nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **); |
65b4643d RK |
334 | extern int nilfs_store_magic_and_option(struct super_block *, |
335 | struct nilfs_super_block *, char *); | |
c5ca48aa RK |
336 | extern int nilfs_check_feature_compatibility(struct super_block *, |
337 | struct nilfs_super_block *); | |
60f46b7e RK |
338 | extern void nilfs_set_log_cursor(struct nilfs_super_block *, |
339 | struct the_nilfs *); | |
f7545144 RK |
340 | struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb, |
341 | int flip); | |
342 | int nilfs_commit_super(struct super_block *sb, int flag); | |
343 | int nilfs_cleanup_super(struct super_block *sb); | |
4e33f9ea | 344 | int nilfs_resize_fs(struct super_block *sb, __u64 newsize); |
f7545144 | 345 | int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt, |
4d8d9293 | 346 | struct nilfs_root **root); |
032dbb3b | 347 | int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno); |
65b4643d RK |
348 | |
349 | /* gcinode.c */ | |
350 | int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64, | |
351 | struct buffer_head **); | |
352 | int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64, | |
353 | struct buffer_head **); | |
354 | int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *); | |
263d90ce RK |
355 | int nilfs_init_gcinode(struct inode *inode); |
356 | void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs); | |
65b4643d | 357 | |
dd70edbd VD |
358 | /* sysfs.c */ |
359 | int __init nilfs_sysfs_init(void); | |
360 | void nilfs_sysfs_exit(void); | |
361 | int nilfs_sysfs_create_device_group(struct super_block *); | |
362 | void nilfs_sysfs_delete_device_group(struct the_nilfs *); | |
363 | int nilfs_sysfs_create_snapshot_group(struct nilfs_root *); | |
364 | void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *); | |
365 | ||
65b4643d RK |
366 | /* |
367 | * Inodes and files operations | |
368 | */ | |
828c0950 | 369 | extern const struct file_operations nilfs_dir_operations; |
6e1d5dcc | 370 | extern const struct inode_operations nilfs_file_inode_operations; |
828c0950 | 371 | extern const struct file_operations nilfs_file_operations; |
7f09410b | 372 | extern const struct address_space_operations nilfs_aops; |
6e1d5dcc AD |
373 | extern const struct inode_operations nilfs_dir_inode_operations; |
374 | extern const struct inode_operations nilfs_special_inode_operations; | |
375 | extern const struct inode_operations nilfs_symlink_inode_operations; | |
65b4643d RK |
376 | |
377 | /* | |
378 | * filesystem type | |
379 | */ | |
380 | extern struct file_system_type nilfs_fs_type; | |
381 | ||
382 | ||
383 | #endif /* _NILFS_H */ |