fs/xfs/libxfs/xfs_dir2.h

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