nilfs2: move next generation counter into 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
693dd321
RK
74 * @ns_dirty_files: list of dirty files
75 * @ns_inode_lock: lock protecting @ns_dirty_files
65b4643d 76 * @ns_gc_inodes: dummy inodes to keep live blocks
9b1fc4e4
RK
77 * @ns_next_generation: next generation number for inodes
78 * @ns_next_gen_lock: lock protecting @ns_next_generation
3b2ce58b 79 * @ns_mount_opt: mount options
574e6c31
RK
80 * @ns_resuid: uid for reserved blocks
81 * @ns_resgid: gid for reserved blocks
82 * @ns_interval: checkpoint creation interval
83 * @ns_watermark: watermark for the number of dirty buffers
65b4643d 84 * @ns_blocksize_bits: bit length of block size
92c60cca 85 * @ns_blocksize: block size
65b4643d
RK
86 * @ns_nsegments: number of segments in filesystem
87 * @ns_blocks_per_segment: number of blocks per segment
88 * @ns_r_segments_percentage: reserved segments percentage
89 * @ns_nrsvsegs: number of reserved segments
90 * @ns_first_data_block: block number of first data block
91 * @ns_inode_size: size of on-disk inode
92 * @ns_first_ino: first not-special inode number
93 * @ns_crc_seed: seed value of CRC32 calculation
94 */
95struct the_nilfs {
96 unsigned long ns_flags;
65b4643d
RK
97
98 struct block_device *ns_bdev;
65b4643d 99 struct rw_semaphore ns_sem;
65b4643d
RK
100
101 /*
102 * used for
103 * - loading the latest checkpoint exclusively.
104 * - allocating a new full segment.
105 * - protecting s_dirt in the super_block struct
106 * (see nilfs_write_super) and the following fields.
107 */
e339ad31
RK
108 struct buffer_head *ns_sbh[2];
109 struct nilfs_super_block *ns_sbp[2];
b2ac86e1
JS
110 time_t ns_sbwtime;
111 unsigned ns_sbwcount;
e339ad31 112 unsigned ns_sbsize;
65b4643d 113 unsigned ns_mount_state;
65b4643d
RK
114
115 /*
116 * Following fields are dedicated to a writable FS-instance.
117 * Except for the period seeking checkpoint, code outside the segment
47420c79
RK
118 * constructor must lock a segment semaphore while accessing these
119 * fields.
65b4643d
RK
120 * The writable FS-instance is sole during a lifetime of the_nilfs.
121 */
122 u64 ns_seg_seq;
123 __u64 ns_segnum;
124 __u64 ns_nextnum;
125 unsigned long ns_pseg_offset;
126 __u64 ns_cno;
127 time_t ns_ctime;
128 time_t ns_nongc_ctime;
129 atomic_t ns_ndirtyblks;
130
131 /*
132 * The following fields hold information on the latest partial segment
133 * written to disk with a super root. These fields are protected by
134 * ns_last_segment_lock.
135 */
136 spinlock_t ns_last_segment_lock;
137 sector_t ns_last_pseg;
138 u64 ns_last_seq;
139 __u64 ns_last_cno;
2c2e52fc 140 u64 ns_prot_seq;
32502047 141 u64 ns_prev_seq;
65b4643d
RK
142
143 struct rw_semaphore ns_segctor_sem;
144
145 /*
146 * Following fields are lock free except for the period before
147 * the_nilfs is initialized.
148 */
149 struct inode *ns_dat;
150 struct inode *ns_cpfile;
151 struct inode *ns_sufile;
65b4643d 152
ba65ae47
RK
153 /* Checkpoint tree */
154 struct rb_root ns_cptree;
155 spinlock_t ns_cptree_lock;
156
693dd321
RK
157 /* Dirty inode list */
158 struct list_head ns_dirty_files;
159 spinlock_t ns_inode_lock;
160
263d90ce 161 /* GC inode list */
65b4643d 162 struct list_head ns_gc_inodes;
65b4643d 163
9b1fc4e4
RK
164 /* Inode allocator */
165 u32 ns_next_generation;
166 spinlock_t ns_next_gen_lock;
167
3b2ce58b
RK
168 /* Mount options */
169 unsigned long ns_mount_opt;
170
574e6c31
RK
171 uid_t ns_resuid;
172 gid_t ns_resgid;
173 unsigned long ns_interval;
174 unsigned long ns_watermark;
175
65b4643d
RK
176 /* Disk layout information (static) */
177 unsigned int ns_blocksize_bits;
92c60cca 178 unsigned int ns_blocksize;
65b4643d
RK
179 unsigned long ns_nsegments;
180 unsigned long ns_blocks_per_segment;
181 unsigned long ns_r_segments_percentage;
182 unsigned long ns_nrsvsegs;
183 unsigned long ns_first_data_block;
184 int ns_inode_size;
185 int ns_first_ino;
186 u32 ns_crc_seed;
187};
188
65b4643d
RK
189#define THE_NILFS_FNS(bit, name) \
190static inline void set_nilfs_##name(struct the_nilfs *nilfs) \
191{ \
192 set_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
193} \
194static inline void clear_nilfs_##name(struct the_nilfs *nilfs) \
195{ \
196 clear_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
197} \
198static inline int nilfs_##name(struct the_nilfs *nilfs) \
199{ \
200 return test_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
201}
202
203THE_NILFS_FNS(INIT, init)
65b4643d 204THE_NILFS_FNS(DISCONTINUED, discontinued)
1cf58fa8 205THE_NILFS_FNS(GC_RUNNING, gc_running)
e605f0a7 206THE_NILFS_FNS(SB_DIRTY, sb_dirty)
65b4643d 207
3b2ce58b
RK
208/*
209 * Mount option operations
210 */
211#define nilfs_clear_opt(nilfs, opt) \
212 do { (nilfs)->ns_mount_opt &= ~NILFS_MOUNT_##opt; } while (0)
213#define nilfs_set_opt(nilfs, opt) \
214 do { (nilfs)->ns_mount_opt |= NILFS_MOUNT_##opt; } while (0)
215#define nilfs_test_opt(nilfs, opt) ((nilfs)->ns_mount_opt & NILFS_MOUNT_##opt)
216#define nilfs_write_opt(nilfs, mask, opt) \
217 do { (nilfs)->ns_mount_opt = \
218 (((nilfs)->ns_mount_opt & ~NILFS_MOUNT_##mask) | \
219 NILFS_MOUNT_##opt); \
220 } while (0)
221
ba65ae47
RK
222/**
223 * struct nilfs_root - nilfs root object
224 * @cno: checkpoint number
225 * @rb_node: red-black tree node
226 * @count: refcount of this structure
227 * @nilfs: nilfs object
228 * @ifile: inode file
229 * @root: root inode
230 * @inodes_count: number of inodes
231 * @blocks_count: number of blocks (Reserved)
232 */
233struct nilfs_root {
234 __u64 cno;
235 struct rb_node rb_node;
236
237 atomic_t count;
238 struct the_nilfs *nilfs;
239 struct inode *ifile;
240
241 atomic_t inodes_count;
242 atomic_t blocks_count;
243};
244
245/* Special checkpoint number */
246#define NILFS_CPTREE_CURRENT_CNO 0
247
e339ad31
RK
248/* Minimum interval of periodical update of superblocks (in seconds) */
249#define NILFS_SB_FREQ 10
e339ad31 250
79efdd94
JS
251static inline int nilfs_sb_need_update(struct the_nilfs *nilfs)
252{
253 u64 t = get_seconds();
b2ac86e1 254 return t < nilfs->ns_sbwtime || t > nilfs->ns_sbwtime + NILFS_SB_FREQ;
79efdd94
JS
255}
256
b2ac86e1 257static inline int nilfs_sb_will_flip(struct the_nilfs *nilfs)
79efdd94 258{
b2ac86e1
JS
259 int flip_bits = nilfs->ns_sbwcount & 0x0FL;
260 return (flip_bits != 0x08 && flip_bits != 0x0F);
79efdd94
JS
261}
262
65b4643d 263void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
348fe8da
RK
264struct the_nilfs *alloc_nilfs(struct block_device *bdev);
265void destroy_nilfs(struct the_nilfs *nilfs);
65b4643d
RK
266int init_nilfs(struct the_nilfs *, struct nilfs_sb_info *, char *);
267int load_nilfs(struct the_nilfs *, struct nilfs_sb_info *);
e902ec99 268int nilfs_discard_segments(struct the_nilfs *, __u64 *, size_t);
65b4643d 269int nilfs_count_free_blocks(struct the_nilfs *, sector_t *);
ba65ae47
RK
270struct nilfs_root *nilfs_lookup_root(struct the_nilfs *nilfs, __u64 cno);
271struct nilfs_root *nilfs_find_or_create_root(struct the_nilfs *nilfs,
272 __u64 cno);
273void nilfs_put_root(struct nilfs_root *root);
6dd47406 274struct nilfs_sb_info *nilfs_find_sbinfo(struct the_nilfs *, int, __u64);
65b4643d 275int nilfs_near_disk_full(struct the_nilfs *);
e339ad31
RK
276void nilfs_fall_back_super_block(struct the_nilfs *);
277void nilfs_swap_super_block(struct the_nilfs *);
65b4643d
RK
278
279
ba65ae47
RK
280static inline void nilfs_get_root(struct nilfs_root *root)
281{
282 atomic_inc(&root->count);
283}
284
a057d2c0
RK
285static inline int nilfs_valid_fs(struct the_nilfs *nilfs)
286{
287 unsigned valid_fs;
288
289 down_read(&nilfs->ns_sem);
290 valid_fs = (nilfs->ns_mount_state & NILFS_VALID_FS);
291 up_read(&nilfs->ns_sem);
292 return valid_fs;
293}
294
65b4643d
RK
295static inline void
296nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
297 sector_t *seg_start, sector_t *seg_end)
298{
299 *seg_start = (sector_t)nilfs->ns_blocks_per_segment * segnum;
300 *seg_end = *seg_start + nilfs->ns_blocks_per_segment - 1;
301 if (segnum == 0)
302 *seg_start = nilfs->ns_first_data_block;
303}
304
305static inline sector_t
306nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
307{
308 return (segnum == 0) ? nilfs->ns_first_data_block :
309 (sector_t)nilfs->ns_blocks_per_segment * segnum;
310}
311
312static inline __u64
313nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
314{
315 sector_t segnum = blocknr;
316
317 sector_div(segnum, nilfs->ns_blocks_per_segment);
318 return segnum;
319}
320
321static inline void
322nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
323 sector_t seg_end)
324{
325 /* terminate the current full segment (used in case of I/O-error) */
326 nilfs->ns_pseg_offset = seg_end - seg_start + 1;
327}
328
329static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
330{
331 /* move forward with a full segment */
332 nilfs->ns_segnum = nilfs->ns_nextnum;
333 nilfs->ns_pseg_offset = 0;
334 nilfs->ns_seg_seq++;
335}
336
337static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
338{
339 __u64 cno;
340
341 spin_lock(&nilfs->ns_last_segment_lock);
342 cno = nilfs->ns_last_cno;
343 spin_unlock(&nilfs->ns_last_segment_lock);
344 return cno;
345}
346
cece5520
RK
347static inline int nilfs_segment_is_active(struct the_nilfs *nilfs, __u64 n)
348{
349 return n == nilfs->ns_segnum || n == nilfs->ns_nextnum;
350}
351
65b4643d 352#endif /* _THE_NILFS_H */