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

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * bmap.h - NILFS block mapping.
 *
 * Copyright (C) 2006-2008 Nippon Telegraph and Telephone Corporation.
 *
 * Written by Koji Sato.
 */

#ifndef _NILFS_BMAP_H
#define _NILFS_BMAP_H

#include <linux/types.h>
#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/nilfs2_ondisk.h>	/* nilfs_binfo, nilfs_inode, etc */
#include "alloc.h"
#include "dat.h"

#define NILFS_BMAP_INVALID_PTR	0

#define nilfs_bmap_keydiff_abs(diff)	((diff) < 0 ? -(diff) : (diff))


struct nilfs_bmap;

/**
 * union nilfs_bmap_ptr_req - request for bmap ptr
 * @bpr_ptr: bmap pointer
 * @bpr_req: request for persistent allocator
 */
union nilfs_bmap_ptr_req {
	__u64 bpr_ptr;
	struct nilfs_palloc_req bpr_req;
};

/**
 * struct nilfs_bmap_stats - bmap statistics
 * @bs_nblocks: number of blocks created or deleted
 */
struct nilfs_bmap_stats {
	unsigned int bs_nblocks;
};

/**
 * struct nilfs_bmap_operations - bmap operation table
 */
struct nilfs_bmap_operations {
	int (*bop_lookup)(const struct nilfs_bmap *, __u64, int, __u64 *);
	int (*bop_lookup_contig)(const struct nilfs_bmap *, __u64, __u64 *,
				 unsigned int);
	int (*bop_insert)(struct nilfs_bmap *, __u64, __u64);
	int (*bop_delete)(struct nilfs_bmap *, __u64);
	void (*bop_clear)(struct nilfs_bmap *);

	int (*bop_propagate)(struct nilfs_bmap *, struct buffer_head *);
	void (*bop_lookup_dirty_buffers)(struct nilfs_bmap *,
					 struct list_head *);

	int (*bop_assign)(struct nilfs_bmap *,
			  struct buffer_head **,
			  sector_t,
			  union nilfs_binfo *);
	int (*bop_mark)(struct nilfs_bmap *, __u64, int);

	int (*bop_seek_key)(const struct nilfs_bmap *, __u64, __u64 *);
	int (*bop_last_key)(const struct nilfs_bmap *, __u64 *);

	/* The following functions are internal use only. */
	int (*bop_check_insert)(const struct nilfs_bmap *, __u64);
	int (*bop_check_delete)(struct nilfs_bmap *, __u64);
	int (*bop_gather_data)(struct nilfs_bmap *, __u64 *, __u64 *, int);
};


#define NILFS_BMAP_SIZE		(NILFS_INODE_BMAP_SIZE * sizeof(__le64))
#define NILFS_BMAP_KEY_BIT	(sizeof(unsigned long) * 8 /* CHAR_BIT */)
#define NILFS_BMAP_NEW_PTR_INIT	\
	(1UL << (sizeof(unsigned long) * 8 /* CHAR_BIT */ - 1))

static inline int nilfs_bmap_is_new_ptr(unsigned long ptr)
{
	return !!(ptr & NILFS_BMAP_NEW_PTR_INIT);
}


/**
 * struct nilfs_bmap - bmap structure
 * @b_u: raw data
 * @b_sem: semaphore
 * @b_inode: owner of bmap
 * @b_ops: bmap operation table
 * @b_last_allocated_key: last allocated key for data block
 * @b_last_allocated_ptr: last allocated ptr for data block
 * @b_ptr_type: pointer type
 * @b_state: state
 * @b_nchildren_per_block: maximum number of child nodes for non-root nodes
 */
struct nilfs_bmap {
	union {
		__u8 u_flags;
		__le64 u_data[NILFS_BMAP_SIZE / sizeof(__le64)];
	} b_u;
	struct rw_semaphore b_sem;
	struct inode *b_inode;
	const struct nilfs_bmap_operations *b_ops;
	__u64 b_last_allocated_key;
	__u64 b_last_allocated_ptr;
	int b_ptr_type;
	int b_state;
	__u16 b_nchildren_per_block;
};

/* pointer type */
#define NILFS_BMAP_PTR_P	0	/* physical block number (i.e. LBN) */
#define NILFS_BMAP_PTR_VS	1	/*
					 * virtual block number (single
					 * version)
					 */
#define NILFS_BMAP_PTR_VM	2	/*
					 * virtual block number (has multiple
					 * versions)
					 */
#define NILFS_BMAP_PTR_U	(-1)	/* never perform pointer operations */

#define NILFS_BMAP_USE_VBN(bmap)	((bmap)->b_ptr_type > 0)

/* state */
#define NILFS_BMAP_DIRTY	0x00000001

/**
 * struct nilfs_bmap_store - shadow copy of bmap state
 * @data: cached raw block mapping of on-disk inode
 * @last_allocated_key: cached value of last allocated key for data block
 * @last_allocated_ptr: cached value of last allocated ptr for data block
 * @state: cached value of state field of bmap structure
 */
struct nilfs_bmap_store {
	__le64 data[NILFS_BMAP_SIZE / sizeof(__le64)];
	__u64 last_allocated_key;
	__u64 last_allocated_ptr;
	int state;
};

int nilfs_bmap_test_and_clear_dirty(struct nilfs_bmap *);
int nilfs_bmap_read(struct nilfs_bmap *, struct nilfs_inode *);
void nilfs_bmap_write(struct nilfs_bmap *, struct nilfs_inode *);
int nilfs_bmap_lookup_contig(struct nilfs_bmap *, __u64, __u64 *, unsigned int);
int nilfs_bmap_insert(struct nilfs_bmap *bmap, __u64 key, unsigned long rec);
int nilfs_bmap_delete(struct nilfs_bmap *bmap, __u64 key);
int nilfs_bmap_seek_key(struct nilfs_bmap *bmap, __u64 start, __u64 *keyp);
int nilfs_bmap_last_key(struct nilfs_bmap *bmap, __u64 *keyp);
int nilfs_bmap_truncate(struct nilfs_bmap *bmap, __u64 key);
void nilfs_bmap_clear(struct nilfs_bmap *);
int nilfs_bmap_propagate(struct nilfs_bmap *, struct buffer_head *);
void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap *, struct list_head *);
int nilfs_bmap_assign(struct nilfs_bmap *, struct buffer_head **,
		      unsigned long, union nilfs_binfo *);
int nilfs_bmap_lookup_at_level(struct nilfs_bmap *, __u64, int, __u64 *);
int nilfs_bmap_mark(struct nilfs_bmap *, __u64, int);

void nilfs_bmap_init_gc(struct nilfs_bmap *);

void nilfs_bmap_save(const struct nilfs_bmap *, struct nilfs_bmap_store *);
void nilfs_bmap_restore(struct nilfs_bmap *, const struct nilfs_bmap_store *);

static inline int nilfs_bmap_lookup(struct nilfs_bmap *bmap, __u64 key,
				    __u64 *ptr)
{
	return nilfs_bmap_lookup_at_level(bmap, key, 1, ptr);
}

/*
 * Internal use only
 */
struct inode *nilfs_bmap_get_dat(const struct nilfs_bmap *);

static inline int nilfs_bmap_prepare_alloc_ptr(struct nilfs_bmap *bmap,
					       union nilfs_bmap_ptr_req *req,
					       struct inode *dat)
{
	if (dat)
		return nilfs_dat_prepare_alloc(dat, &req->bpr_req);
	/* ignore target ptr */
	req->bpr_ptr = bmap->b_last_allocated_ptr++;
	return 0;
}

static inline void nilfs_bmap_commit_alloc_ptr(struct nilfs_bmap *bmap,
					       union nilfs_bmap_ptr_req *req,
					       struct inode *dat)
{
	if (dat)
		nilfs_dat_commit_alloc(dat, &req->bpr_req);
}

static inline void nilfs_bmap_abort_alloc_ptr(struct nilfs_bmap *bmap,
					      union nilfs_bmap_ptr_req *req,
					      struct inode *dat)
{
	if (dat)
		nilfs_dat_abort_alloc(dat, &req->bpr_req);
	else
		bmap->b_last_allocated_ptr--;
}

static inline int nilfs_bmap_prepare_end_ptr(struct nilfs_bmap *bmap,
					     union nilfs_bmap_ptr_req *req,
					     struct inode *dat)
{
	return dat ? nilfs_dat_prepare_end(dat, &req->bpr_req) : 0;
}

static inline void nilfs_bmap_commit_end_ptr(struct nilfs_bmap *bmap,
					     union nilfs_bmap_ptr_req *req,
					     struct inode *dat)
{
	if (dat)
		nilfs_dat_commit_end(dat, &req->bpr_req,
				     bmap->b_ptr_type == NILFS_BMAP_PTR_VS);
}

static inline void nilfs_bmap_abort_end_ptr(struct nilfs_bmap *bmap,
					    union nilfs_bmap_ptr_req *req,
					    struct inode *dat)
{
	if (dat)
		nilfs_dat_abort_end(dat, &req->bpr_req);
}

static inline void nilfs_bmap_set_target_v(struct nilfs_bmap *bmap, __u64 key,
					   __u64 ptr)
{
	bmap->b_last_allocated_key = key;
	bmap->b_last_allocated_ptr = ptr;
}

__u64 nilfs_bmap_data_get_key(const struct nilfs_bmap *,
			      const struct buffer_head *);

__u64 nilfs_bmap_find_target_seq(const struct nilfs_bmap *, __u64);
__u64 nilfs_bmap_find_target_in_group(const struct nilfs_bmap *);


/* Assume that bmap semaphore is locked. */
static inline int nilfs_bmap_dirty(const struct nilfs_bmap *bmap)
{
	return !!(bmap->b_state & NILFS_BMAP_DIRTY);
}

/* Assume that bmap semaphore is locked. */
static inline void nilfs_bmap_set_dirty(struct nilfs_bmap *bmap)
{
	bmap->b_state |= NILFS_BMAP_DIRTY;
}

/* Assume that bmap semaphore is locked. */
static inline void nilfs_bmap_clear_dirty(struct nilfs_bmap *bmap)
{
	bmap->b_state &= ~NILFS_BMAP_DIRTY;
}


#define NILFS_BMAP_LARGE	0x1

#define NILFS_BMAP_SMALL_LOW	NILFS_DIRECT_KEY_MIN
#define NILFS_BMAP_SMALL_HIGH	NILFS_DIRECT_KEY_MAX
#define NILFS_BMAP_LARGE_LOW	NILFS_BTREE_ROOT_NCHILDREN_MAX
#define NILFS_BMAP_LARGE_HIGH	NILFS_BTREE_KEY_MAX

#endif	/* _NILFS_BMAP_H */
Commit	Line	Data
ae98043f	1	/* SPDX-License-Identifier: GPL-2.0+ */
bdb265ea KS	2	/*
	3	* bmap.h - NILFS block mapping.
	4	*
	5	* Copyright (C) 2006-2008 Nippon Telegraph and Telephone Corporation.
	6	*
4b420ab4	7	* Written by Koji Sato.
bdb265ea KS	8	*/
	9
	10	#ifndef _NILFS_BMAP_H
	11	#define _NILFS_BMAP_H
	12
	13	#include <linux/types.h>
	14	#include <linux/fs.h>
	15	#include <linux/buffer_head.h>
e63e88bc	16	#include <linux/nilfs2_ondisk.h> /* nilfs_binfo, nilfs_inode, etc */
bdb265ea	17	#include "alloc.h"
2e0c2c73	18	#include "dat.h"
bdb265ea KS	19
	20	#define NILFS_BMAP_INVALID_PTR 0
	21
bdb265ea KS	22	#define nilfs_bmap_keydiff_abs(diff) ((diff) < 0 ? -(diff) : (diff))
	23
	24
	25	struct nilfs_bmap;
	26
	27	/**
	28	* union nilfs_bmap_ptr_req - request for bmap ptr
	29	* @bpr_ptr: bmap pointer
	30	* @bpr_req: request for persistent allocator
	31	*/
	32	union nilfs_bmap_ptr_req {
	33	__u64 bpr_ptr;
	34	struct nilfs_palloc_req bpr_req;
	35	};
	36
	37	/**
	38	* struct nilfs_bmap_stats - bmap statistics
	39	* @bs_nblocks: number of blocks created or deleted
	40	*/
	41	struct nilfs_bmap_stats {
	42	unsigned int bs_nblocks;
	43	};
	44
	45	/**
	46	* struct nilfs_bmap_operations - bmap operation table
	47	*/
	48	struct nilfs_bmap_operations {
	49	int (bop_lookup)(const struct nilfs_bmap , __u64, int, __u64 *);
c3a7abf0	50	int (bop_lookup_contig)(const struct nilfs_bmap , __u64, __u64 *,
0c6c44cb	51	unsigned int);
bdb265ea KS	52	int (bop_insert)(struct nilfs_bmap , __u64, __u64);
	53	int (bop_delete)(struct nilfs_bmap , __u64);
	54	void (bop_clear)(struct nilfs_bmap );
	55
583ada47	56	int (bop_propagate)(struct nilfs_bmap , struct buffer_head *);
bdb265ea KS	57	void (bop_lookup_dirty_buffers)(struct nilfs_bmap ,
	58	struct list_head *);
	59
	60	int (bop_assign)(struct nilfs_bmap ,
	61	struct buffer_head **,
	62	sector_t,
	63	union nilfs_binfo *);
	64	int (bop_mark)(struct nilfs_bmap , __u64, int);
	65
5b20384f	66	int (bop_seek_key)(const struct nilfs_bmap , __u64, __u64 *);
bdb265ea	67	int (bop_last_key)(const struct nilfs_bmap , __u64 *);
5b20384f RK	68
5b20384f RK	69	/* The following functions are internal use only. */
bdb265ea KS	70	int (bop_check_insert)(const struct nilfs_bmap , __u64);
	71	int (bop_check_delete)(struct nilfs_bmap , __u64);
	72	int (bop_gather_data)(struct nilfs_bmap , __u64 , __u64 , int);
	73	};
	74
	75
bdb265ea KS	76	#define NILFS_BMAP_SIZE (NILFS_INODE_BMAP_SIZE * sizeof(__le64))
	77	#define NILFS_BMAP_KEY_BIT (sizeof(unsigned long) * 8 /* CHAR_BIT */)
	78	#define NILFS_BMAP_NEW_PTR_INIT \
	79	(1UL << (sizeof(unsigned long) * 8 /* CHAR_BIT */ - 1))
	80
	81	static inline int nilfs_bmap_is_new_ptr(unsigned long ptr)
	82	{
	83	return !!(ptr & NILFS_BMAP_NEW_PTR_INIT);
	84	}
	85
	86
	87	/**
	88	* struct nilfs_bmap - bmap structure
	89	* @b_u: raw data
	90	* @b_sem: semaphore
	91	* @b_inode: owner of bmap
	92	* @b_ops: bmap operation table
bdb265ea KS	93	* @b_last_allocated_key: last allocated key for data block
bdb265ea KS	94	* @b_last_allocated_ptr: last allocated ptr for data block
d4b96157	95	* @b_ptr_type: pointer type
bdb265ea	96	* @b_state: state
5ad2686e	97	* @b_nchildren_per_block: maximum number of child nodes for non-root nodes
bdb265ea KS	98	*/
	99	struct nilfs_bmap {
	100	union {
	101	__u8 u_flags;
	102	__le64 u_data[NILFS_BMAP_SIZE / sizeof(__le64)];
	103	} b_u;
	104	struct rw_semaphore b_sem;
	105	struct inode *b_inode;
	106	const struct nilfs_bmap_operations *b_ops;
bdb265ea KS	107	__u64 b_last_allocated_key;
bdb265ea KS	108	__u64 b_last_allocated_ptr;
d4b96157	109	int b_ptr_type;
bdb265ea	110	int b_state;
5ad2686e	111	__u16 b_nchildren_per_block;
bdb265ea KS	112	};
bdb265ea KS	113
d4b96157 RK	114	/* pointer type */
d4b96157 RK	115	#define NILFS_BMAP_PTR_P 0 /* physical block number (i.e. LBN) */
076a378b RK	116	#define NILFS_BMAP_PTR_VS 1 /*
	117	* virtual block number (single
	118	* version)
	119	*/
	120	#define NILFS_BMAP_PTR_VM 2 /*
	121	* virtual block number (has multiple
	122	* versions)
	123	*/
d4b96157 RK	124	#define NILFS_BMAP_PTR_U (-1) /* never perform pointer operations */
	125
	126	#define NILFS_BMAP_USE_VBN(bmap) ((bmap)->b_ptr_type > 0)
	127
bdb265ea KS	128	/* state */
	129	#define NILFS_BMAP_DIRTY 0x00000001
	130
f5974c8f VD	131	/**
	132	* struct nilfs_bmap_store - shadow copy of bmap state
	133	* @data: cached raw block mapping of on-disk inode
	134	* @last_allocated_key: cached value of last allocated key for data block
	135	* @last_allocated_ptr: cached value of last allocated ptr for data block
	136	* @state: cached value of state field of bmap structure
	137	*/
a8070dd3 RK	138	struct nilfs_bmap_store {
	139	__le64 data[NILFS_BMAP_SIZE / sizeof(__le64)];
	140	__u64 last_allocated_key;
	141	__u64 last_allocated_ptr;
	142	int state;
	143	};
bdb265ea KS	144
	145	int nilfs_bmap_test_and_clear_dirty(struct nilfs_bmap *);
	146	int nilfs_bmap_read(struct nilfs_bmap , struct nilfs_inode );
	147	void nilfs_bmap_write(struct nilfs_bmap , struct nilfs_inode );
0c6c44cb	148	int nilfs_bmap_lookup_contig(struct nilfs_bmap , __u64, __u64 , unsigned int);
3568a13f RK	149	int nilfs_bmap_insert(struct nilfs_bmap *bmap, __u64 key, unsigned long rec);
3568a13f RK	150	int nilfs_bmap_delete(struct nilfs_bmap *bmap, __u64 key);
5b20384f	151	int nilfs_bmap_seek_key(struct nilfs_bmap bmap, __u64 start, __u64 keyp);
3568a13f RK	152	int nilfs_bmap_last_key(struct nilfs_bmap bmap, __u64 keyp);
3568a13f RK	153	int nilfs_bmap_truncate(struct nilfs_bmap *bmap, __u64 key);
bdb265ea KS	154	void nilfs_bmap_clear(struct nilfs_bmap *);
	155	int nilfs_bmap_propagate(struct nilfs_bmap , struct buffer_head );
	156	void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap , struct list_head );
	157	int nilfs_bmap_assign(struct nilfs_bmap , struct buffer_head *,
	158	unsigned long, union nilfs_binfo *);
	159	int nilfs_bmap_lookup_at_level(struct nilfs_bmap , __u64, int, __u64 );
	160	int nilfs_bmap_mark(struct nilfs_bmap *, __u64, int);
	161
	162	void nilfs_bmap_init_gc(struct nilfs_bmap *);
bdb265ea	163
a8070dd3 RK	164	void nilfs_bmap_save(const struct nilfs_bmap , struct nilfs_bmap_store );
a8070dd3 RK	165	void nilfs_bmap_restore(struct nilfs_bmap , const struct nilfs_bmap_store );
bdb265ea	166
0f3fe33b RK	167	static inline int nilfs_bmap_lookup(struct nilfs_bmap *bmap, __u64 key,
	168	__u64 *ptr)
	169	{
	170	return nilfs_bmap_lookup_at_level(bmap, key, 1, ptr);
	171	}
	172
bdb265ea KS	173	/*
	174	* Internal use only
	175	*/
c3a7abf0	176	struct inode nilfs_bmap_get_dat(const struct nilfs_bmap );
d4b96157 RK	177
d4b96157 RK	178	static inline int nilfs_bmap_prepare_alloc_ptr(struct nilfs_bmap *bmap,
2e0c2c73 RK	179	union nilfs_bmap_ptr_req *req,
2e0c2c73 RK	180	struct inode *dat)
d4b96157	181	{
2e0c2c73 RK	182	if (dat)
2e0c2c73 RK	183	return nilfs_dat_prepare_alloc(dat, &req->bpr_req);
d4b96157 RK	184	/* ignore target ptr */
	185	req->bpr_ptr = bmap->b_last_allocated_ptr++;
	186	return 0;
	187	}
	188
	189	static inline void nilfs_bmap_commit_alloc_ptr(struct nilfs_bmap *bmap,
2e0c2c73 RK	190	union nilfs_bmap_ptr_req *req,
2e0c2c73 RK	191	struct inode *dat)
d4b96157	192	{
2e0c2c73 RK	193	if (dat)
2e0c2c73 RK	194	nilfs_dat_commit_alloc(dat, &req->bpr_req);
d4b96157 RK	195	}
	196
	197	static inline void nilfs_bmap_abort_alloc_ptr(struct nilfs_bmap *bmap,
2e0c2c73 RK	198	union nilfs_bmap_ptr_req *req,
2e0c2c73 RK	199	struct inode *dat)
d4b96157	200	{
2e0c2c73 RK	201	if (dat)
2e0c2c73 RK	202	nilfs_dat_abort_alloc(dat, &req->bpr_req);
d4b96157 RK	203	else
	204	bmap->b_last_allocated_ptr--;
	205	}
	206
d4b96157	207	static inline int nilfs_bmap_prepare_end_ptr(struct nilfs_bmap *bmap,
2e0c2c73 RK	208	union nilfs_bmap_ptr_req *req,
2e0c2c73 RK	209	struct inode *dat)
d4b96157	210	{
2e0c2c73	211	return dat ? nilfs_dat_prepare_end(dat, &req->bpr_req) : 0;
d4b96157 RK	212	}
	213
	214	static inline void nilfs_bmap_commit_end_ptr(struct nilfs_bmap *bmap,
2e0c2c73 RK	215	union nilfs_bmap_ptr_req *req,
2e0c2c73 RK	216	struct inode *dat)
d4b96157	217	{
2e0c2c73 RK	218	if (dat)
	219	nilfs_dat_commit_end(dat, &req->bpr_req,
	220	bmap->b_ptr_type == NILFS_BMAP_PTR_VS);
d4b96157 RK	221	}
	222
	223	static inline void nilfs_bmap_abort_end_ptr(struct nilfs_bmap *bmap,
2e0c2c73 RK	224	union nilfs_bmap_ptr_req *req,
2e0c2c73 RK	225	struct inode *dat)
d4b96157	226	{
2e0c2c73 RK	227	if (dat)
2e0c2c73 RK	228	nilfs_dat_abort_end(dat, &req->bpr_req);
d4b96157	229	}
bdb265ea	230
dc935be2 RK	231	static inline void nilfs_bmap_set_target_v(struct nilfs_bmap *bmap, __u64 key,
	232	__u64 ptr)
	233	{
	234	bmap->b_last_allocated_key = key;
	235	bmap->b_last_allocated_ptr = ptr;
	236	}
	237
bdb265ea KS	238	__u64 nilfs_bmap_data_get_key(const struct nilfs_bmap *,
	239	const struct buffer_head *);
	240
	241	__u64 nilfs_bmap_find_target_seq(const struct nilfs_bmap *, __u64);
	242	__u64 nilfs_bmap_find_target_in_group(const struct nilfs_bmap *);
	243
bdb265ea	244
bdb265ea KS	245	/* Assume that bmap semaphore is locked. */
	246	static inline int nilfs_bmap_dirty(const struct nilfs_bmap *bmap)
	247	{
	248	return !!(bmap->b_state & NILFS_BMAP_DIRTY);
	249	}
	250
	251	/* Assume that bmap semaphore is locked. */
	252	static inline void nilfs_bmap_set_dirty(struct nilfs_bmap *bmap)
	253	{
	254	bmap->b_state \|= NILFS_BMAP_DIRTY;
	255	}
	256
	257	/* Assume that bmap semaphore is locked. */
	258	static inline void nilfs_bmap_clear_dirty(struct nilfs_bmap *bmap)
	259	{
	260	bmap->b_state &= ~NILFS_BMAP_DIRTY;
	261	}
	262
	263
	264	#define NILFS_BMAP_LARGE 0x1
	265
	266	#define NILFS_BMAP_SMALL_LOW NILFS_DIRECT_KEY_MIN
	267	#define NILFS_BMAP_SMALL_HIGH NILFS_DIRECT_KEY_MAX
	268	#define NILFS_BMAP_LARGE_LOW NILFS_BTREE_ROOT_NCHILDREN_MAX
	269	#define NILFS_BMAP_LARGE_HIGH NILFS_BTREE_KEY_MAX
	270
	271	#endif /* _NILFS_BMAP_H */