[net-next-2.6.git] / fs / nilfs2 / the_nilfs.h

/*
 * the_nilfs.h - the_nilfs shared structure.
 *
 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Written by Ryusuke Konishi <ryusuke@osrg.net>
 *
 */

#ifndef _THE_NILFS_H
#define _THE_NILFS_H

#include <linux/types.h>
#include <linux/buffer_head.h>
#include <linux/fs.h>
#include <linux/blkdev.h>
#include <linux/backing-dev.h>
#include "sb.h"

/* the_nilfs struct */
enum {
	THE_NILFS_INIT = 0,     /* Information from super_block is set */
	THE_NILFS_LOADED,       /* Roll-back/roll-forward has done and
				   the latest checkpoint was loaded */
	THE_NILFS_DISCONTINUED,	/* 'next' pointer chain has broken */
};

/**
 * struct the_nilfs - struct to supervise multiple nilfs mount points
 * @ns_flags: flags
 * @ns_count: reference count
 * @ns_bdev: block device
 * @ns_bdi: backing dev info
 * @ns_writer: back pointer to writable nilfs_sb_info
 * @ns_sem: semaphore for shared states
 * @ns_writer_mutex: mutex protecting ns_writer attach/detach
 * @ns_writer_refcount: number of referrers on ns_writer
 * @ns_sbh: buffer head of the on-disk super block
 * @ns_sbp: pointer to the super block data
 * @ns_used_segments: list of full segments in volatile active state
 * @ns_supers: list of nilfs super block structs
 * @ns_seg_seq: segment sequence counter
 * @ns_segnum: index number of the latest full segment.
 * @ns_nextnum: index number of the full segment index to be used next
 * @ns_pseg_offset: offset of next partial segment in the current full segment
 * @ns_cno: next checkpoint number
 * @ns_ctime: write time of the last segment
 * @ns_nongc_ctime: write time of the last segment not for cleaner operation
 * @ns_ndirtyblks: Number of dirty data blocks
 * @ns_last_segment_lock: lock protecting fields for the latest segment
 * @ns_last_pseg: start block number of the latest segment
 * @ns_last_seq: sequence value of the latest segment
 * @ns_last_cno: checkpoint number of the latest segment
 * @ns_free_segments_count: counter of free segments
 * @ns_segctor_sem: segment constructor semaphore
 * @ns_dat: DAT file inode
 * @ns_cpfile: checkpoint file inode
 * @ns_sufile: segusage file inode
 * @ns_gc_dat: shadow inode of the DAT file inode for GC
 * @ns_gc_inodes: dummy inodes to keep live blocks
 * @ns_gc_inodes_h: hash list to keep dummy inode holding live blocks
 * @ns_blocksize_bits: bit length of block size
 * @ns_nsegments: number of segments in filesystem
 * @ns_blocks_per_segment: number of blocks per segment
 * @ns_r_segments_percentage: reserved segments percentage
 * @ns_nrsvsegs: number of reserved segments
 * @ns_first_data_block: block number of first data block
 * @ns_inode_size: size of on-disk inode
 * @ns_first_ino: first not-special inode number
 * @ns_crc_seed: seed value of CRC32 calculation
 */
struct the_nilfs {
	unsigned long		ns_flags;
	atomic_t		ns_count;

	struct block_device    *ns_bdev;
	struct backing_dev_info *ns_bdi;
	struct nilfs_sb_info   *ns_writer;
	struct rw_semaphore	ns_sem;
	struct mutex		ns_writer_mutex;
	atomic_t		ns_writer_refcount;

	/*
	 * used for
	 * - loading the latest checkpoint exclusively.
	 * - allocating a new full segment.
	 * - protecting s_dirt in the super_block struct
	 *   (see nilfs_write_super) and the following fields.
	 */
	struct buffer_head     *ns_sbh;
	struct nilfs_super_block *ns_sbp;
	struct list_head	ns_used_segments;
	unsigned		ns_mount_state;
	struct list_head	ns_supers;

	/*
	 * Following fields are dedicated to a writable FS-instance.
	 * Except for the period seeking checkpoint, code outside the segment
	 * constructor must lock a segment semaphore while accessing these
	 * fields.
	 * The writable FS-instance is sole during a lifetime of the_nilfs.
	 */
	u64			ns_seg_seq;
	__u64			ns_segnum;
	__u64			ns_nextnum;
	unsigned long		ns_pseg_offset;
	__u64			ns_cno;
	time_t			ns_ctime;
	time_t			ns_nongc_ctime;
	atomic_t		ns_ndirtyblks;

	/*
	 * The following fields hold information on the latest partial segment
	 * written to disk with a super root.  These fields are protected by
	 * ns_last_segment_lock.
	 */
	spinlock_t		ns_last_segment_lock;
	sector_t		ns_last_pseg;
	u64			ns_last_seq;
	__u64			ns_last_cno;
	unsigned long		ns_free_segments_count;

	struct rw_semaphore	ns_segctor_sem;

	/*
	 * Following fields are lock free except for the period before
	 * the_nilfs is initialized.
	 */
	struct inode	       *ns_dat;
	struct inode	       *ns_cpfile;
	struct inode	       *ns_sufile;
	struct inode	       *ns_gc_dat;

	/* GC inode list and hash table head */
	struct list_head	ns_gc_inodes;
	struct hlist_head      *ns_gc_inodes_h;

	/* Disk layout information (static) */
	unsigned int		ns_blocksize_bits;
	unsigned long		ns_nsegments;
	unsigned long		ns_blocks_per_segment;
	unsigned long		ns_r_segments_percentage;
	unsigned long		ns_nrsvsegs;
	unsigned long		ns_first_data_block;
	int			ns_inode_size;
	int			ns_first_ino;
	u32			ns_crc_seed;
};

#define NILFS_GCINODE_HASH_BITS		8
#define NILFS_GCINODE_HASH_SIZE		(1<<NILFS_GCINODE_HASH_BITS)

#define THE_NILFS_FNS(bit, name)					\
static inline void set_nilfs_##name(struct the_nilfs *nilfs)		\
{									\
	set_bit(THE_NILFS_##bit, &(nilfs)->ns_flags);			\
}									\
static inline void clear_nilfs_##name(struct the_nilfs *nilfs)		\
{									\
	clear_bit(THE_NILFS_##bit, &(nilfs)->ns_flags);			\
}									\
static inline int nilfs_##name(struct the_nilfs *nilfs)			\
{									\
	return test_bit(THE_NILFS_##bit, &(nilfs)->ns_flags);		\
}

THE_NILFS_FNS(INIT, init)
THE_NILFS_FNS(LOADED, loaded)
THE_NILFS_FNS(DISCONTINUED, discontinued)

void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
struct the_nilfs *alloc_nilfs(struct block_device *);
void put_nilfs(struct the_nilfs *);
int init_nilfs(struct the_nilfs *, struct nilfs_sb_info *, char *);
int load_nilfs(struct the_nilfs *, struct nilfs_sb_info *);
int nilfs_count_free_blocks(struct the_nilfs *, sector_t *);
void nilfs_dispose_used_segments(struct the_nilfs *);
int nilfs_checkpoint_is_mounted(struct the_nilfs *, __u64, int);
int nilfs_near_disk_full(struct the_nilfs *);


static inline void get_nilfs(struct the_nilfs *nilfs)
{
	/* Caller must have at least one reference of the_nilfs. */
	atomic_inc(&nilfs->ns_count);
}

static inline struct nilfs_sb_info *nilfs_get_writer(struct the_nilfs *nilfs)
{
	if (atomic_inc_and_test(&nilfs->ns_writer_refcount))
		mutex_lock(&nilfs->ns_writer_mutex);
	return nilfs->ns_writer;
}

static inline void nilfs_put_writer(struct the_nilfs *nilfs)
{
	if (atomic_add_negative(-1, &nilfs->ns_writer_refcount))
		mutex_unlock(&nilfs->ns_writer_mutex);
}

static inline void
nilfs_attach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
{
	mutex_lock(&nilfs->ns_writer_mutex);
	nilfs->ns_writer = sbi;
	mutex_unlock(&nilfs->ns_writer_mutex);
}

static inline void
nilfs_detach_writer(struct the_nilfs *nilfs, struct nilfs_sb_info *sbi)
{
	mutex_lock(&nilfs->ns_writer_mutex);
	if (sbi == nilfs->ns_writer)
		nilfs->ns_writer = NULL;
	mutex_unlock(&nilfs->ns_writer_mutex);
}

static inline void
nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
			sector_t *seg_start, sector_t *seg_end)
{
	*seg_start = (sector_t)nilfs->ns_blocks_per_segment * segnum;
	*seg_end = *seg_start + nilfs->ns_blocks_per_segment - 1;
	if (segnum == 0)
		*seg_start = nilfs->ns_first_data_block;
}

static inline sector_t
nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
{
	return (segnum == 0) ? nilfs->ns_first_data_block :
		(sector_t)nilfs->ns_blocks_per_segment * segnum;
}

static inline __u64
nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
{
	sector_t segnum = blocknr;

	sector_div(segnum, nilfs->ns_blocks_per_segment);
	return segnum;
}

static inline void
nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
			sector_t seg_end)
{
	/* terminate the current full segment (used in case of I/O-error) */
	nilfs->ns_pseg_offset = seg_end - seg_start + 1;
}

static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
{
	/* move forward with a full segment */
	nilfs->ns_segnum = nilfs->ns_nextnum;
	nilfs->ns_pseg_offset = 0;
	nilfs->ns_seg_seq++;
}

static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
{
	__u64 cno;

	spin_lock(&nilfs->ns_last_segment_lock);
	cno = nilfs->ns_last_cno;
	spin_unlock(&nilfs->ns_last_segment_lock);
	return cno;
}

#endif /* _THE_NILFS_H */
Commit	Line	Data
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 */
	35	enum {
	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
	46	* @ns_bdev: block device
	47	* @ns_bdi: backing dev info
	48	* @ns_writer: back pointer to writable nilfs_sb_info
	49	* @ns_sem: semaphore for shared states
	50	* @ns_writer_mutex: mutex protecting ns_writer attach/detach
	51	* @ns_writer_refcount: number of referrers on ns_writer
	52	* @ns_sbh: buffer head of the on-disk super block
	53	* @ns_sbp: pointer to the super block data
	54	* @ns_used_segments: list of full segments in volatile active state
	55	* @ns_supers: list of nilfs super block structs
	56	* @ns_seg_seq: segment sequence counter
	57	* @ns_segnum: index number of the latest full segment.
	58	* @ns_nextnum: index number of the full segment index to be used next
	59	* @ns_pseg_offset: offset of next partial segment in the current full segment
	60	* @ns_cno: next checkpoint number
	61	* @ns_ctime: write time of the last segment
	62	* @ns_nongc_ctime: write time of the last segment not for cleaner operation
	63	* @ns_ndirtyblks: Number of dirty data blocks
	64	* @ns_last_segment_lock: lock protecting fields for the latest segment
	65	* @ns_last_pseg: start block number of the latest segment
	66	* @ns_last_seq: sequence value of the latest segment
	67	* @ns_last_cno: checkpoint number of the latest segment
	68	* @ns_free_segments_count: counter of free segments
	69	* @ns_segctor_sem: segment constructor semaphore
	70	* @ns_dat: DAT file inode
	71	* @ns_cpfile: checkpoint file inode
	72	* @ns_sufile: segusage file inode
	73	* @ns_gc_dat: shadow inode of the DAT file inode for GC
	74	* @ns_gc_inodes: dummy inodes to keep live blocks
	75	* @ns_gc_inodes_h: hash list to keep dummy inode holding live blocks
65b4643d RK	76	* @ns_blocksize_bits: bit length of block size
	77	* @ns_nsegments: number of segments in filesystem
	78	* @ns_blocks_per_segment: number of blocks per segment
	79	* @ns_r_segments_percentage: reserved segments percentage
	80	* @ns_nrsvsegs: number of reserved segments
	81	* @ns_first_data_block: block number of first data block
	82	* @ns_inode_size: size of on-disk inode
	83	* @ns_first_ino: first not-special inode number
	84	* @ns_crc_seed: seed value of CRC32 calculation
	85	*/
	86	struct the_nilfs {
	87	unsigned long ns_flags;
	88	atomic_t ns_count;
	89
	90	struct block_device *ns_bdev;
	91	struct backing_dev_info *ns_bdi;
	92	struct nilfs_sb_info *ns_writer;
	93	struct rw_semaphore ns_sem;
	94	struct mutex ns_writer_mutex;
	95	atomic_t ns_writer_refcount;
	96
	97	/*
	98	* used for
	99	* - loading the latest checkpoint exclusively.
	100	* - allocating a new full segment.
	101	* - protecting s_dirt in the super_block struct
	102	* (see nilfs_write_super) and the following fields.
	103	*/
	104	struct buffer_head *ns_sbh;
	105	struct nilfs_super_block *ns_sbp;
	106	struct list_head ns_used_segments;
	107	unsigned ns_mount_state;
	108	struct list_head ns_supers;
	109
	110	/*
	111	* Following fields are dedicated to a writable FS-instance.
	112	* Except for the period seeking checkpoint, code outside the segment
47420c79 RK	113	* constructor must lock a segment semaphore while accessing these
47420c79 RK	114	* fields.
65b4643d RK	115	* The writable FS-instance is sole during a lifetime of the_nilfs.
	116	*/
	117	u64 ns_seg_seq;
	118	__u64 ns_segnum;
	119	__u64 ns_nextnum;
	120	unsigned long ns_pseg_offset;
	121	__u64 ns_cno;
	122	time_t ns_ctime;
	123	time_t ns_nongc_ctime;
	124	atomic_t ns_ndirtyblks;
	125
	126	/*
	127	* The following fields hold information on the latest partial segment
	128	* written to disk with a super root. These fields are protected by
	129	* ns_last_segment_lock.
	130	*/
	131	spinlock_t ns_last_segment_lock;
	132	sector_t ns_last_pseg;
	133	u64 ns_last_seq;
	134	__u64 ns_last_cno;
	135	unsigned long ns_free_segments_count;
	136
	137	struct rw_semaphore ns_segctor_sem;
	138
	139	/*
	140	* Following fields are lock free except for the period before
	141	* the_nilfs is initialized.
	142	*/
	143	struct inode *ns_dat;
	144	struct inode *ns_cpfile;
	145	struct inode *ns_sufile;
	146	struct inode *ns_gc_dat;
	147
	148	/* GC inode list and hash table head */
	149	struct list_head ns_gc_inodes;
	150	struct hlist_head *ns_gc_inodes_h;
	151
65b4643d RK	152	/* Disk layout information (static) */
	153	unsigned int ns_blocksize_bits;
	154	unsigned long ns_nsegments;
	155	unsigned long ns_blocks_per_segment;
	156	unsigned long ns_r_segments_percentage;
	157	unsigned long ns_nrsvsegs;
	158	unsigned long ns_first_data_block;
	159	int ns_inode_size;
	160	int ns_first_ino;
	161	u32 ns_crc_seed;
	162	};
	163
	164	#define NILFS_GCINODE_HASH_BITS 8
	165	#define NILFS_GCINODE_HASH_SIZE (1<<NILFS_GCINODE_HASH_BITS)
	166
	167	#define THE_NILFS_FNS(bit, name) \
	168	static inline void set_nilfs_##name(struct the_nilfs *nilfs) \
	169	{ \
	170	set_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
	171	} \
	172	static inline void clear_nilfs_##name(struct the_nilfs *nilfs) \
	173	{ \
	174	clear_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
	175	} \
	176	static inline int nilfs_##name(struct the_nilfs *nilfs) \
	177	{ \
	178	return test_bit(THE_NILFS_##bit, &(nilfs)->ns_flags); \
	179	}
	180
	181	THE_NILFS_FNS(INIT, init)
	182	THE_NILFS_FNS(LOADED, loaded)
	183	THE_NILFS_FNS(DISCONTINUED, discontinued)
65b4643d RK	184
	185	void nilfs_set_last_segment(struct the_nilfs *, sector_t, u64, __u64);
	186	struct the_nilfs alloc_nilfs(struct block_device );
	187	void put_nilfs(struct the_nilfs *);
	188	int init_nilfs(struct the_nilfs , struct nilfs_sb_info , char *);
	189	int load_nilfs(struct the_nilfs , struct nilfs_sb_info );
	190	int nilfs_count_free_blocks(struct the_nilfs , sector_t );
	191	void nilfs_dispose_used_segments(struct the_nilfs *);
	192	int nilfs_checkpoint_is_mounted(struct the_nilfs *, __u64, int);
	193	int nilfs_near_disk_full(struct the_nilfs *);
	194
	195
	196	static inline void get_nilfs(struct the_nilfs *nilfs)
	197	{
	198	/* Caller must have at least one reference of the_nilfs. */
	199	atomic_inc(&nilfs->ns_count);
	200	}
	201
	202	static inline struct nilfs_sb_info nilfs_get_writer(struct the_nilfs nilfs)
	203	{
	204	if (atomic_inc_and_test(&nilfs->ns_writer_refcount))
	205	mutex_lock(&nilfs->ns_writer_mutex);
	206	return nilfs->ns_writer;
	207	}
	208
	209	static inline void nilfs_put_writer(struct the_nilfs *nilfs)
	210	{
	211	if (atomic_add_negative(-1, &nilfs->ns_writer_refcount))
	212	mutex_unlock(&nilfs->ns_writer_mutex);
	213	}
	214
	215	static inline void
	216	nilfs_attach_writer(struct the_nilfs nilfs, struct nilfs_sb_info sbi)
	217	{
	218	mutex_lock(&nilfs->ns_writer_mutex);
	219	nilfs->ns_writer = sbi;
	220	mutex_unlock(&nilfs->ns_writer_mutex);
	221	}
	222
	223	static inline void
	224	nilfs_detach_writer(struct the_nilfs nilfs, struct nilfs_sb_info sbi)
	225	{
	226	mutex_lock(&nilfs->ns_writer_mutex);
	227	if (sbi == nilfs->ns_writer)
	228	nilfs->ns_writer = NULL;
	229	mutex_unlock(&nilfs->ns_writer_mutex);
	230	}
	231
	232	static inline void
	233	nilfs_get_segment_range(struct the_nilfs *nilfs, __u64 segnum,
	234	sector_t seg_start, sector_t seg_end)
	235	{
	236	seg_start = (sector_t)nilfs->ns_blocks_per_segment segnum;
	237	seg_end = seg_start + nilfs->ns_blocks_per_segment - 1;
	238	if (segnum == 0)
	239	*seg_start = nilfs->ns_first_data_block;
	240	}
	241
	242	static inline sector_t
	243	nilfs_get_segment_start_blocknr(struct the_nilfs *nilfs, __u64 segnum)
	244	{
	245	return (segnum == 0) ? nilfs->ns_first_data_block :
	246	(sector_t)nilfs->ns_blocks_per_segment * segnum;
	247	}
248
249	static inline __u64
250	nilfs_get_segnum_of_block(struct the_nilfs *nilfs, sector_t blocknr)
251	{
252	sector_t segnum = blocknr;
253
254	sector_div(segnum, nilfs->ns_blocks_per_segment);
255	return segnum;
256	}
257
258	static inline void
259	nilfs_terminate_segment(struct the_nilfs *nilfs, sector_t seg_start,
260	sector_t seg_end)
261	{
262	/* terminate the current full segment (used in case of I/O-error) */
263	nilfs->ns_pseg_offset = seg_end - seg_start + 1;
264	}
265
266	static inline void nilfs_shift_to_next_segment(struct the_nilfs *nilfs)
267	{
268	/* move forward with a full segment */
269	nilfs->ns_segnum = nilfs->ns_nextnum;
270	nilfs->ns_pseg_offset = 0;
271	nilfs->ns_seg_seq++;
272	}
273
274	static inline __u64 nilfs_last_cno(struct the_nilfs *nilfs)
275	{
276	__u64 cno;
277
278	spin_lock(&nilfs->ns_last_segment_lock);
279	cno = nilfs->ns_last_cno;
280	spin_unlock(&nilfs->ns_last_segment_lock);
281	return cno;
282	}
283
284	#endif /* _THE_NILFS_H */