[linux.git] / fs / nilfs2 / segment.h

/*
 * segment.h - NILFS Segment constructor prototypes and definitions
 *
 * 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 <[email protected]>
 *
 */
#ifndef _NILFS_SEGMENT_H
#define _NILFS_SEGMENT_H

#include <linux/types.h>
#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/nilfs2_fs.h>
#include "nilfs.h"

struct nilfs_root;

/**
 * struct nilfs_recovery_info - Recovery information
 * @ri_need_recovery: Recovery status
 * @ri_super_root: Block number of the last super root
 * @ri_ri_cno: Number of the last checkpoint
 * @ri_lsegs_start: Region for roll-forwarding (start block number)
 * @ri_lsegs_end: Region for roll-forwarding (end block number)
 * @ri_lseg_start_seq: Sequence value of the segment at ri_lsegs_start
 * @ri_used_segments: List of segments to be mark active
 * @ri_pseg_start: Block number of the last partial segment
 * @ri_seq: Sequence number on the last partial segment
 * @ri_segnum: Segment number on the last partial segment
 * @ri_nextnum: Next segment number on the last partial segment
 */
struct nilfs_recovery_info {
	int			ri_need_recovery;
	sector_t		ri_super_root;
	__u64			ri_cno;

	sector_t		ri_lsegs_start;
	sector_t		ri_lsegs_end;
	u64			ri_lsegs_start_seq;
	struct list_head	ri_used_segments;
	sector_t		ri_pseg_start;
	u64			ri_seq;
	__u64			ri_segnum;
	__u64			ri_nextnum;
};

/* ri_need_recovery */
#define NILFS_RECOVERY_SR_UPDATED	 1  /* The super root was updated */
#define NILFS_RECOVERY_ROLLFORWARD_DONE	 2  /* Rollforward was carried out */

/**
 * struct nilfs_cstage - Context of collection stage
 * @scnt: Stage count
 * @flags: State flags
 * @dirty_file_ptr: Pointer on dirty_files list, or inode of a target file
 * @gc_inode_ptr: Pointer on the list of gc-inodes
 */
struct nilfs_cstage {
	int			scnt;
	unsigned		flags;
	struct nilfs_inode_info *dirty_file_ptr;
	struct nilfs_inode_info *gc_inode_ptr;
};

struct nilfs_segment_buffer;

struct nilfs_segsum_pointer {
	struct buffer_head     *bh;
	unsigned		offset; /* offset in bytes */
};

/**
 * struct nilfs_sc_info - Segment constructor information
 * @sc_super: Back pointer to super_block struct
 * @sc_root: root object of the current filesystem tree
 * @sc_nblk_inc: Block count of current generation
 * @sc_dirty_files: List of files to be written
 * @sc_gc_inodes: List of GC inodes having blocks to be written
 * @sc_freesegs: array of segment numbers to be freed
 * @sc_nfreesegs: number of segments on @sc_freesegs
 * @sc_dsync_inode: inode whose data pages are written for a sync operation
 * @sc_dsync_start: start byte offset of data pages
 * @sc_dsync_end: end byte offset of data pages (inclusive)
 * @sc_segbufs: List of segment buffers
 * @sc_write_logs: List of segment buffers to hold logs under writing
 * @sc_segbuf_nblocks: Number of available blocks in segment buffers.
 * @sc_curseg: Current segment buffer
 * @sc_stage: Collection stage
 * @sc_finfo_ptr: pointer to the current finfo struct in the segment summary
 * @sc_binfo_ptr: pointer to the current binfo struct in the segment summary
 * @sc_blk_cnt:	Block count of a file
 * @sc_datablk_cnt: Data block count of a file
 * @sc_nblk_this_inc: Number of blocks included in the current logical segment
 * @sc_seg_ctime: Creation time
 * @sc_cno: checkpoint number of current log
 * @sc_flags: Internal flags
 * @sc_state_lock: spinlock for sc_state and so on
 * @sc_state: Segctord state flags
 * @sc_flush_request: inode bitmap of metadata files to be flushed
 * @sc_wait_request: Client request queue
 * @sc_wait_daemon: Daemon wait queue
 * @sc_wait_task: Start/end wait queue to control segctord task
 * @sc_seq_request: Request counter
 * @sc_seq_accept: Accepted request count
 * @sc_seq_done: Completion counter
 * @sc_sync: Request of explicit sync operation
 * @sc_interval: Timeout value of background construction
 * @sc_mjcp_freq: Frequency of creating checkpoints
 * @sc_lseg_stime: Start time of the latest logical segment
 * @sc_watermark: Watermark for the number of dirty buffers
 * @sc_timer: Timer for segctord
 * @sc_task: current thread of segctord
 */
struct nilfs_sc_info {
	struct super_block     *sc_super;
	struct nilfs_root      *sc_root;

	unsigned long		sc_nblk_inc;

	struct list_head	sc_dirty_files;
	struct list_head	sc_gc_inodes;

	__u64		       *sc_freesegs;
	size_t			sc_nfreesegs;

	struct nilfs_inode_info *sc_dsync_inode;
	loff_t			sc_dsync_start;
	loff_t			sc_dsync_end;

	/* Segment buffers */
	struct list_head	sc_segbufs;
	struct list_head	sc_write_logs;
	unsigned long		sc_segbuf_nblocks;
	struct nilfs_segment_buffer *sc_curseg;

	struct nilfs_cstage	sc_stage;

	struct nilfs_segsum_pointer sc_finfo_ptr;
	struct nilfs_segsum_pointer sc_binfo_ptr;
	unsigned long		sc_blk_cnt;
	unsigned long		sc_datablk_cnt;
	unsigned long		sc_nblk_this_inc;
	time_t			sc_seg_ctime;
	__u64			sc_cno;
	unsigned long		sc_flags;

	spinlock_t		sc_state_lock;
	unsigned long		sc_state;
	unsigned long		sc_flush_request;

	wait_queue_head_t	sc_wait_request;
	wait_queue_head_t	sc_wait_daemon;
	wait_queue_head_t	sc_wait_task;

	__u32			sc_seq_request;
	__u32			sc_seq_accepted;
	__u32			sc_seq_done;

	int			sc_sync;
	unsigned long		sc_interval;
	unsigned long		sc_mjcp_freq;
	unsigned long		sc_lseg_stime;	/* in 1/HZ seconds */
	unsigned long		sc_watermark;

	struct timer_list	sc_timer;
	struct task_struct     *sc_task;
};

/* sc_flags */
enum {
	NILFS_SC_DIRTY,		/* One or more dirty meta-data blocks exist */
	NILFS_SC_UNCLOSED,	/* Logical segment is not closed */
	NILFS_SC_SUPER_ROOT,	/* The latest segment has a super root */
	NILFS_SC_PRIOR_FLUSH,	/* Requesting immediate flush without making a
				   checkpoint */
	NILFS_SC_HAVE_DELTA,	/* Next checkpoint will have update of files
				   other than DAT, cpfile, sufile, or files
				   moved by GC */
};

/* sc_state */
#define NILFS_SEGCTOR_QUIT	    0x0001  /* segctord is being destroyed */
#define NILFS_SEGCTOR_COMMIT	    0x0004  /* committed transaction exists */

/*
 * Constant parameters
 */
#define NILFS_SC_CLEANUP_RETRY	    3  /* Retry count of construction when
					  destroying segctord */

/*
 * Default values of timeout, in seconds.
 */
#define NILFS_SC_DEFAULT_TIMEOUT    5   /* Timeout value of dirty blocks.
					   It triggers construction of a
					   logical segment with a super root */
#define NILFS_SC_DEFAULT_SR_FREQ    30  /* Maximum frequency of super root
					   creation */

/*
 * The default threshold amount of data, in block counts.
 */
#define NILFS_SC_DEFAULT_WATERMARK  3600

/* super.c */
extern struct kmem_cache *nilfs_transaction_cachep;

/* segment.c */
extern void nilfs_relax_pressure_in_lock(struct super_block *);

extern int nilfs_construct_segment(struct super_block *);
extern int nilfs_construct_dsync_segment(struct super_block *, struct inode *,
					 loff_t, loff_t);
extern void nilfs_flush_segment(struct super_block *, ino_t);
extern int nilfs_clean_segments(struct super_block *, struct nilfs_argv *,
				void **);

int nilfs_attach_log_writer(struct super_block *sb, struct nilfs_root *root);
void nilfs_detach_log_writer(struct super_block *sb);

/* recovery.c */
extern int nilfs_read_super_root_block(struct the_nilfs *, sector_t,
				       struct buffer_head **, int);
extern int nilfs_search_super_root(struct the_nilfs *,
				   struct nilfs_recovery_info *);
int nilfs_salvage_orphan_logs(struct the_nilfs *nilfs, struct super_block *sb,
			      struct nilfs_recovery_info *ri);
extern void nilfs_dispose_segment_list(struct list_head *);

#endif /* _NILFS_SEGMENT_H */
Commit	Line	Data
9ff05123 RK	1	/*
	2	* segment.h - NILFS Segment constructor prototypes and definitions
	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 <[email protected]>
	21	*
	22	*/
	23	#ifndef _NILFS_SEGMENT_H
	24	#define _NILFS_SEGMENT_H
	25
	26	#include <linux/types.h>
	27	#include <linux/fs.h>
	28	#include <linux/buffer_head.h>
	29	#include <linux/nilfs2_fs.h>
e3154e97	30	#include "nilfs.h"
9ff05123	31
e912a5b6 RK	32	struct nilfs_root;
e912a5b6 RK	33
9ff05123	34	/**
7a65004b	35	* struct nilfs_recovery_info - Recovery information
9ff05123 RK	36	* @ri_need_recovery: Recovery status
	37	* @ri_super_root: Block number of the last super root
	38	* @ri_ri_cno: Number of the last checkpoint
	39	* @ri_lsegs_start: Region for roll-forwarding (start block number)
	40	* @ri_lsegs_end: Region for roll-forwarding (end block number)
	41	* @ri_lseg_start_seq: Sequence value of the segment at ri_lsegs_start
	42	* @ri_used_segments: List of segments to be mark active
	43	* @ri_pseg_start: Block number of the last partial segment
	44	* @ri_seq: Sequence number on the last partial segment
	45	* @ri_segnum: Segment number on the last partial segment
	46	* @ri_nextnum: Next segment number on the last partial segment
	47	*/
	48	struct nilfs_recovery_info {
	49	int ri_need_recovery;
	50	sector_t ri_super_root;
	51	__u64 ri_cno;
	52
	53	sector_t ri_lsegs_start;
	54	sector_t ri_lsegs_end;
	55	u64 ri_lsegs_start_seq;
	56	struct list_head ri_used_segments;
	57	sector_t ri_pseg_start;
	58	u64 ri_seq;
	59	__u64 ri_segnum;
	60	__u64 ri_nextnum;
	61	};
	62
	63	/* ri_need_recovery */
	64	#define NILFS_RECOVERY_SR_UPDATED 1 /* The super root was updated */
	65	#define NILFS_RECOVERY_ROLLFORWARD_DONE 2 /* Rollforward was carried out */
	66
	67	/**
	68	* struct nilfs_cstage - Context of collection stage
	69	* @scnt: Stage count
	70	* @flags: State flags
	71	* @dirty_file_ptr: Pointer on dirty_files list, or inode of a target file
	72	* @gc_inode_ptr: Pointer on the list of gc-inodes
	73	*/
	74	struct nilfs_cstage {
	75	int scnt;
55480a06	76	unsigned flags;
9ff05123 RK	77	struct nilfs_inode_info *dirty_file_ptr;
	78	struct nilfs_inode_info *gc_inode_ptr;
	79	};
	80
	81	struct nilfs_segment_buffer;
	82
	83	struct nilfs_segsum_pointer {
	84	struct buffer_head *bh;
	85	unsigned offset; /* offset in bytes */
	86	};
	87
	88	/**
	89	* struct nilfs_sc_info - Segment constructor information
	90	* @sc_super: Back pointer to super_block struct
e912a5b6	91	* @sc_root: root object of the current filesystem tree
9ff05123 RK	92	* @sc_nblk_inc: Block count of current generation
	93	* @sc_dirty_files: List of files to be written
	94	* @sc_gc_inodes: List of GC inodes having blocks to be written
071cb4b8 RK	95	* @sc_freesegs: array of segment numbers to be freed
071cb4b8 RK	96	* @sc_nfreesegs: number of segments on @sc_freesegs
f30bf3e4 RK	97	* @sc_dsync_inode: inode whose data pages are written for a sync operation
	98	* @sc_dsync_start: start byte offset of data pages
	99	* @sc_dsync_end: end byte offset of data pages (inclusive)
9ff05123	100	* @sc_segbufs: List of segment buffers
a694291a	101	* @sc_write_logs: List of segment buffers to hold logs under writing
9ff05123 RK	102	* @sc_segbuf_nblocks: Number of available blocks in segment buffers.
9ff05123 RK	103	* @sc_curseg: Current segment buffer
9ff05123 RK	104	* @sc_stage: Collection stage
	105	* @sc_finfo_ptr: pointer to the current finfo struct in the segment summary
	106	* @sc_binfo_ptr: pointer to the current binfo struct in the segment summary
	107	* @sc_blk_cnt: Block count of a file
	108	* @sc_datablk_cnt: Data block count of a file
	109	* @sc_nblk_this_inc: Number of blocks included in the current logical segment
	110	* @sc_seg_ctime: Creation time
6c43f410	111	* @sc_cno: checkpoint number of current log
9ff05123	112	* @sc_flags: Internal flags
9ff05123 RK	113	* @sc_state_lock: spinlock for sc_state and so on
	114	* @sc_state: Segctord state flags
	115	* @sc_flush_request: inode bitmap of metadata files to be flushed
	116	* @sc_wait_request: Client request queue
	117	* @sc_wait_daemon: Daemon wait queue
	118	* @sc_wait_task: Start/end wait queue to control segctord task
	119	* @sc_seq_request: Request counter
dcd76186	120	* @sc_seq_accept: Accepted request count
9ff05123 RK	121	* @sc_seq_done: Completion counter
	122	* @sc_sync: Request of explicit sync operation
	123	* @sc_interval: Timeout value of background construction
	124	* @sc_mjcp_freq: Frequency of creating checkpoints
	125	* @sc_lseg_stime: Start time of the latest logical segment
	126	* @sc_watermark: Watermark for the number of dirty buffers
	127	* @sc_timer: Timer for segctord
	128	* @sc_task: current thread of segctord
	129	*/
	130	struct nilfs_sc_info {
	131	struct super_block *sc_super;
e912a5b6	132	struct nilfs_root *sc_root;
9ff05123 RK	133
	134	unsigned long sc_nblk_inc;
	135
	136	struct list_head sc_dirty_files;
	137	struct list_head sc_gc_inodes;
9ff05123	138
071cb4b8 RK	139	__u64 *sc_freesegs;
	140	size_t sc_nfreesegs;
	141
f30bf3e4 RK	142	struct nilfs_inode_info *sc_dsync_inode;
	143	loff_t sc_dsync_start;
	144	loff_t sc_dsync_end;
	145
9ff05123 RK	146	/* Segment buffers */
9ff05123 RK	147	struct list_head sc_segbufs;
a694291a	148	struct list_head sc_write_logs;
9ff05123 RK	149	unsigned long sc_segbuf_nblocks;
9ff05123 RK	150	struct nilfs_segment_buffer *sc_curseg;
9ff05123 RK	151
	152	struct nilfs_cstage sc_stage;
	153
	154	struct nilfs_segsum_pointer sc_finfo_ptr;
	155	struct nilfs_segsum_pointer sc_binfo_ptr;
	156	unsigned long sc_blk_cnt;
	157	unsigned long sc_datablk_cnt;
	158	unsigned long sc_nblk_this_inc;
	159	time_t sc_seg_ctime;
6c43f410	160	__u64 sc_cno;
9ff05123 RK	161	unsigned long sc_flags;
9ff05123 RK	162
9ff05123 RK	163	spinlock_t sc_state_lock;
	164	unsigned long sc_state;
	165	unsigned long sc_flush_request;
	166
	167	wait_queue_head_t sc_wait_request;
	168	wait_queue_head_t sc_wait_daemon;
	169	wait_queue_head_t sc_wait_task;
	170
	171	__u32 sc_seq_request;
dcd76186	172	__u32 sc_seq_accepted;
9ff05123 RK	173	__u32 sc_seq_done;
	174
	175	int sc_sync;
	176	unsigned long sc_interval;
	177	unsigned long sc_mjcp_freq;
	178	unsigned long sc_lseg_stime; /* in 1/HZ seconds */
	179	unsigned long sc_watermark;
	180
fdce895e	181	struct timer_list sc_timer;
9ff05123 RK	182	struct task_struct *sc_task;
	183	};
	184
	185	/* sc_flags */
	186	enum {
	187	NILFS_SC_DIRTY, /* One or more dirty meta-data blocks exist */
	188	NILFS_SC_UNCLOSED, /* Logical segment is not closed */
	189	NILFS_SC_SUPER_ROOT, /* The latest segment has a super root */
	190	NILFS_SC_PRIOR_FLUSH, /* Requesting immediate flush without making a
	191	checkpoint */
c96fa464 RK	192	NILFS_SC_HAVE_DELTA, /* Next checkpoint will have update of files
	193	other than DAT, cpfile, sufile, or files
	194	moved by GC */
9ff05123 RK	195	};
	196
	197	/* sc_state */
	198	#define NILFS_SEGCTOR_QUIT 0x0001 /* segctord is being destroyed */
	199	#define NILFS_SEGCTOR_COMMIT 0x0004 /* committed transaction exists */
	200
	201	/*
	202	* Constant parameters
	203	*/
	204	#define NILFS_SC_CLEANUP_RETRY 3 /* Retry count of construction when
	205	destroying segctord */
	206
	207	/*
	208	* Default values of timeout, in seconds.
	209	*/
	210	#define NILFS_SC_DEFAULT_TIMEOUT 5 /* Timeout value of dirty blocks.
	211	It triggers construction of a
	212	logical segment with a super root */
	213	#define NILFS_SC_DEFAULT_SR_FREQ 30 /* Maximum frequency of super root
	214	creation */
9ff05123 RK	215
	216	/*
	217	* The default threshold amount of data, in block counts.
	218	*/
	219	#define NILFS_SC_DEFAULT_WATERMARK 3600
	220
41c88bd7 LH	221	/* super.c */
41c88bd7 LH	222	extern struct kmem_cache *nilfs_transaction_cachep;
9ff05123 RK	223
9ff05123 RK	224	/* segment.c */
9ff05123 RK	225	extern void nilfs_relax_pressure_in_lock(struct super_block *);
	226
	227	extern int nilfs_construct_segment(struct super_block *);
f30bf3e4 RK	228	extern int nilfs_construct_dsync_segment(struct super_block , struct inode ,
f30bf3e4 RK	229	loff_t, loff_t);
9ff05123	230	extern void nilfs_flush_segment(struct super_block *, ino_t);
4f6b8288 RK	231	extern int nilfs_clean_segments(struct super_block , struct nilfs_argv ,
4f6b8288 RK	232	void **);
9ff05123	233
f7545144 RK	234	int nilfs_attach_log_writer(struct super_block sb, struct nilfs_root root);
f7545144 RK	235	void nilfs_detach_log_writer(struct super_block *sb);
9ff05123 RK	236
9ff05123 RK	237	/* recovery.c */
8b94025c	238	extern int nilfs_read_super_root_block(struct the_nilfs *, sector_t,
9ff05123	239	struct buffer_head **, int);
8b94025c	240	extern int nilfs_search_super_root(struct the_nilfs *,
9ff05123	241	struct nilfs_recovery_info *);
f7545144 RK	242	int nilfs_salvage_orphan_logs(struct the_nilfs nilfs, struct super_block sb,
f7545144 RK	243	struct nilfs_recovery_info *ri);
654137dd	244	extern void nilfs_dispose_segment_list(struct list_head *);
9ff05123 RK	245
9ff05123 RK	246	#endif /* _NILFS_SEGMENT_H */