fs/xfs/xfs_dir2.h

   1 /*
   2  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #ifndef __XFS_DIR2_H__
  19 #define __XFS_DIR2_H__
  20
  21 struct xfs_bmap_free;
  22 struct xfs_da_args;
  23 struct xfs_inode;
  24 struct xfs_mount;
  25 struct xfs_trans;
  26 struct xfs_dir2_sf_hdr;
  27 struct xfs_dir2_sf_entry;
  28 struct xfs_dir2_data_hdr;
  29 struct xfs_dir2_data_entry;
  30 struct xfs_dir2_data_unused;
  31
  32 extern struct xfs_name  xfs_name_dotdot;
  33
  34 /*
  35  * directory operations vector for encode/decode routines
  36  */
  37 struct xfs_dir_ops {
  38         int     (*sf_entsize)(struct xfs_dir2_sf_hdr *hdr, int len);
  39         struct xfs_dir2_sf_entry *
  40                 (*sf_nextentry)(struct xfs_dir2_sf_hdr *hdr,
  41                                 struct xfs_dir2_sf_entry *sfep);
  42         __uint8_t (*sf_get_ftype)(struct xfs_dir2_sf_entry *sfep);
  43         void    (*sf_put_ftype)(struct xfs_dir2_sf_entry *sfep,
  44                                 __uint8_t ftype);
  45         xfs_ino_t (*sf_get_ino)(struct xfs_dir2_sf_hdr *hdr,
  46                                 struct xfs_dir2_sf_entry *sfep);
  47         void    (*sf_put_ino)(struct xfs_dir2_sf_hdr *hdr,
  48                               struct xfs_dir2_sf_entry *sfep,
  49                               xfs_ino_t ino);
  50         xfs_ino_t (*sf_get_parent_ino)(struct xfs_dir2_sf_hdr *hdr);
  51         void    (*sf_put_parent_ino)(struct xfs_dir2_sf_hdr *hdr,
  52                                      xfs_ino_t ino);
  53
  54         int     (*data_entsize)(int len);
  55         __uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep);
  56         void    (*data_put_ftype)(struct xfs_dir2_data_entry *dep,
  57                                 __uint8_t ftype);
  58         __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep);
  59         struct xfs_dir2_data_free *
  60                 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr);
  61
  62         xfs_dir2_data_aoff_t (*data_dot_offset)(void);
  63         xfs_dir2_data_aoff_t (*data_dotdot_offset)(void);
  64         xfs_dir2_data_aoff_t (*data_first_offset)(void);
  65         size_t  (*data_entry_offset)(void);
  66
  67         struct xfs_dir2_data_entry *
  68                 (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr);
  69         struct xfs_dir2_data_entry *
  70                 (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr);
  71         struct xfs_dir2_data_entry *
  72                 (*data_first_entry_p)(struct xfs_dir2_data_hdr *hdr);
  73         struct xfs_dir2_data_entry *
  74                 (*data_entry_p)(struct xfs_dir2_data_hdr *hdr);
  75         struct xfs_dir2_data_unused *
  76                 (*data_unused_p)(struct xfs_dir2_data_hdr *hdr);
  77
  78         int     (*leaf_hdr_size)(void);
  79         void    (*leaf_hdr_to_disk)(struct xfs_dir2_leaf *to,
  80                                     struct xfs_dir3_icleaf_hdr *from);
  81         void    (*leaf_hdr_from_disk)(struct xfs_dir3_icleaf_hdr *to,
  82                                       struct xfs_dir2_leaf *from);
  83         int     (*leaf_max_ents)(struct xfs_mount *mp);
  84         struct xfs_dir2_leaf_entry *
  85                 (*leaf_ents_p)(struct xfs_dir2_leaf *lp);
  86
  87         int     (*node_hdr_size)(void);
  88         void    (*node_hdr_to_disk)(struct xfs_da_intnode *to,
  89                                     struct xfs_da3_icnode_hdr *from);
  90         void    (*node_hdr_from_disk)(struct xfs_da3_icnode_hdr *to,
  91                                       struct xfs_da_intnode *from);
  92         struct xfs_da_node_entry *
  93                 (*node_tree_p)(struct xfs_da_intnode *dap);
  94
  95         void    (*free_hdr_to_disk)(struct xfs_dir2_free *to,
  96                                     struct xfs_dir3_icfree_hdr *from);
  97         void    (*free_hdr_from_disk)(struct xfs_dir3_icfree_hdr *to,
  98                                       struct xfs_dir2_free *from);
  99 };
 100
 101 extern const struct xfs_dir_ops *
 102         xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
 103 extern const struct xfs_dir_ops *
 104         xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
 105
 106 /*
 107  * Generic directory interface routines
 108  */
 109 extern void xfs_dir_startup(void);
 110 extern void xfs_dir_mount(struct xfs_mount *mp);
 111 extern int xfs_dir_isempty(struct xfs_inode *dp);
 112 extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
 113                                 struct xfs_inode *pdp);
 114 extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
 115                                 struct xfs_name *name, xfs_ino_t inum,
 116                                 xfs_fsblock_t *first,
 117                                 struct xfs_bmap_free *flist, xfs_extlen_t tot);
 118 extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
 119                                 struct xfs_name *name, xfs_ino_t *inum,
 120                                 struct xfs_name *ci_name);
 121 extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
 122                                 struct xfs_name *name, xfs_ino_t ino,
 123                                 xfs_fsblock_t *first,
 124                                 struct xfs_bmap_free *flist, xfs_extlen_t tot);
 125 extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
 126                                 struct xfs_name *name, xfs_ino_t inum,
 127                                 xfs_fsblock_t *first,
 128                                 struct xfs_bmap_free *flist, xfs_extlen_t tot);
 129 extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
 130                                 struct xfs_name *name, uint resblks);
 131
 132 /*
 133  * Direct call from the bmap code, bypassing the generic directory layer.
 134  */
 135 extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
 136
 137 /*
 138  * Interface routines used by userspace utilities
 139  */
 140 extern int xfs_dir2_isblock(struct xfs_trans *tp, struct xfs_inode *dp, int *r);
 141 extern int xfs_dir2_isleaf(struct xfs_trans *tp, struct xfs_inode *dp, int *r);
 142 extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
 143                                 struct xfs_buf *bp);
 144
 145 extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
 146                 struct xfs_dir2_data_hdr *hdr, int *loghead);
 147 extern void xfs_dir2_data_log_entry(struct xfs_trans *tp, struct xfs_inode *dp,
 148                 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
 149 extern void xfs_dir2_data_log_header(struct xfs_trans *tp, struct xfs_inode *dp,
 150                 struct xfs_buf *bp);
 151 extern void xfs_dir2_data_log_unused(struct xfs_trans *tp, struct xfs_buf *bp,
 152                 struct xfs_dir2_data_unused *dup);
 153 extern void xfs_dir2_data_make_free(struct xfs_trans *tp, struct xfs_inode *dp,
 154                 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
 155                 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
 156 extern void xfs_dir2_data_use_free(struct xfs_trans *tp, struct xfs_inode *dp,
 157                 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
 158                 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
 159                 int *needlogp, int *needscanp);
 160
 161 extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
 162                 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
 163                 struct xfs_dir2_data_unused *dup);
 164
 165 extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
 166 extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
 167 extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
 168 extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
 169 extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
 170
 171 #endif  /* __XFS_DIR2_H__ */