1 /*
2 * Copyright (c) 2000,2002,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_DINODE_H__
19 #define __XFS_DINODE_H__
20
21 #define XFS_DINODE_MAGIC 0x494e /* 'IN' */
22 #define XFS_DINODE_GOOD_VERSION(v) ((v) >= 1 && (v) <= 3)
23
24 typedef struct xfs_timestamp {
25 __be32 t_sec; /* timestamp seconds */
26 __be32 t_nsec; /* timestamp nanoseconds */
27 } xfs_timestamp_t;
28
29 /*
30 * On-disk inode structure.
31 *
32 * This is just the header or "dinode core", the inode is expanded to fill a
33 * variable size the leftover area split into a data and an attribute fork.
34 * The format of the data and attribute fork depends on the format of the
35 * inode as indicated by di_format and di_aformat. To access the data and
36 * attribute use the XFS_DFORK_DPTR, XFS_DFORK_APTR, and XFS_DFORK_PTR macros
37 * below.
38 *
39 * There is a very similar struct icdinode in xfs_inode which matches the
40 * layout of the first 96 bytes of this structure, but is kept in native
41 * format instead of big endian.
42 *
43 * Note: di_flushiter is only used by v1/2 inodes - it's effectively a zeroed
44 * padding field for v3 inodes.
45 */
46 typedef struct xfs_dinode {
47 __be16 di_magic; /* inode magic # = XFS_DINODE_MAGIC */
48 __be16 di_mode; /* mode and type of file */
49 __u8 di_version; /* inode version */
50 __u8 di_format; /* format of di_c data */
51 __be16 di_onlink; /* old number of links to file */
52 __be32 di_uid; /* owner's user id */
53 __be32 di_gid; /* owner's group id */
54 __be32 di_nlink; /* number of links to file */
55 __be16 di_projid_lo; /* lower part of owner's project id */
56 __be16 di_projid_hi; /* higher part owner's project id */
57 __u8 di_pad[6]; /* unused, zeroed space */
58 __be16 di_flushiter; /* incremented on flush */
59 xfs_timestamp_t di_atime; /* time last accessed */
60 xfs_timestamp_t di_mtime; /* time last modified */
61 xfs_timestamp_t di_ctime; /* time created/inode modified */
62 __be64 di_size; /* number of bytes in file */
63 __be64 di_nblocks; /* # of direct & btree blocks used */
64 __be32 di_extsize; /* basic/minimum extent size for file */
65 __be32 di_nextents; /* number of extents in data fork */
66 __be16 di_anextents; /* number of extents in attribute fork*/
67 __u8 di_forkoff; /* attr fork offs, <<3 for 64b align */
68 __s8 di_aformat; /* format of attr fork's data */
69 __be32 di_dmevmask; /* DMIG event mask */
70 __be16 di_dmstate; /* DMIG state info */
71 __be16 di_flags; /* random flags, XFS_DIFLAG_... */
72 __be32 di_gen; /* generation number */
73
74 /* di_next_unlinked is the only non-core field in the old dinode */
75 __be32 di_next_unlinked;/* agi unlinked list ptr */
76
77 /* start of the extended dinode, writable fields */
78 __le32 di_crc; /* CRC of the inode */
79 __be64 di_changecount; /* number of attribute changes */
80 __be64 di_lsn; /* flush sequence */
81 __be64 di_flags2; /* more random flags */
82 __u8 di_pad2[16]; /* more padding for future expansion */
83
84 /* fields only written to during inode creation */
85 xfs_timestamp_t di_crtime; /* time created */
86 __be64 di_ino; /* inode number */
87 uuid_t di_uuid; /* UUID of the filesystem */
88
89 /* structure must be padded to 64 bit alignment */
90 } xfs_dinode_t;
91
92 #define XFS_DINODE_CRC_OFF offsetof(struct xfs_dinode, di_crc)
93
94 #define DI_MAX_FLUSH 0xffff
95
96 /*
97 * Size of the core inode on disk. Version 1 and 2 inodes have
98 * the same size, but version 3 has grown a few additional fields.
99 */
xfs_dinode_size(int version)100 static inline uint xfs_dinode_size(int version)
101 {
102 if (version == 3)
103 return sizeof(struct xfs_dinode);
104 return offsetof(struct xfs_dinode, di_crc);
105 }
106
107 /*
108 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX.
109 * Since the pathconf interface is signed, we use 2^31 - 1 instead.
110 * The old inode format had a 16 bit link count, so its maximum is USHRT_MAX.
111 */
112 #define XFS_MAXLINK ((1U << 31) - 1U)
113 #define XFS_MAXLINK_1 65535U
114
115 /*
116 * Values for di_format
117 */
118 typedef enum xfs_dinode_fmt {
119 XFS_DINODE_FMT_DEV, /* xfs_dev_t */
120 XFS_DINODE_FMT_LOCAL, /* bulk data */
121 XFS_DINODE_FMT_EXTENTS, /* struct xfs_bmbt_rec */
122 XFS_DINODE_FMT_BTREE, /* struct xfs_bmdr_block */
123 XFS_DINODE_FMT_UUID /* uuid_t */
124 } xfs_dinode_fmt_t;
125
126 /*
127 * Inode minimum and maximum sizes.
128 */
129 #define XFS_DINODE_MIN_LOG 8
130 #define XFS_DINODE_MAX_LOG 11
131 #define XFS_DINODE_MIN_SIZE (1 << XFS_DINODE_MIN_LOG)
132 #define XFS_DINODE_MAX_SIZE (1 << XFS_DINODE_MAX_LOG)
133
134 /*
135 * Inode size for given fs.
136 */
137 #define XFS_LITINO(mp, version) \
138 ((int)(((mp)->m_sb.sb_inodesize) - xfs_dinode_size(version)))
139
140 /*
141 * Inode data & attribute fork sizes, per inode.
142 */
143 #define XFS_DFORK_Q(dip) ((dip)->di_forkoff != 0)
144 #define XFS_DFORK_BOFF(dip) ((int)((dip)->di_forkoff << 3))
145
146 #define XFS_DFORK_DSIZE(dip,mp) \
147 (XFS_DFORK_Q(dip) ? \
148 XFS_DFORK_BOFF(dip) : \
149 XFS_LITINO(mp, (dip)->di_version))
150 #define XFS_DFORK_ASIZE(dip,mp) \
151 (XFS_DFORK_Q(dip) ? \
152 XFS_LITINO(mp, (dip)->di_version) - XFS_DFORK_BOFF(dip) : \
153 0)
154 #define XFS_DFORK_SIZE(dip,mp,w) \
155 ((w) == XFS_DATA_FORK ? \
156 XFS_DFORK_DSIZE(dip, mp) : \
157 XFS_DFORK_ASIZE(dip, mp))
158
159 /*
160 * Return pointers to the data or attribute forks.
161 */
162 #define XFS_DFORK_DPTR(dip) \
163 ((char *)dip + xfs_dinode_size(dip->di_version))
164 #define XFS_DFORK_APTR(dip) \
165 (XFS_DFORK_DPTR(dip) + XFS_DFORK_BOFF(dip))
166 #define XFS_DFORK_PTR(dip,w) \
167 ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip))
168
169 #define XFS_DFORK_FORMAT(dip,w) \
170 ((w) == XFS_DATA_FORK ? \
171 (dip)->di_format : \
172 (dip)->di_aformat)
173 #define XFS_DFORK_NEXTENTS(dip,w) \
174 ((w) == XFS_DATA_FORK ? \
175 be32_to_cpu((dip)->di_nextents) : \
176 be16_to_cpu((dip)->di_anextents))
177
178 #define XFS_BUF_TO_DINODE(bp) ((xfs_dinode_t *)((bp)->b_addr))
179
180 /*
181 * For block and character special files the 32bit dev_t is stored at the
182 * beginning of the data fork.
183 */
xfs_dinode_get_rdev(struct xfs_dinode * dip)184 static inline xfs_dev_t xfs_dinode_get_rdev(struct xfs_dinode *dip)
185 {
186 return be32_to_cpu(*(__be32 *)XFS_DFORK_DPTR(dip));
187 }
188
xfs_dinode_put_rdev(struct xfs_dinode * dip,xfs_dev_t rdev)189 static inline void xfs_dinode_put_rdev(struct xfs_dinode *dip, xfs_dev_t rdev)
190 {
191 *(__be32 *)XFS_DFORK_DPTR(dip) = cpu_to_be32(rdev);
192 }
193
194 /*
195 * Values for di_flags
196 * There should be a one-to-one correspondence between these flags and the
197 * XFS_XFLAG_s.
198 */
199 #define XFS_DIFLAG_REALTIME_BIT 0 /* file's blocks come from rt area */
200 #define XFS_DIFLAG_PREALLOC_BIT 1 /* file space has been preallocated */
201 #define XFS_DIFLAG_NEWRTBM_BIT 2 /* for rtbitmap inode, new format */
202 #define XFS_DIFLAG_IMMUTABLE_BIT 3 /* inode is immutable */
203 #define XFS_DIFLAG_APPEND_BIT 4 /* inode is append-only */
204 #define XFS_DIFLAG_SYNC_BIT 5 /* inode is written synchronously */
205 #define XFS_DIFLAG_NOATIME_BIT 6 /* do not update atime */
206 #define XFS_DIFLAG_NODUMP_BIT 7 /* do not dump */
207 #define XFS_DIFLAG_RTINHERIT_BIT 8 /* create with realtime bit set */
208 #define XFS_DIFLAG_PROJINHERIT_BIT 9 /* create with parents projid */
209 #define XFS_DIFLAG_NOSYMLINKS_BIT 10 /* disallow symlink creation */
210 #define XFS_DIFLAG_EXTSIZE_BIT 11 /* inode extent size allocator hint */
211 #define XFS_DIFLAG_EXTSZINHERIT_BIT 12 /* inherit inode extent size */
212 #define XFS_DIFLAG_NODEFRAG_BIT 13 /* do not reorganize/defragment */
213 #define XFS_DIFLAG_FILESTREAM_BIT 14 /* use filestream allocator */
214 #define XFS_DIFLAG_REALTIME (1 << XFS_DIFLAG_REALTIME_BIT)
215 #define XFS_DIFLAG_PREALLOC (1 << XFS_DIFLAG_PREALLOC_BIT)
216 #define XFS_DIFLAG_NEWRTBM (1 << XFS_DIFLAG_NEWRTBM_BIT)
217 #define XFS_DIFLAG_IMMUTABLE (1 << XFS_DIFLAG_IMMUTABLE_BIT)
218 #define XFS_DIFLAG_APPEND (1 << XFS_DIFLAG_APPEND_BIT)
219 #define XFS_DIFLAG_SYNC (1 << XFS_DIFLAG_SYNC_BIT)
220 #define XFS_DIFLAG_NOATIME (1 << XFS_DIFLAG_NOATIME_BIT)
221 #define XFS_DIFLAG_NODUMP (1 << XFS_DIFLAG_NODUMP_BIT)
222 #define XFS_DIFLAG_RTINHERIT (1 << XFS_DIFLAG_RTINHERIT_BIT)
223 #define XFS_DIFLAG_PROJINHERIT (1 << XFS_DIFLAG_PROJINHERIT_BIT)
224 #define XFS_DIFLAG_NOSYMLINKS (1 << XFS_DIFLAG_NOSYMLINKS_BIT)
225 #define XFS_DIFLAG_EXTSIZE (1 << XFS_DIFLAG_EXTSIZE_BIT)
226 #define XFS_DIFLAG_EXTSZINHERIT (1 << XFS_DIFLAG_EXTSZINHERIT_BIT)
227 #define XFS_DIFLAG_NODEFRAG (1 << XFS_DIFLAG_NODEFRAG_BIT)
228 #define XFS_DIFLAG_FILESTREAM (1 << XFS_DIFLAG_FILESTREAM_BIT)
229
230 #ifdef CONFIG_XFS_RT
231
232 /*
233 * make sure we ignore the inode flag if the filesystem doesn't have a
234 * configured realtime device.
235 */
236 #define XFS_IS_REALTIME_INODE(ip) \
237 (((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME) && \
238 (ip)->i_mount->m_rtdev_targp)
239 #else
240 #define XFS_IS_REALTIME_INODE(ip) (0)
241 #endif
242
243 #define XFS_DIFLAG_ANY \
244 (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \
245 XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \
246 XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \
247 XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS | XFS_DIFLAG_EXTSIZE | \
248 XFS_DIFLAG_EXTSZINHERIT | XFS_DIFLAG_NODEFRAG | XFS_DIFLAG_FILESTREAM)
249
250 #endif /* __XFS_DINODE_H__ */
251