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 | * | |
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 "sb.h" | |
34 | #include "bmap.h" | |
35 | #include "bmap_union.h" | |
36 | ||
37 | /* | |
38 | * NILFS filesystem version | |
39 | */ | |
40 | #define NILFS_VERSION "2.0.5" | |
41 | ||
42 | /* | |
43 | * nilfs inode data in memory | |
44 | */ | |
45 | struct nilfs_inode_info { | |
46 | __u32 i_flags; | |
47 | unsigned long i_state; /* Dynamic state flags */ | |
48 | struct nilfs_bmap *i_bmap; | |
49 | union nilfs_bmap_union i_bmap_union; | |
50 | __u64 i_xattr; /* sector_t ??? */ | |
51 | __u32 i_dtime; | |
52 | __u32 i_dir_start_lookup; | |
53 | __u64 i_cno; /* check point number for GC inode */ | |
54 | struct address_space i_btnode_cache; | |
55 | struct list_head i_dirty; /* List for connecting dirty files */ | |
56 | ||
57 | #ifdef CONFIG_NILFS_XATTR | |
58 | /* | |
59 | * Extended attributes can be read independently of the main file | |
60 | * data. Taking i_sem even when reading would cause contention | |
61 | * between readers of EAs and writers of regular file data, so | |
62 | * instead we synchronize on xattr_sem when reading or changing | |
63 | * EAs. | |
64 | */ | |
65 | struct rw_semaphore xattr_sem; | |
66 | #endif | |
67 | #ifdef CONFIG_NILFS_POSIX_ACL | |
68 | struct posix_acl *i_acl; | |
69 | struct posix_acl *i_default_acl; | |
70 | #endif | |
71 | struct buffer_head *i_bh; /* i_bh contains a new or dirty | |
72 | disk inode */ | |
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 | { | |
84 | return container_of((union nilfs_bmap_union *)bmap, | |
85 | struct nilfs_inode_info, | |
86 | i_bmap_union); | |
87 | } | |
88 | ||
89 | static inline struct inode *NILFS_BTNC_I(struct address_space *btnc) | |
90 | { | |
91 | struct nilfs_inode_info *ii = | |
92 | container_of(btnc, struct nilfs_inode_info, i_btnode_cache); | |
93 | return &ii->vfs_inode; | |
94 | } | |
95 | ||
96 | static inline struct inode *NILFS_AS_I(struct address_space *mapping) | |
97 | { | |
98 | return (mapping->host) ? : | |
99 | container_of(mapping, struct inode, i_data); | |
100 | } | |
101 | ||
102 | /* | |
103 | * Dynamic state flags of NILFS on-memory inode (i_state) | |
104 | */ | |
105 | enum { | |
106 | NILFS_I_NEW = 0, /* Inode is newly created */ | |
107 | NILFS_I_DIRTY, /* The file is dirty */ | |
108 | NILFS_I_QUEUED, /* inode is in dirty_files list */ | |
109 | NILFS_I_BUSY, /* inode is grabbed by a segment | |
110 | constructor */ | |
111 | NILFS_I_COLLECTED, /* All dirty blocks are collected */ | |
112 | NILFS_I_UPDATED, /* The file has been written back */ | |
113 | NILFS_I_INODE_DIRTY, /* write_inode is requested */ | |
114 | NILFS_I_BMAP, /* has bmap and btnode_cache */ | |
115 | NILFS_I_GCINODE, /* inode for GC, on memory only */ | |
116 | NILFS_I_GCDAT, /* shadow DAT, on memory only */ | |
117 | }; | |
118 | ||
119 | /* | |
120 | * Macros to check inode numbers | |
121 | */ | |
122 | #define NILFS_MDT_INO_BITS \ | |
123 | ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO | \ | |
124 | 1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO | \ | |
125 | 1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO)) | |
126 | ||
127 | #define NILFS_SYS_INO_BITS \ | |
128 | ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS) | |
129 | ||
130 | #define NILFS_FIRST_INO(sb) (NILFS_SB(sb)->s_nilfs->ns_first_ino) | |
131 | ||
132 | #define NILFS_MDT_INODE(sb, ino) \ | |
133 | ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino)))) | |
134 | #define NILFS_VALID_INODE(sb, ino) \ | |
135 | ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino)))) | |
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 | |
143 | * @ti_garbage: List of inode to be put when releasing semaphore | |
144 | */ | |
145 | struct nilfs_transaction_info { | |
146 | u32 ti_magic; | |
147 | void *ti_save; | |
148 | /* This should never used. If this happens, | |
149 | one of other filesystems has a bug. */ | |
150 | unsigned short ti_flags; | |
151 | unsigned short ti_count; | |
152 | struct list_head ti_garbage; | |
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 */ | |
160 | #define NILFS_TI_SYNC 0x0002 /* Force to construct segment at the | |
161 | end of transaction. */ | |
162 | #define NILFS_TI_GC 0x0004 /* GC context */ | |
163 | #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */ | |
164 | #define NILFS_TI_WRITER 0x0010 /* Constructor context */ | |
165 | ||
166 | ||
167 | int nilfs_transaction_begin(struct super_block *, | |
168 | struct nilfs_transaction_info *, int); | |
47420c79 RK |
169 | int nilfs_transaction_commit(struct super_block *); |
170 | void nilfs_transaction_abort(struct super_block *); | |
65b4643d RK |
171 | |
172 | static inline void nilfs_set_transaction_flag(unsigned int flag) | |
173 | { | |
174 | struct nilfs_transaction_info *ti = current->journal_info; | |
175 | ||
65b4643d RK |
176 | ti->ti_flags |= flag; |
177 | } | |
178 | ||
179 | static inline int nilfs_test_transaction_flag(unsigned int flag) | |
180 | { | |
181 | struct nilfs_transaction_info *ti = current->journal_info; | |
182 | ||
183 | if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC) | |
184 | return 0; | |
185 | return !!(ti->ti_flags & flag); | |
186 | } | |
187 | ||
188 | static inline int nilfs_doing_gc(void) | |
189 | { | |
190 | return nilfs_test_transaction_flag(NILFS_TI_GC); | |
191 | } | |
192 | ||
193 | static inline int nilfs_doing_construction(void) | |
194 | { | |
195 | return nilfs_test_transaction_flag(NILFS_TI_WRITER); | |
196 | } | |
197 | ||
198 | static inline struct inode *nilfs_dat_inode(const struct the_nilfs *nilfs) | |
199 | { | |
200 | return nilfs_doing_gc() ? nilfs->ns_gc_dat : nilfs->ns_dat; | |
201 | } | |
202 | ||
203 | /* | |
204 | * function prototype | |
205 | */ | |
206 | #ifdef CONFIG_NILFS_POSIX_ACL | |
207 | #error "NILFS: not yet supported POSIX ACL" | |
208 | extern int nilfs_permission(struct inode *, int, struct nameidata *); | |
209 | extern int nilfs_acl_chmod(struct inode *); | |
210 | extern int nilfs_init_acl(struct inode *, struct inode *); | |
211 | #else | |
212 | #define nilfs_permission NULL | |
213 | ||
214 | static inline int nilfs_acl_chmod(struct inode *inode) | |
215 | { | |
216 | return 0; | |
217 | } | |
218 | ||
219 | static inline int nilfs_init_acl(struct inode *inode, struct inode *dir) | |
220 | { | |
221 | inode->i_mode &= ~current_umask(); | |
222 | return 0; | |
223 | } | |
224 | #endif | |
225 | ||
226 | #define NILFS_ATIME_DISABLE | |
227 | ||
228 | /* dir.c */ | |
229 | extern int nilfs_add_link(struct dentry *, struct inode *); | |
230 | extern ino_t nilfs_inode_by_name(struct inode *, struct dentry *); | |
231 | extern int nilfs_make_empty(struct inode *, struct inode *); | |
232 | extern struct nilfs_dir_entry * | |
233 | nilfs_find_entry(struct inode *, struct dentry *, 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 *, struct dentry *, int); | |
242 | ||
243 | /* ioctl.c */ | |
7a946193 | 244 | long nilfs_ioctl(struct file *, unsigned int, unsigned long); |
65b4643d RK |
245 | int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, void __user *); |
246 | ||
247 | /* inode.c */ | |
248 | extern struct inode *nilfs_new_inode(struct inode *, int); | |
249 | extern void nilfs_free_inode(struct inode *); | |
250 | extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int); | |
251 | extern void nilfs_set_inode_flags(struct inode *); | |
252 | extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *); | |
253 | extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int); | |
254 | extern struct inode *nilfs_iget(struct super_block *, unsigned long); | |
255 | extern void nilfs_update_inode(struct inode *, struct buffer_head *); | |
256 | extern void nilfs_truncate(struct inode *); | |
257 | extern void nilfs_delete_inode(struct inode *); | |
258 | extern int nilfs_setattr(struct dentry *, struct iattr *); | |
259 | extern int nilfs_load_inode_block(struct nilfs_sb_info *, struct inode *, | |
260 | struct buffer_head **); | |
261 | extern int nilfs_inode_dirty(struct inode *); | |
262 | extern int nilfs_set_file_dirty(struct nilfs_sb_info *, struct inode *, | |
263 | unsigned); | |
264 | extern int nilfs_mark_inode_dirty(struct inode *); | |
265 | extern void nilfs_dirty_inode(struct inode *); | |
266 | ||
267 | /* namei.c */ | |
268 | extern struct dentry *nilfs_get_parent(struct dentry *); | |
269 | ||
270 | /* super.c */ | |
271 | extern struct inode *nilfs_alloc_inode(struct super_block *); | |
272 | extern void nilfs_destroy_inode(struct inode *); | |
273 | extern void nilfs_error(struct super_block *, const char *, const char *, ...) | |
274 | __attribute__ ((format (printf, 3, 4))); | |
275 | extern void nilfs_warning(struct super_block *, const char *, const char *, ...) | |
276 | __attribute__ ((format (printf, 3, 4))); | |
277 | extern struct nilfs_super_block * | |
278 | nilfs_load_super_block(struct super_block *, struct buffer_head **); | |
279 | extern struct nilfs_super_block * | |
280 | nilfs_reload_super_block(struct super_block *, struct buffer_head **, int); | |
281 | extern int nilfs_store_magic_and_option(struct super_block *, | |
282 | struct nilfs_super_block *, char *); | |
283 | extern void nilfs_update_last_segment(struct nilfs_sb_info *, int); | |
284 | extern int nilfs_commit_super(struct nilfs_sb_info *); | |
285 | extern int nilfs_attach_checkpoint(struct nilfs_sb_info *, __u64); | |
286 | extern void nilfs_detach_checkpoint(struct nilfs_sb_info *); | |
287 | ||
288 | /* gcinode.c */ | |
289 | int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64, | |
290 | struct buffer_head **); | |
291 | int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64, | |
292 | struct buffer_head **); | |
293 | int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *); | |
294 | int nilfs_init_gccache(struct the_nilfs *); | |
295 | void nilfs_destroy_gccache(struct the_nilfs *); | |
296 | void nilfs_clear_gcinode(struct inode *); | |
297 | struct inode *nilfs_gc_iget(struct the_nilfs *, ino_t, __u64); | |
298 | void nilfs_remove_all_gcinode(struct the_nilfs *); | |
299 | ||
300 | /* gcdat.c */ | |
301 | int nilfs_init_gcdat_inode(struct the_nilfs *); | |
302 | void nilfs_commit_gcdat_inode(struct the_nilfs *); | |
303 | void nilfs_clear_gcdat_inode(struct the_nilfs *); | |
304 | ||
305 | /* | |
306 | * Inodes and files operations | |
307 | */ | |
308 | extern struct file_operations nilfs_dir_operations; | |
309 | extern struct inode_operations nilfs_file_inode_operations; | |
310 | extern struct file_operations nilfs_file_operations; | |
311 | extern struct address_space_operations nilfs_aops; | |
312 | extern struct inode_operations nilfs_dir_inode_operations; | |
313 | extern struct inode_operations nilfs_special_inode_operations; | |
314 | extern struct inode_operations nilfs_symlink_inode_operations; | |
315 | ||
316 | /* | |
317 | * filesystem type | |
318 | */ | |
319 | extern struct file_system_type nilfs_fs_type; | |
320 | ||
321 | ||
322 | #endif /* _NILFS_H */ |