edf6a59d9f2a1710e404e45250308dfa06ba28f9
[pandora-kernel.git] / fs / nilfs2 / nilfs.h
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 inode data in memory
39  */
40 struct nilfs_inode_info {
41         __u32 i_flags;
42         unsigned long  i_state;         /* Dynamic state flags */
43         struct nilfs_bmap *i_bmap;
44         union nilfs_bmap_union i_bmap_union;
45         __u64 i_xattr;  /* sector_t ??? */
46         __u32 i_dir_start_lookup;
47         __u64 i_cno;            /* check point number for GC inode */
48         struct address_space i_btnode_cache;
49         struct list_head i_dirty;       /* List for connecting dirty files */
50
51 #ifdef CONFIG_NILFS_XATTR
52         /*
53          * Extended attributes can be read independently of the main file
54          * data. Taking i_sem even when reading would cause contention
55          * between readers of EAs and writers of regular file data, so
56          * instead we synchronize on xattr_sem when reading or changing
57          * EAs.
58          */
59         struct rw_semaphore xattr_sem;
60 #endif
61 #ifdef CONFIG_NILFS_POSIX_ACL
62         struct posix_acl *i_acl;
63         struct posix_acl *i_default_acl;
64 #endif
65         struct buffer_head *i_bh;       /* i_bh contains a new or dirty
66                                            disk inode */
67         struct inode vfs_inode;
68 };
69
70 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
71 {
72         return container_of(inode, struct nilfs_inode_info, vfs_inode);
73 }
74
75 static inline struct nilfs_inode_info *
76 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
77 {
78         return container_of((union nilfs_bmap_union *)bmap,
79                             struct nilfs_inode_info,
80                             i_bmap_union);
81 }
82
83 static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
84 {
85         struct nilfs_inode_info *ii =
86                 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
87         return &ii->vfs_inode;
88 }
89
90 static inline struct inode *NILFS_AS_I(struct address_space *mapping)
91 {
92         return (mapping->host) ? :
93                 container_of(mapping, struct inode, i_data);
94 }
95
96 /*
97  * Dynamic state flags of NILFS on-memory inode (i_state)
98  */
99 enum {
100         NILFS_I_NEW = 0,                /* Inode is newly created */
101         NILFS_I_DIRTY,                  /* The file is dirty */
102         NILFS_I_QUEUED,                 /* inode is in dirty_files list */
103         NILFS_I_BUSY,                   /* inode is grabbed by a segment
104                                            constructor */
105         NILFS_I_COLLECTED,              /* All dirty blocks are collected */
106         NILFS_I_UPDATED,                /* The file has been written back */
107         NILFS_I_INODE_DIRTY,            /* write_inode is requested */
108         NILFS_I_BMAP,                   /* has bmap and btnode_cache */
109         NILFS_I_GCINODE,                /* inode for GC, on memory only */
110         NILFS_I_GCDAT,                  /* shadow DAT, on memory only */
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)  (NILFS_SB(sb)->s_nilfs->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
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
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
182 static inline int nilfs_doing_gc(void)
183 {
184         return nilfs_test_transaction_flag(NILFS_TI_GC);
185 }
186
187 static inline int nilfs_doing_construction(void)
188 {
189         return nilfs_test_transaction_flag(NILFS_TI_WRITER);
190 }
191
192 static inline struct inode *nilfs_dat_inode(const struct the_nilfs *nilfs)
193 {
194         return nilfs_doing_gc() ? nilfs->ns_gc_dat : nilfs->ns_dat;
195 }
196
197 /*
198  * function prototype
199  */
200 #ifdef CONFIG_NILFS_POSIX_ACL
201 #error "NILFS: not yet supported POSIX ACL"
202 extern int nilfs_permission(struct inode *, int, struct nameidata *);
203 extern int nilfs_acl_chmod(struct inode *);
204 extern int nilfs_init_acl(struct inode *, struct inode *);
205 #else
206 #define nilfs_permission   NULL
207
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
222 /* dir.c */
223 extern int nilfs_add_link(struct dentry *, struct inode *);
224 extern ino_t nilfs_inode_by_name(struct inode *, struct dentry *);
225 extern int nilfs_make_empty(struct inode *, struct inode *);
226 extern struct nilfs_dir_entry *
227 nilfs_find_entry(struct inode *, struct dentry *, struct page **);
228 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
229 extern int nilfs_empty_dir(struct inode *);
230 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
231 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
232                            struct page *, struct inode *);
233
234 /* file.c */
235 extern int nilfs_sync_file(struct file *, struct dentry *, int);
236
237 /* ioctl.c */
238 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
239 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
240                                        void **);
241
242 /* inode.c */
243 extern struct inode *nilfs_new_inode(struct inode *, int);
244 extern void nilfs_free_inode(struct inode *);
245 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
246 extern void nilfs_set_inode_flags(struct inode *);
247 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
248 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
249 extern struct inode *nilfs_iget(struct super_block *, unsigned long);
250 extern void nilfs_update_inode(struct inode *, struct buffer_head *);
251 extern void nilfs_truncate(struct inode *);
252 extern void nilfs_delete_inode(struct inode *);
253 extern int nilfs_setattr(struct dentry *, struct iattr *);
254 extern int nilfs_load_inode_block(struct nilfs_sb_info *, struct inode *,
255                                   struct buffer_head **);
256 extern int nilfs_inode_dirty(struct inode *);
257 extern int nilfs_set_file_dirty(struct nilfs_sb_info *, struct inode *,
258                                 unsigned);
259 extern int nilfs_mark_inode_dirty(struct inode *);
260 extern void nilfs_dirty_inode(struct inode *);
261
262 /* namei.c */
263 extern struct dentry *nilfs_get_parent(struct dentry *);
264
265 /* super.c */
266 extern struct inode *nilfs_alloc_inode_common(struct the_nilfs *);
267 extern struct inode *nilfs_alloc_inode(struct super_block *);
268 extern void nilfs_destroy_inode(struct inode *);
269 extern void nilfs_error(struct super_block *, const char *, const char *, ...)
270         __attribute__ ((format (printf, 3, 4)));
271 extern void nilfs_warning(struct super_block *, const char *, const char *, ...)
272        __attribute__ ((format (printf, 3, 4)));
273 extern struct nilfs_super_block *
274 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
275 extern int nilfs_store_magic_and_option(struct super_block *,
276                                         struct nilfs_super_block *, char *);
277 extern int nilfs_commit_super(struct nilfs_sb_info *, int);
278 extern int nilfs_attach_checkpoint(struct nilfs_sb_info *, __u64);
279 extern void nilfs_detach_checkpoint(struct nilfs_sb_info *);
280
281 /* gcinode.c */
282 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
283                                    struct buffer_head **);
284 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
285                                    struct buffer_head **);
286 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
287 int nilfs_init_gccache(struct the_nilfs *);
288 void nilfs_destroy_gccache(struct the_nilfs *);
289 void nilfs_clear_gcinode(struct inode *);
290 struct inode *nilfs_gc_iget(struct the_nilfs *, ino_t, __u64);
291 void nilfs_remove_all_gcinode(struct the_nilfs *);
292
293 /* gcdat.c */
294 int nilfs_init_gcdat_inode(struct the_nilfs *);
295 void nilfs_commit_gcdat_inode(struct the_nilfs *);
296 void nilfs_clear_gcdat_inode(struct the_nilfs *);
297
298 /*
299  * Inodes and files operations
300  */
301 extern struct file_operations nilfs_dir_operations;
302 extern struct inode_operations nilfs_file_inode_operations;
303 extern struct file_operations nilfs_file_operations;
304 extern struct address_space_operations nilfs_aops;
305 extern struct inode_operations nilfs_dir_inode_operations;
306 extern struct inode_operations nilfs_special_inode_operations;
307 extern struct inode_operations nilfs_symlink_inode_operations;
308
309 /*
310  * filesystem type
311  */
312 extern struct file_system_type nilfs_fs_type;
313
314
315 #endif  /* _NILFS_H */