fs/xfs/libxfs/xfs_dir2_priv.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_PRIV_H__
   7 #define __XFS_DIR2_PRIV_H__
   8
   9 struct dir_context;
  10
  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  */
  15 struct xfs_dir3_icleaf_hdr {
  16         uint32_t                forw;
  17         uint32_t                back;
  18         uint16_t                magic;
  19         uint16_t                count;
  20         uint16_t                stale;
  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;
  27 };
  28
  29 struct xfs_dir3_icfree_hdr {
  30         uint32_t                magic;
  31         uint32_t                firstdb;
  32         uint32_t                nvalid;
  33         uint32_t                nused;
  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;
  40 };
  41
  42 /* xfs_dir2.c */
  43 xfs_dahash_t xfs_ascii_ci_hashname(const struct xfs_name *name);
  44 enum xfs_dacmp xfs_ascii_ci_compname(struct xfs_da_args *args,
  45                 const unsigned char *name, int len);
  46 extern int xfs_dir2_grow_inode(struct xfs_da_args *args, int space,
  47                                 xfs_dir2_db_t *dbp);
  48 extern int xfs_dir_cilookup_result(struct xfs_da_args *args,
  49                                 const unsigned char *name, int len);
  50
  51
  52 /* xfs_dir2_block.c */
  53 int xfs_dir3_block_read(struct xfs_trans *tp, struct xfs_inode *dp,
  54                 xfs_ino_t owner, struct xfs_buf **bpp);
  55 extern int xfs_dir2_block_addname(struct xfs_da_args *args);
  56 extern int xfs_dir2_block_lookup(struct xfs_da_args *args);
  57 extern int xfs_dir2_block_removename(struct xfs_da_args *args);
  58 extern int xfs_dir2_block_replace(struct xfs_da_args *args);
  59 extern 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 */
  63 struct xfs_dir2_data_free *xfs_dir2_data_bestfree_p(struct xfs_mount *mp,
  64                 struct xfs_dir2_data_hdr *hdr);
  65 __be16 *xfs_dir2_data_entry_tag_p(struct xfs_mount *mp,
  66                 struct xfs_dir2_data_entry *dep);
  67 uint8_t xfs_dir2_data_get_ftype(struct xfs_mount *mp,
  68                 struct xfs_dir2_data_entry *dep);
  69 void xfs_dir2_data_put_ftype(struct xfs_mount *mp,
  70                 struct xfs_dir2_data_entry *dep, uint8_t ftype);
  71
  72 #ifdef DEBUG
  73 extern void xfs_dir3_data_check(struct xfs_inode *dp, struct xfs_buf *bp);
  74 #else
  75 #define xfs_dir3_data_check(dp,bp)
  76 #endif
  77
  78 extern xfs_failaddr_t __xfs_dir3_data_check(struct xfs_inode *dp,
  79                 struct xfs_buf *bp);
  80 int xfs_dir3_data_read(struct xfs_trans *tp, struct xfs_inode *dp,
  81                 xfs_ino_t owner, xfs_dablk_t bno, unsigned int flags,
  82                 struct xfs_buf **bpp);
  83 int xfs_dir3_data_readahead(struct xfs_inode *dp, xfs_dablk_t bno,
  84                 unsigned int flags);
  85
  86 extern struct xfs_dir2_data_free *
  87 xfs_dir2_data_freeinsert(struct xfs_dir2_data_hdr *hdr,
  88                 struct xfs_dir2_data_free *bf, struct xfs_dir2_data_unused *dup,
  89                 int *loghead);
  90 extern int xfs_dir3_data_init(struct xfs_da_args *args, xfs_dir2_db_t blkno,
  91                 struct xfs_buf **bpp);
  92
  93 /* xfs_dir2_leaf.c */
  94 void xfs_dir2_leaf_hdr_from_disk(struct xfs_mount *mp,
  95                 struct xfs_dir3_icleaf_hdr *to, struct xfs_dir2_leaf *from);
  96 void xfs_dir2_leaf_hdr_to_disk(struct xfs_mount *mp, struct xfs_dir2_leaf *to,
  97                 struct xfs_dir3_icleaf_hdr *from);
  98 int xfs_dir3_leaf_read(struct xfs_trans *tp, struct xfs_inode *dp,
  99                 xfs_ino_t owner, xfs_dablk_t fbno, struct xfs_buf **bpp);
 100 int xfs_dir3_leafn_read(struct xfs_trans *tp, struct xfs_inode *dp,
 101                 xfs_ino_t owner, xfs_dablk_t fbno, struct xfs_buf **bpp);
 102 extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
 103                 struct xfs_buf *dbp);
 104 extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
 105 extern void xfs_dir3_leaf_compact(struct xfs_da_args *args,
 106                 struct xfs_dir3_icleaf_hdr *leafhdr, struct xfs_buf *bp);
 107 extern void xfs_dir3_leaf_compact_x1(struct xfs_dir3_icleaf_hdr *leafhdr,
 108                 struct xfs_dir2_leaf_entry *ents, int *indexp,
 109                 int *lowstalep, int *highstalep, int *lowlogp, int *highlogp);
 110 extern int xfs_dir3_leaf_get_buf(struct xfs_da_args *args, xfs_dir2_db_t bno,
 111                 struct xfs_buf **bpp, uint16_t magic);
 112 extern void xfs_dir3_leaf_log_ents(struct xfs_da_args *args,
 113                 struct xfs_dir3_icleaf_hdr *hdr, struct xfs_buf *bp, int first,
 114                 int last);
 115 extern void xfs_dir3_leaf_log_header(struct xfs_da_args *args,
 116                 struct xfs_buf *bp);
 117 extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
 118 extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
 119 extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
 120 extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
 121                 struct xfs_buf *lbp);
 122 extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
 123                 struct xfs_buf *lbp, xfs_dir2_db_t db);
 124 extern struct xfs_dir2_leaf_entry *
 125 xfs_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);
 128 extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
 129
 130 extern xfs_failaddr_t xfs_dir3_leaf_check_int(struct xfs_mount *mp,
 131                 struct xfs_dir3_icleaf_hdr *hdr, struct xfs_dir2_leaf *leaf,
 132                 bool expensive_checks);
 133
 134 /* xfs_dir2_node.c */
 135 void xfs_dir2_free_hdr_from_disk(struct xfs_mount *mp,
 136                 struct xfs_dir3_icfree_hdr *to, struct xfs_dir2_free *from);
 137 extern int xfs_dir2_leaf_to_node(struct xfs_da_args *args,
 138                 struct xfs_buf *lbp);
 139 extern xfs_dahash_t xfs_dir2_leaf_lasthash(struct xfs_inode *dp,
 140                 struct xfs_buf *bp, int *count);
 141 extern int xfs_dir2_leafn_lookup_int(struct xfs_buf *bp,
 142                 struct xfs_da_args *args, int *indexp,
 143                 struct xfs_da_state *state);
 144 extern int xfs_dir2_leafn_order(struct xfs_inode *dp, struct xfs_buf *leaf1_bp,
 145                 struct xfs_buf *leaf2_bp);
 146 extern int xfs_dir2_leafn_split(struct xfs_da_state *state,
 147         struct xfs_da_state_blk *oldblk, struct xfs_da_state_blk *newblk);
 148 extern int xfs_dir2_leafn_toosmall(struct xfs_da_state *state, int *action);
 149 extern 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);
 152 extern int xfs_dir2_node_addname(struct xfs_da_args *args);
 153 extern int xfs_dir2_node_lookup(struct xfs_da_args *args);
 154 extern int xfs_dir2_node_removename(struct xfs_da_args *args);
 155 extern int xfs_dir2_node_replace(struct xfs_da_args *args);
 156 extern int xfs_dir2_node_trim_free(struct xfs_da_args *args, xfs_fileoff_t fo,
 157                 int *rvalp);
 158 int 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);
 160
 161 /* xfs_dir2_sf.c */
 162 xfs_ino_t xfs_dir2_sf_get_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
 163                 struct xfs_dir2_sf_entry *sfep);
 164 xfs_ino_t xfs_dir2_sf_get_parent_ino(struct xfs_dir2_sf_hdr *hdr);
 165 void xfs_dir2_sf_put_parent_ino(struct xfs_dir2_sf_hdr *hdr, xfs_ino_t ino);
 166 uint8_t xfs_dir2_sf_get_ftype(struct xfs_mount *mp,
 167                 struct xfs_dir2_sf_entry *sfep);
 168 struct 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);
 170 extern int xfs_dir2_block_sfsize(struct xfs_inode *dp,
 171                 struct xfs_dir2_data_hdr *block, struct xfs_dir2_sf_hdr *sfhp);
 172 extern int xfs_dir2_block_to_sf(struct xfs_da_args *args, struct xfs_buf *bp,
 173                 int size, xfs_dir2_sf_hdr_t *sfhp);
 174 extern int xfs_dir2_sf_addname(struct xfs_da_args *args);
 175 extern int xfs_dir2_sf_create(struct xfs_da_args *args, xfs_ino_t pino);
 176 extern int xfs_dir2_sf_lookup(struct xfs_da_args *args);
 177 extern int xfs_dir2_sf_removename(struct xfs_da_args *args);
 178 extern int xfs_dir2_sf_replace(struct xfs_da_args *args);
 179 xfs_failaddr_t xfs_dir2_sf_verify(struct xfs_mount *mp,
 180                 struct xfs_dir2_sf_hdr *sfp, int64_t size);
 181 int xfs_dir2_sf_entsize(struct xfs_mount *mp,
 182                 struct xfs_dir2_sf_hdr *hdr, int len);
 183 void 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);
 185 void xfs_dir2_sf_put_ftype(struct xfs_mount *mp,
 186                 struct xfs_dir2_sf_entry *sfep, uint8_t ftype);
 187
 188 /* xfs_dir2_readdir.c */
 189 extern int xfs_readdir(struct xfs_trans *tp, struct xfs_inode *dp,
 190                        struct dir_context *ctx, size_t bufsize);
 191
 192 static inline unsigned int
 193 xfs_dir2_data_unusedsize(
 194         unsigned int    len)
 195 {
 196         return round_up(len, XFS_DIR2_DATA_ALIGN);
 197 }
 198
 199 static inline unsigned int
 200 xfs_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 */;
 208         if (xfs_has_ftype(mp))
 209                 len += sizeof(uint8_t);
 210         return round_up(len, XFS_DIR2_DATA_ALIGN);
 211 }
 212
 213 xfs_dahash_t xfs_dir2_hashname(struct xfs_mount *mp,
 214                 const struct xfs_name *name);
 215 enum xfs_dacmp xfs_dir2_compname(struct xfs_da_args *args,
 216                 const unsigned char *name, int len);
 217
 218 #endif /* __XFS_DIR2_PRIV_H__ */