xref: /minix/sys/ufs/ext2fs/ext2fs_dinode.h (revision 84d9c625)
1 /*	$NetBSD: ext2fs_dinode.h,v 1.26 2013/01/22 09:39:15 dholland 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 #include <sys/stat.h>
71 
72 /*
73  * The root inode is the root of the file system.  Inode 0 can't be used for
74  * normal purposes and bad blocks are normally linked to inode 1, thus
75  * the root inode is 2.
76  * Inode 3 to 10 are reserved in ext2fs.
77  */
78 #define	EXT2_BADBLKINO		((ino_t)1)
79 #define	EXT2_ROOTINO		((ino_t)2)
80 #define	EXT2_ACLIDXINO		((ino_t)3)
81 #define	EXT2_ACLDATAINO		((ino_t)4)
82 #define	EXT2_BOOTLOADERINO	((ino_t)5)
83 #define	EXT2_UNDELDIRINO	((ino_t)6)
84 #define	EXT2_RESIZEINO		((ino_t)7)
85 #define	EXT2_JOURNALINO		((ino_t)8)
86 #define	EXT2_FIRSTINO		((ino_t)11)
87 
88 /*
89  * A dinode contains all the meta-data associated with a UFS file.
90  * This structure defines the on-disk format of a dinode. Since
91  * this structure describes an on-disk structure, all its fields
92  * are defined by types with precise widths.
93  */
94 
95 /*
96  * XXX these are the same values as UFS_NDADDR/UFS_NIADDR and it is
97  * far from clear that there isn't code that relies on them being the
98  * same.
99  */
100 #define	EXT2FS_NDADDR	12		/* Direct addresses in inode. */
101 #define	EXT2FS_NIADDR	3		/* Indirect addresses in inode. */
102 
103 #define EXT2_MAXSYMLINKLEN ((EXT2FS_NDADDR+EXT2FS_NIADDR) * sizeof (uint32_t))
104 
105 struct ext2fs_dinode {
106 	uint16_t	e2di_mode;	/*   0: IFMT, permissions; see below. */
107 	uint16_t	e2di_uid;	/*   2: Owner UID */
108 	uint32_t	e2di_size;	/*   4: Size (in bytes) */
109 	uint32_t	e2di_atime;	/*   8: Access time */
110 	uint32_t	e2di_ctime;	/*  12: Create time */
111 	uint32_t	e2di_mtime;	/*  16: Modification time */
112 	uint32_t	e2di_dtime;	/*  20: Deletion time */
113 	uint16_t	e2di_gid;	/*  24: Owner GID */
114 	uint16_t	e2di_nlink;	/*  26: File link count */
115 	uint32_t	e2di_nblock;	/*  28: Blocks count */
116 	uint32_t	e2di_flags;	/*  32: Status flags (chflags) */
117 	uint32_t	e2di_version;	/*  36: was reserved1 */
118 	uint32_t	e2di_blocks[EXT2FS_NDADDR+EXT2FS_NIADDR];
119 					/* 40: disk blocks */
120 	uint32_t	e2di_gen;	/* 100: generation number */
121 	uint32_t	e2di_facl;	/* 104: file ACL (not implemented) */
122 	uint32_t	e2di_dacl;	/* 108: dir ACL (not implemented) */
123 	uint32_t	e2di_faddr;	/* 112: fragment address */
124 	uint16_t	e2di_nblock_high; /* 116: Blocks count bits 47:32 */
125 	uint16_t	e2di_facl_high; /* 118: file ACL bits 47:32 */
126 	uint16_t	e2di_uid_high;	/* 120: Owner UID top 16 bits */
127 	uint16_t	e2di_gid_high;	/* 122: Owner GID top 16 bits */
128 	uint32_t	e2di_linux_reserved3; /* 124 */
129 };
130 
131 
132 /* XXX how does this differ from EXT2_MAXSYMLINKLEN above? */
133 #define	E2MAXSYMLINKLEN	((EXT2FS_NDADDR + EXT2FS_NIADDR) * sizeof(uint32_t))
134 
135 /* File permissions. */
136 #define	EXT2_IEXEC		0000100		/* Executable. */
137 #define	EXT2_IWRITE		0000200		/* Writable. */
138 #define	EXT2_IREAD		0000400		/* Readable. */
139 #define	EXT2_ISVTX		0001000		/* Sticky bit. */
140 #define	EXT2_ISGID		0002000		/* Set-gid. */
141 #define	EXT2_ISUID		0004000		/* Set-uid. */
142 
143 /* File types. */
144 #define	EXT2_IFMT		0170000		/* Mask of file type. */
145 #define	EXT2_IFIFO		0010000		/* Named pipe (fifo). */
146 #define	EXT2_IFCHR		0020000		/* Character device. */
147 #define	EXT2_IFDIR		0040000		/* Directory file. */
148 #define	EXT2_IFBLK		0060000		/* Block device. */
149 #define	EXT2_IFREG		0100000		/* Regular file. */
150 #define	EXT2_IFLNK		0120000		/* Symbolic link. */
151 #define	EXT2_IFSOCK		0140000		/* UNIX domain socket. */
152 
153 /* file flags */
154 #define EXT2_SECRM		0x00000001 /* Secure deletion */
155 #define EXT2_UNRM		0x00000002 /* Undelete */
156 #define EXT2_COMPR		0x00000004 /* Compress file */
157 #define EXT2_SYNC		0x00000008 /* Synchronous updates */
158 #define EXT2_IMMUTABLE		0x00000010 /* Immutable file */
159 #define EXT2_APPEND		0x00000020 /* writes to file may only append */
160 #define EXT2_NODUMP		0x00000040 /* do not dump file */
161 #define EXT2_NOATIME		0x00000080 /* do not update atime */
162 #define EXT2_INDEX		0x00001000 /* hash-indexed directory */
163 #define EXT2_IMAGIC		0x00002000 /* AFS directory */
164 #define EXT2_JOURNAL_DATA	0x00004000 /* file data should be journaled */
165 #define EXT2_NOTAIL		0x00008000 /* file tail should not be merged */
166 #define EXT2_DIRSYNC		0x00010000 /* dirsync behaviour */
167 #define EXT2_TOPDIR		0x00020000 /* Top of directory hierarchies*/
168 #define EXT2_HUGE_FILE		0x00040000 /* Set to each huge file */
169 #define EXT2_EXTENTS		0x00080000 /* Inode uses extents */
170 #define EXT2_EOFBLOCKS		0x00400000 /* Blocks allocated beyond EOF */
171 
172 /* Size of on-disk inode. */
173 #define EXT2_REV0_DINODE_SIZE	sizeof(struct ext2fs_dinode)
174 #define EXT2_DINODE_SIZE(fs)	((fs)->e2fs.e2fs_rev > E2FS_REV0 ?	\
175 				    (fs)->e2fs.e2fs_inode_size :	\
176 				    EXT2_REV0_DINODE_SIZE)
177 
178 /*
179  * The e2di_blocks fields may be overlaid with other information for
180  * file types that do not have associated disk storage. Block
181  * and character devices overlay the first data block with their
182  * dev_t value. Short symbolic links place their path in the
183  * di_db area.
184  */
185 
186 #define e2di_rdev		e2di_blocks[0]
187 #define e2di_shortlink		e2di_blocks
188 
189 /* e2fs needs byte swapping on big-endian systems */
190 #if BYTE_ORDER == LITTLE_ENDIAN
191 #	define e2fs_iload(old, new)	\
192 		memcpy((new),(old),sizeof(struct ext2fs_dinode))
193 #	define e2fs_isave(old, new)	\
194 		memcpy((new),(old),sizeof(struct ext2fs_dinode))
195 #else
196 void e2fs_i_bswap(struct ext2fs_dinode *, struct ext2fs_dinode *);
197 #	define e2fs_iload(old, new) e2fs_i_bswap((old), (new))
198 #	define e2fs_isave(old, new) e2fs_i_bswap((old), (new))
199 #endif
200 
201 #endif /* !_UFS_EXT2FS_EXT2FS_DINODE_H_ */
202