LXR linux/fs/xfs/libxfs/xfs_dir2

   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
   9struct 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 */
  15struct 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
  29struct 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 */
  43xfs_dahash_t xfs_ascii_ci_hashname(struct xfs_name *name);
  44enum xfs_dacmp xfs_ascii_ci_compname(struct xfs_da_args *args,
  45                const unsigned char *name, int len);
  46extern int xfs_dir2_grow_inode(struct xfs_da_args *args, int space,
  47                                xfs_dir2_db_t *dbp);
  48extern int xfs_dir_cilookup_result(struct xfs_da_args *args,
  49                                const unsigned char *name, int len);
  50
  51
  52/* xfs_dir2_block.c */
  53extern int xfs_dir3_block_read(struct xfs_trans *tp, struct xfs_inode *dp,
  54                               struct xfs_buf **bpp);
  55extern int xfs_dir2_block_addname(struct xfs_da_args *args);
  56extern int xfs_dir2_block_lookup(struct xfs_da_args *args);
  57extern int xfs_dir2_block_removename(struct xfs_da_args *args);
  58extern int xfs_dir2_block_replace(struct xfs_da_args *args);
  59extern 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 */
  63struct 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);
  67uint8_t xfs_dir2_data_get_ftype(struct xfs_mount *mp,
  68                struct xfs_dir2_data_entry *dep);
  69void xfs_dir2_data_put_ftype(struct xfs_mount *mp,
  70                struct xfs_dir2_data_entry *dep, uint8_t ftype);
  71
  72#ifdef DEBUG
  73extern 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
  78extern xfs_failaddr_t __xfs_dir3_data_check(struct xfs_inode *dp,
  79                struct xfs_buf *bp);
  80int xfs_dir3_data_read(struct xfs_trans *tp, struct xfs_inode *dp,
  81                xfs_dablk_t bno, unsigned int flags, struct xfs_buf **bpp);
  82int xfs_dir3_data_readahead(struct xfs_inode *dp, xfs_dablk_t bno,
  83                unsigned int flags);
  84
  85extern struct xfs_dir2_data_free *
  86xfs_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);
  89extern 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 */
  93void xfs_dir2_leaf_hdr_from_disk(struct xfs_mount *mp,
  94                struct xfs_dir3_icleaf_hdr *to, struct xfs_dir2_leaf *from);
  95void xfs_dir2_leaf_hdr_to_disk(struct xfs_mount *mp, struct xfs_dir2_leaf *to,
  96                struct xfs_dir3_icleaf_hdr *from);
  97int xfs_dir3_leaf_read(struct xfs_trans *tp, struct xfs_inode *dp,
  98                xfs_dablk_t fbno, struct xfs_buf **bpp);
  99int xfs_dir3_leafn_read(struct xfs_trans *tp, struct xfs_inode *dp,
 100                xfs_dablk_t fbno, struct xfs_buf **bpp);
 101extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
 102                struct xfs_buf *dbp);
 103extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
 104extern void xfs_dir3_leaf_compact(struct xfs_da_args *args,
 105                struct xfs_dir3_icleaf_hdr *leafhdr, struct xfs_buf *bp);
 106extern 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);
 109extern int xfs_dir3_leaf_get_buf(struct xfs_da_args *args, xfs_dir2_db_t bno,
 110                struct xfs_buf **bpp, uint16_t magic);
 111extern 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);
 114extern void xfs_dir3_leaf_log_header(struct xfs_da_args *args,
 115                struct xfs_buf *bp);
 116extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
 117extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
 118extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
 119extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
 120                struct xfs_buf *lbp);
 121extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
 122                struct xfs_buf *lbp, xfs_dir2_db_t db);
 123extern struct xfs_dir2_leaf_entry *
 124xfs_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);
 127extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
 128
 129extern 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                bool expensive_checks);
 132
 133/* xfs_dir2_node.c */
 134void xfs_dir2_free_hdr_from_disk(struct xfs_mount *mp,
 135                struct xfs_dir3_icfree_hdr *to, struct xfs_dir2_free *from);
 136extern int xfs_dir2_leaf_to_node(struct xfs_da_args *args,
 137                struct xfs_buf *lbp);
 138extern xfs_dahash_t xfs_dir2_leaf_lasthash(struct xfs_inode *dp,
 139                struct xfs_buf *bp, int *count);
 140extern int xfs_dir2_leafn_lookup_int(struct xfs_buf *bp,
 141                struct xfs_da_args *args, int *indexp,
 142                struct xfs_da_state *state);
 143extern int xfs_dir2_leafn_order(struct xfs_inode *dp, struct xfs_buf *leaf1_bp,
 144                struct xfs_buf *leaf2_bp);
 145extern int xfs_dir2_leafn_split(struct xfs_da_state *state,
 146        struct xfs_da_state_blk *oldblk, struct xfs_da_state_blk *newblk);
 147extern int xfs_dir2_leafn_toosmall(struct xfs_da_state *state, int *action);
 148extern void xfs_dir2_leafn_unbalance(struct xfs_da_state *state,
 149                struct xfs_da_state_blk *drop_blk,
 150                struct xfs_da_state_blk *save_blk);
 151extern int xfs_dir2_node_addname(struct xfs_da_args *args);
 152extern int xfs_dir2_node_lookup(struct xfs_da_args *args);
 153extern int xfs_dir2_node_removename(struct xfs_da_args *args);
 154extern int xfs_dir2_node_replace(struct xfs_da_args *args);
 155extern int xfs_dir2_node_trim_free(struct xfs_da_args *args, xfs_fileoff_t fo,
 156                int *rvalp);
 157extern int xfs_dir2_free_read(struct xfs_trans *tp, struct xfs_inode *dp,
 158                xfs_dablk_t fbno, struct xfs_buf **bpp);
 159
 160/* xfs_dir2_sf.c */
 161xfs_ino_t xfs_dir2_sf_get_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
 162                struct xfs_dir2_sf_entry *sfep);
 163xfs_ino_t xfs_dir2_sf_get_parent_ino(struct xfs_dir2_sf_hdr *hdr);
 164void xfs_dir2_sf_put_parent_ino(struct xfs_dir2_sf_hdr *hdr, xfs_ino_t ino);
 165uint8_t xfs_dir2_sf_get_ftype(struct xfs_mount *mp,
 166                struct xfs_dir2_sf_entry *sfep);
 167struct xfs_dir2_sf_entry *xfs_dir2_sf_nextentry(struct xfs_mount *mp,
 168                struct xfs_dir2_sf_hdr *hdr, struct xfs_dir2_sf_entry *sfep);
 169extern int xfs_dir2_block_sfsize(struct xfs_inode *dp,
 170                struct xfs_dir2_data_hdr *block, struct xfs_dir2_sf_hdr *sfhp);
 171extern int xfs_dir2_block_to_sf(struct xfs_da_args *args, struct xfs_buf *bp,
 172                int size, xfs_dir2_sf_hdr_t *sfhp);
 173extern int xfs_dir2_sf_addname(struct xfs_da_args *args);
 174extern int xfs_dir2_sf_create(struct xfs_da_args *args, xfs_ino_t pino);
 175extern int xfs_dir2_sf_lookup(struct xfs_da_args *args);
 176extern int xfs_dir2_sf_removename(struct xfs_da_args *args);
 177extern int xfs_dir2_sf_replace(struct xfs_da_args *args);
 178extern xfs_failaddr_t xfs_dir2_sf_verify(struct xfs_inode *ip);
 179int xfs_dir2_sf_entsize(struct xfs_mount *mp,
 180                struct xfs_dir2_sf_hdr *hdr, int len);
 181void xfs_dir2_sf_put_ino(struct xfs_mount *mp, struct xfs_dir2_sf_hdr *hdr,
 182                struct xfs_dir2_sf_entry *sfep, xfs_ino_t ino);
 183void xfs_dir2_sf_put_ftype(struct xfs_mount *mp,
 184                struct xfs_dir2_sf_entry *sfep, uint8_t ftype);
 185
 186/* xfs_dir2_readdir.c */
 187extern int xfs_readdir(struct xfs_trans *tp, struct xfs_inode *dp,
 188                       struct dir_context *ctx, size_t bufsize);
 189
 190static inline unsigned int
 191xfs_dir2_data_entsize(
 192        struct xfs_mount        *mp,
 193        unsigned int            namelen)
 194{
 195        unsigned int            len;
 196
 197        len = offsetof(struct xfs_dir2_data_entry, name[0]) + namelen +
 198                        sizeof(xfs_dir2_data_off_t) /* tag */;
 199        if (xfs_has_ftype(mp))
 200                len += sizeof(uint8_t);
 201        return round_up(len, XFS_DIR2_DATA_ALIGN);
 202}
 203
 204xfs_dahash_t xfs_dir2_hashname(struct xfs_mount *mp, struct xfs_name *name);
 205enum xfs_dacmp xfs_dir2_compname(struct xfs_da_args *args,
 206                const unsigned char *name, int len);
 207
 208#endif /* __XFS_DIR2_PRIV_H__ */
 209