nilfs2: use BIT() macro
[linux-block.git] / fs / nilfs2 / nilfs.h
CommitLineData
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 *
4b420ab4 16 * Written by Koji Sato and Ryusuke Konishi.
65b4643d
RK
17 */
18
19#ifndef _NILFS_H
20#define _NILFS_H
21
22#include <linux/kernel.h>
23#include <linux/buffer_head.h>
24#include <linux/spinlock.h>
25#include <linux/blkdev.h>
26#include <linux/nilfs2_fs.h>
27#include "the_nilfs.h"
65b4643d 28#include "bmap.h"
65b4643d 29
f5974c8f
VD
30/**
31 * struct nilfs_inode_info - nilfs inode data in memory
32 * @i_flags: inode flags
33 * @i_state: dynamic state flags
34 * @i_bmap: pointer on i_bmap_data
35 * @i_bmap_data: raw block mapping
36 * @i_xattr: <TODO>
37 * @i_dir_start_lookup: page index of last successful search
38 * @i_cno: checkpoint number for GC inode
39 * @i_btnode_cache: cached pages of b-tree nodes
40 * @i_dirty: list for connecting dirty files
41 * @xattr_sem: semaphore for extended attributes processing
42 * @i_bh: buffer contains disk inode
43 * @i_root: root object of the current filesystem tree
44 * @vfs_inode: VFS inode object
65b4643d
RK
45 */
46struct nilfs_inode_info {
47 __u32 i_flags;
48 unsigned long i_state; /* Dynamic state flags */
49 struct nilfs_bmap *i_bmap;
05d0e94b 50 struct nilfs_bmap i_bmap_data;
65b4643d 51 __u64 i_xattr; /* sector_t ??? */
65b4643d
RK
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;
65b4643d 66#endif
076a378b
RK
67 struct buffer_head *i_bh; /*
68 * i_bh contains a new or dirty
69 * disk inode.
70 */
4d8d9293 71 struct nilfs_root *i_root;
65b4643d
RK
72 struct inode vfs_inode;
73};
74
75static inline struct nilfs_inode_info *NILFS_I(const struct inode *inode)
76{
77 return container_of(inode, struct nilfs_inode_info, vfs_inode);
78}
79
80static inline struct nilfs_inode_info *
81NILFS_BMAP_I(const struct nilfs_bmap *bmap)
82{
05d0e94b 83 return container_of(bmap, struct nilfs_inode_info, i_bmap_data);
65b4643d
RK
84}
85
86static inline struct inode *NILFS_BTNC_I(struct address_space *btnc)
87{
88 struct nilfs_inode_info *ii =
89 container_of(btnc, struct nilfs_inode_info, i_btnode_cache);
90 return &ii->vfs_inode;
91}
92
65b4643d
RK
93/*
94 * Dynamic state flags of NILFS on-memory inode (i_state)
95 */
96enum {
97 NILFS_I_NEW = 0, /* Inode is newly created */
98 NILFS_I_DIRTY, /* The file is dirty */
99 NILFS_I_QUEUED, /* inode is in dirty_files list */
076a378b
RK
100 NILFS_I_BUSY, /*
101 * Inode is grabbed by a segment
102 * constructor
103 */
65b4643d
RK
104 NILFS_I_COLLECTED, /* All dirty blocks are collected */
105 NILFS_I_UPDATED, /* The file has been written back */
b9f66140 106 NILFS_I_INODE_SYNC, /* dsync is not allowed for inode */
65b4643d
RK
107 NILFS_I_BMAP, /* has bmap and btnode_cache */
108 NILFS_I_GCINODE, /* inode for GC, on memory only */
65b4643d
RK
109};
110
b2ac86e1
JS
111/*
112 * commit flags for nilfs_commit_super and nilfs_sync_super
113 */
114enum {
115 NILFS_SB_COMMIT = 0, /* Commit a super block alternately */
116 NILFS_SB_COMMIT_ALL /* Commit both super blocks */
117};
118
65b4643d
RK
119/*
120 * Macros to check inode numbers
121 */
4ce5c342
RK
122#define NILFS_MDT_INO_BITS \
123 (BIT(NILFS_DAT_INO) | BIT(NILFS_CPFILE_INO) | \
124 BIT(NILFS_SUFILE_INO) | BIT(NILFS_IFILE_INO) | \
125 BIT(NILFS_ATIME_INO) | BIT(NILFS_SKETCH_INO))
65b4643d 126
4ce5c342 127#define NILFS_SYS_INO_BITS (BIT(NILFS_ROOT_INO) | NILFS_MDT_INO_BITS)
65b4643d 128
e3154e97 129#define NILFS_FIRST_INO(sb) (((struct the_nilfs *)sb->s_fs_info)->ns_first_ino)
65b4643d
RK
130
131#define NILFS_MDT_INODE(sb, ino) \
4ce5c342 132 ((ino) < NILFS_FIRST_INO(sb) && (NILFS_MDT_INO_BITS & BIT(ino)))
65b4643d 133#define NILFS_VALID_INODE(sb, ino) \
4ce5c342 134 ((ino) >= NILFS_FIRST_INO(sb) || (NILFS_SYS_INO_BITS & BIT(ino)))
65b4643d
RK
135
136/**
137 * struct nilfs_transaction_info: context information for synchronization
138 * @ti_magic: Magic number
139 * @ti_save: Backup of journal_info field of task_struct
140 * @ti_flags: Flags
141 * @ti_count: Nest level
65b4643d
RK
142 */
143struct nilfs_transaction_info {
144 u32 ti_magic;
145 void *ti_save;
076a378b
RK
146 /*
147 * This should never be used. If it happens,
148 * one of other filesystems has a bug.
149 */
65b4643d
RK
150 unsigned short ti_flags;
151 unsigned short ti_count;
65b4643d
RK
152};
153
154/* ti_magic */
155#define NILFS_TI_MAGIC 0xd9e392fb
156
157/* ti_flags */
158#define NILFS_TI_DYNAMIC_ALLOC 0x0001 /* Allocated from slab */
076a378b
RK
159#define NILFS_TI_SYNC 0x0002 /*
160 * Force to construct segment at the
161 * end of transaction.
162 */
65b4643d
RK
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
168int nilfs_transaction_begin(struct super_block *,
169 struct nilfs_transaction_info *, int);
47420c79
RK
170int nilfs_transaction_commit(struct super_block *);
171void nilfs_transaction_abort(struct super_block *);
65b4643d
RK
172
173static inline void nilfs_set_transaction_flag(unsigned int flag)
174{
175 struct nilfs_transaction_info *ti = current->journal_info;
176
65b4643d
RK
177 ti->ti_flags |= flag;
178}
179
180static 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
189static inline int nilfs_doing_gc(void)
190{
191 return nilfs_test_transaction_flag(NILFS_TI_GC);
192}
193
194static inline int nilfs_doing_construction(void)
195{
196 return nilfs_test_transaction_flag(NILFS_TI_WRITER);
197}
198
65b4643d
RK
199/*
200 * function prototype
201 */
202#ifdef CONFIG_NILFS_POSIX_ACL
203#error "NILFS: not yet supported POSIX ACL"
65b4643d
RK
204extern int nilfs_acl_chmod(struct inode *);
205extern int nilfs_init_acl(struct inode *, struct inode *);
206#else
65b4643d
RK
207static inline int nilfs_acl_chmod(struct inode *inode)
208{
209 return 0;
210}
211
212static 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
b253a3e4
RK
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. */
228static 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
65b4643d
RK
238/* dir.c */
239extern int nilfs_add_link(struct dentry *, struct inode *);
0319003d 240extern ino_t nilfs_inode_by_name(struct inode *, const struct qstr *);
65b4643d
RK
241extern int nilfs_make_empty(struct inode *, struct inode *);
242extern struct nilfs_dir_entry *
0319003d 243nilfs_find_entry(struct inode *, const struct qstr *, struct page **);
65b4643d
RK
244extern int nilfs_delete_entry(struct nilfs_dir_entry *, struct page *);
245extern int nilfs_empty_dir(struct inode *);
246extern struct nilfs_dir_entry *nilfs_dotdot(struct inode *, struct page **);
247extern void nilfs_set_link(struct inode *, struct nilfs_dir_entry *,
248 struct page *, struct inode *);
249
250/* file.c */
02c24a82 251extern int nilfs_sync_file(struct file *, loff_t, loff_t, int);
65b4643d
RK
252
253/* ioctl.c */
7a946193 254long nilfs_ioctl(struct file *, unsigned int, unsigned long);
828b1c50 255long nilfs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
4f6b8288
RK
256int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *, struct nilfs_argv *,
257 void **);
65b4643d
RK
258
259/* inode.c */
be667377
RK
260void nilfs_inode_add_blocks(struct inode *inode, int n);
261void nilfs_inode_sub_blocks(struct inode *inode, int n);
c6e49e3f 262extern struct inode *nilfs_new_inode(struct inode *, umode_t);
65b4643d
RK
263extern void nilfs_free_inode(struct inode *);
264extern int nilfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
265extern void nilfs_set_inode_flags(struct inode *);
266extern int nilfs_read_inode_common(struct inode *, struct nilfs_inode *);
267extern void nilfs_write_inode_common(struct inode *, struct nilfs_inode *, int);
032dbb3b
RK
268struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
269 unsigned long ino);
f1e89c86
RK
270struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
271 unsigned long ino);
4d8d9293
RK
272struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
273 unsigned long ino);
263d90ce
RK
274extern struct inode *nilfs_iget_for_gc(struct super_block *sb,
275 unsigned long ino, __u64 cno);
b9f66140 276extern void nilfs_update_inode(struct inode *, struct buffer_head *, int);
65b4643d 277extern void nilfs_truncate(struct inode *);
6fd1e5c9 278extern void nilfs_evict_inode(struct inode *);
65b4643d 279extern int nilfs_setattr(struct dentry *, struct iattr *);
2d1b399b 280extern void nilfs_write_failed(struct address_space *mapping, loff_t to);
10556cb2 281int nilfs_permission(struct inode *inode, int mask);
bcbc8c64 282int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh);
65b4643d 283extern int nilfs_inode_dirty(struct inode *);
0c6c44cb 284int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty);
b9f66140 285extern int __nilfs_mark_inode_dirty(struct inode *, int);
aa385729 286extern void nilfs_dirty_inode(struct inode *, int flags);
622daaff
RK
287int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
288 __u64 start, __u64 len);
b9f66140
AR
289static inline int nilfs_mark_inode_dirty(struct inode *inode)
290{
291 return __nilfs_mark_inode_dirty(inode, I_DIRTY);
292}
293static inline int nilfs_mark_inode_dirty_sync(struct inode *inode)
294{
295 return __nilfs_mark_inode_dirty(inode, I_DIRTY_SYNC);
296}
65b4643d 297
65b4643d
RK
298/* super.c */
299extern struct inode *nilfs_alloc_inode(struct super_block *);
300extern void nilfs_destroy_inode(struct inode *);
cae3d4ca 301
a66dfb0a
RK
302extern __printf(3, 4)
303void __nilfs_msg(struct super_block *sb, const char *level,
304 const char *fmt, ...);
b9075fa9 305extern __printf(3, 4)
cae3d4ca
RK
306void __nilfs_error(struct super_block *sb, const char *function,
307 const char *fmt, ...);
cae3d4ca
RK
308
309#ifdef CONFIG_PRINTK
310
a66dfb0a
RK
311#define nilfs_msg(sb, level, fmt, ...) \
312 __nilfs_msg(sb, level, fmt, ##__VA_ARGS__)
cae3d4ca
RK
313#define nilfs_error(sb, fmt, ...) \
314 __nilfs_error(sb, __func__, fmt, ##__VA_ARGS__)
315
316#else
317
a66dfb0a 318#define nilfs_msg(sb, level, fmt, ...) \
d6517deb
RK
319 do { \
320 no_printk(fmt, ##__VA_ARGS__); \
321 (void)(sb); \
322 } while (0)
cae3d4ca
RK
323#define nilfs_error(sb, fmt, ...) \
324 do { \
325 no_printk(fmt, ##__VA_ARGS__); \
326 __nilfs_error(sb, "", " "); \
327 } while (0)
328
329#endif /* CONFIG_PRINTK */
330
65b4643d 331extern struct nilfs_super_block *
e339ad31 332nilfs_read_super_block(struct super_block *, u64, int, struct buffer_head **);
65b4643d
RK
333extern int nilfs_store_magic_and_option(struct super_block *,
334 struct nilfs_super_block *, char *);
c5ca48aa
RK
335extern int nilfs_check_feature_compatibility(struct super_block *,
336 struct nilfs_super_block *);
60f46b7e
RK
337extern void nilfs_set_log_cursor(struct nilfs_super_block *,
338 struct the_nilfs *);
f7545144
RK
339struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
340 int flip);
341int nilfs_commit_super(struct super_block *sb, int flag);
342int nilfs_cleanup_super(struct super_block *sb);
4e33f9ea 343int nilfs_resize_fs(struct super_block *sb, __u64 newsize);
f7545144 344int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
4d8d9293 345 struct nilfs_root **root);
032dbb3b 346int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno);
65b4643d
RK
347
348/* gcinode.c */
349int nilfs_gccache_submit_read_data(struct inode *, sector_t, sector_t, __u64,
350 struct buffer_head **);
351int nilfs_gccache_submit_read_node(struct inode *, sector_t, __u64,
352 struct buffer_head **);
353int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *);
263d90ce
RK
354int nilfs_init_gcinode(struct inode *inode);
355void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs);
65b4643d 356
dd70edbd
VD
357/* sysfs.c */
358int __init nilfs_sysfs_init(void);
359void nilfs_sysfs_exit(void);
360int nilfs_sysfs_create_device_group(struct super_block *);
361void nilfs_sysfs_delete_device_group(struct the_nilfs *);
362int nilfs_sysfs_create_snapshot_group(struct nilfs_root *);
363void nilfs_sysfs_delete_snapshot_group(struct nilfs_root *);
364
65b4643d
RK
365/*
366 * Inodes and files operations
367 */
828c0950 368extern const struct file_operations nilfs_dir_operations;
6e1d5dcc 369extern const struct inode_operations nilfs_file_inode_operations;
828c0950 370extern const struct file_operations nilfs_file_operations;
7f09410b 371extern const struct address_space_operations nilfs_aops;
6e1d5dcc
AD
372extern const struct inode_operations nilfs_dir_inode_operations;
373extern const struct inode_operations nilfs_special_inode_operations;
374extern const struct inode_operations nilfs_symlink_inode_operations;
65b4643d
RK
375
376/*
377 * filesystem type
378 */
379extern struct file_system_type nilfs_fs_type;
380
381
382#endif /* _NILFS_H */