fs/xfs/libxfs/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 #include "xfs_da_format.h"
  22 #include "xfs_da_btree.h"
  23
  24 struct xfs_defer_ops;
  25 struct xfs_da_args;
  26 struct xfs_inode;
  27 struct xfs_mount;
  28 struct xfs_trans;
  29 struct xfs_dir2_sf_hdr;
  30 struct xfs_dir2_sf_entry;
  31 struct xfs_dir2_data_hdr;
  32 struct xfs_dir2_data_entry;
  33 struct xfs_dir2_data_unused;
  34
  35 extern struct xfs_name  xfs_name_dotdot;
  36
  37 /*
  38  * directory filetype conversion tables.
  39  */
  40 #define S_SHIFT 12
  41 extern const unsigned char xfs_mode_to_ftype[];
  42
  43 /*
  44  * directory operations vector for encode/decode routines
  45  */
  46 struct xfs_dir_ops {
  47         int     (*sf_entsize)(struct xfs_dir2_sf_hdr *hdr, int len);
  48         struct xfs_dir2_sf_entry *
  49                 (*sf_nextentry)(struct xfs_dir2_sf_hdr *hdr,
  50                                 struct xfs_dir2_sf_entry *sfep);
  51         __uint8_t (*sf_get_ftype)(struct xfs_dir2_sf_entry *sfep);
  52         void    (*sf_put_ftype)(struct xfs_dir2_sf_entry *sfep,
  53                                 __uint8_t ftype);
  54         xfs_ino_t (*sf_get_ino)(struct xfs_dir2_sf_hdr *hdr,
  55                                 struct xfs_dir2_sf_entry *sfep);
  56         void    (*sf_put_ino)(struct xfs_dir2_sf_hdr *hdr,
  57                               struct xfs_dir2_sf_entry *sfep,
  58                               xfs_ino_t ino);
  59         xfs_ino_t (*sf_get_parent_ino)(struct xfs_dir2_sf_hdr *hdr);
  60         void    (*sf_put_parent_ino)(struct xfs_dir2_sf_hdr *hdr,
  61                                      xfs_ino_t ino);
  62
  63         int     (*data_entsize)(int len);
  64         __uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep);
  65         void    (*data_put_ftype)(struct xfs_dir2_data_entry *dep,
  66                                 __uint8_t ftype);
  67         __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep);
  68         struct xfs_dir2_data_free *
  69                 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr);
  70
  71         xfs_dir2_data_aoff_t data_dot_offset;
  72         xfs_dir2_data_aoff_t data_dotdot_offset;
  73         xfs_dir2_data_aoff_t data_first_offset;
  74         size_t  data_entry_offset;
  75
  76         struct xfs_dir2_data_entry *
  77                 (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr);
  78         struct xfs_dir2_data_entry *
  79                 (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr);
  80         struct xfs_dir2_data_entry *
  81                 (*data_first_entry_p)(struct xfs_dir2_data_hdr *hdr);
  82         struct xfs_dir2_data_entry *
  83                 (*data_entry_p)(struct xfs_dir2_data_hdr *hdr);
  84         struct xfs_dir2_data_unused *
  85                 (*data_unused_p)(struct xfs_dir2_data_hdr *hdr);
  86
  87         int     leaf_hdr_size;
  88         void    (*leaf_hdr_to_disk)(struct xfs_dir2_leaf *to,
  89                                     struct xfs_dir3_icleaf_hdr *from);
  90         void    (*leaf_hdr_from_disk)(struct xfs_dir3_icleaf_hdr *to,
  91                                       struct xfs_dir2_leaf *from);
  92         int     (*leaf_max_ents)(struct xfs_da_geometry *geo);
  93         struct xfs_dir2_leaf_entry *
  94                 (*leaf_ents_p)(struct xfs_dir2_leaf *lp);
  95
  96         int     node_hdr_size;
  97         void    (*node_hdr_to_disk)(struct xfs_da_intnode *to,
  98                                     struct xfs_da3_icnode_hdr *from);
  99         void    (*node_hdr_from_disk)(struct xfs_da3_icnode_hdr *to,
 100                                       struct xfs_da_intnode *from);
 101         struct xfs_da_node_entry *
 102                 (*node_tree_p)(struct xfs_da_intnode *dap);
 103
 104         int     free_hdr_size;
 105         void    (*free_hdr_to_disk)(struct xfs_dir2_free *to,
 106                                     struct xfs_dir3_icfree_hdr *from);
 107         void    (*free_hdr_from_disk)(struct xfs_dir3_icfree_hdr *to,
 108                                       struct xfs_dir2_free *from);
 109         int     (*free_max_bests)(struct xfs_da_geometry *geo);
 110         __be16 * (*free_bests_p)(struct xfs_dir2_free *free);
 111         xfs_dir2_db_t (*db_to_fdb)(struct xfs_da_geometry *geo,
 112                                    xfs_dir2_db_t db);
 113         int     (*db_to_fdindex)(struct xfs_da_geometry *geo,
 114                                  xfs_dir2_db_t db);
 115 };
 116
 117 extern const struct xfs_dir_ops *
 118         xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
 119 extern const struct xfs_dir_ops *
 120         xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
 121
 122 /*
 123  * Generic directory interface routines
 124  */
 125 extern void xfs_dir_startup(void);
 126 extern int xfs_da_mount(struct xfs_mount *mp);
 127 extern void xfs_da_unmount(struct xfs_mount *mp);
 128
 129 extern int xfs_dir_isempty(struct xfs_inode *dp);
 130 extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
 131                                 struct xfs_inode *pdp);
 132 extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
 133                                 struct xfs_name *name, xfs_ino_t inum,
 134                                 xfs_fsblock_t *first,
 135                                 struct xfs_defer_ops *dfops, xfs_extlen_t tot);
 136 extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
 137                                 struct xfs_name *name, xfs_ino_t *inum,
 138                                 struct xfs_name *ci_name);
 139 extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
 140                                 struct xfs_name *name, xfs_ino_t ino,
 141                                 xfs_fsblock_t *first,
 142                                 struct xfs_defer_ops *dfops, xfs_extlen_t tot);
 143 extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
 144                                 struct xfs_name *name, xfs_ino_t inum,
 145                                 xfs_fsblock_t *first,
 146                                 struct xfs_defer_ops *dfops, xfs_extlen_t tot);
 147 extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
 148                                 struct xfs_name *name);
 149
 150 /*
 151  * Direct call from the bmap code, bypassing the generic directory layer.
 152  */
 153 extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
 154
 155 /*
 156  * Interface routines used by userspace utilities
 157  */
 158 extern int xfs_dir2_isblock(struct xfs_da_args *args, int *r);
 159 extern int xfs_dir2_isleaf(struct xfs_da_args *args, int *r);
 160 extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
 161                                 struct xfs_buf *bp);
 162
 163 extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
 164                 struct xfs_dir2_data_hdr *hdr, int *loghead);
 165 extern void xfs_dir2_data_log_entry(struct xfs_da_args *args,
 166                 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
 167 extern void xfs_dir2_data_log_header(struct xfs_da_args *args,
 168                 struct xfs_buf *bp);
 169 extern void xfs_dir2_data_log_unused(struct xfs_da_args *args,
 170                 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup);
 171 extern void xfs_dir2_data_make_free(struct xfs_da_args *args,
 172                 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
 173                 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
 174 extern void xfs_dir2_data_use_free(struct xfs_da_args *args,
 175                 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
 176                 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
 177                 int *needlogp, int *needscanp);
 178
 179 extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
 180                 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
 181                 struct xfs_dir2_data_unused *dup);
 182
 183 extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
 184 extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
 185 extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
 186 extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
 187 extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
 188
 189 /*
 190  * Directory offset/block conversion functions.
 191  *
 192  * DB blocks here are logical directory block numbers, not filesystem blocks.
 193  */
 194
 195 /*
 196  * Convert dataptr to byte in file space
 197  */
 198 static inline xfs_dir2_off_t
 199 xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp)
 200 {
 201         return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG;
 202 }
 203
 204 /*
 205  * Convert byte in file space to dataptr.  It had better be aligned.
 206  */
 207 static inline xfs_dir2_dataptr_t
 208 xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by)
 209 {
 210         return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG);
 211 }
 212
 213 /*
 214  * Convert byte in space to (DB) block
 215  */
 216 static inline xfs_dir2_db_t
 217 xfs_dir2_byte_to_db(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
 218 {
 219         return (xfs_dir2_db_t)(by >> geo->blklog);
 220 }
 221
 222 /*
 223  * Convert dataptr to a block number
 224  */
 225 static inline xfs_dir2_db_t
 226 xfs_dir2_dataptr_to_db(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
 227 {
 228         return xfs_dir2_byte_to_db(geo, xfs_dir2_dataptr_to_byte(dp));
 229 }
 230
 231 /*
 232  * Convert byte in space to offset in a block
 233  */
 234 static inline xfs_dir2_data_aoff_t
 235 xfs_dir2_byte_to_off(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
 236 {
 237         return (xfs_dir2_data_aoff_t)(by & (geo->blksize - 1));
 238 }
 239
 240 /*
 241  * Convert dataptr to a byte offset in a block
 242  */
 243 static inline xfs_dir2_data_aoff_t
 244 xfs_dir2_dataptr_to_off(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
 245 {
 246         return xfs_dir2_byte_to_off(geo, xfs_dir2_dataptr_to_byte(dp));
 247 }
 248
 249 /*
 250  * Convert block and offset to byte in space
 251  */
 252 static inline xfs_dir2_off_t
 253 xfs_dir2_db_off_to_byte(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
 254                         xfs_dir2_data_aoff_t o)
 255 {
 256         return ((xfs_dir2_off_t)db << geo->blklog) + o;
 257 }
 258
 259 /*
 260  * Convert block (DB) to block (dablk)
 261  */
 262 static inline xfs_dablk_t
 263 xfs_dir2_db_to_da(struct xfs_da_geometry *geo, xfs_dir2_db_t db)
 264 {
 265         return (xfs_dablk_t)(db << (geo->blklog - geo->fsblog));
 266 }
 267
 268 /*
 269  * Convert byte in space to (DA) block
 270  */
 271 static inline xfs_dablk_t
 272 xfs_dir2_byte_to_da(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
 273 {
 274         return xfs_dir2_db_to_da(geo, xfs_dir2_byte_to_db(geo, by));
 275 }
 276
 277 /*
 278  * Convert block and offset to dataptr
 279  */
 280 static inline xfs_dir2_dataptr_t
 281 xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
 282                            xfs_dir2_data_aoff_t o)
 283 {
 284         return xfs_dir2_byte_to_dataptr(xfs_dir2_db_off_to_byte(geo, db, o));
 285 }
 286
 287 /*
 288  * Convert block (dablk) to block (DB)
 289  */
 290 static inline xfs_dir2_db_t
 291 xfs_dir2_da_to_db(struct xfs_da_geometry *geo, xfs_dablk_t da)
 292 {
 293         return (xfs_dir2_db_t)(da >> (geo->blklog - geo->fsblog));
 294 }
 295
 296 /*
 297  * Convert block (dablk) to byte offset in space
 298  */
 299 static inline xfs_dir2_off_t
 300 xfs_dir2_da_to_byte(struct xfs_da_geometry *geo, xfs_dablk_t da)
 301 {
 302         return xfs_dir2_db_off_to_byte(geo, xfs_dir2_da_to_db(geo, da), 0);
 303 }
 304
 305 /*
 306  * Directory tail pointer accessor functions. Based on block geometry.
 307  */
 308 static inline struct xfs_dir2_block_tail *
 309 xfs_dir2_block_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_data_hdr *hdr)
 310 {
 311         return ((struct xfs_dir2_block_tail *)
 312                 ((char *)hdr + geo->blksize)) - 1;
 313 }
 314
 315 static inline struct xfs_dir2_leaf_tail *
 316 xfs_dir2_leaf_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_leaf *lp)
 317 {
 318         return (struct xfs_dir2_leaf_tail *)
 319                 ((char *)lp + geo->blksize -
 320                   sizeof(struct xfs_dir2_leaf_tail));
 321 }
 322
 323 #endif  /* __XFS_DIR2_H__ */