[thirdparty/xfsprogs-dev.git] / libxfs / xfs_da_btree.h

/*
 * Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
 * Copyright (c) 2013 Red Hat, Inc.
 * All Rights Reserved.
 *
 * 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.
 *
 * This program is distributed in the hope that it would 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 the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __XFS_DA_BTREE_H__
#define	__XFS_DA_BTREE_H__

struct xfs_defer_ops;
struct xfs_inode;
struct xfs_trans;
struct zone;
struct xfs_dir_ops;

/*
 * Directory/attribute geometry information. There will be one of these for each
 * data fork type, and it will be passed around via the xfs_da_args. Global
 * structures will be attached to the xfs_mount.
 */
struct xfs_da_geometry {
	int		blksize;	/* da block size in bytes */
	int		fsbcount;	/* da block size in filesystem blocks */
	uint8_t		fsblog;		/* log2 of _filesystem_ block size */
	uint8_t		blklog;		/* log2 of da block size */
	uint		node_ents;	/* # of entries in a danode */
	int		magicpct;	/* 37% of block size in bytes */
	xfs_dablk_t	datablk;	/* blockno of dir data v2 */
	xfs_dablk_t	leafblk;	/* blockno of leaf data v2 */
	xfs_dablk_t	freeblk;	/* blockno of free data v2 */
};

/*========================================================================
 * Btree searching and modification structure definitions.
 *========================================================================*/

/*
 * Search comparison results
 */
enum xfs_dacmp {
	XFS_CMP_DIFFERENT,	/* names are completely different */
	XFS_CMP_EXACT,		/* names are exactly the same */
	XFS_CMP_CASE		/* names are same but differ in case */
};

/*
 * Structure to ease passing around component names.
 */
typedef struct xfs_da_args {
	struct xfs_da_geometry *geo;	/* da block geometry */
	const uint8_t		*name;		/* string (maybe not NULL terminated) */
	int		namelen;	/* length of string (maybe no NULL) */
	uint8_t		filetype;	/* filetype of inode for directories */
	uint8_t		*value;		/* set of bytes (maybe contain NULLs) */
	int		valuelen;	/* length of value */
	int		flags;		/* argument flags (eg: ATTR_NOCREATE) */
	xfs_dahash_t	hashval;	/* hash value of name */
	xfs_ino_t	inumber;	/* input/output inode number */
	struct xfs_inode *dp;		/* directory inode to manipulate */
	xfs_fsblock_t	*firstblock;	/* ptr to firstblock for bmap calls */
	struct xfs_defer_ops *dfops;	/* ptr to freelist for bmap_finish */
	struct xfs_trans *trans;	/* current trans (changes over time) */
	xfs_extlen_t	total;		/* total blocks needed, for 1st bmap */
	int		whichfork;	/* data or attribute fork */
	xfs_dablk_t	blkno;		/* blkno of attr leaf of interest */
	int		index;		/* index of attr of interest in blk */
	xfs_dablk_t	rmtblkno;	/* remote attr value starting blkno */
	int		rmtblkcnt;	/* remote attr value block count */
	int		rmtvaluelen;	/* remote attr value length in bytes */
	xfs_dablk_t	blkno2;		/* blkno of 2nd attr leaf of interest */
	int		index2;		/* index of 2nd attr in blk */
	xfs_dablk_t	rmtblkno2;	/* remote attr value starting blkno */
	int		rmtblkcnt2;	/* remote attr value block count */
	int		rmtvaluelen2;	/* remote attr value length in bytes */
	int		op_flags;	/* operation flags */
	enum xfs_dacmp	cmpresult;	/* name compare result for lookups */
} xfs_da_args_t;

/*
 * Operation flags:
 */
#define XFS_DA_OP_JUSTCHECK	0x0001	/* check for ok with no space */
#define XFS_DA_OP_RENAME	0x0002	/* this is an atomic rename op */
#define XFS_DA_OP_ADDNAME	0x0004	/* this is an add operation */
#define XFS_DA_OP_OKNOENT	0x0008	/* lookup/add op, ENOENT ok, else die */
#define XFS_DA_OP_CILOOKUP	0x0010	/* lookup to return CI name if found */

#define XFS_DA_OP_FLAGS \
	{ XFS_DA_OP_JUSTCHECK,	"JUSTCHECK" }, \
	{ XFS_DA_OP_RENAME,	"RENAME" }, \
	{ XFS_DA_OP_ADDNAME,	"ADDNAME" }, \
	{ XFS_DA_OP_OKNOENT,	"OKNOENT" }, \
	{ XFS_DA_OP_CILOOKUP,	"CILOOKUP" }

/*
 * Storage for holding state during Btree searches and split/join ops.
 *
 * Only need space for 5 intermediate nodes.  With a minimum of 62-way
 * fanout to the Btree, we can support over 900 million directory blocks,
 * which is slightly more than enough.
 */
typedef struct xfs_da_state_blk {
	struct xfs_buf	*bp;		/* buffer containing block */
	xfs_dablk_t	blkno;		/* filesystem blkno of buffer */
	xfs_daddr_t	disk_blkno;	/* on-disk blkno (in BBs) of buffer */
	int		index;		/* relevant index into block */
	xfs_dahash_t	hashval;	/* last hash value in block */
	int		magic;		/* blk's magic number, ie: blk type */
} xfs_da_state_blk_t;

typedef struct xfs_da_state_path {
	int			active;		/* number of active levels */
	xfs_da_state_blk_t	blk[XFS_DA_NODE_MAXDEPTH];
} xfs_da_state_path_t;

typedef struct xfs_da_state {
	xfs_da_args_t		*args;		/* filename arguments */
	struct xfs_mount	*mp;		/* filesystem mount point */
	xfs_da_state_path_t	path;		/* search/split paths */
	xfs_da_state_path_t	altpath;	/* alternate path for join */
	unsigned char		inleaf;		/* insert into 1->lf, 0->splf */
	unsigned char		extravalid;	/* T/F: extrablk is in use */
	unsigned char		extraafter;	/* T/F: extrablk is after new */
	xfs_da_state_blk_t	extrablk;	/* for double-splits on leaves */
						/* for dirv2 extrablk is data */
} xfs_da_state_t;

/*
 * Utility macros to aid in logging changed structure fields.
 */
#define XFS_DA_LOGOFF(BASE, ADDR)	((char *)(ADDR) - (char *)(BASE))
#define XFS_DA_LOGRANGE(BASE, ADDR, SIZE)	\
		(uint)(XFS_DA_LOGOFF(BASE, ADDR)), \
		(uint)(XFS_DA_LOGOFF(BASE, ADDR)+(SIZE)-1)

/*
 * Name ops for directory and/or attr name operations
 */
struct xfs_nameops {
	xfs_dahash_t	(*hashname)(struct xfs_name *);
	enum xfs_dacmp	(*compname)(struct xfs_da_args *,
					const unsigned char *, int);
};


/*========================================================================
 * Function prototypes.
 *========================================================================*/

/*
 * Routines used for growing the Btree.
 */
int	xfs_da3_node_create(struct xfs_da_args *args, xfs_dablk_t blkno,
			    int level, struct xfs_buf **bpp, int whichfork);
int	xfs_da3_split(xfs_da_state_t *state);

/*
 * Routines used for shrinking the Btree.
 */
int	xfs_da3_join(xfs_da_state_t *state);
void	xfs_da3_fixhashpath(struct xfs_da_state *state,
			    struct xfs_da_state_path *path_to_to_fix);

/*
 * Routines used for finding things in the Btree.
 */
int	xfs_da3_node_lookup_int(xfs_da_state_t *state, int *result);
int	xfs_da3_path_shift(xfs_da_state_t *state, xfs_da_state_path_t *path,
					 int forward, int release, int *result);
/*
 * Utility routines.
 */
int	xfs_da3_blk_link(xfs_da_state_t *state, xfs_da_state_blk_t *old_blk,
				       xfs_da_state_blk_t *new_blk);
int	xfs_da3_node_read(struct xfs_trans *tp, struct xfs_inode *dp,
			 xfs_dablk_t bno, xfs_daddr_t mappedbno,
			 struct xfs_buf **bpp, int which_fork);

/*
 * Utility routines.
 */
int	xfs_da_grow_inode(xfs_da_args_t *args, xfs_dablk_t *new_blkno);
int	xfs_da_grow_inode_int(struct xfs_da_args *args, xfs_fileoff_t *bno,
			      int count);
int	xfs_da_get_buf(struct xfs_trans *trans, struct xfs_inode *dp,
			      xfs_dablk_t bno, xfs_daddr_t mappedbno,
			      struct xfs_buf **bp, int whichfork);
int	xfs_da_read_buf(struct xfs_trans *trans, struct xfs_inode *dp,
			       xfs_dablk_t bno, xfs_daddr_t mappedbno,
			       struct xfs_buf **bpp, int whichfork,
			       const struct xfs_buf_ops *ops);
int	xfs_da_reada_buf(struct xfs_inode *dp, xfs_dablk_t bno,
				xfs_daddr_t mapped_bno, int whichfork,
				const struct xfs_buf_ops *ops);
int	xfs_da_shrink_inode(xfs_da_args_t *args, xfs_dablk_t dead_blkno,
					  struct xfs_buf *dead_buf);

uint xfs_da_hashname(const uint8_t *name_string, int name_length);
enum xfs_dacmp xfs_da_compname(struct xfs_da_args *args,
				const unsigned char *name, int len);


xfs_da_state_t *xfs_da_state_alloc(void);
void xfs_da_state_free(xfs_da_state_t *state);

extern struct kmem_zone *xfs_da_state_zone;
extern const struct xfs_nameops xfs_default_nameops;

#endif	/* __XFS_DA_BTREE_H__ */
Commit	Line	Data
2bd0ea18	1	/*
f302e9e4	2	* Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
88b32f06	3	* Copyright (c) 2013 Red Hat, Inc.
f302e9e4	4	* All Rights Reserved.
5000d01d	5	*
f302e9e4 NS	6	* This program is free software; you can redistribute it and/or
f302e9e4 NS	7	* modify it under the terms of the GNU General Public License as
2bd0ea18	8	* published by the Free Software Foundation.
5000d01d	9	*
f302e9e4 NS	10	* This program is distributed in the hope that it would be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
5000d01d	14	*
f302e9e4 NS	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write the Free Software Foundation,
	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
2bd0ea18 NS	18	*/
2bd0ea18 NS	19	#ifndef __XFS_DA_BTREE_H__
dfc130f3	20	#define __XFS_DA_BTREE_H__
2bd0ea18	21
6f530e9a	22	struct xfs_defer_ops;
2bd0ea18	23	struct xfs_inode;
2bd0ea18 NS	24	struct xfs_trans;
2bd0ea18 NS	25	struct zone;
ff105f75 DC	26	struct xfs_dir_ops;
	27
	28	/*
	29	* Directory/attribute geometry information. There will be one of these for each
	30	* data fork type, and it will be passed around via the xfs_da_args. Global
	31	* structures will be attached to the xfs_mount.
	32	*/
	33	struct xfs_da_geometry {
	34	int blksize; /* da block size in bytes */
	35	int fsbcount; /* da block size in filesystem blocks */
	36	uint8_t fsblog; /* log2 of _filesystem_ block size */
	37	uint8_t blklog; /* log2 of da block size */
	38	uint node_ents; /* # of entries in a danode */
	39	int magicpct; /* 37% of block size in bytes */
	40	xfs_dablk_t datablk; /* blockno of dir data v2 */
	41	xfs_dablk_t leafblk; /* blockno of leaf data v2 */
	42	xfs_dablk_t freeblk; /* blockno of free data v2 */
	43	};
2bd0ea18	44
2bd0ea18 NS	45	/*========================================================================
	46	* Btree searching and modification structure definitions.
	47	========================================================================/
	48
51ca7008 BN	49	/*
	50	* Search comparison results
	51	*/
	52	enum xfs_dacmp {
	53	XFS_CMP_DIFFERENT, /* names are completely different */
	54	XFS_CMP_EXACT, /* names are exactly the same */
	55	XFS_CMP_CASE /* names are same but differ in case */
	56	};
	57
2bd0ea18 NS	58	/*
	59	* Structure to ease passing around component names.
	60	*/
	61	typedef struct xfs_da_args {
ff105f75	62	struct xfs_da_geometry geo; / da block geometry */
4a492e72	63	const uint8_t name; / string (maybe not NULL terminated) */
2bd0ea18	64	int namelen; /* length of string (maybe no NULL) */
4a492e72 DW	65	uint8_t filetype; /* filetype of inode for directories */
4a492e72 DW	66	uint8_t value; / set of bytes (maybe contain NULLs) */
2bd0ea18 NS	67	int valuelen; /* length of value */
	68	int flags; /* argument flags (eg: ATTR_NOCREATE) */
	69	xfs_dahash_t hashval; /* hash value of name */
	70	xfs_ino_t inumber; /* input/output inode number */
	71	struct xfs_inode dp; / directory inode to manipulate */
	72	xfs_fsblock_t firstblock; / ptr to firstblock for bmap calls */
f33cea1a	73	struct xfs_defer_ops dfops; / ptr to freelist for bmap_finish */
2bd0ea18 NS	74	struct xfs_trans trans; / current trans (changes over time) */
	75	xfs_extlen_t total; /* total blocks needed, for 1st bmap */
	76	int whichfork; /* data or attribute fork */
	77	xfs_dablk_t blkno; /* blkno of attr leaf of interest */
	78	int index; /* index of attr of interest in blk */
	79	xfs_dablk_t rmtblkno; /* remote attr value starting blkno */
	80	int rmtblkcnt; /* remote attr value block count */
ff105f75	81	int rmtvaluelen; /* remote attr value length in bytes */
2bd0ea18 NS	82	xfs_dablk_t blkno2; /* blkno of 2nd attr leaf of interest */
	83	int index2; /* index of 2nd attr in blk */
	84	xfs_dablk_t rmtblkno2; /* remote attr value starting blkno */
	85	int rmtblkcnt2; /* remote attr value block count */
ff105f75	86	int rmtvaluelen2; /* remote attr value length in bytes */
5e656dbb	87	int op_flags; /* operation flags */
51ca7008	88	enum xfs_dacmp cmpresult; /* name compare result for lookups */
2bd0ea18 NS	89	} xfs_da_args_t;
2bd0ea18 NS	90
5e656dbb BN	91	/*
	92	* Operation flags:
	93	*/
	94	#define XFS_DA_OP_JUSTCHECK 0x0001 /* check for ok with no space */
	95	#define XFS_DA_OP_RENAME 0x0002 /* this is an atomic rename op */
	96	#define XFS_DA_OP_ADDNAME 0x0004 /* this is an add operation */
	97	#define XFS_DA_OP_OKNOENT 0x0008 /* lookup/add op, ENOENT ok, else die */
	98	#define XFS_DA_OP_CILOOKUP 0x0010 /* lookup to return CI name if found */
	99
56b2de80 DC	100	#define XFS_DA_OP_FLAGS \
	101	{ XFS_DA_OP_JUSTCHECK, "JUSTCHECK" }, \
	102	{ XFS_DA_OP_RENAME, "RENAME" }, \
	103	{ XFS_DA_OP_ADDNAME, "ADDNAME" }, \
	104	{ XFS_DA_OP_OKNOENT, "OKNOENT" }, \
	105	{ XFS_DA_OP_CILOOKUP, "CILOOKUP" }
	106
2bd0ea18 NS	107	/*
	108	* Storage for holding state during Btree searches and split/join ops.
	109	*
	110	* Only need space for 5 intermediate nodes. With a minimum of 62-way
	111	* fanout to the Btree, we can support over 900 million directory blocks,
	112	* which is slightly more than enough.
	113	*/
	114	typedef struct xfs_da_state_blk {
a2ceac1f	115	struct xfs_buf bp; / buffer containing block */
2bd0ea18	116	xfs_dablk_t blkno; /* filesystem blkno of buffer */
6bef826c	117	xfs_daddr_t disk_blkno; /* on-disk blkno (in BBs) of buffer */
2bd0ea18 NS	118	int index; /* relevant index into block */
	119	xfs_dahash_t hashval; /* last hash value in block */
	120	int magic; /* blk's magic number, ie: blk type */
	121	} xfs_da_state_blk_t;
	122
	123	typedef struct xfs_da_state_path {
	124	int active; /* number of active levels */
	125	xfs_da_state_blk_t blk[XFS_DA_NODE_MAXDEPTH];
	126	} xfs_da_state_path_t;
	127
	128	typedef struct xfs_da_state {
	129	xfs_da_args_t args; / filename arguments */
	130	struct xfs_mount mp; / filesystem mount point */
2bd0ea18 NS	131	xfs_da_state_path_t path; /* search/split paths */
2bd0ea18 NS	132	xfs_da_state_path_t altpath; /* alternate path for join */
32a82561 NS	133	unsigned char inleaf; /* insert into 1->lf, 0->splf */
	134	unsigned char extravalid; /* T/F: extrablk is in use */
	135	unsigned char extraafter; /* T/F: extrablk is after new */
56b2de80	136	xfs_da_state_blk_t extrablk; /* for double-splits on leaves */
2bd0ea18 NS	137	/* for dirv2 extrablk is data */
	138	} xfs_da_state_t;
	139
	140	/*
	141	* Utility macros to aid in logging changed structure fields.
	142	*/
	143	#define XFS_DA_LOGOFF(BASE, ADDR) ((char )(ADDR) - (char )(BASE))
	144	#define XFS_DA_LOGRANGE(BASE, ADDR, SIZE) \
	145	(uint)(XFS_DA_LOGOFF(BASE, ADDR)), \
	146	(uint)(XFS_DA_LOGOFF(BASE, ADDR)+(SIZE)-1)
	147
51ca7008 BN	148	/*
	149	* Name ops for directory and/or attr name operations
	150	*/
	151	struct xfs_nameops {
5e656dbb	152	xfs_dahash_t (hashname)(struct xfs_name );
56b2de80 DC	153	enum xfs_dacmp (compname)(struct xfs_da_args ,
56b2de80 DC	154	const unsigned char *, int);
51ca7008 BN	155	};
51ca7008 BN	156
836f654f	157
2bd0ea18	158	/*========================================================================
5e656dbb	159	* Function prototypes.
2bd0ea18 NS	160	========================================================================/
	161
	162	/*
	163	* Routines used for growing the Btree.
	164	*/
88b32f06 DC	165	int xfs_da3_node_create(struct xfs_da_args *args, xfs_dablk_t blkno,
	166	int level, struct xfs_buf **bpp, int whichfork);
	167	int xfs_da3_split(xfs_da_state_t *state);
2bd0ea18 NS	168
	169	/*
	170	* Routines used for shrinking the Btree.
	171	*/
88b32f06 DC	172	int xfs_da3_join(xfs_da_state_t *state);
	173	void xfs_da3_fixhashpath(struct xfs_da_state *state,
	174	struct xfs_da_state_path *path_to_to_fix);
2bd0ea18 NS	175
	176	/*
	177	* Routines used for finding things in the Btree.
	178	*/
88b32f06 DC	179	int xfs_da3_node_lookup_int(xfs_da_state_t state, int result);
88b32f06 DC	180	int xfs_da3_path_shift(xfs_da_state_t state, xfs_da_state_path_t path,
2bd0ea18 NS	181	int forward, int release, int *result);
	182	/*
	183	* Utility routines.
	184	*/
88b32f06	185	int xfs_da3_blk_link(xfs_da_state_t state, xfs_da_state_blk_t old_blk,
2bd0ea18	186	xfs_da_state_blk_t *new_blk);
88b32f06	187	int xfs_da3_node_read(struct xfs_trans tp, struct xfs_inode dp,
a2ceac1f DC	188	xfs_dablk_t bno, xfs_daddr_t mappedbno,
a2ceac1f DC	189	struct xfs_buf **bpp, int which_fork);
2bd0ea18 NS	190
	191	/*
	192	* Utility routines.
	193	*/
	194	int xfs_da_grow_inode(xfs_da_args_t args, xfs_dablk_t new_blkno);
a2ceac1f DC	195	int xfs_da_grow_inode_int(struct xfs_da_args args, xfs_fileoff_t bno,
a2ceac1f DC	196	int count);
2bd0ea18 NS	197	int xfs_da_get_buf(struct xfs_trans trans, struct xfs_inode dp,
2bd0ea18 NS	198	xfs_dablk_t bno, xfs_daddr_t mappedbno,
a2ceac1f	199	struct xfs_buf **bp, int whichfork);
2bd0ea18 NS	200	int xfs_da_read_buf(struct xfs_trans trans, struct xfs_inode dp,
2bd0ea18 NS	201	xfs_dablk_t bno, xfs_daddr_t mappedbno,
a2ceac1f DC	202	struct xfs_buf **bpp, int whichfork,
a2ceac1f DC	203	const struct xfs_buf_ops *ops);
3a65062f	204	int xfs_da_reada_buf(struct xfs_inode *dp, xfs_dablk_t bno,
ff105f75 DC	205	xfs_daddr_t mapped_bno, int whichfork,
ff105f75 DC	206	const struct xfs_buf_ops *ops);
2bd0ea18	207	int xfs_da_shrink_inode(xfs_da_args_t *args, xfs_dablk_t dead_blkno,
a2ceac1f	208	struct xfs_buf *dead_buf);
2bd0ea18	209
4a492e72	210	uint xfs_da_hashname(const uint8_t *name_string, int name_length);
5e656dbb	211	enum xfs_dacmp xfs_da_compname(struct xfs_da_args *args,
56b2de80	212	const unsigned char *name, int len);
5e656dbb	213
51ca7008	214
2bd0ea18 NS	215	xfs_da_state_t *xfs_da_state_alloc(void);
2bd0ea18 NS	216	void xfs_da_state_free(xfs_da_state_t *state);
2bd0ea18	217
836f654f	218	extern struct kmem_zone *xfs_da_state_zone;
56b2de80	219	extern const struct xfs_nameops xfs_default_nameops;
2bd0ea18 NS	220
2bd0ea18 NS	221	#endif /* __XFS_DA_BTREE_H__ */