[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_dkey_to_key(dkey)	le64_to_cpu(dkey)
#define nilfs_bmap_key_to_dkey(key)	cpu_to_le64(key)
#define nilfs_bmap_dptr_to_ptr(dptr)	le64_to_cpu(dptr)
#define nilfs_bmap_ptr_to_dptr(ptr)	cpu_to_le64(ptr)

#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)(const 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
 */
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;
};

/* 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


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_init_gcdat(struct nilfs_bmap *, struct nilfs_bmap *);
void nilfs_bmap_commit_gcdat(struct nilfs_bmap *, struct nilfs_bmap *);


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);
}

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