blob: 208d2c3c11222f51c5525567ad777dc0c33624a9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_DIR2_SF_H__
19#define __XFS_DIR2_SF_H__
20
21/*
22 * Directory layout when stored internal to an inode.
23 *
24 * Small directories are packed as tightly as possible so as to
25 * fit into the literal area of the inode.
26 */
27
28struct uio;
29struct xfs_dabuf;
30struct xfs_da_args;
31struct xfs_dir2_block;
32struct xfs_inode;
33struct xfs_mount;
34struct xfs_trans;
35
36/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 * Inode number stored as 8 8-bit values.
38 */
39typedef struct { __uint8_t i[8]; } xfs_dir2_ino8_t;
40
41/*
42 * Inode number stored as 4 8-bit values.
43 * Works a lot of the time, when all the inode numbers in a directory
44 * fit in 32 bits.
45 */
46typedef struct { __uint8_t i[4]; } xfs_dir2_ino4_t;
47
48typedef union {
49 xfs_dir2_ino8_t i8;
50 xfs_dir2_ino4_t i4;
51} xfs_dir2_inou_t;
52#define XFS_DIR2_MAX_SHORT_INUM ((xfs_ino_t)0xffffffffULL)
53
54/*
55 * Normalized offset (in a data block) of the entry, really xfs_dir2_data_off_t.
56 * Only need 16 bits, this is the byte offset into the single block form.
57 */
Eric Sandeenae23a5e2008-06-23 13:23:32 +100058typedef struct { __uint8_t i[2]; } __arch_pack xfs_dir2_sf_off_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60/*
61 * The parent directory has a dedicated field, and the self-pointer must
62 * be calculated on the fly.
63 *
64 * Entries are packed toward the top as tightly as possible. The header
65 * and the elements must be memcpy'd out into a work area to get correct
66 * alignment for the inode number fields.
67 */
68typedef struct xfs_dir2_sf_hdr {
69 __uint8_t count; /* count of entries */
70 __uint8_t i8count; /* count of 8-byte inode #s */
71 xfs_dir2_inou_t parent; /* parent dir inode number */
Eric Sandeenae23a5e2008-06-23 13:23:32 +100072} __arch_pack xfs_dir2_sf_hdr_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74typedef struct xfs_dir2_sf_entry {
75 __uint8_t namelen; /* actual name length */
76 xfs_dir2_sf_off_t offset; /* saved offset */
77 __uint8_t name[1]; /* name, variable size */
78 xfs_dir2_inou_t inumber; /* inode number, var. offset */
Eric Sandeenae23a5e2008-06-23 13:23:32 +100079} __arch_pack xfs_dir2_sf_entry_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81typedef struct xfs_dir2_sf {
82 xfs_dir2_sf_hdr_t hdr; /* shortform header */
83 xfs_dir2_sf_entry_t list[1]; /* shortform entries */
84} xfs_dir2_sf_t;
85
Nathan Scotta844f452005-11-02 14:38:42 +110086static inline int xfs_dir2_sf_hdr_size(int i8count)
87{
88 return ((uint)sizeof(xfs_dir2_sf_hdr_t) - \
89 ((i8count) == 0) * \
90 ((uint)sizeof(xfs_dir2_ino8_t) - (uint)sizeof(xfs_dir2_ino4_t)));
91}
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Nathan Scotta844f452005-11-02 14:38:42 +110093static inline xfs_dir2_data_aoff_t
94xfs_dir2_sf_get_offset(xfs_dir2_sf_entry_t *sfep)
95{
96 return INT_GET_UNALIGNED_16_BE(&(sfep)->offset.i);
97}
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Nathan Scotta844f452005-11-02 14:38:42 +110099static inline void
100xfs_dir2_sf_put_offset(xfs_dir2_sf_entry_t *sfep, xfs_dir2_data_aoff_t off)
101{
102 INT_SET_UNALIGNED_16_BE(&(sfep)->offset.i, off);
103}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Nathan Scotta844f452005-11-02 14:38:42 +1100105static inline int xfs_dir2_sf_entsize_byname(xfs_dir2_sf_t *sfp, int len)
106{
107 return ((uint)sizeof(xfs_dir2_sf_entry_t) - 1 + (len) - \
108 ((sfp)->hdr.i8count == 0) * \
109 ((uint)sizeof(xfs_dir2_ino8_t) - (uint)sizeof(xfs_dir2_ino4_t)));
110}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Nathan Scotta844f452005-11-02 14:38:42 +1100112static inline int
113xfs_dir2_sf_entsize_byentry(xfs_dir2_sf_t *sfp, xfs_dir2_sf_entry_t *sfep)
114{
115 return ((uint)sizeof(xfs_dir2_sf_entry_t) - 1 + (sfep)->namelen - \
116 ((sfp)->hdr.i8count == 0) * \
117 ((uint)sizeof(xfs_dir2_ino8_t) - (uint)sizeof(xfs_dir2_ino4_t)));
118}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Nathan Scotta844f452005-11-02 14:38:42 +1100120static inline xfs_dir2_sf_entry_t *xfs_dir2_sf_firstentry(xfs_dir2_sf_t *sfp)
121{
122 return ((xfs_dir2_sf_entry_t *) \
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000123 ((char *)(sfp) + xfs_dir2_sf_hdr_size(sfp->hdr.i8count)));
Nathan Scotta844f452005-11-02 14:38:42 +1100124}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Nathan Scotta844f452005-11-02 14:38:42 +1100126static inline xfs_dir2_sf_entry_t *
127xfs_dir2_sf_nextentry(xfs_dir2_sf_t *sfp, xfs_dir2_sf_entry_t *sfep)
128{
129 return ((xfs_dir2_sf_entry_t *) \
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000130 ((char *)(sfep) + xfs_dir2_sf_entsize_byentry(sfp,sfep)));
Nathan Scotta844f452005-11-02 14:38:42 +1100131}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133/*
134 * Functions.
135 */
Christoph Hellwig8bc38782011-07-08 14:35:03 +0200136extern xfs_ino_t xfs_dir2_sf_get_parent_ino(struct xfs_dir2_sf *sfp);
137extern xfs_ino_t xfs_dir2_sfe_get_ino(struct xfs_dir2_sf *sfp,
138 struct xfs_dir2_sf_entry *sfep);
Nathan Scotta844f452005-11-02 14:38:42 +1100139extern int xfs_dir2_block_sfsize(struct xfs_inode *dp,
140 struct xfs_dir2_block *block,
141 xfs_dir2_sf_hdr_t *sfhp);
142extern int xfs_dir2_block_to_sf(struct xfs_da_args *args, struct xfs_dabuf *bp,
143 int size, xfs_dir2_sf_hdr_t *sfhp);
144extern int xfs_dir2_sf_addname(struct xfs_da_args *args);
145extern int xfs_dir2_sf_create(struct xfs_da_args *args, xfs_ino_t pino);
Christoph Hellwig051e7cd2007-08-28 13:58:24 +1000146extern int xfs_dir2_sf_getdents(struct xfs_inode *dp, void *dirent,
147 xfs_off_t *offset, filldir_t filldir);
Nathan Scotta844f452005-11-02 14:38:42 +1100148extern int xfs_dir2_sf_lookup(struct xfs_da_args *args);
149extern int xfs_dir2_sf_removename(struct xfs_da_args *args);
150extern int xfs_dir2_sf_replace(struct xfs_da_args *args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152#endif /* __XFS_DIR2_SF_H__ */