xref: /netbsd-src/sys/ufs/ext2fs/ext2fs_dinode.h (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1 /*	$NetBSD: ext2fs_dinode.h,v 1.19 2009/03/02 09:54:49 tsutsui 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  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Manuel Bouyer.
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  *
68  *	@(#)dinode.h	8.6 (Berkeley) 9/13/94
69  *  Modified for ext2fs by Manuel Bouyer.
70  */
71 
72 #ifndef _UFS_EXT2FS_EXT2FS_DINODE_H_
73 #define _UFS_EXT2FS_EXT2FS_DINODE_H_
74 
75 #include <sys/stat.h>
76 
77 /*
78  * The root inode is the root of the file system.  Inode 0 can't be used for
79  * normal purposes and bad blocks are normally linked to inode 1, thus
80  * the root inode is 2.
81  * Inode 3 to 10 are reserved in ext2fs.
82  */
83 #define	EXT2_ROOTINO	((ino_t)2)
84 #define	EXT2_RESIZEINO	((ino_t)7)
85 #define	EXT2_FIRSTINO	((ino_t)11)
86 
87 /*
88  * A dinode contains all the meta-data associated with a UFS file.
89  * This structure defines the on-disk format of a dinode. Since
90  * this structure describes an on-disk structure, all its fields
91  * are defined by types with precise widths.
92  */
93 
94 #define	NDADDR	12			/* Direct addresses in inode. */
95 #define	NIADDR	3			/* Indirect addresses in inode. */
96 
97 #define EXT2_MAXSYMLINKLEN ((NDADDR+NIADDR) * sizeof (u_int32_t))
98 
99 struct ext2fs_dinode {
100 	u_int16_t	e2di_mode;	/*   0: IFMT, permissions; see below. */
101 	u_int16_t	e2di_uid;	/*   2: Owner UID */
102 	u_int32_t	e2di_size;	/*	 4: Size (in bytes) */
103 	u_int32_t	e2di_atime;	/*	 8: Acces time */
104 	u_int32_t	e2di_ctime;	/*	12: Create time */
105 	u_int32_t	e2di_mtime;	/*	16: Modification time */
106 	u_int32_t	e2di_dtime;	/*	20: Deletion time */
107 	u_int16_t	e2di_gid;	/*  24: Owner GID */
108 	u_int16_t	e2di_nlink;	/*  26: File link count */
109 	u_int32_t	e2di_nblock;	/*  28: Blocks count */
110 	u_int32_t	e2di_flags;	/*  32: Status flags (chflags) */
111 	u_int32_t	e2di_linux_reserved1; /* 36 */
112 	u_int32_t	e2di_blocks[NDADDR+NIADDR]; /* 40: disk blocks */
113 	u_int32_t	e2di_gen;	/* 100: generation number */
114 	u_int32_t	e2di_facl;	/* 104: file ACL (not implemented) */
115 	u_int32_t	e2di_dacl;	/* 108: dir ACL (not implemented) */
116 	u_int32_t	e2di_faddr;	/* 112: fragment address */
117 	u_int8_t	e2di_nfrag;	/* 116: fragment number */
118 	u_int8_t	e2di_fsize;	/* 117: fragment size */
119 	u_int16_t	e2di_linux_reserved2; /* 118 */
120 	u_int16_t	e2di_uid_high;	/* 120: Owner UID top 16 bits */
121 	u_int16_t	e2di_gid_high;	/* 122: Owner GID top 16 bits */
122 	u_int32_t	e2di_linux_reserved3; /* 124 */
123 };
124 
125 
126 
127 #define	E2MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(u_int32_t))
128 
129 /* File permissions. */
130 #define	EXT2_IEXEC		0000100		/* Executable. */
131 #define	EXT2_IWRITE		0000200		/* Writable. */
132 #define	EXT2_IREAD		0000400		/* Readable. */
133 #define	EXT2_ISVTX		0001000		/* Sticky bit. */
134 #define	EXT2_ISGID		0002000		/* Set-gid. */
135 #define	EXT2_ISUID		0004000		/* Set-uid. */
136 
137 /* File types. */
138 #define	EXT2_IFMT		0170000		/* Mask of file type. */
139 #define	EXT2_IFIFO		0010000		/* Named pipe (fifo). */
140 #define	EXT2_IFCHR		0020000		/* Character device. */
141 #define	EXT2_IFDIR		0040000		/* Directory file. */
142 #define	EXT2_IFBLK		0060000		/* Block device. */
143 #define	EXT2_IFREG		0100000		/* Regular file. */
144 #define	EXT2_IFLNK		0120000		/* Symbolic link. */
145 #define	EXT2_IFSOCK		0140000		/* UNIX domain socket. */
146 
147 /* file flags */
148 #define EXT2_SECRM		0x00000001	/* Secure deletion */
149 #define EXT2_UNRM		0x00000002	/* Undelete */
150 #define EXT2_COMPR		0x00000004	/* Compress file */
151 #define EXT2_SYNC		0x00000008	/* Synchronous updates */
152 #define EXT2_IMMUTABLE		0x00000010	/* Immutable file */
153 #define EXT2_APPEND		0x00000020 /* writes to file may only append */
154 #define EXT2_NODUMP		0x00000040	/* do not dump file */
155 
156 /* Size of on-disk inode. */
157 #define EXT2_REV0_DINODE_SIZE	sizeof(struct ext2fs_dinode)
158 #define EXT2_DINODE_SIZE(fs)	((fs)->e2fs.e2fs_rev > E2FS_REV0 ?	\
159 				    (fs)->e2fs.e2fs_inode_size :	\
160 				    EXT2_REV0_DINODE_SIZE)
161 
162 /*
163  * The e2di_blocks fields may be overlaid with other information for
164  * file types that do not have associated disk storage. Block
165  * and character devices overlay the first data block with their
166  * dev_t value. Short symbolic links place their path in the
167  * di_db area.
168  */
169 
170 #define e2di_rdev		e2di_blocks[0]
171 #define e2di_shortlink		e2di_blocks
172 
173 /* e2fs needs byte swapping on big-endian systems */
174 #if BYTE_ORDER == LITTLE_ENDIAN
175 #	define e2fs_iload(old, new)	\
176 		memcpy((new),(old),sizeof(struct ext2fs_dinode))
177 #	define e2fs_isave(old, new)	\
178 		memcpy((new),(old),sizeof(struct ext2fs_dinode))
179 #else
180 void e2fs_i_bswap(struct ext2fs_dinode *, struct ext2fs_dinode *);
181 #	define e2fs_iload(old, new) e2fs_i_bswap((old), (new))
182 #	define e2fs_isave(old, new) e2fs_i_bswap((old), (new))
183 #endif
184 
185 #endif /* !_UFS_EXT2FS_EXT2FS_DINODE_H_ */
186