1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc. 4 * All Rights Reserved. 5 */ 6 #ifndef __XFS_DIR2_H__ 7 #define __XFS_DIR2_H__ 8 9 #include "xfs_da_format.h" 10 #include "xfs_da_btree.h" 11 12 struct xfs_da_args; 13 struct xfs_inode; 14 struct xfs_mount; 15 struct xfs_trans; 16 struct xfs_dir2_sf_hdr; 17 struct xfs_dir2_sf_entry; 18 struct xfs_dir2_data_hdr; 19 struct xfs_dir2_data_entry; 20 struct xfs_dir2_data_unused; 21 struct xfs_dir3_icfree_hdr; 22 struct xfs_dir3_icleaf_hdr; 23 24 extern struct xfs_name xfs_name_dotdot; 25 26 /* 27 * Convert inode mode to directory entry filetype 28 */ 29 extern unsigned char xfs_mode_to_ftype(int mode); 30 31 /* 32 * directory operations vector for encode/decode routines 33 */ 34 struct xfs_dir_ops { 35 int (*data_entsize)(int len); 36 uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep); 37 void (*data_put_ftype)(struct xfs_dir2_data_entry *dep, 38 uint8_t ftype); 39 __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep); 40 struct xfs_dir2_data_free * 41 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr); 42 43 xfs_dir2_data_aoff_t data_dot_offset; 44 xfs_dir2_data_aoff_t data_dotdot_offset; 45 xfs_dir2_data_aoff_t data_first_offset; 46 size_t data_entry_offset; 47 48 struct xfs_dir2_data_entry * 49 (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr); 50 struct xfs_dir2_data_entry * 51 (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr); 52 struct xfs_dir2_data_entry * 53 (*data_entry_p)(struct xfs_dir2_data_hdr *hdr); 54 struct xfs_dir2_data_unused * 55 (*data_unused_p)(struct xfs_dir2_data_hdr *hdr); 56 }; 57 58 extern const struct xfs_dir_ops * 59 xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp); 60 61 /* 62 * Generic directory interface routines 63 */ 64 extern void xfs_dir_startup(void); 65 extern int xfs_da_mount(struct xfs_mount *mp); 66 extern void xfs_da_unmount(struct xfs_mount *mp); 67 68 extern int xfs_dir_isempty(struct xfs_inode *dp); 69 extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp, 70 struct xfs_inode *pdp); 71 extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp, 72 struct xfs_name *name, xfs_ino_t inum, 73 xfs_extlen_t tot); 74 extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp, 75 struct xfs_name *name, xfs_ino_t *inum, 76 struct xfs_name *ci_name); 77 extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp, 78 struct xfs_name *name, xfs_ino_t ino, 79 xfs_extlen_t tot); 80 extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp, 81 struct xfs_name *name, xfs_ino_t inum, 82 xfs_extlen_t tot); 83 extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp, 84 struct xfs_name *name); 85 86 /* 87 * Direct call from the bmap code, bypassing the generic directory layer. 88 */ 89 extern int xfs_dir2_sf_to_block(struct xfs_da_args *args); 90 91 /* 92 * Interface routines used by userspace utilities 93 */ 94 extern int xfs_dir2_isblock(struct xfs_da_args *args, int *r); 95 extern int xfs_dir2_isleaf(struct xfs_da_args *args, int *r); 96 extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db, 97 struct xfs_buf *bp); 98 99 extern void xfs_dir2_data_freescan_int(struct xfs_da_geometry *geo, 100 const struct xfs_dir_ops *ops, 101 struct xfs_dir2_data_hdr *hdr, int *loghead); 102 extern void xfs_dir2_data_freescan(struct xfs_inode *dp, 103 struct xfs_dir2_data_hdr *hdr, int *loghead); 104 extern void xfs_dir2_data_log_entry(struct xfs_da_args *args, 105 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep); 106 extern void xfs_dir2_data_log_header(struct xfs_da_args *args, 107 struct xfs_buf *bp); 108 extern void xfs_dir2_data_log_unused(struct xfs_da_args *args, 109 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup); 110 extern void xfs_dir2_data_make_free(struct xfs_da_args *args, 111 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset, 112 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp); 113 extern int xfs_dir2_data_use_free(struct xfs_da_args *args, 114 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup, 115 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len, 116 int *needlogp, int *needscanp); 117 118 extern struct xfs_dir2_data_free *xfs_dir2_data_freefind( 119 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf, 120 struct xfs_dir2_data_unused *dup); 121 122 extern int xfs_dir_ino_validate(struct xfs_mount *mp, xfs_ino_t ino); 123 124 extern const struct xfs_buf_ops xfs_dir3_block_buf_ops; 125 extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops; 126 extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops; 127 extern const struct xfs_buf_ops xfs_dir3_free_buf_ops; 128 extern const struct xfs_buf_ops xfs_dir3_data_buf_ops; 129 130 /* 131 * Directory offset/block conversion functions. 132 * 133 * DB blocks here are logical directory block numbers, not filesystem blocks. 134 */ 135 136 /* 137 * Convert dataptr to byte in file space 138 */ 139 static inline xfs_dir2_off_t 140 xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp) 141 { 142 return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG; 143 } 144 145 /* 146 * Convert byte in file space to dataptr. It had better be aligned. 147 */ 148 static inline xfs_dir2_dataptr_t 149 xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by) 150 { 151 return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG); 152 } 153 154 /* 155 * Convert byte in space to (DB) block 156 */ 157 static inline xfs_dir2_db_t 158 xfs_dir2_byte_to_db(struct xfs_da_geometry *geo, xfs_dir2_off_t by) 159 { 160 return (xfs_dir2_db_t)(by >> geo->blklog); 161 } 162 163 /* 164 * Convert dataptr to a block number 165 */ 166 static inline xfs_dir2_db_t 167 xfs_dir2_dataptr_to_db(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp) 168 { 169 return xfs_dir2_byte_to_db(geo, xfs_dir2_dataptr_to_byte(dp)); 170 } 171 172 /* 173 * Convert byte in space to offset in a block 174 */ 175 static inline xfs_dir2_data_aoff_t 176 xfs_dir2_byte_to_off(struct xfs_da_geometry *geo, xfs_dir2_off_t by) 177 { 178 return (xfs_dir2_data_aoff_t)(by & (geo->blksize - 1)); 179 } 180 181 /* 182 * Convert dataptr to a byte offset in a block 183 */ 184 static inline xfs_dir2_data_aoff_t 185 xfs_dir2_dataptr_to_off(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp) 186 { 187 return xfs_dir2_byte_to_off(geo, xfs_dir2_dataptr_to_byte(dp)); 188 } 189 190 /* 191 * Convert block and offset to byte in space 192 */ 193 static inline xfs_dir2_off_t 194 xfs_dir2_db_off_to_byte(struct xfs_da_geometry *geo, xfs_dir2_db_t db, 195 xfs_dir2_data_aoff_t o) 196 { 197 return ((xfs_dir2_off_t)db << geo->blklog) + o; 198 } 199 200 /* 201 * Convert block (DB) to block (dablk) 202 */ 203 static inline xfs_dablk_t 204 xfs_dir2_db_to_da(struct xfs_da_geometry *geo, xfs_dir2_db_t db) 205 { 206 return (xfs_dablk_t)(db << (geo->blklog - geo->fsblog)); 207 } 208 209 /* 210 * Convert byte in space to (DA) block 211 */ 212 static inline xfs_dablk_t 213 xfs_dir2_byte_to_da(struct xfs_da_geometry *geo, xfs_dir2_off_t by) 214 { 215 return xfs_dir2_db_to_da(geo, xfs_dir2_byte_to_db(geo, by)); 216 } 217 218 /* 219 * Convert block and offset to dataptr 220 */ 221 static inline xfs_dir2_dataptr_t 222 xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry *geo, xfs_dir2_db_t db, 223 xfs_dir2_data_aoff_t o) 224 { 225 return xfs_dir2_byte_to_dataptr(xfs_dir2_db_off_to_byte(geo, db, o)); 226 } 227 228 /* 229 * Convert block (dablk) to block (DB) 230 */ 231 static inline xfs_dir2_db_t 232 xfs_dir2_da_to_db(struct xfs_da_geometry *geo, xfs_dablk_t da) 233 { 234 return (xfs_dir2_db_t)(da >> (geo->blklog - geo->fsblog)); 235 } 236 237 /* 238 * Convert block (dablk) to byte offset in space 239 */ 240 static inline xfs_dir2_off_t 241 xfs_dir2_da_to_byte(struct xfs_da_geometry *geo, xfs_dablk_t da) 242 { 243 return xfs_dir2_db_off_to_byte(geo, xfs_dir2_da_to_db(geo, da), 0); 244 } 245 246 /* 247 * Directory tail pointer accessor functions. Based on block geometry. 248 */ 249 static inline struct xfs_dir2_block_tail * 250 xfs_dir2_block_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_data_hdr *hdr) 251 { 252 return ((struct xfs_dir2_block_tail *) 253 ((char *)hdr + geo->blksize)) - 1; 254 } 255 256 static inline struct xfs_dir2_leaf_tail * 257 xfs_dir2_leaf_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_leaf *lp) 258 { 259 return (struct xfs_dir2_leaf_tail *) 260 ((char *)lp + geo->blksize - 261 sizeof(struct xfs_dir2_leaf_tail)); 262 } 263 264 /* 265 * The Linux API doesn't pass down the total size of the buffer 266 * we read into down to the filesystem. With the filldir concept 267 * it's not needed for correct information, but the XFS dir2 leaf 268 * code wants an estimate of the buffer size to calculate it's 269 * readahead window and size the buffers used for mapping to 270 * physical blocks. 271 * 272 * Try to give it an estimate that's good enough, maybe at some 273 * point we can change the ->readdir prototype to include the 274 * buffer size. For now we use the current glibc buffer size. 275 * musl libc hardcodes 2k and dietlibc uses PAGE_SIZE. 276 */ 277 #define XFS_READDIR_BUFSIZE (32768) 278 279 unsigned char xfs_dir3_get_dtype(struct xfs_mount *mp, uint8_t filetype); 280 void *xfs_dir3_data_endp(struct xfs_da_geometry *geo, 281 struct xfs_dir2_data_hdr *hdr); 282 bool xfs_dir2_namecheck(const void *name, size_t length); 283 284 #endif /* __XFS_DIR2_H__ */ 285