1/* $NetBSD: ext2fs_dinode.h,v 1.37 2017/01/13 18:04:36 christos Exp $ */
2
3/*
4 * Copyright (c) 1982, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)dinode.h 8.6 (Berkeley) 9/13/94
37 * Modified for ext2fs by Manuel Bouyer.
38 */
39
40/*
41 * Copyright (c) 1997 Manuel Bouyer.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
53 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
56 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
57 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
61 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *
63 * @(#)dinode.h 8.6 (Berkeley) 9/13/94
64 * Modified for ext2fs by Manuel Bouyer.
65 */
66
67#ifndef _UFS_EXT2FS_EXT2FS_DINODE_H_
68#define _UFS_EXT2FS_EXT2FS_DINODE_H_
69
70#if !defined(_KERNEL) && !defined(_STANDALONE)
71#include <stddef.h> /* for offsetof */
72#endif
73
74#include <sys/stat.h>
75
76/*
77 * The root inode is the root of the file system. Inode 0 can't be used for
78 * normal purposes and bad blocks are normally linked to inode 1, thus
79 * the root inode is 2.
80 * Inode 3 to 10 are reserved in ext2fs.
81 */
82#define EXT2_BADBLKINO ((ino_t)1)
83#define EXT2_ROOTINO ((ino_t)2)
84#define EXT2_ACLIDXINO ((ino_t)3)
85#define EXT2_ACLDATAINO ((ino_t)4)
86#define EXT2_BOOTLOADERINO ((ino_t)5)
87#define EXT2_UNDELDIRINO ((ino_t)6)
88#define EXT2_RESIZEINO ((ino_t)7)
89#define EXT2_JOURNALINO ((ino_t)8)
90#define EXT2_FIRSTINO ((ino_t)11)
91
92/*
93 * A dinode contains all the meta-data associated with a UFS file.
94 * This structure defines the on-disk format of a dinode. Since
95 * this structure describes an on-disk structure, all its fields
96 * are defined by types with precise widths.
97 */
98
99/*
100 * XXX these are the same values as UFS_NDADDR/UFS_NIADDR and it is
101 * far from clear that there isn't code that relies on them being the
102 * same.
103 */
104#define EXT2FS_NDADDR 12 /* Direct addresses in inode. */
105#define EXT2FS_NIADDR 3 /* Indirect addresses in inode. */
106
107#define EXT2_MAXSYMLINKLEN ((EXT2FS_NDADDR+EXT2FS_NIADDR) * sizeof (uint32_t))
108#define E2MAXSYMLINKLEN EXT2_MAXSYMLINKLEN
109
110struct ext2fs_dinode {
111 uint16_t e2di_mode; /* 0: IFMT, permissions; see below. */
112 uint16_t e2di_uid; /* 2: Owner UID */
113 uint32_t e2di_size; /* 4: Size (in bytes) */
114 uint32_t e2di_atime; /* 8: Access time */
115 uint32_t e2di_ctime; /* 12: Create time */
116 uint32_t e2di_mtime; /* 16: Modification time */
117 uint32_t e2di_dtime; /* 20: Deletion time */
118 uint16_t e2di_gid; /* 24: Owner GID */
119 uint16_t e2di_nlink; /* 26: File link count */
120 uint32_t e2di_nblock; /* 28: Blocks count */
121 uint32_t e2di_flags; /* 32: Status flags (chflags) */
122 uint32_t e2di_version; /* 36: was reserved1 */
123 uint32_t e2di_blocks[EXT2FS_NDADDR+EXT2FS_NIADDR];
124 /* 40: disk blocks */
125 uint32_t e2di_gen; /* 100: generation number */
126 uint32_t e2di_facl; /* 104: file ACL (ext3) */
127 uint32_t e2di_size_high; /* 108: Size (in bytes) high */
128 uint32_t e2di_obso_faddr;/* 112: obsolete fragment address (ext2) */
129 uint16_t e2di_nblock_high; /* 116: Blocks count bits 47:32 (ext4) */
130 uint16_t e2di_facl_high; /* 118: file ACL bits 47:32 (ext4/64bit) */
131 uint16_t e2di_uid_high; /* 120: Owner UID top 16 bits (ext4) */
132 uint16_t e2di_gid_high; /* 122: Owner GID top 16 bits (ext4) */
133 uint16_t e2di_checksum_low; /* 124: crc LE (not implemented) (ext4) */
134 uint16_t e2di_reserved; /* 126: reserved */
135 uint16_t e2di_extra_isize; /* 128: inode extra size (over 128) actually used (ext4) */
136 uint16_t e2di_checksum_high; /* 130: crc BE (not implemented) (ext4) */
137 uint32_t e2di_ctime_extra; /* 132: ctime (nsec << 2 | high epoch) (ext4) */
138 uint32_t e2di_mtime_extra; /* 136: mtime (nsec << 2 | high epoch) (ext4) */
139 uint32_t e2di_atime_extra; /* 140: atime (nsec << 2 | high epoch) (ext4) */
140 uint32_t e2di_crtime; /* 144: creation time (epoch) (ext4) */
141 uint32_t e2di_crtime_extra; /* 148: creation time (nsec << 2 | high epoch) (ext4) */
142 uint32_t e2di_version_high; /* 152: version high (ext4) */
143 uint32_t e2di_projid; /* 156: project id (not implemented) (ext4) */
144};
145
146#define i_e2fs_mode i_din.e2fs_din->e2di_mode
147#define i_e2fs_uid i_din.e2fs_din->e2di_uid
148#define i_e2fs_size i_din.e2fs_din->e2di_size
149#define i_e2fs_atime i_din.e2fs_din->e2di_atime
150#define i_e2fs_ctime i_din.e2fs_din->e2di_ctime
151#define i_e2fs_mtime i_din.e2fs_din->e2di_mtime
152#define i_e2fs_dtime i_din.e2fs_din->e2di_dtime
153#define i_e2fs_gid i_din.e2fs_din->e2di_gid
154#define i_e2fs_nlink i_din.e2fs_din->e2di_nlink
155#define i_e2fs_nblock i_din.e2fs_din->e2di_nblock
156#define i_e2fs_flags i_din.e2fs_din->e2di_flags
157#define i_e2fs_version i_din.e2fs_din->e2di_version
158#define i_e2fs_blocks i_din.e2fs_din->e2di_blocks
159#define i_e2fs_rdev i_din.e2fs_din->e2di_rdev
160#define i_e2fs_gen i_din.e2fs_din->e2di_gen
161#define i_e2fs_facl i_din.e2fs_din->e2di_facl
162#define i_e2fs_nblock_high i_din.e2fs_din->e2di_nblock_high
163#define i_e2fs_facl_high i_din.e2fs_din->e2di_facl_high
164#define i_e2fs_uid_high i_din.e2fs_din->e2di_uid_high
165#define i_e2fs_gid_high i_din.e2fs_din->e2di_gid_high
166
167/* File permissions. */
168#define EXT2_IEXEC 0000100 /* Executable. */
169#define EXT2_IWRITE 0000200 /* Writable. */
170#define EXT2_IREAD 0000400 /* Readable. */
171#define EXT2_ISVTX 0001000 /* Sticky bit. */
172#define EXT2_ISGID 0002000 /* Set-gid. */
173#define EXT2_ISUID 0004000 /* Set-uid. */
174
175/* File types. */
176#define EXT2_IFMT 0170000 /* Mask of file type. */
177#define EXT2_IFIFO 0010000 /* Named pipe (fifo). */
178#define EXT2_IFCHR 0020000 /* Character device. */
179#define EXT2_IFDIR 0040000 /* Directory file. */
180#define EXT2_IFBLK 0060000 /* Block device. */
181#define EXT2_IFREG 0100000 /* Regular file. */
182#define EXT2_IFLNK 0120000 /* Symbolic link. */
183#define EXT2_IFSOCK 0140000 /* UNIX domain socket. */
184
185/* file flags */
186#define EXT2_SECRM 0x00000001 /* Secure deletion */
187#define EXT2_UNRM 0x00000002 /* Undelete */
188#define EXT2_COMPR 0x00000004 /* Compress file */
189#define EXT2_SYNC 0x00000008 /* Synchronous updates */
190#define EXT2_IMMUTABLE 0x00000010 /* Immutable file */
191#define EXT2_APPEND 0x00000020 /* writes to file may only append */
192#define EXT2_NODUMP 0x00000040 /* do not dump file */
193#define EXT2_NOATIME 0x00000080 /* do not update atime */
194#define EXT2_INDEX 0x00001000 /* hash-indexed directory */
195#define EXT2_IMAGIC 0x00002000 /* AFS directory */
196#define EXT2_JOURNAL_DATA 0x00004000 /* file data should be journaled */
197#define EXT2_NOTAIL 0x00008000 /* file tail should not be merged */
198#define EXT2_DIRSYNC 0x00010000 /* dirsync behaviour */
199#define EXT2_TOPDIR 0x00020000 /* Top of directory hierarchies*/
200#define EXT2_HUGE_FILE 0x00040000 /* Set to each huge file */
201#define EXT2_EXTENTS 0x00080000 /* Inode uses extents */
202#define EXT2_EA_INODE 0x00200000 /* Inode used for large EA */
203#define EXT2_EOFBLOCKS 0x00400000 /* Blocks allocated beyond EOF */
204#define EXT2_INLINE_DATA 0x10000000 /* Inode has inline data */
205#define EXT2_PROJINHERIT 0x20000000 /* Children inherit project ID */
206
207/* Size of on-disk inode. */
208#define EXT2_REV0_DINODE_SIZE 128U
209#define EXT2_DINODE_SIZE(fs) ((fs)->e2fs.e2fs_rev > E2FS_REV0 ? \
210 (fs)->e2fs.e2fs_inode_size : \
211 EXT2_REV0_DINODE_SIZE)
212#define EXT2_DINODE_FITS(dinode, field, isize) (\
213 (isize > EXT2_REV0_DINODE_SIZE) \
214 && ((EXT2_REV0_DINODE_SIZE + (dinode)->e2di_extra_isize) >= offsetof(struct ext2fs_dinode, field) + sizeof((dinode)->field)) \
215 )
216
217/*
218 * Time encoding
219 * Lower two bits of extra field are extra high bits for epoch; unfortunately still, Linux kernels treat 11 there as 00 for compatibility
220 * Rest of extra fields are nanoseconds
221 */
222static __inline void
223ext2fs_dinode_time_get(struct timespec *ts, uint32_t epoch, uint32_t extra)
224{
225 ts->tv_sec = (signed) epoch;
226
227 if (extra) {
228 uint64_t epoch_bits = extra & 0x3;
229 /* XXX compatibility with linux kernel < 4.20 */
230 if (epoch_bits == 3 && ts->tv_sec < 0)
231 epoch_bits = 0;
232
233 ts->tv_sec |= epoch_bits << 32;
234
235 ts->tv_nsec = extra >> 2;
236 } else {
237 ts->tv_nsec = 0;
238 }
239}
240#define EXT2_DINODE_TIME_GET(ts, dinode, field, isize) \
241 ext2fs_dinode_time_get(ts, (dinode)->field, \
242 EXT2_DINODE_FITS(dinode, field ## _extra, isize) \
243 ? (dinode)->field ## _extra : 0 \
244 )
245
246static __inline void
247ext2fs_dinode_time_set(const struct timespec *ts, uint32_t *epoch, uint32_t *extra)
248{
249 *epoch = (int32_t) ts->tv_sec;
250
251 if (extra) {
252 uint32_t epoch_bits = (ts->tv_sec >> 32) & 0x3;
253
254 *extra = (ts->tv_nsec << 2) | epoch_bits;
255 }
256}
257#define EXT2_DINODE_TIME_SET(ts, dinode, field, isize) \
258 ext2fs_dinode_time_set(ts, &(dinode)->field, \
259 EXT2_DINODE_FITS(dinode, field ## _extra, isize) \
260 ? &(dinode)->field ## _extra : NULL \
261 )
262
263/*
264 * The e2di_blocks fields may be overlaid with other information for
265 * file types that do not have associated disk storage. Block
266 * and character devices overlay the first data block with their
267 * dev_t value. Short symbolic links place their path in the
268 * di_db area.
269 */
270
271#define e2di_rdev e2di_blocks[0]
272#define e2di_shortlink e2di_blocks
273
274/* e2fs needs byte swapping on big-endian systems */
275#if BYTE_ORDER == LITTLE_ENDIAN
276# define e2fs_iload(old, new, isize) \
277 memcpy((new),(old),(isize))
278# define e2fs_isave(old, new, isize) \
279 memcpy((new),(old),(isize))
280#else
281void e2fs_i_bswap(struct ext2fs_dinode *, struct ext2fs_dinode *, size_t);
282# define e2fs_iload(old, new, isize) e2fs_i_bswap((old), (new), (isize))
283# define e2fs_isave(old, new, isize) e2fs_i_bswap((old), (new), (isize))
284#endif
285
286#endif /* !_UFS_EXT2FS_EXT2FS_DINODE_H_ */