nilfs2: move mount options to nilfs object
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / fs / nilfs2 / the_nilfs.h
CommitLineData
65b4643d
RK
1/*
2 * the_nilfs.h - the_nilfs shared structure.
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 Ryusuke Konishi <ryusuke@osrg.net>
21 *
22 */
23
24#ifndef _THE_NILFS_H
25#define _THE_NILFS_H
26
27#include <linux/types.h>
28#include <linux/buffer_head.h>
ba65ae47 29#include <linux/rbtree.h>
65b4643d
RK
30#include <linux/fs.h>
31#include <linux/blkdev.h>
32#include <linux/backing-dev.h>
5a0e3ad6 33#include <linux/slab.h>
65b4643d
RK
34#include "sb.h"
35
36/* the_nilfs struct */
37enum {
38 THE_NILFS_INIT = 0, /* Information from super_block is set */
65b4643d 39 THE_NILFS_DISCONTINUED, /* 'next' pointer chain has broken */
1cf58fa8 40 THE_NILFS_GC_RUNNING, /* gc process is running */
e605f0a7 41 THE_NILFS_SB_DIRTY, /* super block is dirty */
65b4643d
RK
42};
43
44/**
45 * struct the_nilfs - struct to supervise multiple nilfs mount points
46 * @ns_flags: flags
65b4643d 47 * @ns_bdev: block device
65b4643d 48 * @ns_sem: semaphore for shared states
e339ad31
RK
49 * @ns_sbh: buffer heads of on-disk super blocks
50 * @ns_sbp: pointers to super block data
b2ac86e1
JS
51 * @ns_sbwtime: previous write time of super block
52 * @ns_sbwcount: write count of super block
e339ad31 53 * @ns_sbsize: size of valid data in super block
65b4643d
RK
54 * @ns_seg_seq: segment sequence counter
55 * @ns_segnum: index number of the latest full segment.
56 * @ns_nextnum: index number of the full segment index to be used next
57 * @ns_pseg_offset: offset of next partial segment in the current full segment
58 * @ns_cno: next checkpoint number
59 * @ns_ctime: write time of the last segment
60 * @ns_nongc_ctime: write time of the last segment not for cleaner operation
61 * @ns_ndirtyblks: Number of dirty data blocks
62 * @ns_last_segment_lock: lock protecting fields for the latest segment
63 * @ns_last_pseg: start block number of the latest segment
64 * @ns_last_seq: sequence value of the latest segment
65 * @ns_last_cno: checkpoint number of the latest segment
2c2e52fc 66 * @ns_prot_seq: least sequence number of segments which must not be reclaimed
32502047 67 * @ns_prev_seq: base sequence number used to decide if advance log cursor
65b4643d
RK
68 * @ns_segctor_sem: segment constructor semaphore
69 * @ns_dat: DAT file inode
70 * @ns_cpfile: checkpoint file inode
71 * @ns_sufile: segusage file inode
ba65ae47
RK
72 * @ns_cptree: rb-tree of all mounted checkpoints (nilfs_root)
73 * @ns_cptree_lock: lock protecting @ns_cptree
65b4643d 74 * @ns_gc_inodes: dummy inodes to keep live blocks
3b2ce58b 75 * @ns_mount_opt: mount options
65b4643d 76 * @ns_blocksize_bits: bit length of block size
92c60cca 77 * @ns_blocksize: block size
65b4643d
RK
78 * @ns_nsegments: number of segments in filesystem
79 * @ns_blocks_per_segment: number of blocks per segment
80 * @ns_r_segments_percentage: reserved segments percentage
81 * @ns_nrsvsegs: number of reserved segments
82 * @ns_first_data_block: block number of first data block
83 * @ns_inode_size: size of on-disk inode
84 * @ns_first_ino: first not-special inode number
85 * @ns_crc_seed: seed value of CRC32 calculation
86 */
87struct the_nilfs {
88 unsigned long ns_flags;
65b4643d
RK
89
90 struct block_device *ns_bdev;
65b4643d 91 struct rw_semaphore ns_sem;
65b4643d
RK
92
93 /*
94 * used for
95 * - loading the latest checkpoint exclusively.
96 * - allocating a new full segment.
97 * - protecting s_dirt in the super_block struct
98 * (see nilfs_write_super) and the following fields.
99 */
e339ad31
RK
100 struct buffer_head *ns_sbh[2];
101 struct nilfs_super_block *ns_sbp[2];
b2ac86e1
JS
102 time_t ns_sbwtime;
103 unsigned ns_sbwcount;
e339ad31 104 unsigned ns_sbsize;
65b4643d 105 unsigned ns_mount_state;
65b4643d
RK
106
107 /*
108 * Following fields are dedicated to a writable FS-instance.
109 * Except for the period seeking checkpoint, code outside the segment
47420c79
RK
110 * constructor must lock a segment semaphore while accessing these
111 * fields.
65b4643d
RK
112 * The writable FS-instance is sole during a lifetime of the_nilfs.
113 */
114 u64 ns_seg_seq;
115 __u64 ns_segnum;
116 __u64 ns_nextnum;
117 unsigned long ns_pseg_offset;
118 __u64 ns_cno;
119 time_t ns_ctime;
120 time_t ns_nongc_ctime;
121 atomic_t ns_ndirtyblks;
122
123 /*
124 * The following fields hold information on the latest partial segment
125 * written to disk with a super root. These fields are protected by
126 * ns_last_segment_lock.
127 */
128 spinlock_t ns_last_segment_lock;
129 sector_t ns_last_pseg;
130 u64 ns_last_seq;
131 __u64 ns_last_cno;
2c2e52fc 132 u64 ns_prot_seq;
32502047 133 u64 ns_prev_seq;
65b4643d
RK
134
135 struct rw_semaphore ns_segctor_sem;
136
137 /*
138 * Following fields are lock free except for the period before
139 * the_nilfs is initialized.
140 */
141 struct inode *ns_dat;
142 struct inode *ns_cpfile;
143 struct inode *ns_sufile;
65b4643d 144
ba65ae47
RK
145 /* Checkpoint tree */
146 struct rb_root ns_cptree;
147 spinlock_t ns_cptree_lock;
148
263d90ce 149 /* GC inode list */
65b4643d 150 struct list_head ns_gc_inodes;
65b4643d 151
3b2ce58b
RK
152 /* Mount options */
153 unsigned long ns_mount_opt;
154
65b4643d
RK
155 /* Disk layout information (static) */
156 unsigned int ns_blocksize_bits;
92c60cca 157 unsigned int ns_blocksize;
65b4643d
RK
158 unsigned long ns_nsegments;
159 unsigned long ns_blocks_per_segment;
160 unsigned long ns_r_segments_percentage;
161 unsigned long ns_nrsvsegs;
162 unsigned long ns_first_data_block;
163 int ns_inode_size;
164 int ns_first_ino;
165 u32 ns_crc_seed;
166};
167
65b4643d
RK
168#define THE_NILFS_FNS(bit, name) \
169static inline void set_nilfs_##name(struct the_nilfs *nilfs) \
170{ \
171 set_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
172} \
173static inline void clear_nilfs_##name(struct the_nilfs *nilfs) \
174{ \
175 clear_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
176} \
177static inline int nilfs_##name(struct the_nilfs *nilfs) \
178{ \
179 return test_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
180}
181
182THE_NILFS_FNS(INIT, init)
65b4643d 183THE_NILFS_FNS(DISCONTINUED, discontinued)
1cf58fa8 184THE_NILFS_FNS(GC_RUNNING, gc_running)
e605f0a7 185THE_NILFS_FNS(SB_DIRTY, sb_dirty)
65b4643d 186
3b2ce58b
RK
187/*
188 * Mount option operations
189 */
190#define nilfs_clear_opt(nilfs, opt) \
191 do { (nilfs)->ns_mount_opt &= ~NILFS_MOUNT_##opt; } while (0)
192#define nilfs_set_opt(nilfs, opt) \
193 do { (nilfs)->ns_mount_opt |= NILFS_MOUNT_##opt; } while (0)
194#define nilfs_test_opt(nilfs, opt) ((nilfs)->ns_mount_opt & NILFS_MOUNT_##opt)
195#define nilfs_write_opt(nilfs, mask, opt) \
196 do { (nilfs)->ns_mount_opt = \
197 (((nilfs)->ns_mount_opt & ~NILFS_MOUNT_##mask) | \
198 NILFS_MOUNT_##opt); \
199 } while (0)
200
ba65ae47
RK
201/**
202 * struct nilfs_root - nilfs root object
203 * @cno: checkpoint number
204 * @rb_node: red-black tree node
205 * @count: refcount of this structure
206 * @nilfs: nilfs object
207 * @ifile: inode file
208 * @root: root inode
209 * @inodes_count: number of inodes
210 * @blocks_count: number of blocks (Reserved)
211 */
212struct nilfs_root {
213 __u64 cno;
214 struct rb_node rb_node;
215
216 atomic_t count;
217 struct the_nilfs *nilfs;
218 struct inode *ifile;
219
220 atomic_t inodes_count;
221 atomic_t blocks_count;
222};
223
224/* Special checkpoint number */
225#define NILFS_CPTREE_CURRENT_CNO 0
226
e339ad31
RK
227/* Minimum interval of periodical update of superblocks (in seconds) */
228#define NILFS_SB_FREQ 10
e339ad31 229
79efdd94
JS
230static inline int nilfs_sb_need_update(struct the_nilfs *nilfs)
231{
232 u64 t = get_seconds();
b2ac86e1 233 return t < nilfs->ns_sbwtime || t > nilfs->ns_sbwtime + NILFS_SB_FREQ;
79efdd94
JS
234}
235
b2ac86e1 236static inline int nilfs_sb_will_flip(struct the_nilfs *nilfs)
79efdd94 237{
b2ac86e1
JS
238 int flip_bits = nilfs->ns_sbwcount & 0x0FL;
239 return (flip_bits != 0x08 && flip_bits != 0x0F);
79efdd94
JS
240}
241
65b4643d 242void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
348fe8da
RK
243struct the_nilfs *alloc_nilfs(struct block_device *bdev);
244void destroy_nilfs(struct the_nilfs *nilfs);
65b4643d
RK
245int init_nilfs(struct the_nilfs *, struct nilfs_sb_info *, char *);
246int load_nilfs(struct the_nilfs *, struct nilfs_sb_info *);
e902ec99 247int nilfs_discard_segments(struct the_nilfs *, __u64 *, size_t);
65b4643d 248int nilfs_count_free_blocks(struct the_nilfs *, sector_t *);
ba65ae47
RK
249struct nilfs_root *nilfs_lookup_root(struct the_nilfs *nilfs, __u64 cno);
250struct nilfs_root *nilfs_find_or_create_root(struct the_nilfs *nilfs,
251 __u64 cno);
252void nilfs_put_root(struct nilfs_root *root);
6dd47406 253struct nilfs_sb_info *nilfs_find_sbinfo(struct the_nilfs *, int, __u64);
65b4643d 254int nilfs_near_disk_full(struct the_nilfs *);
e339ad31
RK
255void nilfs_fall_back_super_block(struct the_nilfs *);
256void nilfs_swap_super_block(struct the_nilfs *);
65b4643d
RK
257
258
ba65ae47
RK
259static inline void nilfs_get_root(struct nilfs_root *root)
260{
261 atomic_inc(&root->count);
262}
263
a057d2c0
RK
264static inline int nilfs_valid_fs(struct the_nilfs *nilfs)
265{
266 unsigned valid_fs;
267
268 down_read(&nilfs->ns_sem);
269 valid_fs = (nilfs->ns_mount_state & NILFS_VALID_FS);
270 up_read(&nilfs->ns_sem);
271 return valid_fs;
272}
273
65b4643d
RK
274static inline void
275nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
276 sector_t *seg_start, sector_t *seg_end)
277{
278 *seg_start = (sector_t)nilfs->ns_blocks_per_segment * segnum;
279 *seg_end = *seg_start + nilfs->ns_blocks_per_segment - 1;
280 if (segnum == 0)
281 *seg_start = nilfs->ns_first_data_block;
282}
283
284static inline sector_t
285nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
286{
287 return (segnum == 0) ? nilfs->ns_first_data_block :
288 (sector_t)nilfs->ns_blocks_per_segment * segnum;
289}
290
291static inline __u64
292nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
293{
294 sector_t segnum = blocknr;
295
296 sector_div(segnum, nilfs->ns_blocks_per_segment);
297 return segnum;
298}
299
300static inline void
301nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
302 sector_t seg_end)
303{
304 /* terminate the current full segment (used in case of I/O-error) */
305 nilfs->ns_pseg_offset = seg_end - seg_start + 1;
306}
307
308static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
309{
310 /* move forward with a full segment */
311 nilfs->ns_segnum = nilfs->ns_nextnum;
312 nilfs->ns_pseg_offset = 0;
313 nilfs->ns_seg_seq++;
314}
315
316static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
317{
318 __u64 cno;
319
320 spin_lock(&nilfs->ns_last_segment_lock);
321 cno = nilfs->ns_last_cno;
322 spin_unlock(&nilfs->ns_last_segment_lock);
323 return cno;
324}
325
cece5520
RK
326static inline int nilfs_segment_is_active(struct the_nilfs *nilfs, __u64 n)
327{
328 return n == nilfs->ns_segnum || n == nilfs->ns_nextnum;
329}
330
65b4643d 331#endif /* _THE_NILFS_H */