nilfs2: simplify remaining sget() use
[deliverable/linux.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>
32#include "sb.h"
33
34/* the_nilfs struct */
35enum {
36 THE_NILFS_INIT = 0, /* Information from super_block is set */
37 THE_NILFS_LOADED, /* Roll-back/roll-forward has done and
38 the latest checkpoint was loaded */
39 THE_NILFS_DISCONTINUED, /* 'next' pointer chain has broken */
65b4643d
RK
40};
41
42/**
43 * struct the_nilfs - struct to supervise multiple nilfs mount points
44 * @ns_flags: flags
45 * @ns_count: reference count
33c8e57c 46 * @ns_list: list head for nilfs_list
65b4643d
RK
47 * @ns_bdev: block device
48 * @ns_bdi: backing dev info
49 * @ns_writer: back pointer to writable nilfs_sb_info
50 * @ns_sem: semaphore for shared states
51 * @ns_writer_mutex: mutex protecting ns_writer attach/detach
52 * @ns_writer_refcount: number of referrers on ns_writer
3f82ff55 53 * @ns_current: back pointer to current mount
e339ad31
RK
54 * @ns_sbh: buffer heads of on-disk super blocks
55 * @ns_sbp: pointers to super block data
56 * @ns_sbwtime: previous write time of super blocks
57 * @ns_sbsize: size of valid data in super block
65b4643d
RK
58 * @ns_supers: list of nilfs super block structs
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
65b4643d
RK
72 * @ns_free_segments_count: counter of free segments
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
78 * @ns_gc_inodes: dummy inodes to keep live blocks
79 * @ns_gc_inodes_h: hash list to keep dummy inode holding live blocks
65b4643d
RK
80 * @ns_blocksize_bits: bit length of block size
81 * @ns_nsegments: number of segments in filesystem
82 * @ns_blocks_per_segment: number of blocks per segment
83 * @ns_r_segments_percentage: reserved segments percentage
84 * @ns_nrsvsegs: number of reserved segments
85 * @ns_first_data_block: block number of first data block
86 * @ns_inode_size: size of on-disk inode
87 * @ns_first_ino: first not-special inode number
88 * @ns_crc_seed: seed value of CRC32 calculation
89 */
90struct the_nilfs {
91 unsigned long ns_flags;
92 atomic_t ns_count;
33c8e57c 93 struct list_head ns_list;
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;
99 struct mutex ns_writer_mutex;
100 atomic_t ns_writer_refcount;
101
3f82ff55
RK
102 struct nilfs_sb_info *ns_current;
103
65b4643d
RK
104 /*
105 * used for
106 * - loading the latest checkpoint exclusively.
107 * - allocating a new full segment.
108 * - protecting s_dirt in the super_block struct
109 * (see nilfs_write_super) and the following fields.
110 */
e339ad31
RK
111 struct buffer_head *ns_sbh[2];
112 struct nilfs_super_block *ns_sbp[2];
113 time_t ns_sbwtime[2];
114 unsigned ns_sbsize;
65b4643d
RK
115 unsigned ns_mount_state;
116 struct list_head ns_supers;
117
118 /*
119 * Following fields are dedicated to a writable FS-instance.
120 * Except for the period seeking checkpoint, code outside the segment
47420c79
RK
121 * constructor must lock a segment semaphore while accessing these
122 * fields.
65b4643d
RK
123 * The writable FS-instance is sole during a lifetime of the_nilfs.
124 */
125 u64 ns_seg_seq;
126 __u64 ns_segnum;
127 __u64 ns_nextnum;
128 unsigned long ns_pseg_offset;
129 __u64 ns_cno;
130 time_t ns_ctime;
131 time_t ns_nongc_ctime;
132 atomic_t ns_ndirtyblks;
133
134 /*
135 * The following fields hold information on the latest partial segment
136 * written to disk with a super root. These fields are protected by
137 * ns_last_segment_lock.
138 */
139 spinlock_t ns_last_segment_lock;
140 sector_t ns_last_pseg;
141 u64 ns_last_seq;
142 __u64 ns_last_cno;
2c2e52fc 143 u64 ns_prot_seq;
65b4643d
RK
144 unsigned long ns_free_segments_count;
145
146 struct rw_semaphore ns_segctor_sem;
147
148 /*
149 * Following fields are lock free except for the period before
150 * the_nilfs is initialized.
151 */
152 struct inode *ns_dat;
153 struct inode *ns_cpfile;
154 struct inode *ns_sufile;
155 struct inode *ns_gc_dat;
156
157 /* GC inode list and hash table head */
158 struct list_head ns_gc_inodes;
159 struct hlist_head *ns_gc_inodes_h;
160
65b4643d
RK
161 /* Disk layout information (static) */
162 unsigned int ns_blocksize_bits;
163 unsigned long ns_nsegments;
164 unsigned long ns_blocks_per_segment;
165 unsigned long ns_r_segments_percentage;
166 unsigned long ns_nrsvsegs;
167 unsigned long ns_first_data_block;
168 int ns_inode_size;
169 int ns_first_ino;
170 u32 ns_crc_seed;
171};
172
173#define NILFS_GCINODE_HASH_BITS 8
174#define NILFS_GCINODE_HASH_SIZE (1<<NILFS_GCINODE_HASH_BITS)
175
176#define THE_NILFS_FNS(bit, name) \
177static inline void set_nilfs_##name(struct the_nilfs *nilfs) \
178{ \
179 set_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
180} \
181static inline void clear_nilfs_##name(struct the_nilfs *nilfs) \
182{ \
183 clear_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
184} \
185static inline int nilfs_##name(struct the_nilfs *nilfs) \
186{ \
187 return test_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
188}
189
190THE_NILFS_FNS(INIT, init)
191THE_NILFS_FNS(LOADED, loaded)
192THE_NILFS_FNS(DISCONTINUED, discontinued)
65b4643d 193
e339ad31
RK
194/* Minimum interval of periodical update of superblocks (in seconds) */
195#define NILFS_SB_FREQ 10
196#define NILFS_ALTSB_FREQ 60 /* spare superblock */
197
65b4643d 198void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
33c8e57c 199struct the_nilfs *find_or_create_nilfs(struct block_device *);
65b4643d
RK
200void put_nilfs(struct the_nilfs *);
201int init_nilfs(struct the_nilfs *, struct nilfs_sb_info *, char *);
202int load_nilfs(struct the_nilfs *, struct nilfs_sb_info *);
203int nilfs_count_free_blocks(struct the_nilfs *, sector_t *);
6dd47406 204struct nilfs_sb_info *nilfs_find_sbinfo(struct the_nilfs *, int, __u64);
65b4643d
RK
205int nilfs_checkpoint_is_mounted(struct the_nilfs *, __u64, int);
206int nilfs_near_disk_full(struct the_nilfs *);
e339ad31
RK
207void nilfs_fall_back_super_block(struct the_nilfs *);
208void nilfs_swap_super_block(struct the_nilfs *);
65b4643d
RK
209
210
211static inline void get_nilfs(struct the_nilfs *nilfs)
212{
213 /* Caller must have at least one reference of the_nilfs. */
214 atomic_inc(&nilfs->ns_count);
215}
216
217static inline struct nilfs_sb_info *nilfs_get_writer(struct the_nilfs *nilfs)
218{
219 if (atomic_inc_and_test(&nilfs->ns_writer_refcount))
220 mutex_lock(&nilfs->ns_writer_mutex);
221 return nilfs->ns_writer;
222}
223
224static inline void nilfs_put_writer(struct the_nilfs *nilfs)
225{
226 if (atomic_add_negative(-1, &nilfs->ns_writer_refcount))
227 mutex_unlock(&nilfs->ns_writer_mutex);
228}
229
230static inline void
231nilfs_attach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
232{
233 mutex_lock(&nilfs->ns_writer_mutex);
234 nilfs->ns_writer = sbi;
235 mutex_unlock(&nilfs->ns_writer_mutex);
236}
237
238static inline void
239nilfs_detach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
240{
241 mutex_lock(&nilfs->ns_writer_mutex);
242 if (sbi == nilfs->ns_writer)
243 nilfs->ns_writer = NULL;
244 mutex_unlock(&nilfs->ns_writer_mutex);
245}
246
6dd47406
RK
247static inline void nilfs_put_sbinfo(struct nilfs_sb_info *sbi)
248{
249 if (!atomic_dec_and_test(&sbi->s_count))
250 kfree(sbi);
251}
252
65b4643d
RK
253static inline void
254nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
255 sector_t *seg_start, sector_t *seg_end)
256{
257 *seg_start = (sector_t)nilfs->ns_blocks_per_segment * segnum;
258 *seg_end = *seg_start + nilfs->ns_blocks_per_segment - 1;
259 if (segnum == 0)
260 *seg_start = nilfs->ns_first_data_block;
261}
262
263static inline sector_t
264nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
265{
266 return (segnum == 0) ? nilfs->ns_first_data_block :
267 (sector_t)nilfs->ns_blocks_per_segment * segnum;
268}
269
270static inline __u64
271nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
272{
273 sector_t segnum = blocknr;
274
275 sector_div(segnum, nilfs->ns_blocks_per_segment);
276 return segnum;
277}
278
279static inline void
280nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
281 sector_t seg_end)
282{
283 /* terminate the current full segment (used in case of I/O-error) */
284 nilfs->ns_pseg_offset = seg_end - seg_start + 1;
285}
286
287static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
288{
289 /* move forward with a full segment */
290 nilfs->ns_segnum = nilfs->ns_nextnum;
291 nilfs->ns_pseg_offset = 0;
292 nilfs->ns_seg_seq++;
293}
294
295static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
296{
297 __u64 cno;
298
299 spin_lock(&nilfs->ns_last_segment_lock);
300 cno = nilfs->ns_last_cno;
301 spin_unlock(&nilfs->ns_last_segment_lock);
302 return cno;
303}
304
cece5520
RK
305static inline int nilfs_segment_is_active(struct the_nilfs *nilfs, __u64 n)
306{
307 return n == nilfs->ns_segnum || n == nilfs->ns_nextnum;
308}
309
65b4643d 310#endif /* _THE_NILFS_H */
This page took 0.056279 seconds and 5 git commands to generate.