Commit | Line | Data |
---|---|---|
ae98043f | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
65b4643d | 2 | /* |
94ee1d91 | 3 | * NILFS local header file. |
65b4643d RK |
4 | * |
5 | * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation. | |
6 | * | |
4b420ab4 | 7 | * Written by Koji Sato and Ryusuke Konishi. |
65b4643d RK |
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> | |
e63e88bc RK |
17 | #include <linux/nilfs2_api.h> |
18 | #include <linux/nilfs2_ondisk.h> | |
65b4643d | 19 | #include "the_nilfs.h" |
65b4643d | 20 | #include "bmap.h" |
65b4643d | 21 | |
f5974c8f VD |
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 | |
e897be17 | 31 | * @i_assoc_inode: associated inode (B-tree node cache holder or back pointer) |
f5974c8f VD |
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 | |
65b4643d RK |
37 | */ |
38 | struct nilfs_inode_info { | |
39 | __u32 i_flags; | |
40 | unsigned long i_state; /* Dynamic state flags */ | |
41 | struct nilfs_bmap *i_bmap; | |
05d0e94b | 42 | struct nilfs_bmap i_bmap_data; |
65b4643d | 43 | __u64 i_xattr; /* sector_t ??? */ |
65b4643d RK |
44 | __u32 i_dir_start_lookup; |
45 | __u64 i_cno; /* check point number for GC inode */ | |
e897be17 | 46 | struct inode *i_assoc_inode; |
65b4643d RK |
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; | |
65b4643d | 58 | #endif |
076a378b RK |
59 | struct buffer_head *i_bh; /* |
60 | * i_bh contains a new or dirty | |
61 | * disk inode. | |
62 | */ | |
4d8d9293 | 63 | struct nilfs_root *i_root; |
65b4643d RK |
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 | { | |
05d0e94b | 75 | return container_of(bmap, struct nilfs_inode_info, i_bmap_data); |
65b4643d RK |
76 | } |
77 | ||
65b4643d RK |
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 */ | |
076a378b RK |
85 | NILFS_I_BUSY, /* |
86 | * Inode is grabbed by a segment | |
87 | * constructor | |
88 | */ | |
65b4643d RK |
89 | NILFS_I_COLLECTED, /* All dirty blocks are collected */ |
90 | NILFS_I_UPDATED, /* The file has been written back */ | |
b9f66140 | 91 | NILFS_I_INODE_SYNC, /* dsync is not allowed for inode */ |
65b4643d RK |
92 | NILFS_I_BMAP, /* has bmap and btnode_cache */ |
93 | NILFS_I_GCINODE, /* inode for GC, on memory only */ | |
e897be17 | 94 | NILFS_I_BTNC, /* inode for btree node cache */ |
6e211930 | 95 | NILFS_I_SHADOW, /* inode for shadowed page cache */ |
65b4643d RK |
96 | }; |
97 | ||
b2ac86e1 JS |
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 | ||
65b4643d RK |
106 | /* |
107 | * Macros to check inode numbers | |
108 | */ | |
4ce5c342 RK |
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)) | |
65b4643d | 113 | |
4ce5c342 | 114 | #define NILFS_SYS_INO_BITS (BIT(NILFS_ROOT_INO) | NILFS_MDT_INO_BITS) |
65b4643d | 115 | |
e3154e97 | 116 | #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino) |
65b4643d RK |
117 | |
118 | #define NILFS_MDT_INODE(sb, ino) \ | |
4ce5c342 | 119 | ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & BIT(ino))) |
65b4643d | 120 | #define NILFS_VALID_INODE(sb, ino) \ |
4ce5c342 | 121 | ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & BIT(ino))) |
65b4643d RK |
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 | |
65b4643d RK |
129 | */ |
130 | struct nilfs_transaction_info { | |
131 | u32 ti_magic; | |
132 | void *ti_save; | |
076a378b RK |
133 | /* |
134 | * This should never be used. If it happens, | |
135 | * one of other filesystems has a bug. | |
136 | */ | |
65b4643d RK |
137 | unsigned short ti_flags; |
138 | unsigned short ti_count; | |
65b4643d RK |
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 */ | |
076a378b RK |
146 | #define NILFS_TI_SYNC 0x0002 /* |
147 | * Force to construct segment at the | |
148 | * end of transaction. | |
149 | */ | |
65b4643d RK |
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); | |
47420c79 RK |
157 | int nilfs_transaction_commit(struct super_block *); |
158 | void nilfs_transaction_abort(struct super_block *); | |
65b4643d RK |
159 | |
160 | static inline void nilfs_set_transaction_flag(unsigned int flag) | |
161 | { | |
162 | struct nilfs_transaction_info *ti = current->journal_info; | |
163 | ||
65b4643d RK |
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 | ||
65b4643d RK |
186 | /* |
187 | * function prototype | |
188 | */ | |
189 | #ifdef CONFIG_NILFS_POSIX_ACL | |
190 | #error "NILFS: not yet supported POSIX ACL" | |
65b4643d RK |
191 | extern int nilfs_acl_chmod(struct inode *); |
192 | extern int nilfs_init_acl(struct inode *, struct inode *); | |
193 | #else | |
65b4643d RK |
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 | { | |
5924e6ec RK |
201 | if (S_ISLNK(inode->i_mode)) |
202 | return 0; | |
203 | ||
65b4643d RK |
204 | inode->i_mode &= ~current_umask(); |
205 | return 0; | |
206 | } | |
207 | #endif | |
208 | ||
209 | #define NILFS_ATIME_DISABLE | |
210 | ||
b253a3e4 RK |
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 | ||
65b4643d | 228 | /* dir.c */ |
6f133c97 MWO |
229 | int nilfs_add_link(struct dentry *, struct inode *); |
230 | ino_t nilfs_inode_by_name(struct inode *, const struct qstr *); | |
231 | int nilfs_make_empty(struct inode *, struct inode *); | |
232 | struct nilfs_dir_entry *nilfs_find_entry(struct inode *, const struct qstr *, | |
233 | struct folio **); | |
234 | int nilfs_delete_entry(struct nilfs_dir_entry *, struct folio *); | |
235 | int nilfs_empty_dir(struct inode *); | |
236 | struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct folio **); | |
237 | void nilfs_set_link(struct inode *, struct nilfs_dir_entry *, | |
238 | struct folio *, struct inode *); | |
65b4643d RK |
239 | |
240 | /* file.c */ | |
02c24a82 | 241 | extern int nilfs_sync_file(struct file *, loff_t, loff_t, int); |
65b4643d RK |
242 | |
243 | /* ioctl.c */ | |
7c7c436e | 244 | int nilfs_fileattr_get(struct dentry *dentry, struct fileattr *m); |
8782a9ae | 245 | int nilfs_fileattr_set(struct mnt_idmap *idmap, |
7c7c436e | 246 | struct dentry *dentry, struct fileattr *fa); |
7a946193 | 247 | long nilfs_ioctl(struct file *, unsigned int, unsigned long); |
828b1c50 | 248 | long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg); |
4f6b8288 RK |
249 | int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *, |
250 | void **); | |
65b4643d RK |
251 | |
252 | /* inode.c */ | |
be667377 RK |
253 | void nilfs_inode_add_blocks(struct inode *inode, int n); |
254 | void nilfs_inode_sub_blocks(struct inode *inode, int n); | |
c6e49e3f | 255 | extern struct inode *nilfs_new_inode(struct inode *, umode_t); |
65b4643d RK |
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 *); | |
9cced6a5 RK |
259 | void nilfs_write_inode_common(struct inode *inode, |
260 | struct nilfs_inode *raw_inode); | |
032dbb3b RK |
261 | struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root, |
262 | unsigned long ino); | |
f1e89c86 RK |
263 | struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root, |
264 | unsigned long ino); | |
4d8d9293 RK |
265 | struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root, |
266 | unsigned long ino); | |
263d90ce RK |
267 | extern struct inode *nilfs_iget_for_gc(struct super_block *sb, |
268 | unsigned long ino, __u64 cno); | |
e897be17 RK |
269 | int nilfs_attach_btree_node_cache(struct inode *inode); |
270 | void nilfs_detach_btree_node_cache(struct inode *inode); | |
6e211930 | 271 | struct inode *nilfs_iget_for_shadow(struct inode *inode); |
b9f66140 | 272 | extern void nilfs_update_inode(struct inode *, struct buffer_head *, int); |
65b4643d | 273 | extern void nilfs_truncate(struct inode *); |
6fd1e5c9 | 274 | extern void nilfs_evict_inode(struct inode *); |
c1632a0f | 275 | extern int nilfs_setattr(struct mnt_idmap *, struct dentry *, |
549c7297 | 276 | struct iattr *); |
2d1b399b | 277 | extern void nilfs_write_failed(struct address_space *mapping, loff_t to); |
4609e1f1 | 278 | int nilfs_permission(struct mnt_idmap *idmap, struct inode *inode, |
549c7297 | 279 | int mask); |
bcbc8c64 | 280 | int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh); |
65b4643d | 281 | extern int nilfs_inode_dirty(struct inode *); |
0c6c44cb | 282 | int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty); |
b9f66140 | 283 | extern int __nilfs_mark_inode_dirty(struct inode *, int); |
aa385729 | 284 | extern void nilfs_dirty_inode(struct inode *, int flags); |
622daaff RK |
285 | int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo, |
286 | __u64 start, __u64 len); | |
b9f66140 AR |
287 | static inline int nilfs_mark_inode_dirty(struct inode *inode) |
288 | { | |
289 | return __nilfs_mark_inode_dirty(inode, I_DIRTY); | |
290 | } | |
291 | static inline int nilfs_mark_inode_dirty_sync(struct inode *inode) | |
292 | { | |
293 | return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC); | |
294 | } | |
65b4643d | 295 | |
65b4643d RK |
296 | /* super.c */ |
297 | extern struct inode *nilfs_alloc_inode(struct super_block *); | |
cae3d4ca | 298 | |
2987a4cf JP |
299 | __printf(2, 3) |
300 | void __nilfs_msg(struct super_block *sb, const char *fmt, ...); | |
b9075fa9 | 301 | extern __printf(3, 4) |
cae3d4ca RK |
302 | void __nilfs_error(struct super_block *sb, const char *function, |
303 | const char *fmt, ...); | |
cae3d4ca RK |
304 | |
305 | #ifdef CONFIG_PRINTK | |
306 | ||
a66dfb0a | 307 | #define nilfs_msg(sb, level, fmt, ...) \ |
2987a4cf | 308 | __nilfs_msg(sb, level fmt, ##__VA_ARGS__) |
cae3d4ca RK |
309 | #define nilfs_error(sb, fmt, ...) \ |
310 | __nilfs_error(sb, __func__, fmt, ##__VA_ARGS__) | |
311 | ||
312 | #else | |
313 | ||
a66dfb0a | 314 | #define nilfs_msg(sb, level, fmt, ...) \ |
d6517deb | 315 | do { \ |
2987a4cf | 316 | no_printk(level fmt, ##__VA_ARGS__); \ |
d6517deb RK |
317 | (void)(sb); \ |
318 | } while (0) | |
cae3d4ca RK |
319 | #define nilfs_error(sb, fmt, ...) \ |
320 | do { \ | |
321 | no_printk(fmt, ##__VA_ARGS__); \ | |
322 | __nilfs_error(sb, "", " "); \ | |
323 | } while (0) | |
324 | ||
325 | #endif /* CONFIG_PRINTK */ | |
326 | ||
a1d0747a JP |
327 | #define nilfs_crit(sb, fmt, ...) \ |
328 | nilfs_msg(sb, KERN_CRIT, fmt, ##__VA_ARGS__) | |
329 | #define nilfs_err(sb, fmt, ...) \ | |
330 | nilfs_msg(sb, KERN_ERR, fmt, ##__VA_ARGS__) | |
331 | #define nilfs_warn(sb, fmt, ...) \ | |
332 | nilfs_msg(sb, KERN_WARNING, fmt, ##__VA_ARGS__) | |
333 | #define nilfs_info(sb, fmt, ...) \ | |
334 | nilfs_msg(sb, KERN_INFO, fmt, ##__VA_ARGS__) | |
335 | ||
65b4643d | 336 | extern struct nilfs_super_block * |
e339ad31 | 337 | nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **); |
36defdd9 ES |
338 | extern int nilfs_store_magic(struct super_block *sb, |
339 | struct nilfs_super_block *sbp); | |
c5ca48aa RK |
340 | extern int nilfs_check_feature_compatibility(struct super_block *, |
341 | struct nilfs_super_block *); | |
60f46b7e RK |
342 | extern void nilfs_set_log_cursor(struct nilfs_super_block *, |
343 | struct the_nilfs *); | |
f7545144 RK |
344 | struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb, |
345 | int flip); | |
346 | int nilfs_commit_super(struct super_block *sb, int flag); | |
347 | int nilfs_cleanup_super(struct super_block *sb); | |
4e33f9ea | 348 | int nilfs_resize_fs(struct super_block *sb, __u64 newsize); |
f7545144 | 349 | int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt, |
4d8d9293 | 350 | struct nilfs_root **root); |
032dbb3b | 351 | int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno); |
65b4643d RK |
352 | |
353 | /* gcinode.c */ | |
354 | int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64, | |
355 | struct buffer_head **); | |
356 | int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64, | |
357 | struct buffer_head **); | |
358 | int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *); | |
263d90ce RK |
359 | int nilfs_init_gcinode(struct inode *inode); |
360 | void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs); | |
65b4643d | 361 | |
dd70edbd VD |
362 | /* sysfs.c */ |
363 | int __init nilfs_sysfs_init(void); | |
364 | void nilfs_sysfs_exit(void); | |
365 | int nilfs_sysfs_create_device_group(struct super_block *); | |
366 | void nilfs_sysfs_delete_device_group(struct the_nilfs *); | |
367 | int nilfs_sysfs_create_snapshot_group(struct nilfs_root *); | |
368 | void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *); | |
369 | ||
65b4643d RK |
370 | /* |
371 | * Inodes and files operations | |
372 | */ | |
828c0950 | 373 | extern const struct file_operations nilfs_dir_operations; |
6e1d5dcc | 374 | extern const struct inode_operations nilfs_file_inode_operations; |
828c0950 | 375 | extern const struct file_operations nilfs_file_operations; |
7f09410b | 376 | extern const struct address_space_operations nilfs_aops; |
6e1d5dcc AD |
377 | extern const struct inode_operations nilfs_dir_inode_operations; |
378 | extern const struct inode_operations nilfs_special_inode_operations; | |
379 | extern const struct inode_operations nilfs_symlink_inode_operations; | |
65b4643d RK |
380 | |
381 | /* | |
382 | * filesystem type | |
383 | */ | |
384 | extern struct file_system_type nilfs_fs_type; | |
385 | ||
386 | ||
387 | #endif /* _NILFS_H */ |