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