nilfs2: remove own inode hash used for GC
[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>
29#include <linux/fs.h>
30#include <linux/blkdev.h>
31#include <linux/backing-dev.h>
5a0e3ad6 32#include <linux/slab.h>
65b4643d
RK
33#include "sb.h"
34
35/* the_nilfs struct */
36enum {
37 THE_NILFS_INIT = 0, /* Information from super_block is set */
38 THE_NILFS_LOADED, /* Roll-back/roll-forward has done and
39 the latest checkpoint was loaded */
40 THE_NILFS_DISCONTINUED, /* 'next' pointer chain has broken */
1cf58fa8 41 THE_NILFS_GC_RUNNING, /* gc process is running */
e605f0a7 42 THE_NILFS_SB_DIRTY, /* super block is dirty */
65b4643d
RK
43};
44
45/**
46 * struct the_nilfs - struct to supervise multiple nilfs mount points
47 * @ns_flags: flags
48 * @ns_count: reference count
33c8e57c 49 * @ns_list: list head for nilfs_list
65b4643d
RK
50 * @ns_bdev: block device
51 * @ns_bdi: backing dev info
52 * @ns_writer: back pointer to writable nilfs_sb_info
53 * @ns_sem: semaphore for shared states
e59399d0 54 * @ns_super_sem: semaphore for global operations across super block instances
aa7dfb89 55 * @ns_mount_mutex: mutex protecting mount process of nilfs
027d6404 56 * @ns_writer_sem: semaphore protecting ns_writer attach/detach
3f82ff55 57 * @ns_current: back pointer to current mount
e339ad31
RK
58 * @ns_sbh: buffer heads of on-disk super blocks
59 * @ns_sbp: pointers to super block data
b2ac86e1
JS
60 * @ns_sbwtime: previous write time of super block
61 * @ns_sbwcount: write count of super block
e339ad31 62 * @ns_sbsize: size of valid data in super block
65b4643d
RK
63 * @ns_supers: list of nilfs super block structs
64 * @ns_seg_seq: segment sequence counter
65 * @ns_segnum: index number of the latest full segment.
66 * @ns_nextnum: index number of the full segment index to be used next
67 * @ns_pseg_offset: offset of next partial segment in the current full segment
68 * @ns_cno: next checkpoint number
69 * @ns_ctime: write time of the last segment
70 * @ns_nongc_ctime: write time of the last segment not for cleaner operation
71 * @ns_ndirtyblks: Number of dirty data blocks
72 * @ns_last_segment_lock: lock protecting fields for the latest segment
73 * @ns_last_pseg: start block number of the latest segment
74 * @ns_last_seq: sequence value of the latest segment
75 * @ns_last_cno: checkpoint number of the latest segment
2c2e52fc 76 * @ns_prot_seq: least sequence number of segments which must not be reclaimed
32502047 77 * @ns_prev_seq: base sequence number used to decide if advance log cursor
65b4643d
RK
78 * @ns_segctor_sem: segment constructor semaphore
79 * @ns_dat: DAT file inode
80 * @ns_cpfile: checkpoint file inode
81 * @ns_sufile: segusage file inode
82 * @ns_gc_dat: shadow inode of the DAT file inode for GC
83 * @ns_gc_inodes: dummy inodes to keep live blocks
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;
97 atomic_t ns_count;
33c8e57c 98 struct list_head ns_list;
65b4643d
RK
99
100 struct block_device *ns_bdev;
101 struct backing_dev_info *ns_bdi;
102 struct nilfs_sb_info *ns_writer;
103 struct rw_semaphore ns_sem;
e59399d0 104 struct rw_semaphore ns_super_sem;
aa7dfb89 105 struct mutex ns_mount_mutex;
027d6404 106 struct rw_semaphore ns_writer_sem;
65b4643d 107
e59399d0
RK
108 /*
109 * components protected by ns_super_sem
110 */
3f82ff55 111 struct nilfs_sb_info *ns_current;
e59399d0 112 struct list_head ns_supers;
3f82ff55 113
65b4643d
RK
114 /*
115 * used for
116 * - loading the latest checkpoint exclusively.
117 * - allocating a new full segment.
118 * - protecting s_dirt in the super_block struct
119 * (see nilfs_write_super) and the following fields.
120 */
e339ad31
RK
121 struct buffer_head *ns_sbh[2];
122 struct nilfs_super_block *ns_sbp[2];
b2ac86e1
JS
123 time_t ns_sbwtime;
124 unsigned ns_sbwcount;
e339ad31 125 unsigned ns_sbsize;
65b4643d 126 unsigned ns_mount_state;
65b4643d
RK
127
128 /*
129 * Following fields are dedicated to a writable FS-instance.
130 * Except for the period seeking checkpoint, code outside the segment
47420c79
RK
131 * constructor must lock a segment semaphore while accessing these
132 * fields.
65b4643d
RK
133 * The writable FS-instance is sole during a lifetime of the_nilfs.
134 */
135 u64 ns_seg_seq;
136 __u64 ns_segnum;
137 __u64 ns_nextnum;
138 unsigned long ns_pseg_offset;
139 __u64 ns_cno;
140 time_t ns_ctime;
141 time_t ns_nongc_ctime;
142 atomic_t ns_ndirtyblks;
143
144 /*
145 * The following fields hold information on the latest partial segment
146 * written to disk with a super root. These fields are protected by
147 * ns_last_segment_lock.
148 */
149 spinlock_t ns_last_segment_lock;
150 sector_t ns_last_pseg;
151 u64 ns_last_seq;
152 __u64 ns_last_cno;
2c2e52fc 153 u64 ns_prot_seq;
32502047 154 u64 ns_prev_seq;
65b4643d
RK
155
156 struct rw_semaphore ns_segctor_sem;
157
158 /*
159 * Following fields are lock free except for the period before
160 * the_nilfs is initialized.
161 */
162 struct inode *ns_dat;
163 struct inode *ns_cpfile;
164 struct inode *ns_sufile;
165 struct inode *ns_gc_dat;
166
263d90ce 167 /* GC inode list */
65b4643d 168 struct list_head ns_gc_inodes;
65b4643d 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)
198THE_NILFS_FNS(LOADED, loaded)
199THE_NILFS_FNS(DISCONTINUED, discontinued)
1cf58fa8 200THE_NILFS_FNS(GC_RUNNING, gc_running)
e605f0a7 201THE_NILFS_FNS(SB_DIRTY, sb_dirty)
65b4643d 202
e339ad31
RK
203/* Minimum interval of periodical update of superblocks (in seconds) */
204#define NILFS_SB_FREQ 10
e339ad31 205
79efdd94
JS
206static inline int nilfs_sb_need_update(struct the_nilfs *nilfs)
207{
208 u64 t = get_seconds();
b2ac86e1 209 return t < nilfs->ns_sbwtime || t > nilfs->ns_sbwtime + NILFS_SB_FREQ;
79efdd94
JS
210}
211
b2ac86e1 212static inline int nilfs_sb_will_flip(struct the_nilfs *nilfs)
79efdd94 213{
b2ac86e1
JS
214 int flip_bits = nilfs->ns_sbwcount & 0x0FL;
215 return (flip_bits != 0x08 && flip_bits != 0x0F);
79efdd94
JS
216}
217
65b4643d 218void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
33c8e57c 219struct the_nilfs *find_or_create_nilfs(struct block_device *);
65b4643d
RK
220void put_nilfs(struct the_nilfs *);
221int init_nilfs(struct the_nilfs *, struct nilfs_sb_info *, char *);
222int load_nilfs(struct the_nilfs *, struct nilfs_sb_info *);
e902ec99 223int nilfs_discard_segments(struct the_nilfs *, __u64 *, size_t);
65b4643d 224int nilfs_count_free_blocks(struct the_nilfs *, sector_t *);
6dd47406 225struct nilfs_sb_info *nilfs_find_sbinfo(struct the_nilfs *, int, __u64);
65b4643d
RK
226int nilfs_checkpoint_is_mounted(struct the_nilfs *, __u64, int);
227int nilfs_near_disk_full(struct the_nilfs *);
e339ad31
RK
228void nilfs_fall_back_super_block(struct the_nilfs *);
229void nilfs_swap_super_block(struct the_nilfs *);
65b4643d
RK
230
231
232static inline void get_nilfs(struct the_nilfs *nilfs)
233{
234 /* Caller must have at least one reference of the_nilfs. */
235 atomic_inc(&nilfs->ns_count);
236}
237
65b4643d
RK
238static inline void
239nilfs_attach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
240{
027d6404 241 down_write(&nilfs->ns_writer_sem);
65b4643d 242 nilfs->ns_writer = sbi;
027d6404 243 up_write(&nilfs->ns_writer_sem);
65b4643d
RK
244}
245
246static inline void
247nilfs_detach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
248{
027d6404 249 down_write(&nilfs->ns_writer_sem);
65b4643d
RK
250 if (sbi == nilfs->ns_writer)
251 nilfs->ns_writer = NULL;
027d6404 252 up_write(&nilfs->ns_writer_sem);
65b4643d
RK
253}
254
6dd47406
RK
255static inline void nilfs_put_sbinfo(struct nilfs_sb_info *sbi)
256{
a9245860 257 if (atomic_dec_and_test(&sbi->s_count))
6dd47406
RK
258 kfree(sbi);
259}
260
a057d2c0
RK
261static inline int nilfs_valid_fs(struct the_nilfs *nilfs)
262{
263 unsigned valid_fs;
264
265 down_read(&nilfs->ns_sem);
266 valid_fs = (nilfs->ns_mount_state & NILFS_VALID_FS);
267 up_read(&nilfs->ns_sem);
268 return valid_fs;
269}
270
65b4643d
RK
271static inline void
272nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
273 sector_t *seg_start, sector_t *seg_end)
274{
275 *seg_start = (sector_t)nilfs->ns_blocks_per_segment * segnum;
276 *seg_end = *seg_start + nilfs->ns_blocks_per_segment - 1;
277 if (segnum == 0)
278 *seg_start = nilfs->ns_first_data_block;
279}
280
281static inline sector_t
282nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
283{
284 return (segnum == 0) ? nilfs->ns_first_data_block :
285 (sector_t)nilfs->ns_blocks_per_segment * segnum;
286}
287
288static inline __u64
289nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
290{
291 sector_t segnum = blocknr;
292
293 sector_div(segnum, nilfs->ns_blocks_per_segment);
294 return segnum;
295}
296
297static inline void
298nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
299 sector_t seg_end)
300{
301 /* terminate the current full segment (used in case of I/O-error) */
302 nilfs->ns_pseg_offset = seg_end - seg_start + 1;
303}
304
305static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
306{
307 /* move forward with a full segment */
308 nilfs->ns_segnum = nilfs->ns_nextnum;
309 nilfs->ns_pseg_offset = 0;
310 nilfs->ns_seg_seq++;
311}
312
313static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
314{
315 __u64 cno;
316
317 spin_lock(&nilfs->ns_last_segment_lock);
318 cno = nilfs->ns_last_cno;
319 spin_unlock(&nilfs->ns_last_segment_lock);
320 return cno;
321}
322
cece5520
RK
323static inline int nilfs_segment_is_active(struct the_nilfs *nilfs, __u64 n)
324{
325 return n == nilfs->ns_segnum || n == nilfs->ns_nextnum;
326}
327
65b4643d 328#endif /* _THE_NILFS_H */