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