[linux.git] / fs / jfs / jfs_xtree.h

/*
 *   Copyright (C) International Business Machines Corp., 2000-2002
 *
 *   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
#ifndef _H_JFS_XTREE
#define _H_JFS_XTREE

/*
 *	jfs_xtree.h: extent allocation descriptor B+-tree manager
 */

#include "jfs_btree.h"


/*
 *	extent allocation descriptor (xad)
 */
typedef struct xad {
	__u8 flag;	/* 1: flag */
	__u8 rsvrd[2];	/* 2: reserved */
	__u8 off1;	/* 1: offset in unit of fsblksize */
	__le32 off2;	/* 4: offset in unit of fsblksize */
	pxd_t loc;	/* 8: length and address in unit of fsblksize */
} xad_t;			/* (16) */

#define MAXXLEN		((1 << 24) - 1)

#define XTSLOTSIZE	16
#define L2XTSLOTSIZE	4

/* xad_t field construction */
#define XADoffset(xad, offset64)\
{\
	(xad)->off1 = ((u64)offset64) >> 32;\
	(xad)->off2 = __cpu_to_le32((offset64) & 0xffffffff);\
}
#define XADaddress(xad, address64) PXDaddress(&(xad)->loc, address64)
#define XADlength(xad, length32) PXDlength(&(xad)->loc, length32)

/* xad_t field extraction */
#define offsetXAD(xad)\
	( ((s64)((xad)->off1)) << 32 | __le32_to_cpu((xad)->off2))
#define addressXAD(xad) addressPXD(&(xad)->loc)
#define lengthXAD(xad) lengthPXD(&(xad)->loc)

/* xad list */
struct xadlist {
	s16 maxnxad;
	s16 nxad;
	xad_t *xad;
};

/* xad_t flags */
#define XAD_NEW		0x01	/* new */
#define XAD_EXTENDED	0x02	/* extended */
#define XAD_COMPRESSED	0x04	/* compressed with recorded length */
#define XAD_NOTRECORDED 0x08	/* allocated but not recorded */
#define XAD_COW		0x10	/* copy-on-write */


/* possible values for maxentry */
#define XTROOTINITSLOT_DIR 6
#define XTROOTINITSLOT	10
#define XTROOTMAXSLOT	18
#define XTPAGEMAXSLOT	256
#define XTENTRYSTART	2

/*
 *	xtree page:
 */
typedef union {
	struct xtheader {
		__le64 next;	/* 8: */
		__le64 prev;	/* 8: */

		u8 flag;	/* 1: */
		u8 rsrvd1;	/* 1: */
		__le16 nextindex;	/* 2: next index = number of entries */
		__le16 maxentry;	/* 2: max number of entries */
		__le16 rsrvd2;	/* 2: */

		pxd_t self;	/* 8: self */
	} header;		/* (32) */

	xad_t xad[XTROOTMAXSLOT];	/* 16 * maxentry: xad array */
} xtpage_t;

/*
 *	external declaration
 */
extern int xtLookup(struct inode *ip, s64 lstart, s64 llen,
		    int *pflag, s64 * paddr, int *plen, int flag);
extern void xtInitRoot(tid_t tid, struct inode *ip);
extern int xtInsert(tid_t tid, struct inode *ip,
		    int xflag, s64 xoff, int xlen, s64 * xaddrp, int flag);
extern int xtExtend(tid_t tid, struct inode *ip, s64 xoff, int xlen,
		    int flag);
#ifdef _NOTYET
extern int xtTailgate(tid_t tid, struct inode *ip,
		      s64 xoff, int xlen, s64 xaddr, int flag);
#endif
extern int xtUpdate(tid_t tid, struct inode *ip, struct xad *nxad);
extern int xtDelete(tid_t tid, struct inode *ip, s64 xoff, int xlen,
		    int flag);
extern s64 xtTruncate(tid_t tid, struct inode *ip, s64 newsize, int type);
extern s64 xtTruncate_pmap(tid_t tid, struct inode *ip, s64 committed_size);
extern int xtRelocate(tid_t tid, struct inode *ip,
		      xad_t * oxad, s64 nxaddr, int xtype);
extern int xtAppend(tid_t tid,
		    struct inode *ip, int xflag, s64 xoff, int maxblocks,
		    int *xlenp, s64 * xaddrp, int flag);
#endif				/* !_H_JFS_XTREE */
Commit	Line	Data
1da177e4	1	/*
63f83c9f	2	* Copyright (C) International Business Machines Corp., 2000-2002
1da177e4 LT	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
63f83c9f	6	* the Free Software Foundation; either version 2 of the License, or
1da177e4	7	* (at your option) any later version.
63f83c9f	8	*
1da177e4 LT	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
	12	* the GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
63f83c9f	15	* along with this program; if not, write to the Free Software
1da177e4 LT	16	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	17	*/
	18	#ifndef _H_JFS_XTREE
	19	#define _H_JFS_XTREE
	20
	21	/*
f720e3ba	22	* jfs_xtree.h: extent allocation descriptor B+-tree manager
1da177e4 LT	23	*/
	24
	25	#include "jfs_btree.h"
	26
	27
	28	/*
f720e3ba	29	* extent allocation descriptor (xad)
1da177e4 LT	30	*/
1da177e4 LT	31	typedef struct xad {
e1f1fe79 AV	32	__u8 flag; /* 1: flag */
	33	__u8 rsvrd[2]; /* 2: reserved */
	34	__u8 off1; /* 1: offset in unit of fsblksize */
	35	__le32 off2; /* 4: offset in unit of fsblksize */
	36	pxd_t loc; /* 8: length and address in unit of fsblksize */
1da177e4 LT	37	} xad_t; /* (16) */
1da177e4 LT	38
f720e3ba	39	#define MAXXLEN ((1 << 24) - 1)
1da177e4	40
f720e3ba DK	41	#define XTSLOTSIZE 16
f720e3ba DK	42	#define L2XTSLOTSIZE 4
1da177e4 LT	43
	44	/* xad_t field construction */
	45	#define XADoffset(xad, offset64)\
	46	{\
f720e3ba DK	47	(xad)->off1 = ((u64)offset64) >> 32;\
f720e3ba DK	48	(xad)->off2 = __cpu_to_le32((offset64) & 0xffffffff);\
1da177e4	49	}
e1f1fe79 AV	50	#define XADaddress(xad, address64) PXDaddress(&(xad)->loc, address64)
e1f1fe79 AV	51	#define XADlength(xad, length32) PXDlength(&(xad)->loc, length32)
1da177e4 LT	52
	53	/* xad_t field extraction */
	54	#define offsetXAD(xad)\
f720e3ba	55	( ((s64)((xad)->off1)) << 32 \| __le32_to_cpu((xad)->off2))
e1f1fe79 AV	56	#define addressXAD(xad) addressPXD(&(xad)->loc)
e1f1fe79 AV	57	#define lengthXAD(xad) lengthPXD(&(xad)->loc)
1da177e4 LT	58
	59	/* xad list */
	60	struct xadlist {
	61	s16 maxnxad;
	62	s16 nxad;
	63	xad_t *xad;
	64	};
	65
	66	/* xad_t flags */
f720e3ba DK	67	#define XAD_NEW 0x01 /* new */
	68	#define XAD_EXTENDED 0x02 /* extended */
	69	#define XAD_COMPRESSED 0x04 /* compressed with recorded length */
1da177e4	70	#define XAD_NOTRECORDED 0x08 /* allocated but not recorded */
f720e3ba	71	#define XAD_COW 0x10 /* copy-on-write */
1da177e4 LT	72
	73
	74	/* possible values for maxentry */
f720e3ba DK	75	#define XTROOTINITSLOT_DIR 6
	76	#define XTROOTINITSLOT 10
	77	#define XTROOTMAXSLOT 18
	78	#define XTPAGEMAXSLOT 256
	79	#define XTENTRYSTART 2
1da177e4 LT	80
1da177e4 LT	81	/*
f720e3ba	82	* xtree page:
1da177e4 LT	83	*/
	84	typedef union {
	85	struct xtheader {
	86	__le64 next; /* 8: */
	87	__le64 prev; /* 8: */
	88
	89	u8 flag; /* 1: */
	90	u8 rsrvd1; /* 1: */
	91	__le16 nextindex; /* 2: next index = number of entries */
	92	__le16 maxentry; /* 2: max number of entries */
	93	__le16 rsrvd2; /* 2: */
	94
	95	pxd_t self; /* 8: self */
	96	} header; /* (32) */
	97
	98	xad_t xad[XTROOTMAXSLOT]; /* 16 * maxentry: xad array */
	99	} xtpage_t;
	100
	101	/*
f720e3ba	102	* external declaration
1da177e4 LT	103	*/
	104	extern int xtLookup(struct inode *ip, s64 lstart, s64 llen,
	105	int pflag, s64 paddr, int *plen, int flag);
1da177e4 LT	106	extern void xtInitRoot(tid_t tid, struct inode *ip);
	107	extern int xtInsert(tid_t tid, struct inode *ip,
	108	int xflag, s64 xoff, int xlen, s64 * xaddrp, int flag);
	109	extern int xtExtend(tid_t tid, struct inode *ip, s64 xoff, int xlen,
	110	int flag);
	111	#ifdef _NOTYET
	112	extern int xtTailgate(tid_t tid, struct inode *ip,
	113	s64 xoff, int xlen, s64 xaddr, int flag);
	114	#endif
	115	extern int xtUpdate(tid_t tid, struct inode ip, struct xad nxad);
	116	extern int xtDelete(tid_t tid, struct inode *ip, s64 xoff, int xlen,
	117	int flag);
	118	extern s64 xtTruncate(tid_t tid, struct inode *ip, s64 newsize, int type);
	119	extern s64 xtTruncate_pmap(tid_t tid, struct inode *ip, s64 committed_size);
	120	extern int xtRelocate(tid_t tid, struct inode *ip,
	121	xad_t * oxad, s64 nxaddr, int xtype);
	122	extern int xtAppend(tid_t tid,
	123	struct inode *ip, int xflag, s64 xoff, int maxblocks,
	124	int xlenp, s64 xaddrp, int flag);
1da177e4	125	#endif /* !_H_JFS_XTREE */