Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nilfs.h
Go to the documentation of this file.
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 <[email protected]>
21  * Ryusuke Konishi <[email protected]>
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 "bmap.h"
34 
51 struct nilfs_inode_info {
52  __u32 i_flags;
53  unsigned long i_state; /* Dynamic state flags */
54  struct nilfs_bmap *i_bmap;
55  struct nilfs_bmap i_bmap_data;
56  __u64 i_xattr; /* sector_t ??? */
57  __u32 i_dir_start_lookup;
58  __u64 i_cno; /* check point number for GC inode */
59  struct address_space i_btnode_cache;
60  struct list_head i_dirty; /* List for connecting dirty files */
61 
62 #ifdef CONFIG_NILFS_XATTR
63  /*
64  * Extended attributes can be read independently of the main file
65  * data. Taking i_sem even when reading would cause contention
66  * between readers of EAs and writers of regular file data, so
67  * instead we synchronize on xattr_sem when reading or changing
68  * EAs.
69  */
70  struct rw_semaphore xattr_sem;
71 #endif
72  struct buffer_head *i_bh; /* i_bh contains a new or dirty
73  disk inode */
74  struct nilfs_root *i_root;
75  struct inode vfs_inode;
76 };
77 
78 static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
79 {
80  return container_of(inode, struct nilfs_inode_info, vfs_inode);
81 }
82 
83 static inline struct nilfs_inode_info *
84 NILFS_BMAP_I(const struct nilfs_bmap *bmap)
85 {
86  return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
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 /*
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 };
111 
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 
120 /*
121  * Macros to check inode numbers
122  */
123 #define NILFS_MDT_INO_BITS \
124  ((unsigned int)(1 << NILFS_DAT_INO | 1 << NILFS_CPFILE_INO | \
125  1 << NILFS_SUFILE_INO | 1 << NILFS_IFILE_INO | \
126  1 << NILFS_ATIME_INO | 1 << NILFS_SKETCH_INO))
127 
128 #define NILFS_SYS_INO_BITS \
129  ((unsigned int)(1 << NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
130 
131 #define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
132 
133 #define NILFS_MDT_INODE(sb, ino) \
134  ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & (1 << (ino))))
135 #define NILFS_VALID_INODE(sb, ino) \
136  ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & (1 << (ino))))
137 
146 struct nilfs_transaction_info {
147  u32 ti_magic;
148  void *ti_save;
149  /* This should never used. If this happens,
150  one of other filesystems has a bug. */
151  unsigned short ti_flags;
152  unsigned short ti_count;
153  struct list_head ti_garbage;
154 };
155 
156 /* ti_magic */
157 #define NILFS_TI_MAGIC 0xd9e392fb
158 
159 /* ti_flags */
160 #define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */
161 #define NILFS_TI_SYNC 0x0002 /* Force to construct segment at the
162  end of transaction. */
163 #define NILFS_TI_GC 0x0004 /* GC context */
164 #define NILFS_TI_COMMIT 0x0008 /* Change happened or not */
165 #define NILFS_TI_WRITER 0x0010 /* Constructor context */
166 
167 
168 int nilfs_transaction_begin(struct super_block *,
169  struct nilfs_transaction_info *, int);
170 int nilfs_transaction_commit(struct super_block *);
171 void nilfs_transaction_abort(struct super_block *);
172 
173 static inline void nilfs_set_transaction_flag(unsigned int flag)
174 {
175  struct nilfs_transaction_info *ti = current->journal_info;
176 
177  ti->ti_flags |= flag;
178 }
179 
180 static inline int nilfs_test_transaction_flag(unsigned int flag)
181 {
182  struct nilfs_transaction_info *ti = current->journal_info;
183 
184  if (ti == NULL || ti->ti_magic != NILFS_TI_MAGIC)
185  return 0;
186  return !!(ti->ti_flags & flag);
187 }
188 
189 static inline int nilfs_doing_gc(void)
190 {
191  return nilfs_test_transaction_flag(NILFS_TI_GC);
192 }
193 
194 static inline int nilfs_doing_construction(void)
195 {
196  return nilfs_test_transaction_flag(NILFS_TI_WRITER);
197 }
198 
199 /*
200  * function prototype
201  */
202 #ifdef CONFIG_NILFS_POSIX_ACL
203 #error "NILFS: not yet supported POSIX ACL"
204 extern int nilfs_acl_chmod(struct inode *);
205 extern int nilfs_init_acl(struct inode *, struct inode *);
206 #else
207 static inline int nilfs_acl_chmod(struct inode *inode)
208 {
209  return 0;
210 }
211 
212 static inline int nilfs_init_acl(struct inode *inode, struct inode *dir)
213 {
214  inode->i_mode &= ~current_umask();
215  return 0;
216 }
217 #endif
218 
219 #define NILFS_ATIME_DISABLE
220 
221 /* Flags that should be inherited by new inodes from their parent. */
222 #define NILFS_FL_INHERITED \
223  (FS_SECRM_FL | FS_UNRM_FL | FS_COMPR_FL | FS_SYNC_FL | \
224  FS_IMMUTABLE_FL | FS_APPEND_FL | FS_NODUMP_FL | FS_NOATIME_FL |\
225  FS_COMPRBLK_FL | FS_NOCOMP_FL | FS_NOTAIL_FL | FS_DIRSYNC_FL)
226 
227 /* Mask out flags that are inappropriate for the given type of inode. */
228 static inline __u32 nilfs_mask_flags(umode_t mode, __u32 flags)
229 {
230  if (S_ISDIR(mode))
231  return flags;
232  else if (S_ISREG(mode))
233  return flags & ~(FS_DIRSYNC_FL | FS_TOPDIR_FL);
234  else
235  return flags & (FS_NODUMP_FL | FS_NOATIME_FL);
236 }
237 
238 /* dir.c */
239 extern int nilfs_add_link(struct dentry *, struct inode *);
240 extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
241 extern int nilfs_make_empty(struct inode *, struct inode *);
242 extern struct nilfs_dir_entry *
243 nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
244 extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
245 extern int nilfs_empty_dir(struct inode *);
246 extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
247 extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
248  struct page *, struct inode *);
249 
250 /* file.c */
251 extern int nilfs_sync_file(struct file *, loff_t, loff_t, int);
252 
253 /* ioctl.c */
254 long nilfs_ioctl(struct file *, unsigned int, unsigned long);
255 long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
256 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
257  void **);
258 
259 /* inode.c */
260 void nilfs_inode_add_blocks(struct inode *inode, int n);
261 void nilfs_inode_sub_blocks(struct inode *inode, int n);
262 extern struct inode *nilfs_new_inode(struct inode *, umode_t);
263 extern void nilfs_free_inode(struct inode *);
264 extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
265 extern void nilfs_set_inode_flags(struct inode *);
266 extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
267 extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
268 struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
269  unsigned long ino);
270 struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
271  unsigned long ino);
272 struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
273  unsigned long ino);
274 extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
275  unsigned long ino, __u64 cno);
276 extern void nilfs_update_inode(struct inode *, struct buffer_head *);
277 extern void nilfs_truncate(struct inode *);
278 extern void nilfs_evict_inode(struct inode *);
279 extern int nilfs_setattr(struct dentry *, struct iattr *);
280 int nilfs_permission(struct inode *inode, int mask);
281 int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
282 extern int nilfs_inode_dirty(struct inode *);
283 int nilfs_set_file_dirty(struct inode *inode, unsigned nr_dirty);
284 extern int nilfs_mark_inode_dirty(struct inode *);
285 extern void nilfs_dirty_inode(struct inode *, int flags);
286 int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
287  __u64 start, __u64 len);
288 
289 /* super.c */
290 extern struct inode *nilfs_alloc_inode(struct super_block *);
291 extern void nilfs_destroy_inode(struct inode *);
292 extern __printf(3, 4)
293 void nilfs_error(struct super_block *, const char *, const char *, ...);
294 extern __printf(3, 4)
295 void nilfs_warning(struct super_block *, const char *, const char *, ...);
296 extern struct nilfs_super_block *
297 nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
298 extern int nilfs_store_magic_and_option(struct super_block *,
299  struct nilfs_super_block *, char *);
300 extern int nilfs_check_feature_compatibility(struct super_block *,
301  struct nilfs_super_block *);
302 extern void nilfs_set_log_cursor(struct nilfs_super_block *,
303  struct the_nilfs *);
304 struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
305  int flip);
306 int nilfs_commit_super(struct super_block *sb, int flag);
307 int nilfs_cleanup_super(struct super_block *sb);
308 int nilfs_resize_fs(struct super_block *sb, __u64 newsize);
309 int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
310  struct nilfs_root **root);
311 int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
312 
313 /* gcinode.c */
314 int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
315  struct buffer_head **);
316 int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
317  struct buffer_head **);
318 int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
319 int nilfs_init_gcinode(struct inode *inode);
320 void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
321 
322 /*
323  * Inodes and files operations
324  */
325 extern const struct file_operations nilfs_dir_operations;
326 extern const struct inode_operations nilfs_file_inode_operations;
327 extern const struct file_operations nilfs_file_operations;
328 extern const struct address_space_operations nilfs_aops;
329 extern const struct inode_operations nilfs_dir_inode_operations;
330 extern const struct inode_operations nilfs_special_inode_operations;
331 extern const struct inode_operations nilfs_symlink_inode_operations;
332 
333 /*
334  * filesystem type
335  */
336 extern struct file_system_type nilfs_fs_type;
337 
338 
339 #endif /* _NILFS_H */
Generated on Thu Jan 10 2013 14:48:59 for Linux Kernel by   doxygen 1.8.2