fs/xfs/xfs_dir2_format.h

   1 /*
   2  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
   3  * Copyright (c) 2013 Red Hat, Inc.
   4  * All Rights Reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it would be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write the Free Software Foundation,
  17  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19 #ifndef __XFS_DIR2_FORMAT_H__
  20 #define __XFS_DIR2_FORMAT_H__
  21
  22 /*
  23  * Directory version 2.
  24  *
  25  * There are 4 possible formats:
  26  *  - shortform - embedded into the inode
  27  *  - single block - data with embedded leaf at the end
  28  *  - multiple data blocks, single leaf+freeindex block
  29  *  - data blocks, node and leaf blocks (btree), freeindex blocks
  30  *
  31  * Note: many node blocks structures and constants are shared with the attr
  32  * code and defined in xfs_da_btree.h.
  33  */
  34
  35 #define XFS_DIR2_BLOCK_MAGIC    0x58443242      /* XD2B: single block dirs */
  36 #define XFS_DIR2_DATA_MAGIC     0x58443244      /* XD2D: multiblock dirs */
  37 #define XFS_DIR2_FREE_MAGIC     0x58443246      /* XD2F: free index blocks */
  38
  39 /*
  40  * Directory Version 3 With CRCs.
  41  *
  42  * The tree formats are the same as for version 2 directories.  The difference
  43  * is in the block header and dirent formats. In many cases the v3 structures
  44  * use v2 definitions as they are no different and this makes code sharing much
  45  * easier.
  46  *
  47  * Also, the xfs_dir3_*() functions handle both v2 and v3 formats - if the
  48  * format is v2 then they switch to the existing v2 code, or the format is v3
  49  * they implement the v3 functionality. This means the existing dir2 is a mix of
  50  * xfs_dir2/xfs_dir3 calls and functions. The xfs_dir3 functions are called
  51  * where there is a difference in the formats, otherwise the code is unchanged.
  52  *
  53  * Where it is possible, the code decides what to do based on the magic numbers
  54  * in the blocks rather than feature bits in the superblock. This means the code
  55  * is as independent of the external XFS code as possible as doesn't require
  56  * passing struct xfs_mount pointers into places where it isn't really
  57  * necessary.
  58  *
  59  * Version 3 includes:
  60  *
  61  *      - a larger block header for CRC and identification purposes and so the
  62  *      offsets of all the structures inside the blocks are different.
  63  *
  64  *      - new magic numbers to be able to detect the v2/v3 types on the fly.
  65  */
  66
  67 #define XFS_DIR3_BLOCK_MAGIC    0x58444233      /* XDB3: single block dirs */
  68 #define XFS_DIR3_DATA_MAGIC     0x58444433      /* XDD3: multiblock dirs */
  69 #define XFS_DIR3_FREE_MAGIC     0x58444633      /* XDF3: free index blocks */
  70
  71 /*
  72  * Byte offset in data block and shortform entry.
  73  */
  74 typedef __uint16_t      xfs_dir2_data_off_t;
  75 #define NULLDATAOFF     0xffffU
  76 typedef uint            xfs_dir2_data_aoff_t;   /* argument form */
  77
  78 /*
  79  * Normalized offset (in a data block) of the entry, really xfs_dir2_data_off_t.
  80  * Only need 16 bits, this is the byte offset into the single block form.
  81  */
  82 typedef struct { __uint8_t i[2]; } __arch_pack xfs_dir2_sf_off_t;
  83
  84 /*
  85  * Offset in data space of a data entry.
  86  */
  87 typedef __uint32_t      xfs_dir2_dataptr_t;
  88 #define XFS_DIR2_MAX_DATAPTR    ((xfs_dir2_dataptr_t)0xffffffff)
  89 #define XFS_DIR2_NULL_DATAPTR   ((xfs_dir2_dataptr_t)0)
  90
  91 /*
  92  * Byte offset in a directory.
  93  */
  94 typedef xfs_off_t       xfs_dir2_off_t;
  95
  96 /*
  97  * Directory block number (logical dirblk in file)
  98  */
  99 typedef __uint32_t      xfs_dir2_db_t;
 100
 101 /*
 102  * Inode number stored as 8 8-bit values.
 103  */
 104 typedef struct { __uint8_t i[8]; } xfs_dir2_ino8_t;
 105
 106 /*
 107  * Inode number stored as 4 8-bit values.
 108  * Works a lot of the time, when all the inode numbers in a directory
 109  * fit in 32 bits.
 110  */
 111 typedef struct { __uint8_t i[4]; } xfs_dir2_ino4_t;
 112
 113 typedef union {
 114         xfs_dir2_ino8_t i8;
 115         xfs_dir2_ino4_t i4;
 116 } xfs_dir2_inou_t;
 117 #define XFS_DIR2_MAX_SHORT_INUM ((xfs_ino_t)0xffffffffULL)
 118
 119 /*
 120  * Directory layout when stored internal to an inode.
 121  *
 122  * Small directories are packed as tightly as possible so as to fit into the
 123  * literal area of the inode.  These "shortform" directories consist of a
 124  * single xfs_dir2_sf_hdr header followed by zero or more xfs_dir2_sf_entry
 125  * structures.  Due the different inode number storage size and the variable
 126  * length name field in the xfs_dir2_sf_entry all these structure are
 127  * variable length, and the accessors in this file should be used to iterate
 128  * over them.
 129  */
 130 typedef struct xfs_dir2_sf_hdr {
 131         __uint8_t               count;          /* count of entries */
 132         __uint8_t               i8count;        /* count of 8-byte inode #s */
 133         xfs_dir2_inou_t         parent;         /* parent dir inode number */
 134 } __arch_pack xfs_dir2_sf_hdr_t;
 135
 136 typedef struct xfs_dir2_sf_entry {
 137         __u8                    namelen;        /* actual name length */
 138         xfs_dir2_sf_off_t       offset;         /* saved offset */
 139         __u8                    name[];         /* name, variable size */
 140         /*
 141          * A xfs_dir2_ino8_t or xfs_dir2_ino4_t follows here, at a
 142          * variable offset after the name.
 143          */
 144 } __arch_pack xfs_dir2_sf_entry_t;
 145
 146 static inline int xfs_dir2_sf_hdr_size(int i8count)
 147 {
 148         return sizeof(struct xfs_dir2_sf_hdr) -
 149                 (i8count == 0) *
 150                 (sizeof(xfs_dir2_ino8_t) - sizeof(xfs_dir2_ino4_t));
 151 }
 152
 153 static inline xfs_dir2_data_aoff_t
 154 xfs_dir2_sf_get_offset(xfs_dir2_sf_entry_t *sfep)
 155 {
 156         return get_unaligned_be16(&sfep->offset.i);
 157 }
 158
 159 static inline void
 160 xfs_dir2_sf_put_offset(xfs_dir2_sf_entry_t *sfep, xfs_dir2_data_aoff_t off)
 161 {
 162         put_unaligned_be16(off, &sfep->offset.i);
 163 }
 164
 165 static inline int
 166 xfs_dir2_sf_entsize(struct xfs_dir2_sf_hdr *hdr, int len)
 167 {
 168         return sizeof(struct xfs_dir2_sf_entry) +       /* namelen + offset */
 169                 len +                                   /* name */
 170                 (hdr->i8count ?                         /* ino */
 171                  sizeof(xfs_dir2_ino8_t) :
 172                  sizeof(xfs_dir2_ino4_t));
 173 }
 174
 175 static inline struct xfs_dir2_sf_entry *
 176 xfs_dir2_sf_firstentry(struct xfs_dir2_sf_hdr *hdr)
 177 {
 178         return (struct xfs_dir2_sf_entry *)
 179                 ((char *)hdr + xfs_dir2_sf_hdr_size(hdr->i8count));
 180 }
 181
 182 static inline struct xfs_dir2_sf_entry *
 183 xfs_dir2_sf_nextentry(struct xfs_dir2_sf_hdr *hdr,
 184                 struct xfs_dir2_sf_entry *sfep)
 185 {
 186         return (struct xfs_dir2_sf_entry *)
 187                 ((char *)sfep + xfs_dir2_sf_entsize(hdr, sfep->namelen));
 188 }
 189
 190
 191 /*
 192  * Data block structures.
 193  *
 194  * A pure data block looks like the following drawing on disk:
 195  *
 196  *    +-------------------------------------------------+
 197  *    | xfs_dir2_data_hdr_t                             |
 198  *    +-------------------------------------------------+
 199  *    | xfs_dir2_data_entry_t OR xfs_dir2_data_unused_t |
 200  *    | xfs_dir2_data_entry_t OR xfs_dir2_data_unused_t |
 201  *    | xfs_dir2_data_entry_t OR xfs_dir2_data_unused_t |
 202  *    | ...                                             |
 203  *    +-------------------------------------------------+
 204  *    | unused space                                    |
 205  *    +-------------------------------------------------+
 206  *
 207  * As all the entries are variable size structures the accessors below should
 208  * be used to iterate over them.
 209  *
 210  * In addition to the pure data blocks for the data and node formats,
 211  * most structures are also used for the combined data/freespace "block"
 212  * format below.
 213  */
 214
 215 #define XFS_DIR2_DATA_ALIGN_LOG 3               /* i.e., 8 bytes */
 216 #define XFS_DIR2_DATA_ALIGN     (1 << XFS_DIR2_DATA_ALIGN_LOG)
 217 #define XFS_DIR2_DATA_FREE_TAG  0xffff
 218 #define XFS_DIR2_DATA_FD_COUNT  3
 219
 220 /*
 221  * Directory address space divided into sections,
 222  * spaces separated by 32GB.
 223  */
 224 #define XFS_DIR2_SPACE_SIZE     (1ULL << (32 + XFS_DIR2_DATA_ALIGN_LOG))
 225 #define XFS_DIR2_DATA_SPACE     0
 226 #define XFS_DIR2_DATA_OFFSET    (XFS_DIR2_DATA_SPACE * XFS_DIR2_SPACE_SIZE)
 227 #define XFS_DIR2_DATA_FIRSTDB(mp)       \
 228         xfs_dir2_byte_to_db(mp, XFS_DIR2_DATA_OFFSET)
 229
 230 /*
 231  * Offsets of . and .. in data space (always block 0)
 232  */
 233 #define XFS_DIR2_DATA_DOT_OFFSET        \
 234         ((xfs_dir2_data_aoff_t)sizeof(struct xfs_dir2_data_hdr))
 235 #define XFS_DIR2_DATA_DOTDOT_OFFSET     \
 236         (XFS_DIR2_DATA_DOT_OFFSET + xfs_dir2_data_entsize(1))
 237 #define XFS_DIR2_DATA_FIRST_OFFSET              \
 238         (XFS_DIR2_DATA_DOTDOT_OFFSET + xfs_dir2_data_entsize(2))
 239
 240 /*
 241  * Describe a free area in the data block.
 242  *
 243  * The freespace will be formatted as a xfs_dir2_data_unused_t.
 244  */
 245 typedef struct xfs_dir2_data_free {
 246         __be16                  offset;         /* start of freespace */
 247         __be16                  length;         /* length of freespace */
 248 } xfs_dir2_data_free_t;
 249
 250 /*
 251  * Header for the data blocks.
 252  *
 253  * The code knows that XFS_DIR2_DATA_FD_COUNT is 3.
 254  */
 255 typedef struct xfs_dir2_data_hdr {
 256         __be32                  magic;          /* XFS_DIR2_DATA_MAGIC or */
 257                                                 /* XFS_DIR2_BLOCK_MAGIC */
 258         xfs_dir2_data_free_t    bestfree[XFS_DIR2_DATA_FD_COUNT];
 259 } xfs_dir2_data_hdr_t;
 260
 261 /*
 262  * define a structure for all the verification fields we are adding to the
 263  * directory block structures. This will be used in several structures.
 264  * The magic number must be the first entry to align with all the dir2
 265  * structures so we determine how to decode them just by the magic number.
 266  */
 267 struct xfs_dir3_blk_hdr {
 268         __be32                  magic;  /* magic number */
 269         __be32                  crc;    /* CRC of block */
 270         __be64                  blkno;  /* first block of the buffer */
 271         __be64                  lsn;    /* sequence number of last write */
 272         uuid_t                  uuid;   /* filesystem we belong to */
 273         __be64                  owner;  /* inode that owns the block */
 274 };
 275
 276 struct xfs_dir3_data_hdr {
 277         struct xfs_dir3_blk_hdr hdr;
 278         xfs_dir2_data_free_t    best_free[XFS_DIR2_DATA_FD_COUNT];
 279 };
 280
 281 #define XFS_DIR3_DATA_CRC_OFF  offsetof(struct xfs_dir3_data_hdr, hdr.crc)
 282
 283 static inline struct xfs_dir2_data_free *
 284 xfs_dir3_data_bestfree_p(struct xfs_dir2_data_hdr *hdr)
 285 {
 286         if (hdr->magic == cpu_to_be32(XFS_DIR3_DATA_MAGIC) ||
 287             hdr->magic == cpu_to_be32(XFS_DIR3_BLOCK_MAGIC)) {
 288                 struct xfs_dir3_data_hdr *hdr3 = (struct xfs_dir3_data_hdr *)hdr;
 289                 return hdr3->best_free;
 290         }
 291         return hdr->bestfree;
 292 }
 293
 294 /*
 295  * Active entry in a data block.
 296  *
 297  * Aligned to 8 bytes.  After the variable length name field there is a
 298  * 2 byte tag field, which can be accessed using xfs_dir2_data_entry_tag_p.
 299  */
 300 typedef struct xfs_dir2_data_entry {
 301         __be64                  inumber;        /* inode number */
 302         __u8                    namelen;        /* name length */
 303         __u8                    name[];         /* name bytes, no null */
 304      /* __be16                  tag; */         /* starting offset of us */
 305 } xfs_dir2_data_entry_t;
 306
 307 /*
 308  * Unused entry in a data block.
 309  *
 310  * Aligned to 8 bytes.  Tag appears as the last 2 bytes and must be accessed
 311  * using xfs_dir2_data_unused_tag_p.
 312  */
 313 typedef struct xfs_dir2_data_unused {
 314         __be16                  freetag;        /* XFS_DIR2_DATA_FREE_TAG */
 315         __be16                  length;         /* total free length */
 316                                                 /* variable offset */
 317         __be16                  tag;            /* starting offset of us */
 318 } xfs_dir2_data_unused_t;
 319
 320 /*
 321  * Size of a data entry.
 322  */
 323 static inline int xfs_dir2_data_entsize(int n)
 324 {
 325         return (int)roundup(offsetof(struct xfs_dir2_data_entry, name[0]) + n +
 326                  (uint)sizeof(xfs_dir2_data_off_t), XFS_DIR2_DATA_ALIGN);
 327 }
 328
 329 /*
 330  * Pointer to an entry's tag word.
 331  */
 332 static inline __be16 *
 333 xfs_dir2_data_entry_tag_p(struct xfs_dir2_data_entry *dep)
 334 {
 335         return (__be16 *)((char *)dep +
 336                 xfs_dir2_data_entsize(dep->namelen) - sizeof(__be16));
 337 }
 338
 339 /*
 340  * Pointer to a freespace's tag word.
 341  */
 342 static inline __be16 *
 343 xfs_dir2_data_unused_tag_p(struct xfs_dir2_data_unused *dup)
 344 {
 345         return (__be16 *)((char *)dup +
 346                         be16_to_cpu(dup->length) - sizeof(__be16));
 347 }
 348
 349 static inline size_t
 350 xfs_dir3_data_hdr_size(bool dir3)
 351 {
 352         if (dir3)
 353                 return sizeof(struct xfs_dir3_data_hdr);
 354         return sizeof(struct xfs_dir2_data_hdr);
 355 }
 356
 357 static inline size_t
 358 xfs_dir3_data_entry_offset(struct xfs_dir2_data_hdr *hdr)
 359 {
 360         bool dir3 = hdr->magic == cpu_to_be32(XFS_DIR3_DATA_MAGIC) ||
 361                     hdr->magic == cpu_to_be32(XFS_DIR3_BLOCK_MAGIC);
 362         return xfs_dir3_data_hdr_size(dir3);
 363 }
 364
 365 static inline struct xfs_dir2_data_entry *
 366 xfs_dir3_data_entry_p(struct xfs_dir2_data_hdr *hdr)
 367 {
 368         return (struct xfs_dir2_data_entry *)
 369                 ((char *)hdr + xfs_dir3_data_entry_offset(hdr));
 370 }
 371
 372 static inline struct xfs_dir2_data_unused *
 373 xfs_dir3_data_unused_p(struct xfs_dir2_data_hdr *hdr)
 374 {
 375         return (struct xfs_dir2_data_unused *)
 376                 ((char *)hdr + xfs_dir3_data_entry_offset(hdr));
 377 }
 378
 379 /*
 380  * Offsets of . and .. in data space (always block 0)
 381  */
 382 static inline xfs_dir2_data_aoff_t
 383 xfs_dir3_data_dot_offset(struct xfs_dir2_data_hdr *hdr)
 384 {
 385         return xfs_dir3_data_entry_offset(hdr);
 386 }
 387
 388 static inline xfs_dir2_data_aoff_t
 389 xfs_dir3_data_dotdot_offset(struct xfs_dir2_data_hdr *hdr)
 390 {
 391         return xfs_dir3_data_dot_offset(hdr) + xfs_dir2_data_entsize(1);
 392 }
 393
 394 static inline xfs_dir2_data_aoff_t
 395 xfs_dir3_data_first_offset(struct xfs_dir2_data_hdr *hdr)
 396 {
 397         return xfs_dir3_data_dotdot_offset(hdr) + xfs_dir2_data_entsize(2);
 398 }
 399
 400 /*
 401  * location of . and .. in data space (always block 0)
 402  */
 403 static inline struct xfs_dir2_data_entry *
 404 xfs_dir3_data_dot_entry_p(struct xfs_dir2_data_hdr *hdr)
 405 {
 406         return (struct xfs_dir2_data_entry *)
 407                 ((char *)hdr + xfs_dir3_data_dot_offset(hdr));
 408 }
 409
 410 static inline struct xfs_dir2_data_entry *
 411 xfs_dir3_data_dotdot_entry_p(struct xfs_dir2_data_hdr *hdr)
 412 {
 413         return (struct xfs_dir2_data_entry *)
 414                 ((char *)hdr + xfs_dir3_data_dotdot_offset(hdr));
 415 }
 416
 417 static inline struct xfs_dir2_data_entry *
 418 xfs_dir3_data_first_entry_p(struct xfs_dir2_data_hdr *hdr)
 419 {
 420         return (struct xfs_dir2_data_entry *)
 421                 ((char *)hdr + xfs_dir3_data_first_offset(hdr));
 422 }
 423
 424 /*
 425  * Leaf block structures.
 426  *
 427  * A pure leaf block looks like the following drawing on disk:
 428  *
 429  *    +---------------------------+
 430  *    | xfs_dir2_leaf_hdr_t       |
 431  *    +---------------------------+
 432  *    | xfs_dir2_leaf_entry_t     |
 433  *    | xfs_dir2_leaf_entry_t     |
 434  *    | xfs_dir2_leaf_entry_t     |
 435  *    | xfs_dir2_leaf_entry_t     |
 436  *    | ...                       |
 437  *    +---------------------------+
 438  *    | xfs_dir2_data_off_t       |
 439  *    | xfs_dir2_data_off_t       |
 440  *    | xfs_dir2_data_off_t       |
 441  *    | ...                       |
 442  *    +---------------------------+
 443  *    | xfs_dir2_leaf_tail_t      |
 444  *    +---------------------------+
 445  *
 446  * The xfs_dir2_data_off_t members (bests) and tail are at the end of the block
 447  * for single-leaf (magic = XFS_DIR2_LEAF1_MAGIC) blocks only, but not present
 448  * for directories with separate leaf nodes and free space blocks
 449  * (magic = XFS_DIR2_LEAFN_MAGIC).
 450  *
 451  * As all the entries are variable size structures the accessors below should
 452  * be used to iterate over them.
 453  */
 454
 455 /*
 456  * Offset of the leaf/node space.  First block in this space
 457  * is the btree root.
 458  */
 459 #define XFS_DIR2_LEAF_SPACE     1
 460 #define XFS_DIR2_LEAF_OFFSET    (XFS_DIR2_LEAF_SPACE * XFS_DIR2_SPACE_SIZE)
 461 #define XFS_DIR2_LEAF_FIRSTDB(mp)       \
 462         xfs_dir2_byte_to_db(mp, XFS_DIR2_LEAF_OFFSET)
 463
 464 /*
 465  * Leaf block header.
 466  */
 467 typedef struct xfs_dir2_leaf_hdr {
 468         xfs_da_blkinfo_t        info;           /* header for da routines */
 469         __be16                  count;          /* count of entries */
 470         __be16                  stale;          /* count of stale entries */
 471 } xfs_dir2_leaf_hdr_t;
 472
 473 /*
 474  * Leaf block entry.
 475  */
 476 typedef struct xfs_dir2_leaf_entry {
 477         __be32                  hashval;        /* hash value of name */
 478         __be32                  address;        /* address of data entry */
 479 } xfs_dir2_leaf_entry_t;
 480
 481 /*
 482  * Leaf block tail.
 483  */
 484 typedef struct xfs_dir2_leaf_tail {
 485         __be32                  bestcount;
 486 } xfs_dir2_leaf_tail_t;
 487
 488 /*
 489  * Leaf block.
 490  */
 491 typedef struct xfs_dir2_leaf {
 492         xfs_dir2_leaf_hdr_t     hdr;            /* leaf header */
 493         xfs_dir2_leaf_entry_t   ents[];         /* entries */
 494 } xfs_dir2_leaf_t;
 495
 496 /*
 497  * DB blocks here are logical directory block numbers, not filesystem blocks.
 498  */
 499
 500 static inline int xfs_dir2_max_leaf_ents(struct xfs_mount *mp)
 501 {
 502         return (mp->m_dirblksize - (uint)sizeof(struct xfs_dir2_leaf_hdr)) /
 503                 (uint)sizeof(struct xfs_dir2_leaf_entry);
 504 }
 505
 506 /*
 507  * Get address of the bestcount field in the single-leaf block.
 508  */
 509 static inline struct xfs_dir2_leaf_tail *
 510 xfs_dir2_leaf_tail_p(struct xfs_mount *mp, struct xfs_dir2_leaf *lp)
 511 {
 512         return (struct xfs_dir2_leaf_tail *)
 513                 ((char *)lp + mp->m_dirblksize -
 514                   sizeof(struct xfs_dir2_leaf_tail));
 515 }
 516
 517 /*
 518  * Get address of the bests array in the single-leaf block.
 519  */
 520 static inline __be16 *
 521 xfs_dir2_leaf_bests_p(struct xfs_dir2_leaf_tail *ltp)
 522 {
 523         return (__be16 *)ltp - be32_to_cpu(ltp->bestcount);
 524 }
 525
 526 /*
 527  * Convert dataptr to byte in file space
 528  */
 529 static inline xfs_dir2_off_t
 530 xfs_dir2_dataptr_to_byte(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
 531 {
 532         return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG;
 533 }
 534
 535 /*
 536  * Convert byte in file space to dataptr.  It had better be aligned.
 537  */
 538 static inline xfs_dir2_dataptr_t
 539 xfs_dir2_byte_to_dataptr(struct xfs_mount *mp, xfs_dir2_off_t by)
 540 {
 541         return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG);
 542 }
 543
 544 /*
 545  * Convert byte in space to (DB) block
 546  */
 547 static inline xfs_dir2_db_t
 548 xfs_dir2_byte_to_db(struct xfs_mount *mp, xfs_dir2_off_t by)
 549 {
 550         return (xfs_dir2_db_t)
 551                 (by >> (mp->m_sb.sb_blocklog + mp->m_sb.sb_dirblklog));
 552 }
 553
 554 /*
 555  * Convert dataptr to a block number
 556  */
 557 static inline xfs_dir2_db_t
 558 xfs_dir2_dataptr_to_db(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
 559 {
 560         return xfs_dir2_byte_to_db(mp, xfs_dir2_dataptr_to_byte(mp, dp));
 561 }
 562
 563 /*
 564  * Convert byte in space to offset in a block
 565  */
 566 static inline xfs_dir2_data_aoff_t
 567 xfs_dir2_byte_to_off(struct xfs_mount *mp, xfs_dir2_off_t by)
 568 {
 569         return (xfs_dir2_data_aoff_t)(by &
 570                 ((1 << (mp->m_sb.sb_blocklog + mp->m_sb.sb_dirblklog)) - 1));
 571 }
 572
 573 /*
 574  * Convert dataptr to a byte offset in a block
 575  */
 576 static inline xfs_dir2_data_aoff_t
 577 xfs_dir2_dataptr_to_off(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
 578 {
 579         return xfs_dir2_byte_to_off(mp, xfs_dir2_dataptr_to_byte(mp, dp));
 580 }
 581
 582 /*
 583  * Convert block and offset to byte in space
 584  */
 585 static inline xfs_dir2_off_t
 586 xfs_dir2_db_off_to_byte(struct xfs_mount *mp, xfs_dir2_db_t db,
 587                         xfs_dir2_data_aoff_t o)
 588 {
 589         return ((xfs_dir2_off_t)db <<
 590                 (mp->m_sb.sb_blocklog + mp->m_sb.sb_dirblklog)) + o;
 591 }
 592
 593 /*
 594  * Convert block (DB) to block (dablk)
 595  */
 596 static inline xfs_dablk_t
 597 xfs_dir2_db_to_da(struct xfs_mount *mp, xfs_dir2_db_t db)
 598 {
 599         return (xfs_dablk_t)(db << mp->m_sb.sb_dirblklog);
 600 }
 601
 602 /*
 603  * Convert byte in space to (DA) block
 604  */
 605 static inline xfs_dablk_t
 606 xfs_dir2_byte_to_da(struct xfs_mount *mp, xfs_dir2_off_t by)
 607 {
 608         return xfs_dir2_db_to_da(mp, xfs_dir2_byte_to_db(mp, by));
 609 }
 610
 611 /*
 612  * Convert block and offset to dataptr
 613  */
 614 static inline xfs_dir2_dataptr_t
 615 xfs_dir2_db_off_to_dataptr(struct xfs_mount *mp, xfs_dir2_db_t db,
 616                            xfs_dir2_data_aoff_t o)
 617 {
 618         return xfs_dir2_byte_to_dataptr(mp, xfs_dir2_db_off_to_byte(mp, db, o));
 619 }
 620
 621 /*
 622  * Convert block (dablk) to block (DB)
 623  */
 624 static inline xfs_dir2_db_t
 625 xfs_dir2_da_to_db(struct xfs_mount *mp, xfs_dablk_t da)
 626 {
 627         return (xfs_dir2_db_t)(da >> mp->m_sb.sb_dirblklog);
 628 }
 629
 630 /*
 631  * Convert block (dablk) to byte offset in space
 632  */
 633 static inline xfs_dir2_off_t
 634 xfs_dir2_da_to_byte(struct xfs_mount *mp, xfs_dablk_t da)
 635 {
 636         return xfs_dir2_db_off_to_byte(mp, xfs_dir2_da_to_db(mp, da), 0);
 637 }
 638
 639 /*
 640  * Free space block defintions for the node format.
 641  */
 642
 643 /*
 644  * Offset of the freespace index.
 645  */
 646 #define XFS_DIR2_FREE_SPACE     2
 647 #define XFS_DIR2_FREE_OFFSET    (XFS_DIR2_FREE_SPACE * XFS_DIR2_SPACE_SIZE)
 648 #define XFS_DIR2_FREE_FIRSTDB(mp)       \
 649         xfs_dir2_byte_to_db(mp, XFS_DIR2_FREE_OFFSET)
 650
 651 typedef struct xfs_dir2_free_hdr {
 652         __be32                  magic;          /* XFS_DIR2_FREE_MAGIC */
 653         __be32                  firstdb;        /* db of first entry */
 654         __be32                  nvalid;         /* count of valid entries */
 655         __be32                  nused;          /* count of used entries */
 656 } xfs_dir2_free_hdr_t;
 657
 658 typedef struct xfs_dir2_free {
 659         xfs_dir2_free_hdr_t     hdr;            /* block header */
 660         __be16                  bests[];        /* best free counts */
 661                                                 /* unused entries are -1 */
 662 } xfs_dir2_free_t;
 663
 664 struct xfs_dir3_free_hdr {
 665         struct xfs_dir3_blk_hdr hdr;
 666         __be32                  firstdb;        /* db of first entry */
 667         __be32                  nvalid;         /* count of valid entries */
 668         __be32                  nused;          /* count of used entries */
 669 };
 670
 671 struct xfs_dir3_free {
 672         struct xfs_dir3_free_hdr hdr;
 673         __be16                  bests[];        /* best free counts */
 674                                                 /* unused entries are -1 */
 675 };
 676
 677 #define XFS_DIR3_FREE_CRC_OFF  offsetof(struct xfs_dir3_free, hdr.hdr.crc)
 678
 679 /*
 680  * In core version of the free block header, abstracted away from on-disk format
 681  * differences. Use this in the code, and convert to/from the disk version using
 682  * xfs_dir3_free_hdr_from_disk/xfs_dir3_free_hdr_to_disk.
 683  */
 684 struct xfs_dir3_icfree_hdr {
 685         __uint32_t      magic;
 686         __uint32_t      firstdb;
 687         __uint32_t      nvalid;
 688         __uint32_t      nused;
 689
 690 };
 691
 692 void xfs_dir3_free_hdr_from_disk(struct xfs_dir3_icfree_hdr *to,
 693                                  struct xfs_dir2_free *from);
 694
 695 static inline int
 696 xfs_dir3_free_hdr_size(struct xfs_mount *mp)
 697 {
 698         if (xfs_sb_version_hascrc(&mp->m_sb))
 699                 return sizeof(struct xfs_dir3_free_hdr);
 700         return sizeof(struct xfs_dir2_free_hdr);
 701 }
 702
 703 static inline int
 704 xfs_dir3_free_max_bests(struct xfs_mount *mp)
 705 {
 706         return (mp->m_dirblksize - xfs_dir3_free_hdr_size(mp)) /
 707                 sizeof(xfs_dir2_data_off_t);
 708 }
 709
 710 static inline __be16 *
 711 xfs_dir3_free_bests_p(struct xfs_mount *mp, struct xfs_dir2_free *free)
 712 {
 713         return (__be16 *)((char *)free + xfs_dir3_free_hdr_size(mp));
 714 }
 715
 716 /*
 717  * Convert data space db to the corresponding free db.
 718  */
 719 static inline xfs_dir2_db_t
 720 xfs_dir2_db_to_fdb(struct xfs_mount *mp, xfs_dir2_db_t db)
 721 {
 722         return XFS_DIR2_FREE_FIRSTDB(mp) + db / xfs_dir3_free_max_bests(mp);
 723 }
 724
 725 /*
 726  * Convert data space db to the corresponding index in a free db.
 727  */
 728 static inline int
 729 xfs_dir2_db_to_fdindex(struct xfs_mount *mp, xfs_dir2_db_t db)
 730 {
 731         return db % xfs_dir3_free_max_bests(mp);
 732 }
 733
 734 /*
 735  * Single block format.
 736  *
 737  * The single block format looks like the following drawing on disk:
 738  *
 739  *    +-------------------------------------------------+
 740  *    | xfs_dir2_data_hdr_t                             |
 741  *    +-------------------------------------------------+
 742  *    | xfs_dir2_data_entry_t OR xfs_dir2_data_unused_t |
 743  *    | xfs_dir2_data_entry_t OR xfs_dir2_data_unused_t |
 744  *    | xfs_dir2_data_entry_t OR xfs_dir2_data_unused_t :
 745  *    | ...                                             |
 746  *    +-------------------------------------------------+
 747  *    | unused space                                    |
 748  *    +-------------------------------------------------+
 749  *    | ...                                             |
 750  *    | xfs_dir2_leaf_entry_t                           |
 751  *    | xfs_dir2_leaf_entry_t                           |
 752  *    +-------------------------------------------------+
 753  *    | xfs_dir2_block_tail_t                           |
 754  *    +-------------------------------------------------+
 755  *
 756  * As all the entries are variable size structures the accessors below should
 757  * be used to iterate over them.
 758  */
 759
 760 typedef struct xfs_dir2_block_tail {
 761         __be32          count;                  /* count of leaf entries */
 762         __be32          stale;                  /* count of stale lf entries */
 763 } xfs_dir2_block_tail_t;
 764
 765 /*
 766  * Pointer to the leaf header embedded in a data block (1-block format)
 767  */
 768 static inline struct xfs_dir2_block_tail *
 769 xfs_dir2_block_tail_p(struct xfs_mount *mp, struct xfs_dir2_data_hdr *hdr)
 770 {
 771         return ((struct xfs_dir2_block_tail *)
 772                 ((char *)hdr + mp->m_dirblksize)) - 1;
 773 }
 774
 775 /*
 776  * Pointer to the leaf entries embedded in a data block (1-block format)
 777  */
 778 static inline struct xfs_dir2_leaf_entry *
 779 xfs_dir2_block_leaf_p(struct xfs_dir2_block_tail *btp)
 780 {
 781         return ((struct xfs_dir2_leaf_entry *)btp) - be32_to_cpu(btp->count);
 782 }
 783
 784 #endif /* __XFS_DIR2_FORMAT_H__ */