blob: 2b75b767e152a746e53203c66193663e8cfdd7dd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (c) 2000 Silicon Graphics, Inc. All Rights Reserved.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11 *
12 * Further, this software is distributed without any warranty that it is
13 * free of the rightful claim of any third person regarding infringement
14 * or the like. Any license provided herein, whether implied or
15 * otherwise, applies only to this software file. Patent licenses, if
16 * any, provided herein do not apply to combinations of this program with
17 * other software, or any other product whatsoever.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write the Free Software Foundation, Inc., 59
21 * Temple Place - Suite 330, Boston MA 02111-1307, USA.
22 *
23 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24 * Mountain View, CA 94043, or:
25 *
26 * http://www.sgi.com
27 *
28 * For further information regarding this notice, see:
29 *
30 * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
31 */
32#ifndef __XFS_DIR_SF_H__
33#define __XFS_DIR_SF_H__
34
35/*
36 * Directory layout when stored internal to an inode.
37 *
38 * Small directories are packed as tightly as possible so as to
39 * fit into the literal area of the inode.
40 */
41
42typedef struct { __uint8_t i[sizeof(xfs_ino_t)]; } xfs_dir_ino_t;
43
44/*
45 * The parent directory has a dedicated field, and the self-pointer must
46 * be calculated on the fly.
47 *
48 * Entries are packed toward the top as tight as possible. The header
49 * and the elements much be memcpy'd out into a work area to get correct
50 * alignment for the inode number fields.
51 */
52typedef struct xfs_dir_shortform {
53 struct xfs_dir_sf_hdr { /* constant-structure header block */
54 xfs_dir_ino_t parent; /* parent dir inode number */
55 __uint8_t count; /* count of active entries */
56 } hdr;
57 struct xfs_dir_sf_entry {
58 xfs_dir_ino_t inumber; /* referenced inode number */
59 __uint8_t namelen; /* actual length of name (no NULL) */
60 __uint8_t name[1]; /* name */
61 } list[1]; /* variable sized array */
62} xfs_dir_shortform_t;
63typedef struct xfs_dir_sf_hdr xfs_dir_sf_hdr_t;
64typedef struct xfs_dir_sf_entry xfs_dir_sf_entry_t;
65
66/*
67 * We generate this then sort it, so that readdirs are returned in
68 * hash-order. Else seekdir won't work.
69 */
70typedef struct xfs_dir_sf_sort {
71 __uint8_t entno; /* .=0, ..=1, else entry# + 2 */
72 __uint8_t seqno; /* sequence # with same hash value */
73 __uint8_t namelen; /* length of name value (no null) */
74 xfs_dahash_t hash; /* this entry's hash value */
75 xfs_intino_t ino; /* this entry's inode number */
76 char *name; /* name value, pointer into buffer */
77} xfs_dir_sf_sort_t;
78
Nathan Scotta844f452005-11-02 14:38:42 +110079#define XFS_DIR_SF_GET_DIRINO(from,to) xfs_dir_sf_get_dirino(from, to)
80static inline void xfs_dir_sf_get_dirino(xfs_dir_ino_t *from, xfs_ino_t *to)
81{
82 *(to) = XFS_GET_DIR_INO8(*from);
83}
84
85#define XFS_DIR_SF_PUT_DIRINO(from,to) xfs_dir_sf_put_dirino(from, to)
86static inline void xfs_dir_sf_put_dirino(xfs_ino_t *from, xfs_dir_ino_t *to)
87{
88 XFS_PUT_DIR_INO8(*(from), *(to));
89}
90
91#define XFS_DIR_SF_ENTSIZE_BYNAME(len) xfs_dir_sf_entsize_byname(len)
92static inline int xfs_dir_sf_entsize_byname(int len)
93{
94 return (uint)sizeof(xfs_dir_sf_entry_t)-1 + (len);
95}
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define XFS_DIR_SF_ENTSIZE_BYENTRY(sfep) xfs_dir_sf_entsize_byentry(sfep)
Nathan Scotta844f452005-11-02 14:38:42 +110098static inline int xfs_dir_sf_entsize_byentry(xfs_dir_sf_entry_t *sfep)
99{
100 return (uint)sizeof(xfs_dir_sf_entry_t)-1 + (sfep)->namelen;
101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#define XFS_DIR_SF_NEXTENTRY(sfep) xfs_dir_sf_nextentry(sfep)
Nathan Scotta844f452005-11-02 14:38:42 +1100104static inline xfs_dir_sf_entry_t *xfs_dir_sf_nextentry(xfs_dir_sf_entry_t *sfep)
105{
106 return (xfs_dir_sf_entry_t *) \
107 ((char *)(sfep) + XFS_DIR_SF_ENTSIZE_BYENTRY(sfep));
108}
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#define XFS_DIR_SF_ALLFIT(count,totallen) \
111 xfs_dir_sf_allfit(count,totallen)
Nathan Scotta844f452005-11-02 14:38:42 +1100112static inline int xfs_dir_sf_allfit(int count, int totallen)
113{
114 return ((uint)sizeof(xfs_dir_sf_hdr_t) + \
115 ((uint)sizeof(xfs_dir_sf_entry_t)-1)*(count) + (totallen));
116}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118#if defined(XFS_DIR_TRACE)
119
120/*
121 * Kernel tracing support for directories.
122 */
123struct uio;
124struct xfs_inode;
125struct xfs_da_intnode;
126struct xfs_dinode;
127struct xfs_dir_leafblock;
128struct xfs_dir_leaf_entry;
129
130#define XFS_DIR_TRACE_SIZE 4096 /* size of global trace buffer */
131extern ktrace_t *xfs_dir_trace_buf;
132
133/*
134 * Trace record types.
135 */
136#define XFS_DIR_KTRACE_G_DU 1 /* dp, uio */
137#define XFS_DIR_KTRACE_G_DUB 2 /* dp, uio, bno */
138#define XFS_DIR_KTRACE_G_DUN 3 /* dp, uio, node */
139#define XFS_DIR_KTRACE_G_DUL 4 /* dp, uio, leaf */
140#define XFS_DIR_KTRACE_G_DUE 5 /* dp, uio, leaf entry */
141#define XFS_DIR_KTRACE_G_DUC 6 /* dp, uio, cookie */
142
143void xfs_dir_trace_g_du(char *where, struct xfs_inode *dp, struct uio *uio);
144void xfs_dir_trace_g_dub(char *where, struct xfs_inode *dp, struct uio *uio,
145 xfs_dablk_t bno);
146void xfs_dir_trace_g_dun(char *where, struct xfs_inode *dp, struct uio *uio,
147 struct xfs_da_intnode *node);
148void xfs_dir_trace_g_dul(char *where, struct xfs_inode *dp, struct uio *uio,
149 struct xfs_dir_leafblock *leaf);
150void xfs_dir_trace_g_due(char *where, struct xfs_inode *dp, struct uio *uio,
151 struct xfs_dir_leaf_entry *entry);
152void xfs_dir_trace_g_duc(char *where, struct xfs_inode *dp, struct uio *uio,
153 xfs_off_t cookie);
154void xfs_dir_trace_enter(int type, char *where,
155 void *a0, void *a1, void *a2, void *a3,
156 void *a4, void *a5, void *a6, void *a7,
157 void *a8, void *a9, void *a10, void *a11);
158#else
159#define xfs_dir_trace_g_du(w,d,u)
160#define xfs_dir_trace_g_dub(w,d,u,b)
161#define xfs_dir_trace_g_dun(w,d,u,n)
162#define xfs_dir_trace_g_dul(w,d,u,l)
163#define xfs_dir_trace_g_due(w,d,u,e)
164#define xfs_dir_trace_g_duc(w,d,u,c)
165#endif /* DEBUG */
166
167#endif /* __XFS_DIR_SF_H__ */