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