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

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * NILFS Segment buffer prototypes and definitions
 *
 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
 *
 * Written by Ryusuke Konishi.
 *
 */
#ifndef _NILFS_SEGBUF_H
#define _NILFS_SEGBUF_H

#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/bio.h>
#include <linux/completion.h>

/**
 * struct nilfs_segsum_info - On-memory segment summary
 * @flags: Flags
 * @nfinfo: Number of file information structures
 * @nblocks: Number of blocks included in the partial segment
 * @nsumblk: Number of summary blocks
 * @sumbytes: Byte count of segment summary
 * @nfileblk: Total number of file blocks
 * @seg_seq: Segment sequence number
 * @cno: Checkpoint number
 * @ctime: Creation time
 * @next: Block number of the next full segment
 */
struct nilfs_segsum_info {
	unsigned int		flags;
	unsigned long		nfinfo;
	unsigned long		nblocks;
	unsigned long		nsumblk;
	unsigned long		sumbytes;
	unsigned long		nfileblk;
	u64			seg_seq;
	__u64			cno;
	time64_t		ctime;
	sector_t		next;
};

/**
 * struct nilfs_segment_buffer - Segment buffer
 * @sb_super: back pointer to a superblock struct
 * @sb_list: List head to chain this structure
 * @sb_sum: On-memory segment summary
 * @sb_segnum: Index number of the full segment
 * @sb_nextnum: Index number of the next full segment
 * @sb_fseg_start: Start block number of the full segment
 * @sb_fseg_end: End block number of the full segment
 * @sb_pseg_start: Disk block number of partial segment
 * @sb_rest_blocks: Number of residual blocks in the current segment
 * @sb_segsum_buffers: List of buffers for segment summaries
 * @sb_payload_buffers: List of buffers for segment payload
 * @sb_super_root: Pointer to buffer storing a super root block (if exists)
 * @sb_nbio: Number of flying bio requests
 * @sb_err: I/O error status
 * @sb_bio_event: Completion event of log writing
 */
struct nilfs_segment_buffer {
	struct super_block     *sb_super;
	struct list_head	sb_list;

	/* Segment information */
	struct nilfs_segsum_info sb_sum;
	__u64			sb_segnum;
	__u64			sb_nextnum;
	sector_t		sb_fseg_start, sb_fseg_end;
	sector_t		sb_pseg_start;
	unsigned int		sb_rest_blocks;

	/* Buffers */
	struct list_head	sb_segsum_buffers;
	struct list_head	sb_payload_buffers; /* including super root */
	struct buffer_head     *sb_super_root;

	/* io status */
	int			sb_nbio;
	atomic_t		sb_err;
	struct completion	sb_bio_event;
};

#define NILFS_LIST_SEGBUF(head)  \
	list_entry((head), struct nilfs_segment_buffer, sb_list)
#define NILFS_NEXT_SEGBUF(segbuf)  NILFS_LIST_SEGBUF((segbuf)->sb_list.next)
#define NILFS_PREV_SEGBUF(segbuf)  NILFS_LIST_SEGBUF((segbuf)->sb_list.prev)
#define NILFS_LAST_SEGBUF(head)    NILFS_LIST_SEGBUF((head)->prev)
#define NILFS_FIRST_SEGBUF(head)   NILFS_LIST_SEGBUF((head)->next)
#define NILFS_SEGBUF_IS_LAST(segbuf, head)  ((segbuf)->sb_list.next == (head))

#define nilfs_for_each_segbuf_before(s, t, h) \
	for ((s) = NILFS_FIRST_SEGBUF(h); (s) != (t); \
	     (s) = NILFS_NEXT_SEGBUF(s))

#define NILFS_SEGBUF_FIRST_BH(head)  \
	(list_entry((head)->next, struct buffer_head, b_assoc_buffers))
#define NILFS_SEGBUF_NEXT_BH(bh)  \
	(list_entry((bh)->b_assoc_buffers.next, struct buffer_head, \
		    b_assoc_buffers))
#define NILFS_SEGBUF_BH_IS_LAST(bh, head)  ((bh)->b_assoc_buffers.next == head)

extern struct kmem_cache *nilfs_segbuf_cachep;

struct nilfs_segment_buffer *nilfs_segbuf_new(struct super_block *);
void nilfs_segbuf_free(struct nilfs_segment_buffer *);
void nilfs_segbuf_map(struct nilfs_segment_buffer *, __u64, unsigned long,
		      struct the_nilfs *);
void nilfs_segbuf_map_cont(struct nilfs_segment_buffer *segbuf,
			   struct nilfs_segment_buffer *prev);
void nilfs_segbuf_set_next_segnum(struct nilfs_segment_buffer *, __u64,
				  struct the_nilfs *);
int nilfs_segbuf_reset(struct nilfs_segment_buffer *, unsigned int, time64_t,
		       __u64);
int nilfs_segbuf_extend_segsum(struct nilfs_segment_buffer *);
int nilfs_segbuf_extend_payload(struct nilfs_segment_buffer *,
				struct buffer_head **);
void nilfs_segbuf_fill_in_segsum(struct nilfs_segment_buffer *);

static inline int nilfs_segbuf_simplex(struct nilfs_segment_buffer *segbuf)
{
	unsigned int flags = segbuf->sb_sum.flags;

	return (flags & (NILFS_SS_LOGBGN | NILFS_SS_LOGEND)) ==
		(NILFS_SS_LOGBGN | NILFS_SS_LOGEND);
}

static inline int nilfs_segbuf_empty(struct nilfs_segment_buffer *segbuf)
{
	return segbuf->sb_sum.nblocks == segbuf->sb_sum.nsumblk;
}

static inline void
nilfs_segbuf_add_segsum_buffer(struct nilfs_segment_buffer *segbuf,
			       struct buffer_head *bh)
{
	list_add_tail(&bh->b_assoc_buffers, &segbuf->sb_segsum_buffers);
	segbuf->sb_sum.nblocks++;
	segbuf->sb_sum.nsumblk++;
}

static inline void
nilfs_segbuf_add_payload_buffer(struct nilfs_segment_buffer *segbuf,
				struct buffer_head *bh)
{
	list_add_tail(&bh->b_assoc_buffers, &segbuf->sb_payload_buffers);
	segbuf->sb_sum.nblocks++;
}

static inline void
nilfs_segbuf_add_file_buffer(struct nilfs_segment_buffer *segbuf,
			     struct buffer_head *bh)
{
	get_bh(bh);
	nilfs_segbuf_add_payload_buffer(segbuf, bh);
	segbuf->sb_sum.nfileblk++;
}

void nilfs_clear_logs(struct list_head *logs);
void nilfs_truncate_logs(struct list_head *logs,
			 struct nilfs_segment_buffer *last);
int nilfs_write_logs(struct list_head *logs, struct the_nilfs *nilfs);
int nilfs_wait_on_logs(struct list_head *logs);
void nilfs_add_checksums_on_logs(struct list_head *logs, u32 seed);

static inline void nilfs_destroy_logs(struct list_head *logs)
{
	nilfs_truncate_logs(logs, NULL);
}

#endif /* _NILFS_SEGBUF_H */
Commit	Line	Data
ae98043f	1	/* SPDX-License-Identifier: GPL-2.0+ */
64b5a32e	2	/*
94ee1d91	3	* NILFS Segment buffer prototypes and definitions
64b5a32e RK	4	*
	5	* Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
	6	*
4b420ab4	7	* Written by Ryusuke Konishi.
64b5a32e RK	8	*
	9	*/
	10	#ifndef _NILFS_SEGBUF_H
	11	#define _NILFS_SEGBUF_H
	12
	13	#include <linux/fs.h>
	14	#include <linux/buffer_head.h>
	15	#include <linux/bio.h>
	16	#include <linux/completion.h>
64b5a32e RK	17
	18	/**
	19	* struct nilfs_segsum_info - On-memory segment summary
	20	* @flags: Flags
	21	* @nfinfo: Number of file information structures
	22	* @nblocks: Number of blocks included in the partial segment
	23	* @nsumblk: Number of summary blocks
	24	* @sumbytes: Byte count of segment summary
	25	* @nfileblk: Total number of file blocks
	26	* @seg_seq: Segment sequence number
50614bcf	27	* @cno: Checkpoint number
64b5a32e RK	28	* @ctime: Creation time
	29	* @next: Block number of the next full segment
	30	*/
	31	struct nilfs_segsum_info {
	32	unsigned int flags;
	33	unsigned long nfinfo;
	34	unsigned long nblocks;
	35	unsigned long nsumblk;
	36	unsigned long sumbytes;
	37	unsigned long nfileblk;
	38	u64 seg_seq;
50614bcf	39	__u64 cno;
fb04b91b	40	time64_t ctime;
64b5a32e RK	41	sector_t next;
	42	};
	43
64b5a32e RK	44	/**
	45	* struct nilfs_segment_buffer - Segment buffer
	46	* @sb_super: back pointer to a superblock struct
	47	* @sb_list: List head to chain this structure
64b5a32e RK	48	* @sb_sum: On-memory segment summary
	49	* @sb_segnum: Index number of the full segment
	50	* @sb_nextnum: Index number of the next full segment
	51	* @sb_fseg_start: Start block number of the full segment
	52	* @sb_fseg_end: End block number of the full segment
	53	* @sb_pseg_start: Disk block number of partial segment
	54	* @sb_rest_blocks: Number of residual blocks in the current segment
	55	* @sb_segsum_buffers: List of buffers for segment summaries
	56	* @sb_payload_buffers: List of buffers for segment payload
1e2b68bf	57	* @sb_super_root: Pointer to buffer storing a super root block (if exists)
9284ad2a RK	58	* @sb_nbio: Number of flying bio requests
	59	* @sb_err: I/O error status
	60	* @sb_bio_event: Completion event of log writing
64b5a32e RK	61	*/
	62	struct nilfs_segment_buffer {
	63	struct super_block *sb_super;
	64	struct list_head sb_list;
64b5a32e RK	65
	66	/* Segment information */
	67	struct nilfs_segsum_info sb_sum;
	68	__u64 sb_segnum;
	69	__u64 sb_nextnum;
	70	sector_t sb_fseg_start, sb_fseg_end;
	71	sector_t sb_pseg_start;
0c6c44cb	72	unsigned int sb_rest_blocks;
64b5a32e RK	73
	74	/* Buffers */
	75	struct list_head sb_segsum_buffers;
	76	struct list_head sb_payload_buffers; /* including super root */
1e2b68bf	77	struct buffer_head *sb_super_root;
64b5a32e RK	78
64b5a32e RK	79	/* io status */
9284ad2a RK	80	int sb_nbio;
	81	atomic_t sb_err;
	82	struct completion sb_bio_event;
64b5a32e RK	83	};
	84
	85	#define NILFS_LIST_SEGBUF(head) \
	86	list_entry((head), struct nilfs_segment_buffer, sb_list)
	87	#define NILFS_NEXT_SEGBUF(segbuf) NILFS_LIST_SEGBUF((segbuf)->sb_list.next)
	88	#define NILFS_PREV_SEGBUF(segbuf) NILFS_LIST_SEGBUF((segbuf)->sb_list.prev)
	89	#define NILFS_LAST_SEGBUF(head) NILFS_LIST_SEGBUF((head)->prev)
	90	#define NILFS_FIRST_SEGBUF(head) NILFS_LIST_SEGBUF((head)->next)
	91	#define NILFS_SEGBUF_IS_LAST(segbuf, head) ((segbuf)->sb_list.next == (head))
	92
	93	#define nilfs_for_each_segbuf_before(s, t, h) \
	94	for ((s) = NILFS_FIRST_SEGBUF(h); (s) != (t); \
	95	(s) = NILFS_NEXT_SEGBUF(s))
	96
	97	#define NILFS_SEGBUF_FIRST_BH(head) \
	98	(list_entry((head)->next, struct buffer_head, b_assoc_buffers))
	99	#define NILFS_SEGBUF_NEXT_BH(bh) \
	100	(list_entry((bh)->b_assoc_buffers.next, struct buffer_head, \
	101	b_assoc_buffers))
	102	#define NILFS_SEGBUF_BH_IS_LAST(bh, head) ((bh)->b_assoc_buffers.next == head)
	103
41c88bd7	104	extern struct kmem_cache *nilfs_segbuf_cachep;
64b5a32e	105
64b5a32e RK	106	struct nilfs_segment_buffer nilfs_segbuf_new(struct super_block );
64b5a32e RK	107	void nilfs_segbuf_free(struct nilfs_segment_buffer *);
cece5520 RK	108	void nilfs_segbuf_map(struct nilfs_segment_buffer *, __u64, unsigned long,
cece5520 RK	109	struct the_nilfs *);
a694291a RK	110	void nilfs_segbuf_map_cont(struct nilfs_segment_buffer *segbuf,
a694291a RK	111	struct nilfs_segment_buffer *prev);
64b5a32e RK	112	void nilfs_segbuf_set_next_segnum(struct nilfs_segment_buffer *, __u64,
64b5a32e RK	113	struct the_nilfs *);
fb04b91b	114	int nilfs_segbuf_reset(struct nilfs_segment_buffer *, unsigned int, time64_t,
0c6c44cb	115	__u64);
64b5a32e RK	116	int nilfs_segbuf_extend_segsum(struct nilfs_segment_buffer *);
	117	int nilfs_segbuf_extend_payload(struct nilfs_segment_buffer *,
	118	struct buffer_head **);
	119	void nilfs_segbuf_fill_in_segsum(struct nilfs_segment_buffer *);
64b5a32e	120
4762077c RK	121	static inline int nilfs_segbuf_simplex(struct nilfs_segment_buffer *segbuf)
	122	{
	123	unsigned int flags = segbuf->sb_sum.flags;
	124
	125	return (flags & (NILFS_SS_LOGBGN \| NILFS_SS_LOGEND)) ==
	126	(NILFS_SS_LOGBGN \| NILFS_SS_LOGEND);
	127	}
	128
	129	static inline int nilfs_segbuf_empty(struct nilfs_segment_buffer *segbuf)
	130	{
	131	return segbuf->sb_sum.nblocks == segbuf->sb_sum.nsumblk;
	132	}
	133
64b5a32e RK	134	static inline void
	135	nilfs_segbuf_add_segsum_buffer(struct nilfs_segment_buffer *segbuf,
	136	struct buffer_head *bh)
	137	{
	138	list_add_tail(&bh->b_assoc_buffers, &segbuf->sb_segsum_buffers);
	139	segbuf->sb_sum.nblocks++;
	140	segbuf->sb_sum.nsumblk++;
	141	}
	142
	143	static inline void
	144	nilfs_segbuf_add_payload_buffer(struct nilfs_segment_buffer *segbuf,
	145	struct buffer_head *bh)
	146	{
	147	list_add_tail(&bh->b_assoc_buffers, &segbuf->sb_payload_buffers);
	148	segbuf->sb_sum.nblocks++;
	149	}
	150
	151	static inline void
	152	nilfs_segbuf_add_file_buffer(struct nilfs_segment_buffer *segbuf,
	153	struct buffer_head *bh)
	154	{
	155	get_bh(bh);
	156	nilfs_segbuf_add_payload_buffer(segbuf, bh);
	157	segbuf->sb_sum.nfileblk++;
	158	}
	159
e29df395 RK	160	void nilfs_clear_logs(struct list_head *logs);
	161	void nilfs_truncate_logs(struct list_head *logs,
	162	struct nilfs_segment_buffer *last);
d1c6b72a	163	int nilfs_write_logs(struct list_head logs, struct the_nilfs nilfs);
e29df395	164	int nilfs_wait_on_logs(struct list_head *logs);
aaed1d5b	165	void nilfs_add_checksums_on_logs(struct list_head *logs, u32 seed);
e29df395 RK	166
	167	static inline void nilfs_destroy_logs(struct list_head *logs)
	168	{
	169	nilfs_truncate_logs(logs, NULL);
	170	}
	171
64b5a32e	172	#endif /* _NILFS_SEGBUF_H */