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

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (c) 2000,2002-2003,2005 Silicon Graphics, Inc.
 * Copyright (c) 2013 Red Hat, Inc.
 * All Rights Reserved.
 */
#ifndef __XFS_ATTR_LEAF_H__
#define	__XFS_ATTR_LEAF_H__

struct attrlist;
struct xfs_attr_list_context;
struct xfs_da_args;
struct xfs_da_state;
struct xfs_da_state_blk;
struct xfs_inode;
struct xfs_trans;

/*
 * Incore version of the attribute leaf header.
 */
struct xfs_attr3_icleaf_hdr {
	uint32_t	forw;
	uint32_t	back;
	uint16_t	magic;
	uint16_t	count;
	uint16_t	usedbytes;
	/*
	 * Firstused is 32-bit here instead of 16-bit like the on-disk variant
	 * to support maximum fsb size of 64k without overflow issues throughout
	 * the attr code. Instead, the overflow condition is handled on
	 * conversion to/from disk.
	 */
	uint32_t	firstused;
	__u8		holes;
	struct {
		uint16_t	base;
		uint16_t	size;
	} freemap[XFS_ATTR_LEAF_MAPSIZE];
};

/*========================================================================
 * Function prototypes for the kernel.
 *========================================================================*/

/*
 * Internal routines when attribute fork size < XFS_LITINO(mp).
 */
void	xfs_attr_shortform_create(struct xfs_da_args *args);
void	xfs_attr_shortform_add(struct xfs_da_args *args, int forkoff);
int	xfs_attr_shortform_lookup(struct xfs_da_args *args);
int	xfs_attr_shortform_getvalue(struct xfs_da_args *args);
int	xfs_attr_shortform_to_leaf(struct xfs_da_args *args);
int	xfs_attr_sf_removename(struct xfs_da_args *args);
int	xfs_attr_sf_findname(struct xfs_da_args *args,
			     struct xfs_attr_sf_entry **sfep,
			     unsigned int *basep);
int	xfs_attr_shortform_allfit(struct xfs_buf *bp, struct xfs_inode *dp);
int	xfs_attr_shortform_bytesfit(struct xfs_inode *dp, int bytes);
xfs_failaddr_t xfs_attr_shortform_verify(struct xfs_inode *ip);
void	xfs_attr_fork_remove(struct xfs_inode *ip, struct xfs_trans *tp);

/*
 * Internal routines when attribute fork size == XFS_LBSIZE(mp).
 */
int	xfs_attr3_leaf_to_node(struct xfs_da_args *args);
int	xfs_attr3_leaf_to_shortform(struct xfs_buf *bp,
				   struct xfs_da_args *args, int forkoff);
int	xfs_attr3_leaf_clearflag(struct xfs_da_args *args);
int	xfs_attr3_leaf_setflag(struct xfs_da_args *args);
int	xfs_attr3_leaf_flipflags(struct xfs_da_args *args);

/*
 * Routines used for growing the Btree.
 */
int	xfs_attr3_leaf_split(struct xfs_da_state *state,
				   struct xfs_da_state_blk *oldblk,
				   struct xfs_da_state_blk *newblk);
int	xfs_attr3_leaf_lookup_int(struct xfs_buf *leaf,
					struct xfs_da_args *args);
int	xfs_attr3_leaf_getvalue(struct xfs_buf *bp, struct xfs_da_args *args);
int	xfs_attr3_leaf_add(struct xfs_buf *leaf_buffer,
				 struct xfs_da_args *args);
int	xfs_attr3_leaf_remove(struct xfs_buf *leaf_buffer,
				    struct xfs_da_args *args);
int	xfs_attr3_leaf_list_int(struct xfs_buf *bp,
				struct xfs_attr_list_context *context);

/*
 * Routines used for shrinking the Btree.
 */
int	xfs_attr3_leaf_toosmall(struct xfs_da_state *state, int *retval);
void	xfs_attr3_leaf_unbalance(struct xfs_da_state *state,
				       struct xfs_da_state_blk *drop_blk,
				       struct xfs_da_state_blk *save_blk);
/*
 * Utility routines.
 */
xfs_dahash_t	xfs_attr_leaf_lasthash(struct xfs_buf *bp, int *count);
int	xfs_attr_leaf_order(struct xfs_buf *leaf1_bp,
				   struct xfs_buf *leaf2_bp);
int	xfs_attr_leaf_newentsize(struct xfs_da_args *args, int *local);
int	xfs_attr3_leaf_read(struct xfs_trans *tp, struct xfs_inode *dp,
			xfs_dablk_t bno, struct xfs_buf **bpp);
void	xfs_attr3_leaf_hdr_from_disk(struct xfs_da_geometry *geo,
				     struct xfs_attr3_icleaf_hdr *to,
				     struct xfs_attr_leafblock *from);
void	xfs_attr3_leaf_hdr_to_disk(struct xfs_da_geometry *geo,
				   struct xfs_attr_leafblock *to,
				   struct xfs_attr3_icleaf_hdr *from);

#endif	/* __XFS_ATTR_LEAF_H__ */
Commit	Line	Data
7acf15bf	1	/* SPDX-License-Identifier: GPL-2.0 */
2bd0ea18	2	/*
f302e9e4	3	* Copyright (c) 2000,2002-2003,2005 Silicon Graphics, Inc.
a24374f4	4	* Copyright (c) 2013 Red Hat, Inc.
f302e9e4	5	* All Rights Reserved.
2bd0ea18 NS	6	*/
2bd0ea18 NS	7	#ifndef __XFS_ATTR_LEAF_H__
dfc130f3	8	#define __XFS_ATTR_LEAF_H__
2bd0ea18	9
2bd0ea18	10	struct attrlist;
5e656dbb	11	struct xfs_attr_list_context;
2bd0ea18 NS	12	struct xfs_da_args;
	13	struct xfs_da_state;
	14	struct xfs_da_state_blk;
	15	struct xfs_inode;
	16	struct xfs_trans;
	17
bd045c51 CH	18	/*
	19	* Incore version of the attribute leaf header.
	20	*/
	21	struct xfs_attr3_icleaf_hdr {
	22	uint32_t forw;
	23	uint32_t back;
	24	uint16_t magic;
	25	uint16_t count;
	26	uint16_t usedbytes;
	27	/*
	28	* Firstused is 32-bit here instead of 16-bit like the on-disk variant
	29	* to support maximum fsb size of 64k without overflow issues throughout
	30	* the attr code. Instead, the overflow condition is handled on
	31	* conversion to/from disk.
	32	*/
	33	uint32_t firstused;
	34	__u8 holes;
	35	struct {
	36	uint16_t base;
	37	uint16_t size;
	38	} freemap[XFS_ATTR_LEAF_MAPSIZE];
	39	};
	40
2bd0ea18 NS	41	/*========================================================================
	42	* Function prototypes for the kernel.
	43	========================================================================/
	44
	45	/*
ca86e759	46	* Internal routines when attribute fork size < XFS_LITINO(mp).
2bd0ea18	47	*/
ca86e759 NS	48	void xfs_attr_shortform_create(struct xfs_da_args *args);
ca86e759 NS	49	void xfs_attr_shortform_add(struct xfs_da_args *args, int forkoff);
2bd0ea18 NS	50	int xfs_attr_shortform_lookup(struct xfs_da_args *args);
2bd0ea18 NS	51	int xfs_attr_shortform_getvalue(struct xfs_da_args *args);
c21a5691	52	int xfs_attr_shortform_to_leaf(struct xfs_da_args *args);
f0c4e745	53	int xfs_attr_sf_removename(struct xfs_da_args *args);
11b4b23d AC	54	int xfs_attr_sf_findname(struct xfs_da_args *args,
	55	struct xfs_attr_sf_entry **sfep,
	56	unsigned int *basep);
a2ceac1f	57	int xfs_attr_shortform_allfit(struct xfs_buf bp, struct xfs_inode dp);
b626fb59	58	int xfs_attr_shortform_bytesfit(struct xfs_inode *dp, int bytes);
c7a710b7	59	xfs_failaddr_t xfs_attr_shortform_verify(struct xfs_inode *ip);
a37f46d5	60	void xfs_attr_fork_remove(struct xfs_inode ip, struct xfs_trans tp);
2bd0ea18 NS	61
2bd0ea18 NS	62	/*
5a35bf2c	63	* Internal routines when attribute fork size == XFS_LBSIZE(mp).
2bd0ea18	64	*/
a24374f4 DC	65	int xfs_attr3_leaf_to_node(struct xfs_da_args *args);
a24374f4 DC	66	int xfs_attr3_leaf_to_shortform(struct xfs_buf *bp,
ca86e759	67	struct xfs_da_args *args, int forkoff);
a24374f4 DC	68	int xfs_attr3_leaf_clearflag(struct xfs_da_args *args);
	69	int xfs_attr3_leaf_setflag(struct xfs_da_args *args);
	70	int xfs_attr3_leaf_flipflags(struct xfs_da_args *args);
2bd0ea18 NS	71
	72	/*
	73	* Routines used for growing the Btree.
	74	*/
a24374f4	75	int xfs_attr3_leaf_split(struct xfs_da_state *state,
2bd0ea18 NS	76	struct xfs_da_state_blk *oldblk,
2bd0ea18 NS	77	struct xfs_da_state_blk *newblk);
a24374f4	78	int xfs_attr3_leaf_lookup_int(struct xfs_buf *leaf,
2bd0ea18	79	struct xfs_da_args *args);
a24374f4 DC	80	int xfs_attr3_leaf_getvalue(struct xfs_buf bp, struct xfs_da_args args);
a24374f4 DC	81	int xfs_attr3_leaf_add(struct xfs_buf *leaf_buffer,
2bd0ea18	82	struct xfs_da_args *args);
a24374f4	83	int xfs_attr3_leaf_remove(struct xfs_buf *leaf_buffer,
2bd0ea18	84	struct xfs_da_args *args);
43074fba DW	85	int xfs_attr3_leaf_list_int(struct xfs_buf *bp,
43074fba DW	86	struct xfs_attr_list_context *context);
2bd0ea18 NS	87
	88	/*
	89	* Routines used for shrinking the Btree.
	90	*/
a24374f4 DC	91	int xfs_attr3_leaf_toosmall(struct xfs_da_state state, int retval);
a24374f4 DC	92	void xfs_attr3_leaf_unbalance(struct xfs_da_state *state,
2bd0ea18 NS	93	struct xfs_da_state_blk *drop_blk,
2bd0ea18 NS	94	struct xfs_da_state_blk *save_blk);
2bd0ea18 NS	95	/*
	96	* Utility routines.
	97	*/
a2ceac1f DC	98	xfs_dahash_t xfs_attr_leaf_lasthash(struct xfs_buf bp, int count);
	99	int xfs_attr_leaf_order(struct xfs_buf *leaf1_bp,
	100	struct xfs_buf *leaf2_bp);
ff105f75	101	int xfs_attr_leaf_newentsize(struct xfs_da_args args, int local);
a24374f4	102	int xfs_attr3_leaf_read(struct xfs_trans tp, struct xfs_inode dp,
edf3b3a8	103	xfs_dablk_t bno, struct xfs_buf **bpp);
19ebedcf DC	104	void xfs_attr3_leaf_hdr_from_disk(struct xfs_da_geometry *geo,
19ebedcf DC	105	struct xfs_attr3_icleaf_hdr *to,
a24374f4	106	struct xfs_attr_leafblock *from);
19ebedcf DC	107	void xfs_attr3_leaf_hdr_to_disk(struct xfs_da_geometry *geo,
19ebedcf DC	108	struct xfs_attr_leafblock *to,
658ac3e3	109	struct xfs_attr3_icleaf_hdr *from);
a2ceac1f	110
2bd0ea18	111	#endif /* __XFS_ATTR_LEAF_H__ */