]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - fs/nilfs2/the_nilfs.h
nilfs2: simplify life cycle management of nilfs object
[mirror_ubuntu-zesty-kernel.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 */
39 THE_NILFS_LOADED, /* Roll-back/roll-forward has done and
40 the latest checkpoint was loaded */
41 THE_NILFS_DISCONTINUED, /* 'next' pointer chain has broken */
1cf58fa8 42 THE_NILFS_GC_RUNNING, /* gc process is running */
e605f0a7 43 THE_NILFS_SB_DIRTY, /* super block is dirty */
65b4643d
RK
44};
45
46/**
47 * struct the_nilfs - struct to supervise multiple nilfs mount points
48 * @ns_flags: flags
65b4643d
RK
49 * @ns_bdev: block device
50 * @ns_bdi: backing dev info
51 * @ns_writer: back pointer to writable nilfs_sb_info
52 * @ns_sem: semaphore for shared states
027d6404 53 * @ns_writer_sem: semaphore protecting ns_writer attach/detach
e339ad31
RK
54 * @ns_sbh: buffer heads of on-disk super blocks
55 * @ns_sbp: pointers to super block data
b2ac86e1
JS
56 * @ns_sbwtime: previous write time of super block
57 * @ns_sbwcount: write count of super block
e339ad31 58 * @ns_sbsize: size of valid data in super block
65b4643d
RK
59 * @ns_seg_seq: segment sequence counter
60 * @ns_segnum: index number of the latest full segment.
61 * @ns_nextnum: index number of the full segment index to be used next
62 * @ns_pseg_offset: offset of next partial segment in the current full segment
63 * @ns_cno: next checkpoint number
64 * @ns_ctime: write time of the last segment
65 * @ns_nongc_ctime: write time of the last segment not for cleaner operation
66 * @ns_ndirtyblks: Number of dirty data blocks
67 * @ns_last_segment_lock: lock protecting fields for the latest segment
68 * @ns_last_pseg: start block number of the latest segment
69 * @ns_last_seq: sequence value of the latest segment
70 * @ns_last_cno: checkpoint number of the latest segment
2c2e52fc 71 * @ns_prot_seq: least sequence number of segments which must not be reclaimed
32502047 72 * @ns_prev_seq: base sequence number used to decide if advance log cursor
65b4643d
RK
73 * @ns_segctor_sem: segment constructor semaphore
74 * @ns_dat: DAT file inode
75 * @ns_cpfile: checkpoint file inode
76 * @ns_sufile: segusage file inode
77 * @ns_gc_dat: shadow inode of the DAT file inode for GC
ba65ae47
RK
78 * @ns_cptree: rb-tree of all mounted checkpoints (nilfs_root)
79 * @ns_cptree_lock: lock protecting @ns_cptree
65b4643d 80 * @ns_gc_inodes: dummy inodes to keep live blocks
65b4643d 81 * @ns_blocksize_bits: bit length of block size
92c60cca 82 * @ns_blocksize: block size
65b4643d
RK
83 * @ns_nsegments: number of segments in filesystem
84 * @ns_blocks_per_segment: number of blocks per segment
85 * @ns_r_segments_percentage: reserved segments percentage
86 * @ns_nrsvsegs: number of reserved segments
87 * @ns_first_data_block: block number of first data block
88 * @ns_inode_size: size of on-disk inode
89 * @ns_first_ino: first not-special inode number
90 * @ns_crc_seed: seed value of CRC32 calculation
91 */
92struct the_nilfs {
93 unsigned long ns_flags;
65b4643d
RK
94
95 struct block_device *ns_bdev;
96 struct backing_dev_info *ns_bdi;
97 struct nilfs_sb_info *ns_writer;
98 struct rw_semaphore ns_sem;
027d6404 99 struct rw_semaphore ns_writer_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;
152 struct inode *ns_gc_dat;
153
ba65ae47
RK
154 /* Checkpoint tree */
155 struct rb_root ns_cptree;
156 spinlock_t ns_cptree_lock;
157
263d90ce 158 /* GC inode list */
65b4643d 159 struct list_head ns_gc_inodes;
65b4643d 160
65b4643d
RK
161 /* Disk layout information (static) */
162 unsigned int ns_blocksize_bits;
92c60cca 163 unsigned int ns_blocksize;
65b4643d
RK
164 unsigned long ns_nsegments;
165 unsigned long ns_blocks_per_segment;
166 unsigned long ns_r_segments_percentage;
167 unsigned long ns_nrsvsegs;
168 unsigned long ns_first_data_block;
169 int ns_inode_size;
170 int ns_first_ino;
171 u32 ns_crc_seed;
172};
173
65b4643d
RK
174#define THE_NILFS_FNS(bit, name) \
175static inline void set_nilfs_##name(struct the_nilfs *nilfs) \
176{ \
177 set_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
178} \
179static inline void clear_nilfs_##name(struct the_nilfs *nilfs) \
180{ \
181 clear_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
182} \
183static inline int nilfs_##name(struct the_nilfs *nilfs) \
184{ \
185 return test_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
186}
187
188THE_NILFS_FNS(INIT, init)
189THE_NILFS_FNS(LOADED, loaded)
190THE_NILFS_FNS(DISCONTINUED, discontinued)
1cf58fa8 191THE_NILFS_FNS(GC_RUNNING, gc_running)
e605f0a7 192THE_NILFS_FNS(SB_DIRTY, sb_dirty)
65b4643d 193
ba65ae47
RK
194/**
195 * struct nilfs_root - nilfs root object
196 * @cno: checkpoint number
197 * @rb_node: red-black tree node
198 * @count: refcount of this structure
199 * @nilfs: nilfs object
200 * @ifile: inode file
201 * @root: root inode
202 * @inodes_count: number of inodes
203 * @blocks_count: number of blocks (Reserved)
204 */
205struct nilfs_root {
206 __u64 cno;
207 struct rb_node rb_node;
208
209 atomic_t count;
210 struct the_nilfs *nilfs;
211 struct inode *ifile;
212
213 atomic_t inodes_count;
214 atomic_t blocks_count;
215};
216
217/* Special checkpoint number */
218#define NILFS_CPTREE_CURRENT_CNO 0
219
e339ad31
RK
220/* Minimum interval of periodical update of superblocks (in seconds) */
221#define NILFS_SB_FREQ 10
e339ad31 222
79efdd94
JS
223static inline int nilfs_sb_need_update(struct the_nilfs *nilfs)
224{
225 u64 t = get_seconds();
b2ac86e1 226 return t < nilfs->ns_sbwtime || t > nilfs->ns_sbwtime + NILFS_SB_FREQ;
79efdd94
JS
227}
228
b2ac86e1 229static inline int nilfs_sb_will_flip(struct the_nilfs *nilfs)
79efdd94 230{
b2ac86e1
JS
231 int flip_bits = nilfs->ns_sbwcount & 0x0FL;
232 return (flip_bits != 0x08 && flip_bits != 0x0F);
79efdd94
JS
233}
234
65b4643d 235void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
348fe8da
RK
236struct the_nilfs *alloc_nilfs(struct block_device *bdev);
237void destroy_nilfs(struct the_nilfs *nilfs);
65b4643d
RK
238int init_nilfs(struct the_nilfs *, struct nilfs_sb_info *, char *);
239int load_nilfs(struct the_nilfs *, struct nilfs_sb_info *);
e902ec99 240int nilfs_discard_segments(struct the_nilfs *, __u64 *, size_t);
65b4643d 241int nilfs_count_free_blocks(struct the_nilfs *, sector_t *);
ba65ae47
RK
242struct nilfs_root *nilfs_lookup_root(struct the_nilfs *nilfs, __u64 cno);
243struct nilfs_root *nilfs_find_or_create_root(struct the_nilfs *nilfs,
244 __u64 cno);
245void nilfs_put_root(struct nilfs_root *root);
6dd47406 246struct nilfs_sb_info *nilfs_find_sbinfo(struct the_nilfs *, int, __u64);
65b4643d
RK
247int nilfs_checkpoint_is_mounted(struct the_nilfs *, __u64, int);
248int nilfs_near_disk_full(struct the_nilfs *);
e339ad31
RK
249void nilfs_fall_back_super_block(struct the_nilfs *);
250void nilfs_swap_super_block(struct the_nilfs *);
65b4643d
RK
251
252
ba65ae47
RK
253static inline void nilfs_get_root(struct nilfs_root *root)
254{
255 atomic_inc(&root->count);
256}
257
65b4643d
RK
258static inline void
259nilfs_attach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
260{
027d6404 261 down_write(&nilfs->ns_writer_sem);
65b4643d 262 nilfs->ns_writer = sbi;
027d6404 263 up_write(&nilfs->ns_writer_sem);
65b4643d
RK
264}
265
266static inline void
267nilfs_detach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
268{
027d6404 269 down_write(&nilfs->ns_writer_sem);
65b4643d
RK
270 if (sbi == nilfs->ns_writer)
271 nilfs->ns_writer = NULL;
027d6404 272 up_write(&nilfs->ns_writer_sem);
65b4643d
RK
273}
274
a057d2c0
RK
275static inline int nilfs_valid_fs(struct the_nilfs *nilfs)
276{
277 unsigned valid_fs;
278
279 down_read(&nilfs->ns_sem);
280 valid_fs = (nilfs->ns_mount_state & NILFS_VALID_FS);
281 up_read(&nilfs->ns_sem);
282 return valid_fs;
283}
284
65b4643d
RK
285static inline void
286nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
287 sector_t *seg_start, sector_t *seg_end)
288{
289 *seg_start = (sector_t)nilfs->ns_blocks_per_segment * segnum;
290 *seg_end = *seg_start + nilfs->ns_blocks_per_segment - 1;
291 if (segnum == 0)
292 *seg_start = nilfs->ns_first_data_block;
293}
294
295static inline sector_t
296nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
297{
298 return (segnum == 0) ? nilfs->ns_first_data_block :
299 (sector_t)nilfs->ns_blocks_per_segment * segnum;
300}
301
302static inline __u64
303nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
304{
305 sector_t segnum = blocknr;
306
307 sector_div(segnum, nilfs->ns_blocks_per_segment);
308 return segnum;
309}
310
311static inline void
312nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
313 sector_t seg_end)
314{
315 /* terminate the current full segment (used in case of I/O-error) */
316 nilfs->ns_pseg_offset = seg_end - seg_start + 1;
317}
318
319static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
320{
321 /* move forward with a full segment */
322 nilfs->ns_segnum = nilfs->ns_nextnum;
323 nilfs->ns_pseg_offset = 0;
324 nilfs->ns_seg_seq++;
325}
326
327static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
328{
329 __u64 cno;
330
331 spin_lock(&nilfs->ns_last_segment_lock);
332 cno = nilfs->ns_last_cno;
333 spin_unlock(&nilfs->ns_last_segment_lock);
334 return cno;
335}
336
cece5520
RK
337static inline int nilfs_segment_is_active(struct the_nilfs *nilfs, __u64 n)
338{
339 return n == nilfs->ns_segnum || n == nilfs->ns_nextnum;
340}
341
65b4643d 342#endif /* _THE_NILFS_H */