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(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 extern int xfs_dir3_block_read(struct xfs_trans *tp, struct xfs_inode *dp,
  54                                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_dablk_t bno, unsigned int flags, struct xfs_buf **bpp);
  82 int xfs_dir3_data_readahead(struct xfs_inode *dp, xfs_dablk_t bno,
  83                 unsigned int flags);
  84
  85 extern struct xfs_dir2_data_free *
  86 xfs_dir2_data_freeinsert(struct xfs_dir2_data_hdr *hdr,
  87                 struct xfs_dir2_data_free *bf, struct xfs_dir2_data_unused *dup,
  88                 int *loghead);
  89 extern int xfs_dir3_data_init(struct xfs_da_args *args, xfs_dir2_db_t blkno,
  90                 struct xfs_buf **bpp);
  91
  92 /* xfs_dir2_leaf.c */
  93 void xfs_dir2_leaf_hdr_from_disk(struct xfs_mount *mp,
  94                 struct xfs_dir3_icleaf_hdr *to, struct xfs_dir2_leaf *from);
  95 void xfs_dir2_leaf_hdr_to_disk(struct xfs_mount *mp, struct xfs_dir2_leaf *to,
  96                 struct xfs_dir3_icleaf_hdr *from);
  97 int xfs_dir3_leaf_read(struct xfs_trans *tp, struct xfs_inode *dp,
  98                 xfs_dablk_t fbno, struct xfs_buf **bpp);
  99 int xfs_dir3_leafn_read(struct xfs_trans *tp, struct xfs_inode *dp,
 100                 xfs_dablk_t fbno, struct xfs_buf **bpp);
 101 extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
 102                 struct xfs_buf *dbp);
 103 extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
 104 extern void xfs_dir3_leaf_compact(struct xfs_da_args *args,
 105                 struct xfs_dir3_icleaf_hdr *leafhdr, struct xfs_buf *bp);
 106 extern void xfs_dir3_leaf_compact_x1(struct xfs_dir3_icleaf_hdr *leafhdr,
 107                 struct xfs_dir2_leaf_entry *ents, int *indexp,
 108                 int *lowstalep, int *highstalep, int *lowlogp, int *highlogp);
 109 extern int xfs_dir3_leaf_get_buf(struct xfs_da_args *args, xfs_dir2_db_t bno,
 110                 struct xfs_buf **bpp, uint16_t magic);
 111 extern void xfs_dir3_leaf_log_ents(struct xfs_da_args *args,
 112                 struct xfs_dir3_icleaf_hdr *hdr, struct xfs_buf *bp, int first,
 113                 int last);
 114 extern void xfs_dir3_leaf_log_header(struct xfs_da_args *args,
 115                 struct xfs_buf *bp);
 116 extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
 117 extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
 118 extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
 119 extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
 120                 struct xfs_buf *lbp);
 121 extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
 122                 struct xfs_buf *lbp, xfs_dir2_db_t db);
 123 extern struct xfs_dir2_leaf_entry *
 124 xfs_dir3_leaf_find_entry(struct xfs_dir3_icleaf_hdr *leafhdr,
 125                 struct xfs_dir2_leaf_entry *ents, int index, int compact,
 126                 int lowstale, int highstale, int *lfloglow, int *lfloghigh);
 127 extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
 128
 129 extern xfs_failaddr_t xfs_dir3_leaf_check_int(struct xfs_mount *mp,
 130                 struct xfs_dir3_icleaf_hdr *hdr, struct xfs_dir2_leaf *leaf);
 131
 132 /* xfs_dir2_node.c */
 133 void xfs_dir2_free_hdr_from_disk(struct xfs_mount *mp,
 134                 struct xfs_dir3_icfree_hdr *to, struct xfs_dir2_free *from);
 135 extern int xfs_dir2_leaf_to_node(struct xfs_da_args *args,
 136                 struct xfs_buf *lbp);
 137 extern xfs_dahash_t xfs_dir2_leaf_lasthash(struct xfs_inode *dp,
 138                 struct xfs_buf *bp, int *count);
 139 extern int xfs_dir2_leafn_lookup_int(struct xfs_buf *bp,
 140                 struct xfs_da_args *args, int *indexp,
 141                 struct xfs_da_state *state);
 142 extern int xfs_dir2_leafn_order(struct xfs_inode *dp, struct xfs_buf *leaf1_bp,
 143                 struct xfs_buf *leaf2_bp);
 144 extern int xfs_dir2_leafn_split(struct xfs_da_state *state,
 145         struct xfs_da_state_blk *oldblk, struct xfs_da_state_blk *newblk);
 146 extern int xfs_dir2_leafn_toosmall(struct xfs_da_state *state, int *action);
 147 extern void xfs_dir2_leafn_unbalance(struct xfs_da_state *state,
 148                 struct xfs_da_state_blk *drop_blk,
 149                 struct xfs_da_state_blk *save_blk);
 150 extern int xfs_dir2_node_addname(struct xfs_da_args *args);
 151 extern int xfs_dir2_node_lookup(struct xfs_da_args *args);
 152 extern int xfs_dir2_node_removename(struct xfs_da_args *args);
 153 extern int xfs_dir2_node_replace(struct xfs_da_args *args);
 154 extern int xfs_dir2_node_trim_free(struct xfs_da_args *args, xfs_fileoff_t fo,
 155                 int *rvalp);
 156 extern int xfs_dir2_free_read(struct xfs_trans *tp, struct xfs_inode *dp,
 157                 xfs_dablk_t fbno, struct xfs_buf **bpp);
 158
 159 /* xfs_dir2_sf.c */
 160 xfs_ino_t xfs_dir2_sf_get_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
 161                 struct xfs_dir2_sf_entry *sfep);
 162 xfs_ino_t xfs_dir2_sf_get_parent_ino(struct xfs_dir2_sf_hdr *hdr);
 163 void xfs_dir2_sf_put_parent_ino(struct xfs_dir2_sf_hdr *hdr, xfs_ino_t ino);
 164 uint8_t xfs_dir2_sf_get_ftype(struct xfs_mount *mp,
 165                 struct xfs_dir2_sf_entry *sfep);
 166 struct xfs_dir2_sf_entry *xfs_dir2_sf_nextentry(struct xfs_mount *mp,
 167                 struct xfs_dir2_sf_hdr *hdr, struct xfs_dir2_sf_entry *sfep);
 168 extern int xfs_dir2_block_sfsize(struct xfs_inode *dp,
 169                 struct xfs_dir2_data_hdr *block, struct xfs_dir2_sf_hdr *sfhp);
 170 extern int xfs_dir2_block_to_sf(struct xfs_da_args *args, struct xfs_buf *bp,
 171                 int size, xfs_dir2_sf_hdr_t *sfhp);
 172 extern int xfs_dir2_sf_addname(struct xfs_da_args *args);
 173 extern int xfs_dir2_sf_create(struct xfs_da_args *args, xfs_ino_t pino);
 174 extern int xfs_dir2_sf_lookup(struct xfs_da_args *args);
 175 extern int xfs_dir2_sf_removename(struct xfs_da_args *args);
 176 extern int xfs_dir2_sf_replace(struct xfs_da_args *args);
 177 extern xfs_failaddr_t xfs_dir2_sf_verify(struct xfs_inode *ip);
 178 int xfs_dir2_sf_entsize(struct xfs_mount *mp,
 179                 struct xfs_dir2_sf_hdr *hdr, int len);
 180 void xfs_dir2_sf_put_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
 181                 struct xfs_dir2_sf_entry *sfep, xfs_ino_t ino);
 182 void xfs_dir2_sf_put_ftype(struct xfs_mount *mp,
 183                 struct xfs_dir2_sf_entry *sfep, uint8_t ftype);
 184
 185 /* xfs_dir2_readdir.c */
 186 extern int xfs_readdir(struct xfs_trans *tp, struct xfs_inode *dp,
 187                        struct dir_context *ctx, size_t bufsize);
 188
 189 static inline unsigned int
 190 xfs_dir2_data_entsize(
 191         struct xfs_mount        *mp,
 192         unsigned int            namelen)
 193 {
 194         unsigned int            len;
 195
 196         len = offsetof(struct xfs_dir2_data_entry, name[0]) + namelen +
 197                         sizeof(xfs_dir2_data_off_t) /* tag */;
 198         if (xfs_sb_version_hasftype(&mp->m_sb))
 199                 len += sizeof(uint8_t);
 200         return round_up(len, XFS_DIR2_DATA_ALIGN);
 201 }
 202
 203 xfs_dahash_t xfs_dir2_hashname(struct xfs_mount *mp, struct xfs_name *name);
 204 enum xfs_dacmp xfs_dir2_compname(struct xfs_da_args *args,
 205                 const unsigned char *name, int len);
 206
 207 #endif /* __XFS_DIR2_PRIV_H__ */