]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - libxfs/xfs_dir2_priv.h
xfsprogs: Release v6.15.0
[thirdparty/xfsprogs-dev.git] / libxfs / xfs_dir2_priv.h
CommitLineData
7acf15bf 1/* SPDX-License-Identifier: GPL-2.0 */
a2ceac1f
DC
2/*
3 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
a2ceac1f
DC
5 */
6#ifndef __XFS_DIR2_PRIV_H__
7#define __XFS_DIR2_PRIV_H__
8
494434d7
DC
9struct dir_context;
10
bd045c51
CH
11/*
12 * In-core version of the leaf and free block headers to abstract the
13 * differences in the v2 and v3 disk format of the headers.
14 */
15struct xfs_dir3_icleaf_hdr {
16 uint32_t forw;
17 uint32_t back;
18 uint16_t magic;
19 uint16_t count;
20 uint16_t stale;
a2279497
CH
21
22 /*
23 * Pointer to the on-disk format entries, which are behind the
24 * variable size (v4 vs v5) header in the on-disk block.
25 */
26 struct xfs_dir2_leaf_entry *ents;
bd045c51
CH
27};
28
29struct xfs_dir3_icfree_hdr {
30 uint32_t magic;
31 uint32_t firstdb;
32 uint32_t nvalid;
33 uint32_t nused;
cb5d1930
CH
34
35 /*
36 * Pointer to the on-disk format entries, which are behind the
37 * variable size (v4 vs v5) header in the on-disk block.
38 */
39 __be16 *bests;
bd045c51
CH
40};
41
a2ceac1f 42/* xfs_dir2.c */
c331b654 43xfs_dahash_t xfs_ascii_ci_hashname(const struct xfs_name *name);
e169cc9b
CH
44enum xfs_dacmp xfs_ascii_ci_compname(struct xfs_da_args *args,
45 const unsigned char *name, int len);
a2ceac1f
DC
46extern int xfs_dir2_grow_inode(struct xfs_da_args *args, int space,
47 xfs_dir2_db_t *dbp);
a2ceac1f
DC
48extern int xfs_dir_cilookup_result(struct xfs_da_args *args,
49 const unsigned char *name, int len);
50
494434d7 51
a2ceac1f 52/* xfs_dir2_block.c */
482abce5
DW
53int xfs_dir3_block_read(struct xfs_trans *tp, struct xfs_inode *dp,
54 xfs_ino_t owner, struct xfs_buf **bpp);
a2ceac1f 55extern int xfs_dir2_block_addname(struct xfs_da_args *args);
a2ceac1f
DC
56extern int xfs_dir2_block_lookup(struct xfs_da_args *args);
57extern int xfs_dir2_block_removename(struct xfs_da_args *args);
58extern int xfs_dir2_block_replace(struct xfs_da_args *args);
59extern int xfs_dir2_leaf_to_block(struct xfs_da_args *args,
60 struct xfs_buf *lbp, struct xfs_buf *dbp);
61
62/* xfs_dir2_data.c */
04f6f354
CH
63struct xfs_dir2_data_free *xfs_dir2_data_bestfree_p(struct xfs_mount *mp,
64 struct xfs_dir2_data_hdr *hdr);
823711f2
CH
65__be16 *xfs_dir2_data_entry_tag_p(struct xfs_mount *mp,
66 struct xfs_dir2_data_entry *dep);
28e6e614
CH
67uint8_t xfs_dir2_data_get_ftype(struct xfs_mount *mp,
68 struct xfs_dir2_data_entry *dep);
69void xfs_dir2_data_put_ftype(struct xfs_mount *mp,
70 struct xfs_dir2_data_entry *dep, uint8_t ftype);
271a654f 71
a2ceac1f 72#ifdef DEBUG
bc01119d 73extern void xfs_dir3_data_check(struct xfs_inode *dp, struct xfs_buf *bp);
a2ceac1f 74#else
90ea28c3 75#define xfs_dir3_data_check(dp,bp)
a2ceac1f
DC
76#endif
77
bc01119d
DW
78extern xfs_failaddr_t __xfs_dir3_data_check(struct xfs_inode *dp,
79 struct xfs_buf *bp);
5f356ae6 80int xfs_dir3_data_read(struct xfs_trans *tp, struct xfs_inode *dp,
72386ff0
DW
81 xfs_ino_t owner, xfs_dablk_t bno, unsigned int flags,
82 struct xfs_buf **bpp);
c6c4bbf3
CH
83int xfs_dir3_data_readahead(struct xfs_inode *dp, xfs_dablk_t bno,
84 unsigned int flags);
a2ceac1f
DC
85
86extern struct xfs_dir2_data_free *
87xfs_dir2_data_freeinsert(struct xfs_dir2_data_hdr *hdr,
ff105f75
DC
88 struct xfs_dir2_data_free *bf, struct xfs_dir2_data_unused *dup,
89 int *loghead);
693fc8f6 90extern int xfs_dir3_data_init(struct xfs_da_args *args, xfs_dir2_db_t blkno,
a2ceac1f 91 struct xfs_buf **bpp);
a2ceac1f
DC
92
93/* xfs_dir2_leaf.c */
9db68faf
CH
94void xfs_dir2_leaf_hdr_from_disk(struct xfs_mount *mp,
95 struct xfs_dir3_icleaf_hdr *to, struct xfs_dir2_leaf *from);
7adfbcf6
CH
96void xfs_dir2_leaf_hdr_to_disk(struct xfs_mount *mp, struct xfs_dir2_leaf *to,
97 struct xfs_dir3_icleaf_hdr *from);
0939d90b 98int xfs_dir3_leaf_read(struct xfs_trans *tp, struct xfs_inode *dp,
17e0d66d 99 xfs_ino_t owner, xfs_dablk_t fbno, struct xfs_buf **bpp);
5fcb9cbc 100int xfs_dir3_leafn_read(struct xfs_trans *tp, struct xfs_inode *dp,
17e0d66d 101 xfs_ino_t owner, xfs_dablk_t fbno, struct xfs_buf **bpp);
a2ceac1f
DC
102extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
103 struct xfs_buf *dbp);
104extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
65b80c98
DC
105extern void xfs_dir3_leaf_compact(struct xfs_da_args *args,
106 struct xfs_dir3_icleaf_hdr *leafhdr, struct xfs_buf *bp);
107extern void xfs_dir3_leaf_compact_x1(struct xfs_dir3_icleaf_hdr *leafhdr,
108 struct xfs_dir2_leaf_entry *ents, int *indexp,
a2ceac1f 109 int *lowstalep, int *highstalep, int *lowlogp, int *highlogp);
65b80c98 110extern int xfs_dir3_leaf_get_buf(struct xfs_da_args *args, xfs_dir2_db_t bno,
4a492e72 111 struct xfs_buf **bpp, uint16_t magic);
ff105f75 112extern void xfs_dir3_leaf_log_ents(struct xfs_da_args *args,
a2279497
CH
113 struct xfs_dir3_icleaf_hdr *hdr, struct xfs_buf *bp, int first,
114 int last);
ff105f75 115extern void xfs_dir3_leaf_log_header(struct xfs_da_args *args,
a2ceac1f
DC
116 struct xfs_buf *bp);
117extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
118extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
119extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
120extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
121 struct xfs_buf *lbp);
122extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
123 struct xfs_buf *lbp, xfs_dir2_db_t db);
124extern struct xfs_dir2_leaf_entry *
65b80c98
DC
125xfs_dir3_leaf_find_entry(struct xfs_dir3_icleaf_hdr *leafhdr,
126 struct xfs_dir2_leaf_entry *ents, int index, int compact,
127 int lowstale, int highstale, int *lfloglow, int *lfloghigh);
a2ceac1f
DC
128extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
129
bc01119d 130extern xfs_failaddr_t xfs_dir3_leaf_check_int(struct xfs_mount *mp,
f5e56725
DC
131 struct xfs_dir3_icleaf_hdr *hdr, struct xfs_dir2_leaf *leaf,
132 bool expensive_checks);
65b80c98 133
a2ceac1f 134/* xfs_dir2_node.c */
61e2142e
CH
135void xfs_dir2_free_hdr_from_disk(struct xfs_mount *mp,
136 struct xfs_dir3_icfree_hdr *to, struct xfs_dir2_free *from);
a2ceac1f
DC
137extern int xfs_dir2_leaf_to_node(struct xfs_da_args *args,
138 struct xfs_buf *lbp);
94ffb80a 139extern xfs_dahash_t xfs_dir2_leaf_lasthash(struct xfs_inode *dp,
ff105f75 140 struct xfs_buf *bp, int *count);
a2ceac1f
DC
141extern int xfs_dir2_leafn_lookup_int(struct xfs_buf *bp,
142 struct xfs_da_args *args, int *indexp,
143 struct xfs_da_state *state);
ff105f75 144extern int xfs_dir2_leafn_order(struct xfs_inode *dp, struct xfs_buf *leaf1_bp,
a2ceac1f
DC
145 struct xfs_buf *leaf2_bp);
146extern int xfs_dir2_leafn_split(struct xfs_da_state *state,
147 struct xfs_da_state_blk *oldblk, struct xfs_da_state_blk *newblk);
148extern int xfs_dir2_leafn_toosmall(struct xfs_da_state *state, int *action);
149extern void xfs_dir2_leafn_unbalance(struct xfs_da_state *state,
150 struct xfs_da_state_blk *drop_blk,
151 struct xfs_da_state_blk *save_blk);
152extern int xfs_dir2_node_addname(struct xfs_da_args *args);
153extern int xfs_dir2_node_lookup(struct xfs_da_args *args);
154extern int xfs_dir2_node_removename(struct xfs_da_args *args);
155extern int xfs_dir2_node_replace(struct xfs_da_args *args);
156extern int xfs_dir2_node_trim_free(struct xfs_da_args *args, xfs_fileoff_t fo,
157 int *rvalp);
92244687
DW
158int xfs_dir2_free_read(struct xfs_trans *tp, struct xfs_inode *dp,
159 xfs_ino_t owner, xfs_dablk_t fbno, struct xfs_buf **bpp);
a2ceac1f
DC
160
161/* xfs_dir2_sf.c */
e96bd2d3
CH
162xfs_ino_t xfs_dir2_sf_get_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
163 struct xfs_dir2_sf_entry *sfep);
8a7190bd
CH
164xfs_ino_t xfs_dir2_sf_get_parent_ino(struct xfs_dir2_sf_hdr *hdr);
165void xfs_dir2_sf_put_parent_ino(struct xfs_dir2_sf_hdr *hdr, xfs_ino_t ino);
d49d4ff5
CH
166uint8_t xfs_dir2_sf_get_ftype(struct xfs_mount *mp,
167 struct xfs_dir2_sf_entry *sfep);
660836c9
CH
168struct xfs_dir2_sf_entry *xfs_dir2_sf_nextentry(struct xfs_mount *mp,
169 struct xfs_dir2_sf_hdr *hdr, struct xfs_dir2_sf_entry *sfep);
a2ceac1f
DC
170extern int xfs_dir2_block_sfsize(struct xfs_inode *dp,
171 struct xfs_dir2_data_hdr *block, struct xfs_dir2_sf_hdr *sfhp);
172extern int xfs_dir2_block_to_sf(struct xfs_da_args *args, struct xfs_buf *bp,
173 int size, xfs_dir2_sf_hdr_t *sfhp);
174extern int xfs_dir2_sf_addname(struct xfs_da_args *args);
175extern int xfs_dir2_sf_create(struct xfs_da_args *args, xfs_ino_t pino);
a2ceac1f
DC
176extern int xfs_dir2_sf_lookup(struct xfs_da_args *args);
177extern int xfs_dir2_sf_removename(struct xfs_da_args *args);
178extern int xfs_dir2_sf_replace(struct xfs_da_args *args);
7c5d4f92
DW
179xfs_failaddr_t xfs_dir2_sf_verify(struct xfs_mount *mp,
180 struct xfs_dir2_sf_hdr *sfp, int64_t size);
846e459c
DW
181int xfs_dir2_sf_entsize(struct xfs_mount *mp,
182 struct xfs_dir2_sf_hdr *hdr, int len);
183void xfs_dir2_sf_put_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
184 struct xfs_dir2_sf_entry *sfep, xfs_ino_t ino);
185void xfs_dir2_sf_put_ftype(struct xfs_mount *mp,
186 struct xfs_dir2_sf_entry *sfep, uint8_t ftype);
a2ceac1f 187
494434d7 188/* xfs_dir2_readdir.c */
581ce8a5
DW
189extern int xfs_readdir(struct xfs_trans *tp, struct xfs_inode *dp,
190 struct dir_context *ctx, size_t bufsize);
494434d7 191
6540c8ae 192static inline unsigned int
193xfs_dir2_data_unusedsize(
194 unsigned int len)
195{
196 return round_up(len, XFS_DIR2_DATA_ALIGN);
197}
198
e778c95d
CH
199static inline unsigned int
200xfs_dir2_data_entsize(
201 struct xfs_mount *mp,
202 unsigned int namelen)
203{
204 unsigned int len;
205
206 len = offsetof(struct xfs_dir2_data_entry, name[0]) + namelen +
207 sizeof(xfs_dir2_data_off_t) /* tag */;
94541a16 208 if (xfs_has_ftype(mp))
e778c95d
CH
209 len += sizeof(uint8_t);
210 return round_up(len, XFS_DIR2_DATA_ALIGN);
211}
212
c331b654
DW
213xfs_dahash_t xfs_dir2_hashname(struct xfs_mount *mp,
214 const struct xfs_name *name);
846e459c
DW
215enum xfs_dacmp xfs_dir2_compname(struct xfs_da_args *args,
216 const unsigned char *name, int len);
e169cc9b 217
a2ceac1f 218#endif /* __XFS_DIR2_PRIV_H__ */