xref: /openbsd/sys/ufs/ext2fs/ext2fs_dinode.h (revision d31d4a6e)
1 /*	$OpenBSD: ext2fs_dinode.h,v 1.17 2014/07/31 17:37:52 pelikan Exp $	*/
2 /*	$NetBSD: ext2fs_dinode.h,v 1.6 2000/01/26 16:21:33 bouyer Exp $	*/
3 
4 /*
5  * Copyright (c) 1997 Manuel Bouyer.
6  * Copyright (c) 1982, 1989, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  * (c) UNIX System Laboratories, Inc.
9  * All or some portions of this file are derived from material licensed
10  * to the University of California by American Telephone and Telegraph
11  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
12  * the permission of UNIX System Laboratories, Inc.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)dinode.h	8.6 (Berkeley) 9/13/94
39  *  Modified for ext2fs by Manuel Bouyer.
40  */
41 
42 #include <sys/stat.h>
43 #include <ufs/ufs/dinode.h>	/* for ufsino_t */
44 
45 /*
46  * The root inode is the root of the file system.  Inode 0 can't be used for
47  * normal purposes and bad blocks are normally linked to inode 1, thus
48  * the root inode is 2.
49  * Inode 3 to 10 are reserved in ext2fs.
50  */
51 #define	EXT2_ROOTINO ((ufsino_t)2)
52 #define EXT2_RESIZEINO ((ufsino_t)7)
53 #define EXT2_FIRSTINO ((ufsino_t)11)
54 
55 /*
56  * A dinode contains all the meta-data associated with a UFS file.
57  * This structure defines the on-disk format of a dinode. Since
58  * this structure describes an on-disk structure, all its fields
59  * are defined by types with precise widths.
60  */
61 
62 #define	NDADDR	12			/* Direct addresses in inode. */
63 #define	NIADDR	3			/* Indirect addresses in inode. */
64 
65 #define EXT2_MAXSYMLINKLEN ((NDADDR+NIADDR) * sizeof (u_int32_t))
66 
67 struct ext2fs_dinode {
68 	u_int16_t	e2di_mode;	/*   0: IFMT, permissions; see below. */
69 	u_int16_t	e2di_uid_low;	/*   2: owner UID, bits 15:0 */
70 	u_int32_t	e2di_size;	/*   4: file size (bytes) bits 31:0 */
71 	u_int32_t	e2di_atime;	/*   8: Access time */
72 	u_int32_t	e2di_ctime;	/*  12: Change time */
73 	u_int32_t	e2di_mtime;	/*  16: Modification time */
74 	u_int32_t	e2di_dtime;	/*  20: Deletion time */
75 	u_int16_t	e2di_gid_low;	/*  24: Owner GID, lowest bits */
76 	u_int16_t	e2di_nlink;	/*  26: File link count */
77 	u_int32_t	e2di_nblock;	/*  28: blocks count */
78 	u_int32_t	e2di_flags;	/*  32: status flags (chflags) */
79 	u_int32_t	e2di_version_lo; /* 36: inode version, bits 31:0 */
80 	u_int32_t	e2di_blocks[NDADDR+NIADDR]; /* 40: disk blocks */
81 	u_int32_t	e2di_gen;	/* 100: generation number */
82 	u_int32_t	e2di_facl;	/* 104: file ACL, bits 31:0 */
83 	u_int32_t	e2di_size_hi;	/* 108: file size (bytes), bits 63:32 */
84 	u_int32_t	e2di_faddr;	/* 112: fragment address (obsolete) */
85 	u_int16_t	e2di_nblock_hi;	/* 116: blocks count, bits 47:32 */
86 	u_int16_t	e2di_facl_hi;	/* 118: file ACL, bits 47:32 */
87 	u_int16_t	e2di_uid_high;	/* 120: owner UID, bits 31:16 */
88 	u_int16_t	e2di_gid_high;	/* 122: owner GID, bits 31:16 */
89 	u_int16_t	e2di_chksum_lo;	/* 124: inode checksum, bits 15:0 */
90 	u_int16_t	e2di__reserved;	/* 126: 	unused */
91 	u_int16_t	e2di_isize;	/* 128: size of this inode */
92 	u_int16_t	e2di_chksum_hi;	/* 130: inode checksum, bits 31:16 */
93 	u_int32_t	e2di_x_ctime;	/* 132: extra Change time */
94 	u_int32_t	e2di_x_mtime;	/* 136: extra Modification time */
95 	u_int32_t	e2di_x_atime;	/* 140: extra Access time */
96 	u_int32_t	e2di_crtime;	/* 144: Creation (birth) time */
97 	u_int32_t	e2di_x_crtime;	/* 148: extra Creation (birth) time */
98 	u_int32_t	e2di_version_hi; /* 152: inode version, bits 63:31 */
99 };
100 
101 #define	E2MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(u_int32_t))
102 
103 /* File permissions. */
104 #define	EXT2_IEXEC		0000100		/* Executable. */
105 #define	EXT2_IWRITE		0000200		/* Writeable. */
106 #define	EXT2_IREAD		0000400		/* Readable. */
107 #define	EXT2_ISVTX		0001000		/* Sticky bit. */
108 #define	EXT2_ISGID		0002000		/* Set-gid. */
109 #define	EXT2_ISUID		0004000		/* Set-uid. */
110 
111 /* File types. */
112 #define	EXT2_IFMT		0170000		/* Mask of file type. */
113 #define	EXT2_IFIFO		0010000		/* Named pipe (fifo). */
114 #define	EXT2_IFCHR		0020000		/* Character device. */
115 #define	EXT2_IFDIR		0040000		/* Directory file. */
116 #define	EXT2_IFBLK		0060000		/* Block device. */
117 #define	EXT2_IFREG		0100000		/* Regular file. */
118 #define	EXT2_IFLNK		0120000		/* Symbolic link. */
119 #define	EXT2_IFSOCK		0140000		/* UNIX domain socket. */
120 
121 /* file flags */
122 #define EXT2_SECRM		0x00000001	/* Secure deletion */
123 #define EXT2_UNRM		0x00000002	/* Undelete */
124 #define EXT2_COMPR		0x00000004	/* Compress file */
125 #define EXT2_SYNC		0x00000008	/* Synchronous updates */
126 #define EXT2_IMMUTABLE		0x00000010	/* Immutable file */
127 #define EXT2_APPEND		0x00000020	/* writes to file may only append */
128 #define EXT2_NODUMP		0x00000040	/* do not dump file */
129 #define EXT2_NOATIME		0x00000080	/* do not update access time */
130 #define EXT4_INDEX		0x00001000	/* hash-indexed directory */
131 #define EXT4_JOURNAL_DATA	0x00004000	/* file data should be journaled */
132 #define EXT4_DIRSYNC		0x00010000	/* all dirent updates done synchronously */
133 #define EXT4_TOPDIR		0x00020000	/* top of directory hierarchies */
134 #define EXT4_HUGE_FILE		0x00040000	/* nblocks unit is fsb, not db */
135 #define EXT4_EXTENTS		0x00080000	/* inode uses extents */
136 #define EXT4_EOFBLOCKS		0x00400000	/* blocks allocated beyond EOF */
137 
138 /* Size of on-disk inode. */
139 #define EXT2_REV0_DINODE_SIZE	128
140 #define EXT2_DINODE_SIZE(fs)	((fs)->e2fs.e2fs_rev > E2FS_REV0 ?  \
141 				    (fs)->e2fs.e2fs_inode_size : \
142 				    EXT2_REV0_DINODE_SIZE)
143 
144 /*
145  * The e2di_blocks fields may be overlaid with other information for
146  * file types that do not have associated disk storage. Block
147  * and character devices overlay the first data block with their
148  * dev_t value. Short symbolic links place their path in the
149  * di_db area.
150  */
151 
152 #define e2di_rdev		e2di_blocks[0]
153 #define e2di_shortlink	e2di_blocks
154 
155 /* e2fs needs byte swapping on big-endian systems */
156 #if BYTE_ORDER == LITTLE_ENDIAN
157 #	define e2fs_iload(fs, old, new)	\
158 		memcpy((new),(old), MIN(EXT2_DINODE_SIZE(fs), sizeof(*new)))
159 #	define e2fs_isave(fs, old, new) \
160 		memcpy((new),(old), MIN(EXT2_DINODE_SIZE(fs), sizeof(*new)))
161 #else
162 struct m_ext2fs;
163 void e2fs_i_bswap(struct m_ext2fs *, struct ext2fs_dinode *, struct ext2fs_dinode *);
164 #	define e2fs_iload(fs, old, new) e2fs_i_bswap((fs), (old), (new))
165 #	define e2fs_isave(fs, old, new) e2fs_i_bswap((fs), (old), (new))
166 #endif
167