1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
2 | /* |
3 | * NILFS local header file. |
4 | * |
5 | * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation. |
6 | * |
7 | * Written by Koji Sato and Ryusuke Konishi. |
8 | */ |
9 | |
10 | #ifndef _NILFS_H |
11 | #define _NILFS_H |
12 | |
13 | #include <linux/kernel.h> |
14 | #include <linux/buffer_head.h> |
15 | #include <linux/spinlock.h> |
16 | #include <linux/blkdev.h> |
17 | #include <linux/nilfs2_api.h> |
18 | #include <linux/nilfs2_ondisk.h> |
19 | #include "the_nilfs.h" |
20 | #include "bmap.h" |
21 | |
22 | /** |
23 | * struct nilfs_inode_info - nilfs inode data in memory |
24 | * @i_flags: inode flags |
25 | * @i_state: dynamic state flags |
26 | * @i_bmap: pointer on i_bmap_data |
27 | * @i_bmap_data: raw block mapping |
28 | * @i_xattr: <TODO> |
29 | * @i_dir_start_lookup: page index of last successful search |
30 | * @i_cno: checkpoint number for GC inode |
31 | * @i_assoc_inode: associated inode (B-tree node cache holder or back pointer) |
32 | * @i_dirty: list for connecting dirty files |
33 | * @xattr_sem: semaphore for extended attributes processing |
34 | * @i_bh: buffer contains disk inode |
35 | * @i_root: root object of the current filesystem tree |
36 | * @vfs_inode: VFS inode object |
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 inode *i_assoc_inode; |
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; /* |
60 | * i_bh contains a new or dirty |
61 | * disk inode. |
62 | */ |
63 | struct nilfs_root *i_root; |
64 | struct inode vfs_inode; |
65 | }; |
66 | |
67 | static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode) |
68 | { |
69 | return container_of(inode, struct nilfs_inode_info, vfs_inode); |
70 | } |
71 | |
72 | static inline struct nilfs_inode_info * |
73 | NILFS_BMAP_I(const struct nilfs_bmap *bmap) |
74 | { |
75 | return container_of(bmap, struct nilfs_inode_info, i_bmap_data); |
76 | } |
77 | |
78 | /* |
79 | * Dynamic state flags of NILFS on-memory inode (i_state) |
80 | */ |
81 | enum { |
82 | NILFS_I_NEW = 0, /* Inode is newly created */ |
83 | NILFS_I_DIRTY, /* The file is dirty */ |
84 | NILFS_I_QUEUED, /* inode is in dirty_files list */ |
85 | NILFS_I_BUSY, /* |
86 | * Inode is grabbed by a segment |
87 | * constructor |
88 | */ |
89 | NILFS_I_COLLECTED, /* All dirty blocks are collected */ |
90 | NILFS_I_UPDATED, /* The file has been written back */ |
91 | NILFS_I_INODE_SYNC, /* dsync is not allowed for inode */ |
92 | NILFS_I_BMAP, /* has bmap and btnode_cache */ |
93 | NILFS_I_GCINODE, /* inode for GC, on memory only */ |
94 | NILFS_I_BTNC, /* inode for btree node cache */ |
95 | NILFS_I_SHADOW, /* inode for shadowed page cache */ |
96 | }; |
97 | |
98 | /* |
99 | * commit flags for nilfs_commit_super and nilfs_sync_super |
100 | */ |
101 | enum { |
102 | NILFS_SB_COMMIT = 0, /* Commit a super block alternately */ |
103 | NILFS_SB_COMMIT_ALL /* Commit both super blocks */ |
104 | }; |
105 | |
106 | /* |
107 | * Macros to check inode numbers |
108 | */ |
109 | #define NILFS_MDT_INO_BITS \ |
110 | (BIT(NILFS_DAT_INO) | BIT(NILFS_CPFILE_INO) | \ |
111 | BIT(NILFS_SUFILE_INO) | BIT(NILFS_IFILE_INO) | \ |
112 | BIT(NILFS_ATIME_INO) | BIT(NILFS_SKETCH_INO)) |
113 | |
114 | #define NILFS_SYS_INO_BITS (BIT(NILFS_ROOT_INO) | NILFS_MDT_INO_BITS) |
115 | |
116 | #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino) |
117 | |
118 | #define NILFS_MDT_INODE(sb, ino) \ |
119 | ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & BIT(ino))) |
120 | #define NILFS_VALID_INODE(sb, ino) \ |
121 | ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & BIT(ino))) |
122 | |
123 | /** |
124 | * struct nilfs_transaction_info: context information for synchronization |
125 | * @ti_magic: Magic number |
126 | * @ti_save: Backup of journal_info field of task_struct |
127 | * @ti_flags: Flags |
128 | * @ti_count: Nest level |
129 | */ |
130 | struct nilfs_transaction_info { |
131 | u32 ti_magic; |
132 | void *ti_save; |
133 | /* |
134 | * This should never be used. If it happens, |
135 | * one of other filesystems has a bug. |
136 | */ |
137 | unsigned short ti_flags; |
138 | unsigned short ti_count; |
139 | }; |
140 | |
141 | /* ti_magic */ |
142 | #define NILFS_TI_MAGIC 0xd9e392fb |
143 | |
144 | /* ti_flags */ |
145 | #define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */ |
146 | #define NILFS_TI_SYNC 0x0002 /* |
147 | * Force to construct segment at the |
148 | * end of transaction. |
149 | */ |
150 | #define NILFS_TI_GC 0x0004 /* GC context */ |
151 | #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */ |
152 | #define NILFS_TI_WRITER 0x0010 /* Constructor context */ |
153 | |
154 | |
155 | int nilfs_transaction_begin(struct super_block *, |
156 | struct nilfs_transaction_info *, int); |
157 | int nilfs_transaction_commit(struct super_block *); |
158 | void nilfs_transaction_abort(struct super_block *); |
159 | |
160 | static inline void nilfs_set_transaction_flag(unsigned int flag) |
161 | { |
162 | struct nilfs_transaction_info *ti = current->journal_info; |
163 | |
164 | ti->ti_flags |= flag; |
165 | } |
166 | |
167 | static inline int nilfs_test_transaction_flag(unsigned int flag) |
168 | { |
169 | struct nilfs_transaction_info *ti = current->journal_info; |
170 | |
171 | if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC) |
172 | return 0; |
173 | return !!(ti->ti_flags & flag); |
174 | } |
175 | |
176 | static inline int nilfs_doing_gc(void) |
177 | { |
178 | return nilfs_test_transaction_flag(NILFS_TI_GC); |
179 | } |
180 | |
181 | static inline int nilfs_doing_construction(void) |
182 | { |
183 | return nilfs_test_transaction_flag(NILFS_TI_WRITER); |
184 | } |
185 | |
186 | /* |
187 | * function prototype |
188 | */ |
189 | #ifdef CONFIG_NILFS_POSIX_ACL |
190 | #error "NILFS: not yet supported POSIX ACL" |
191 | extern int nilfs_acl_chmod(struct inode *); |
192 | extern int nilfs_init_acl(struct inode *, struct inode *); |
193 | #else |
194 | static inline int nilfs_acl_chmod(struct inode *inode) |
195 | { |
196 | return 0; |
197 | } |
198 | |
199 | static inline int nilfs_init_acl(struct inode *inode, struct inode *dir) |
200 | { |
201 | if (S_ISLNK(inode->i_mode)) |
202 | return 0; |
203 | |
204 | inode->i_mode &= ~current_umask(); |
205 | return 0; |
206 | } |
207 | #endif |
208 | |
209 | #define NILFS_ATIME_DISABLE |
210 | |
211 | /* Flags that should be inherited by new inodes from their parent. */ |
212 | #define NILFS_FL_INHERITED \ |
213 | (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL | \ |
214 | FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\ |
215 | FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL) |
216 | |
217 | /* Mask out flags that are inappropriate for the given type of inode. */ |
218 | static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags) |
219 | { |
220 | if (S_ISDIR(mode)) |
221 | return flags; |
222 | else if (S_ISREG(mode)) |
223 | return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL); |
224 | else |
225 | return flags & (FS_NODUMP_FL | FS_NOATIME_FL); |
226 | } |
227 | |
228 | /* dir.c */ |
229 | extern int nilfs_add_link(struct dentry *, struct inode *); |
230 | extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *); |
231 | extern int nilfs_make_empty(struct inode *, struct inode *); |
232 | extern struct nilfs_dir_entry * |
233 | nilfs_find_entry(struct inode *, const struct qstr *, struct page **); |
234 | extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *); |
235 | extern int nilfs_empty_dir(struct inode *); |
236 | extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **); |
237 | extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *, |
238 | struct page *, struct inode *); |
239 | |
240 | /* file.c */ |
241 | extern int nilfs_sync_file(struct file *, loff_t, loff_t, int); |
242 | |
243 | /* ioctl.c */ |
244 | int nilfs_fileattr_get(struct dentry *dentry, struct fileattr *m); |
245 | int nilfs_fileattr_set(struct mnt_idmap *idmap, |
246 | struct dentry *dentry, struct fileattr *fa); |
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 *, umode_t); |
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, |
261 | unsigned long ino); |
262 | struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root, |
263 | unsigned long ino); |
264 | struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root, |
265 | unsigned long ino); |
266 | extern struct inode *nilfs_iget_for_gc(struct super_block *sb, |
267 | unsigned long ino, __u64 cno); |
268 | int nilfs_attach_btree_node_cache(struct inode *inode); |
269 | void nilfs_detach_btree_node_cache(struct inode *inode); |
270 | struct inode *nilfs_iget_for_shadow(struct inode *inode); |
271 | extern void nilfs_update_inode(struct inode *, struct buffer_head *, int); |
272 | extern void nilfs_truncate(struct inode *); |
273 | extern void nilfs_evict_inode(struct inode *); |
274 | extern int nilfs_setattr(struct mnt_idmap *, struct dentry *, |
275 | struct iattr *); |
276 | extern void nilfs_write_failed(struct address_space *mapping, loff_t to); |
277 | int nilfs_permission(struct mnt_idmap *idmap, struct inode *inode, |
278 | int mask); |
279 | int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh); |
280 | extern int nilfs_inode_dirty(struct inode *); |
281 | int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty); |
282 | extern int __nilfs_mark_inode_dirty(struct inode *, int); |
283 | extern void nilfs_dirty_inode(struct inode *, int flags); |
284 | int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, |
285 | __u64 start, __u64 len); |
286 | static inline int nilfs_mark_inode_dirty(struct inode *inode) |
287 | { |
288 | return __nilfs_mark_inode_dirty(inode, I_DIRTY); |
289 | } |
290 | static inline int nilfs_mark_inode_dirty_sync(struct inode *inode) |
291 | { |
292 | return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC); |
293 | } |
294 | |
295 | /* super.c */ |
296 | extern struct inode *nilfs_alloc_inode(struct super_block *); |
297 | |
298 | __printf(2, 3) |
299 | void __nilfs_msg(struct super_block *sb, const char *fmt, ...); |
300 | extern __printf(3, 4) |
301 | void __nilfs_error(struct super_block *sb, const char *function, |
302 | const char *fmt, ...); |
303 | |
304 | #ifdef CONFIG_PRINTK |
305 | |
306 | #define nilfs_msg(sb, level, fmt, ...) \ |
307 | __nilfs_msg(sb, level fmt, ##__VA_ARGS__) |
308 | #define nilfs_error(sb, fmt, ...) \ |
309 | __nilfs_error(sb, __func__, fmt, ##__VA_ARGS__) |
310 | |
311 | #else |
312 | |
313 | #define nilfs_msg(sb, level, fmt, ...) \ |
314 | do { \ |
315 | no_printk(level fmt, ##__VA_ARGS__); \ |
316 | (void)(sb); \ |
317 | } while (0) |
318 | #define nilfs_error(sb, fmt, ...) \ |
319 | do { \ |
320 | no_printk(fmt, ##__VA_ARGS__); \ |
321 | __nilfs_error(sb, "", " "); \ |
322 | } while (0) |
323 | |
324 | #endif /* CONFIG_PRINTK */ |
325 | |
326 | #define nilfs_crit(sb, fmt, ...) \ |
327 | nilfs_msg(sb, KERN_CRIT, fmt, ##__VA_ARGS__) |
328 | #define nilfs_err(sb, fmt, ...) \ |
329 | nilfs_msg(sb, KERN_ERR, fmt, ##__VA_ARGS__) |
330 | #define nilfs_warn(sb, fmt, ...) \ |
331 | nilfs_msg(sb, KERN_WARNING, fmt, ##__VA_ARGS__) |
332 | #define nilfs_info(sb, fmt, ...) \ |
333 | nilfs_msg(sb, KERN_INFO, fmt, ##__VA_ARGS__) |
334 | |
335 | extern struct nilfs_super_block * |
336 | nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **); |
337 | extern int nilfs_store_magic_and_option(struct super_block *, |
338 | struct nilfs_super_block *, char *); |
339 | extern int nilfs_check_feature_compatibility(struct super_block *, |
340 | struct nilfs_super_block *); |
341 | extern void nilfs_set_log_cursor(struct nilfs_super_block *, |
342 | struct the_nilfs *); |
343 | struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb, |
344 | int flip); |
345 | int nilfs_commit_super(struct super_block *sb, int flag); |
346 | int nilfs_cleanup_super(struct super_block *sb); |
347 | int nilfs_resize_fs(struct super_block *sb, __u64 newsize); |
348 | int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt, |
349 | struct nilfs_root **root); |
350 | int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno); |
351 | |
352 | /* gcinode.c */ |
353 | int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64, |
354 | struct buffer_head **); |
355 | int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64, |
356 | struct buffer_head **); |
357 | int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *); |
358 | int nilfs_init_gcinode(struct inode *inode); |
359 | void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs); |
360 | |
361 | /* sysfs.c */ |
362 | int __init nilfs_sysfs_init(void); |
363 | void nilfs_sysfs_exit(void); |
364 | int nilfs_sysfs_create_device_group(struct super_block *); |
365 | void nilfs_sysfs_delete_device_group(struct the_nilfs *); |
366 | int nilfs_sysfs_create_snapshot_group(struct nilfs_root *); |
367 | void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *); |
368 | |
369 | /* |
370 | * Inodes and files operations |
371 | */ |
372 | extern const struct file_operations nilfs_dir_operations; |
373 | extern const struct inode_operations nilfs_file_inode_operations; |
374 | extern const struct file_operations nilfs_file_operations; |
375 | extern const struct address_space_operations nilfs_aops; |
376 | extern const struct inode_operations nilfs_dir_inode_operations; |
377 | extern const struct inode_operations nilfs_special_inode_operations; |
378 | extern const struct inode_operations nilfs_symlink_inode_operations; |
379 | |
380 | /* |
381 | * filesystem type |
382 | */ |
383 | extern struct file_system_type nilfs_fs_type; |
384 | |
385 | |
386 | #endif /* _NILFS_H */ |
387 | |