[XFS] Update license/copyright notices to match the prefered SGI
[linux-block.git] / fs / xfs / xfs_dinode.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
NS
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
NS
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.
1da177e4 13 *
7b718769
NS
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
1da177e4
LT
17 */
18#ifndef __XFS_DINODE_H__
19#define __XFS_DINODE_H__
20
21struct xfs_buf;
22struct xfs_mount;
23
24#define XFS_DINODE_VERSION_1 1
25#define XFS_DINODE_VERSION_2 2
a844f451
NS
26#define XFS_DINODE_GOOD_VERSION(v) \
27 (((v) == XFS_DINODE_VERSION_1 || (v) == XFS_DINODE_VERSION_2))
1da177e4
LT
28#define XFS_DINODE_MAGIC 0x494e /* 'IN' */
29
30/*
31 * Disk inode structure.
32 * This is just the header; the inode is expanded to fill a variable size
33 * with the last field expanding. It is split into the core and "other"
34 * because we only need the core part in the in-core inode.
35 */
36typedef struct xfs_timestamp {
37 __int32_t t_sec; /* timestamp seconds */
38 __int32_t t_nsec; /* timestamp nanoseconds */
39} xfs_timestamp_t;
40
41/*
42 * Note: Coordinate changes to this structure with the XFS_DI_* #defines
43 * below and the offsets table in xfs_ialloc_log_di().
44 */
45typedef struct xfs_dinode_core
46{
47 __uint16_t di_magic; /* inode magic # = XFS_DINODE_MAGIC */
48 __uint16_t di_mode; /* mode and type of file */
49 __int8_t di_version; /* inode version */
50 __int8_t di_format; /* format of di_c data */
51 __uint16_t di_onlink; /* old number of links to file */
52 __uint32_t di_uid; /* owner's user id */
53 __uint32_t di_gid; /* owner's group id */
54 __uint32_t di_nlink; /* number of links to file */
55 __uint16_t di_projid; /* owner's project id */
56 __uint8_t di_pad[8]; /* unused, zeroed space */
57 __uint16_t di_flushiter; /* incremented on flush */
58 xfs_timestamp_t di_atime; /* time last accessed */
59 xfs_timestamp_t di_mtime; /* time last modified */
60 xfs_timestamp_t di_ctime; /* time created/inode modified */
61 xfs_fsize_t di_size; /* number of bytes in file */
62 xfs_drfsbno_t di_nblocks; /* # of direct & btree blocks used */
63 xfs_extlen_t di_extsize; /* basic/minimum extent size for file */
64 xfs_extnum_t di_nextents; /* number of extents in data fork */
65 xfs_aextnum_t di_anextents; /* number of extents in attribute fork*/
66 __uint8_t di_forkoff; /* attr fork offs, <<3 for 64b align */
67 __int8_t di_aformat; /* format of attr fork's data */
68 __uint32_t di_dmevmask; /* DMIG event mask */
69 __uint16_t di_dmstate; /* DMIG state info */
70 __uint16_t di_flags; /* random flags, XFS_DIFLAG_... */
71 __uint32_t di_gen; /* generation number */
72} xfs_dinode_core_t;
73
74#define DI_MAX_FLUSH 0xffff
75
76typedef struct xfs_dinode
77{
78 xfs_dinode_core_t di_core;
79 /*
80 * In adding anything between the core and the union, be
81 * sure to update the macros like XFS_LITINO below and
82 * XFS_BMAP_RBLOCK_DSIZE in xfs_bmap_btree.h.
83 */
84 xfs_agino_t di_next_unlinked;/* agi unlinked list ptr */
85 union {
86 xfs_bmdr_block_t di_bmbt; /* btree root block */
87 xfs_bmbt_rec_32_t di_bmx[1]; /* extent list */
88 xfs_dir_shortform_t di_dirsf; /* shortform directory */
89 xfs_dir2_sf_t di_dir2sf; /* shortform directory v2 */
90 char di_c[1]; /* local contents */
91 xfs_dev_t di_dev; /* device for S_IFCHR/S_IFBLK */
92 uuid_t di_muuid; /* mount point value */
93 char di_symlink[1]; /* local symbolic link */
94 } di_u;
95 union {
96 xfs_bmdr_block_t di_abmbt; /* btree root block */
97 xfs_bmbt_rec_32_t di_abmx[1]; /* extent list */
98 xfs_attr_shortform_t di_attrsf; /* shortform attribute list */
99 } di_a;
100} xfs_dinode_t;
101
102/*
103 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX.
104 * Since the pathconf interface is signed, we use 2^31 - 1 instead.
105 * The old inode format had a 16 bit link count, so its maximum is USHRT_MAX.
106 */
107#define XFS_MAXLINK ((1U << 31) - 1U)
108#define XFS_MAXLINK_1 65535U
109
110/*
111 * Bit names for logging disk inodes only
112 */
113#define XFS_DI_MAGIC 0x0000001
114#define XFS_DI_MODE 0x0000002
115#define XFS_DI_VERSION 0x0000004
116#define XFS_DI_FORMAT 0x0000008
117#define XFS_DI_ONLINK 0x0000010
118#define XFS_DI_UID 0x0000020
119#define XFS_DI_GID 0x0000040
120#define XFS_DI_NLINK 0x0000080
121#define XFS_DI_PROJID 0x0000100
122#define XFS_DI_PAD 0x0000200
123#define XFS_DI_ATIME 0x0000400
124#define XFS_DI_MTIME 0x0000800
125#define XFS_DI_CTIME 0x0001000
126#define XFS_DI_SIZE 0x0002000
127#define XFS_DI_NBLOCKS 0x0004000
128#define XFS_DI_EXTSIZE 0x0008000
129#define XFS_DI_NEXTENTS 0x0010000
130#define XFS_DI_NAEXTENTS 0x0020000
131#define XFS_DI_FORKOFF 0x0040000
132#define XFS_DI_AFORMAT 0x0080000
133#define XFS_DI_DMEVMASK 0x0100000
134#define XFS_DI_DMSTATE 0x0200000
135#define XFS_DI_FLAGS 0x0400000
136#define XFS_DI_GEN 0x0800000
137#define XFS_DI_NEXT_UNLINKED 0x1000000
138#define XFS_DI_U 0x2000000
139#define XFS_DI_A 0x4000000
140#define XFS_DI_NUM_BITS 27
141#define XFS_DI_ALL_BITS ((1 << XFS_DI_NUM_BITS) - 1)
142#define XFS_DI_CORE_BITS (XFS_DI_ALL_BITS & ~(XFS_DI_U|XFS_DI_A))
143
144/*
145 * Values for di_format
146 */
147typedef enum xfs_dinode_fmt
148{
149 XFS_DINODE_FMT_DEV, /* CHR, BLK: di_dev */
150 XFS_DINODE_FMT_LOCAL, /* DIR, REG: di_c */
151 /* LNK: di_symlink */
152 XFS_DINODE_FMT_EXTENTS, /* DIR, REG, LNK: di_bmx */
153 XFS_DINODE_FMT_BTREE, /* DIR, REG, LNK: di_bmbt */
154 XFS_DINODE_FMT_UUID /* MNT: di_uuid */
155} xfs_dinode_fmt_t;
156
157/*
158 * Inode minimum and maximum sizes.
159 */
160#define XFS_DINODE_MIN_LOG 8
161#define XFS_DINODE_MAX_LOG 11
162#define XFS_DINODE_MIN_SIZE (1 << XFS_DINODE_MIN_LOG)
163#define XFS_DINODE_MAX_SIZE (1 << XFS_DINODE_MAX_LOG)
164
165/*
166 * Inode size for given fs.
167 */
1da177e4 168#define XFS_LITINO(mp) ((mp)->m_litino)
1da177e4
LT
169#define XFS_BROOT_SIZE_ADJ \
170 (sizeof(xfs_bmbt_block_t) - sizeof(xfs_bmdr_block_t))
171
1da177e4
LT
172/*
173 * Inode data & attribute fork sizes, per inode.
174 */
1da177e4 175#define XFS_CFORK_Q(dcp) ((dcp)->di_forkoff != 0)
a844f451 176#define XFS_CFORK_Q_DISK(dcp) ((dcp)->di_forkoff != 0)
1da177e4 177
1da177e4 178#define XFS_CFORK_BOFF(dcp) ((int)((dcp)->di_forkoff << 3))
a844f451
NS
179#define XFS_CFORK_BOFF_DISK(dcp) \
180 ((int)(INT_GET((dcp)->di_forkoff, ARCH_CONVERT) << 3))
1da177e4 181
1da177e4
LT
182#define XFS_CFORK_DSIZE_DISK(dcp,mp) \
183 (XFS_CFORK_Q_DISK(dcp) ? XFS_CFORK_BOFF_DISK(dcp) : XFS_LITINO(mp))
184#define XFS_CFORK_DSIZE(dcp,mp) \
185 (XFS_CFORK_Q(dcp) ? XFS_CFORK_BOFF(dcp) : XFS_LITINO(mp))
186
1da177e4
LT
187#define XFS_CFORK_ASIZE_DISK(dcp,mp) \
188 (XFS_CFORK_Q_DISK(dcp) ? XFS_LITINO(mp) - XFS_CFORK_BOFF_DISK(dcp) : 0)
189#define XFS_CFORK_ASIZE(dcp,mp) \
190 (XFS_CFORK_Q(dcp) ? XFS_LITINO(mp) - XFS_CFORK_BOFF(dcp) : 0)
191
1da177e4
LT
192#define XFS_CFORK_SIZE_DISK(dcp,mp,w) \
193 ((w) == XFS_DATA_FORK ? \
194 XFS_CFORK_DSIZE_DISK(dcp, mp) : \
195 XFS_CFORK_ASIZE_DISK(dcp, mp))
196#define XFS_CFORK_SIZE(dcp,mp,w) \
197 ((w) == XFS_DATA_FORK ? \
198 XFS_CFORK_DSIZE(dcp, mp) : XFS_CFORK_ASIZE(dcp, mp))
199
a844f451
NS
200#define XFS_DFORK_DSIZE(dip,mp) \
201 XFS_CFORK_DSIZE_DISK(&(dip)->di_core, mp)
202#define XFS_DFORK_ASIZE(dip,mp) \
203 XFS_CFORK_ASIZE_DISK(&(dip)->di_core, mp)
204#define XFS_DFORK_SIZE(dip,mp,w) \
205 XFS_CFORK_SIZE_DISK(&(dip)->di_core, mp, w)
1da177e4 206
1da177e4 207#define XFS_DFORK_Q(dip) XFS_CFORK_Q_DISK(&(dip)->di_core)
1da177e4 208#define XFS_DFORK_BOFF(dip) XFS_CFORK_BOFF_DISK(&(dip)->di_core)
1da177e4 209#define XFS_DFORK_DPTR(dip) ((dip)->di_u.di_c)
a844f451
NS
210#define XFS_DFORK_APTR(dip) \
211 ((dip)->di_u.di_c + XFS_DFORK_BOFF(dip))
1da177e4
LT
212#define XFS_DFORK_PTR(dip,w) \
213 ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip))
a844f451 214#define XFS_CFORK_FORMAT(dcp,w) \
1da177e4 215 ((w) == XFS_DATA_FORK ? (dcp)->di_format : (dcp)->di_aformat)
1da177e4
LT
216#define XFS_CFORK_FMT_SET(dcp,w,n) \
217 ((w) == XFS_DATA_FORK ? \
a844f451 218 ((dcp)->di_format = (n)) : ((dcp)->di_aformat = (n)))
1da177e4 219
1da177e4
LT
220#define XFS_CFORK_NEXTENTS_DISK(dcp,w) \
221 ((w) == XFS_DATA_FORK ? \
222 INT_GET((dcp)->di_nextents, ARCH_CONVERT) : \
223 INT_GET((dcp)->di_anextents, ARCH_CONVERT))
224#define XFS_CFORK_NEXTENTS(dcp,w) \
225 ((w) == XFS_DATA_FORK ? (dcp)->di_nextents : (dcp)->di_anextents)
226
1da177e4
LT
227#define XFS_CFORK_NEXT_SET(dcp,w,n) \
228 ((w) == XFS_DATA_FORK ? \
a844f451 229 ((dcp)->di_nextents = (n)) : ((dcp)->di_anextents = (n)))
1da177e4 230
1da177e4 231#define XFS_DFORK_NEXTENTS(dip,w) XFS_CFORK_NEXTENTS_DISK(&(dip)->di_core, w)
1da177e4 232
a844f451 233#define XFS_BUF_TO_DINODE(bp) ((xfs_dinode_t *)XFS_BUF_PTR(bp))
1da177e4
LT
234
235/*
236 * Values for di_flags
237 * There should be a one-to-one correspondence between these flags and the
238 * XFS_XFLAG_s.
239 */
240#define XFS_DIFLAG_REALTIME_BIT 0 /* file's blocks come from rt area */
241#define XFS_DIFLAG_PREALLOC_BIT 1 /* file space has been preallocated */
242#define XFS_DIFLAG_NEWRTBM_BIT 2 /* for rtbitmap inode, new format */
243#define XFS_DIFLAG_IMMUTABLE_BIT 3 /* inode is immutable */
244#define XFS_DIFLAG_APPEND_BIT 4 /* inode is append-only */
245#define XFS_DIFLAG_SYNC_BIT 5 /* inode is written synchronously */
246#define XFS_DIFLAG_NOATIME_BIT 6 /* do not update atime */
247#define XFS_DIFLAG_NODUMP_BIT 7 /* do not dump */
248#define XFS_DIFLAG_RTINHERIT_BIT 8 /* create with realtime bit set */
249#define XFS_DIFLAG_PROJINHERIT_BIT 9 /* create with parents projid */
250#define XFS_DIFLAG_NOSYMLINKS_BIT 10 /* disallow symlink creation */
251#define XFS_DIFLAG_REALTIME (1 << XFS_DIFLAG_REALTIME_BIT)
252#define XFS_DIFLAG_PREALLOC (1 << XFS_DIFLAG_PREALLOC_BIT)
253#define XFS_DIFLAG_NEWRTBM (1 << XFS_DIFLAG_NEWRTBM_BIT)
254#define XFS_DIFLAG_IMMUTABLE (1 << XFS_DIFLAG_IMMUTABLE_BIT)
255#define XFS_DIFLAG_APPEND (1 << XFS_DIFLAG_APPEND_BIT)
256#define XFS_DIFLAG_SYNC (1 << XFS_DIFLAG_SYNC_BIT)
257#define XFS_DIFLAG_NOATIME (1 << XFS_DIFLAG_NOATIME_BIT)
258#define XFS_DIFLAG_NODUMP (1 << XFS_DIFLAG_NODUMP_BIT)
259#define XFS_DIFLAG_RTINHERIT (1 << XFS_DIFLAG_RTINHERIT_BIT)
260#define XFS_DIFLAG_PROJINHERIT (1 << XFS_DIFLAG_PROJINHERIT_BIT)
261#define XFS_DIFLAG_NOSYMLINKS (1 << XFS_DIFLAG_NOSYMLINKS_BIT)
262
263#define XFS_DIFLAG_ANY \
264 (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \
265 XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \
266 XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \
267 XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS)
268
269#endif /* __XFS_DINODE_H__ */