[deliverable/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 <ryusuke@osrg.net>
 *
 */
#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 "sb.h"

/**
 * struct nilfs_recovery_info - Recovery infomation
 * @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_sbi: Back pointer to nilfs_sb_info struct
 * @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_cleaning_segments: List of segments to be freed through construction
 * @sc_copied_buffers: List of copied buffers (buffer heads) to freeze data
 * @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_segbuf_nblocks: Number of available blocks in segment buffers.
 * @sc_curseg: Current segment buffer
 * @sc_super_root: Pointer to the super root 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_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_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_sb_info   *sc_sbi;

	unsigned long		sc_nblk_inc;

	struct list_head	sc_dirty_files;
	struct list_head	sc_gc_inodes;
	struct list_head	sc_cleaning_segments;
	struct list_head	sc_copied_buffers;

	struct nilfs_inode_info *sc_dsync_inode;
	loff_t			sc_dsync_start;
	loff_t			sc_dsync_end;

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

	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;

	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_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 */
#define NILFS_SC_DEFAULT_SB_FREQ    30  /* Minimum interval of periodical
					   update of superblock (reserved) */

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


/* segment.c */
extern int nilfs_init_transaction_cache(void);
extern void nilfs_destroy_transaction_cache(void);
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 *, void __user *);

extern int nilfs_segctor_add_segments_to_be_freed(struct nilfs_sc_info *,
						  __u64 *, size_t);
extern void nilfs_segctor_clear_segments_to_be_freed(struct nilfs_sc_info *);

extern int nilfs_attach_segment_constructor(struct nilfs_sb_info *);
extern void nilfs_detach_segment_constructor(struct nilfs_sb_info *);

/* recovery.c */
extern int nilfs_read_super_root_block(struct super_block *, sector_t,
				       struct buffer_head **, int);
extern int nilfs_search_super_root(struct the_nilfs *, struct nilfs_sb_info *,
				   struct nilfs_recovery_info *);
extern int nilfs_recover_logical_segments(struct the_nilfs *,
					  struct nilfs_sb_info *,
					  struct nilfs_recovery_info *);

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