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

/*
 * bmap.h - NILFS block mapping.
 *
 * Copyright (C) 2006-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 Koji Sato <koji@osrg.net>.
 */

#ifndef _NILFS_BMAP_H
#define _NILFS_BMAP_H

#include <linux/types.h>
#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/nilfs2_fs.h>
#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 (*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);

	/* The following functions are internal use only. */
	int (*bop_last_key)(const struct nilfs_bmap *, __u64 *);
	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 {
	__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 nilfs_bmap_insert(struct nilfs_bmap *, unsigned long, unsigned long);
int nilfs_bmap_delete(struct nilfs_bmap *, unsigned long);
int nilfs_bmap_last_key(struct nilfs_bmap *, unsigned long *);
int nilfs_bmap_truncate(struct nilfs_bmap *, unsigned long);
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 *);

void nilfs_bmap_add_blocks(const struct nilfs_bmap *, int);
void nilfs_bmap_sub_blocks(const struct nilfs_bmap *, int);


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