1 /*
2 * Copyright (c) 2000,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_DIR_SF_H__
19 #define __XFS_DIR_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
28 typedef struct { __uint8_t i[sizeof(xfs_ino_t)]; } xfs_dir_ino_t;
29
30 /*
31 * The parent directory has a dedicated field, and the self-pointer must
32 * be calculated on the fly.
33 *
34 * Entries are packed toward the top as tight as possible. The header
35 * and the elements much be memcpy'd out into a work area to get correct
36 * alignment for the inode number fields.
37 */
38 typedef struct xfs_dir_sf_hdr { /* constant-structure header block */
39 xfs_dir_ino_t parent; /* parent dir inode number */
40 __uint8_t count; /* count of active entries */
41 } xfs_dir_sf_hdr_t;
42
43 typedef struct xfs_dir_sf_entry {
44 xfs_dir_ino_t inumber; /* referenced inode number */
45 __uint8_t namelen; /* actual length of name (no NULL) */
46 __uint8_t name[1]; /* name */
47 } xfs_dir_sf_entry_t;
48
49 typedef struct xfs_dir_shortform {
50 xfs_dir_sf_hdr_t hdr;
51 xfs_dir_sf_entry_t list[1]; /* variable sized array */
52 } xfs_dir_shortform_t;
53
54 /*
55 * We generate this then sort it, so that readdirs are returned in
56 * hash-order. Else seekdir won't work.
57 */
58 typedef struct xfs_dir_sf_sort {
59 __uint8_t entno; /* .=0, ..=1, else entry# + 2 */
60 __uint8_t seqno; /* sequence # with same hash value */
61 __uint8_t namelen; /* length of name value (no null) */
62 xfs_dahash_t hash; /* this entry's hash value */
63 xfs_intino_t ino; /* this entry's inode number */
64 char *name; /* name value, pointer into buffer */
65 } xfs_dir_sf_sort_t;
66
67 #define XFS_DIR_SF_GET_DIRINO(from,to) xfs_dir_sf_get_dirino(from, to)
xfs_dir_sf_get_dirino(xfs_dir_ino_t * from,xfs_ino_t * to)68 static inline void xfs_dir_sf_get_dirino(xfs_dir_ino_t *from, xfs_ino_t *to)
69 {
70 *(to) = XFS_GET_DIR_INO8(*from);
71 }
72
73 #define XFS_DIR_SF_PUT_DIRINO(from,to) xfs_dir_sf_put_dirino(from, to)
xfs_dir_sf_put_dirino(xfs_ino_t * from,xfs_dir_ino_t * to)74 static inline void xfs_dir_sf_put_dirino(xfs_ino_t *from, xfs_dir_ino_t *to)
75 {
76 XFS_PUT_DIR_INO8(*(from), *(to));
77 }
78
79 #define XFS_DIR_SF_ENTSIZE_BYNAME(len) xfs_dir_sf_entsize_byname(len)
xfs_dir_sf_entsize_byname(int len)80 static inline int xfs_dir_sf_entsize_byname(int len)
81 {
82 return (uint)sizeof(xfs_dir_sf_entry_t)-1 + (len);
83 }
84
85 #define XFS_DIR_SF_ENTSIZE_BYENTRY(sfep) xfs_dir_sf_entsize_byentry(sfep)
xfs_dir_sf_entsize_byentry(xfs_dir_sf_entry_t * sfep)86 static inline int xfs_dir_sf_entsize_byentry(xfs_dir_sf_entry_t *sfep)
87 {
88 return (uint)sizeof(xfs_dir_sf_entry_t)-1 + (sfep)->namelen;
89 }
90
91 #define XFS_DIR_SF_NEXTENTRY(sfep) xfs_dir_sf_nextentry(sfep)
xfs_dir_sf_nextentry(xfs_dir_sf_entry_t * sfep)92 static inline xfs_dir_sf_entry_t *xfs_dir_sf_nextentry(xfs_dir_sf_entry_t *sfep)
93 {
94 return (xfs_dir_sf_entry_t *) \
95 ((char *)(sfep) + XFS_DIR_SF_ENTSIZE_BYENTRY(sfep));
96 }
97
98 #define XFS_DIR_SF_ALLFIT(count,totallen) \
99 xfs_dir_sf_allfit(count,totallen)
xfs_dir_sf_allfit(int count,int totallen)100 static inline int xfs_dir_sf_allfit(int count, int totallen)
101 {
102 return ((uint)sizeof(xfs_dir_sf_hdr_t) + \
103 ((uint)sizeof(xfs_dir_sf_entry_t)-1)*(count) + (totallen));
104 }
105
106 #if defined(XFS_DIR_TRACE)
107
108 /*
109 * Kernel tracing support for directories.
110 */
111 struct uio;
112 struct xfs_inode;
113 struct xfs_da_intnode;
114 struct xfs_dinode;
115 struct xfs_dir_leafblock;
116 struct xfs_dir_leaf_entry;
117
118 #define XFS_DIR_TRACE_SIZE 4096 /* size of global trace buffer */
119 extern ktrace_t *xfs_dir_trace_buf;
120
121 /*
122 * Trace record types.
123 */
124 #define XFS_DIR_KTRACE_G_DU 1 /* dp, uio */
125 #define XFS_DIR_KTRACE_G_DUB 2 /* dp, uio, bno */
126 #define XFS_DIR_KTRACE_G_DUN 3 /* dp, uio, node */
127 #define XFS_DIR_KTRACE_G_DUL 4 /* dp, uio, leaf */
128 #define XFS_DIR_KTRACE_G_DUE 5 /* dp, uio, leaf entry */
129 #define XFS_DIR_KTRACE_G_DUC 6 /* dp, uio, cookie */
130
131 void xfs_dir_trace_g_du(char *where, struct xfs_inode *dp, struct uio *uio);
132 void xfs_dir_trace_g_dub(char *where, struct xfs_inode *dp, struct uio *uio,
133 xfs_dablk_t bno);
134 void xfs_dir_trace_g_dun(char *where, struct xfs_inode *dp, struct uio *uio,
135 struct xfs_da_intnode *node);
136 void xfs_dir_trace_g_dul(char *where, struct xfs_inode *dp, struct uio *uio,
137 struct xfs_dir_leafblock *leaf);
138 void xfs_dir_trace_g_due(char *where, struct xfs_inode *dp, struct uio *uio,
139 struct xfs_dir_leaf_entry *entry);
140 void xfs_dir_trace_g_duc(char *where, struct xfs_inode *dp, struct uio *uio,
141 xfs_off_t cookie);
142 void xfs_dir_trace_enter(int type, char *where,
143 void *a0, void *a1, void *a2, void *a3,
144 void *a4, void *a5, void *a6, void *a7,
145 void *a8, void *a9, void *a10, void *a11);
146 #else
147 #define xfs_dir_trace_g_du(w,d,u)
148 #define xfs_dir_trace_g_dub(w,d,u,b)
149 #define xfs_dir_trace_g_dun(w,d,u,n)
150 #define xfs_dir_trace_g_dul(w,d,u,l)
151 #define xfs_dir_trace_g_due(w,d,u,e)
152 #define xfs_dir_trace_g_duc(w,d,u,c)
153 #endif /* DEBUG */
154
155 #endif /* __XFS_DIR_SF_H__ */
156