1/*	$NetBSD: ext2fs_dinode.h,v 1.21 2009/10/19 18:41:17 bouyer 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#define	NDADDR	12			/* Direct addresses in inode. */
96#define	NIADDR	3			/* Indirect addresses in inode. */
97
98#define EXT2_MAXSYMLINKLEN ((NDADDR+NIADDR) * sizeof (uint32_t))
99
100struct ext2fs_dinode {
101	uint16_t	e2di_mode;	/*   0: IFMT, permissions; see below. */
102	uint16_t	e2di_uid;	/*   2: Owner UID */
103	uint32_t	e2di_size;	/*	 4: Size (in bytes) */
104	uint32_t	e2di_atime;	/*	 8: Acces time */
105	uint32_t	e2di_ctime;	/*	12: Create time */
106	uint32_t	e2di_mtime;	/*	16: Modification time */
107	uint32_t	e2di_dtime;	/*	20: Deletion time */
108	uint16_t	e2di_gid;	/*  24: Owner GID */
109	uint16_t	e2di_nlink;	/*  26: File link count */
110	uint32_t	e2di_nblock;	/*  28: Blocks count */
111	uint32_t	e2di_flags;	/*  32: Status flags (chflags) */
112	uint32_t	e2di_linux_reserved1; /* 36 */
113	uint32_t	e2di_blocks[NDADDR+NIADDR]; /* 40: disk blocks */
114	uint32_t	e2di_gen;	/* 100: generation number */
115	uint32_t	e2di_facl;	/* 104: file ACL (not implemented) */
116	uint32_t	e2di_dacl;	/* 108: dir ACL (not implemented) */
117	uint32_t	e2di_faddr;	/* 112: fragment address */
118	uint8_t		e2di_nfrag;	/* 116: fragment number */
119	uint8_t		e2di_fsize;	/* 117: fragment size */
120	uint16_t	e2di_linux_reserved2; /* 118 */
121	uint16_t	e2di_uid_high;	/* 120: Owner UID top 16 bits */
122	uint16_t	e2di_gid_high;	/* 122: Owner GID top 16 bits */
123	uint32_t	e2di_linux_reserved3; /* 124 */
124};
125
126
127
128#define	E2MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(uint32_t))
129
130/* File permissions. */
131#define	EXT2_IEXEC		0000100		/* Executable. */
132#define	EXT2_IWRITE		0000200		/* Writable. */
133#define	EXT2_IREAD		0000400		/* Readable. */
134#define	EXT2_ISVTX		0001000		/* Sticky bit. */
135#define	EXT2_ISGID		0002000		/* Set-gid. */
136#define	EXT2_ISUID		0004000		/* Set-uid. */
137
138/* File types. */
139#define	EXT2_IFMT		0170000		/* Mask of file type. */
140#define	EXT2_IFIFO		0010000		/* Named pipe (fifo). */
141#define	EXT2_IFCHR		0020000		/* Character device. */
142#define	EXT2_IFDIR		0040000		/* Directory file. */
143#define	EXT2_IFBLK		0060000		/* Block device. */
144#define	EXT2_IFREG		0100000		/* Regular file. */
145#define	EXT2_IFLNK		0120000		/* Symbolic link. */
146#define	EXT2_IFSOCK		0140000		/* UNIX domain socket. */
147
148/* file flags */
149#define EXT2_SECRM		0x00000001	/* Secure deletion */
150#define EXT2_UNRM		0x00000002	/* Undelete */
151#define EXT2_COMPR		0x00000004	/* Compress file */
152#define EXT2_SYNC		0x00000008	/* Synchronous updates */
153#define EXT2_IMMUTABLE		0x00000010	/* Immutable file */
154#define EXT2_APPEND		0x00000020 /* writes to file may only append */
155#define EXT2_NODUMP		0x00000040	/* do not dump file */
156
157/* Size of on-disk inode. */
158#define EXT2_REV0_DINODE_SIZE	sizeof(struct ext2fs_dinode)
159#define EXT2_DINODE_SIZE(fs)	((fs)->e2fs.e2fs_rev > E2FS_REV0 ?	\
160				    (fs)->e2fs.e2fs_inode_size :	\
161				    EXT2_REV0_DINODE_SIZE)
162
163/*
164 * The e2di_blocks fields may be overlaid with other information for
165 * file types that do not have associated disk storage. Block
166 * and character devices overlay the first data block with their
167 * dev_t value. Short symbolic links place their path in the
168 * di_db area.
169 */
170
171#define e2di_rdev		e2di_blocks[0]
172#define e2di_shortlink		e2di_blocks
173
174/* e2fs needs byte swapping on big-endian systems */
175#if BYTE_ORDER == LITTLE_ENDIAN
176#	define e2fs_iload(old, new)	\
177		memcpy((new),(old),sizeof(struct ext2fs_dinode))
178#	define e2fs_isave(old, new)	\
179		memcpy((new),(old),sizeof(struct ext2fs_dinode))
180#else
181void e2fs_i_bswap(struct ext2fs_dinode *, struct ext2fs_dinode *);
182#	define e2fs_iload(old, new) e2fs_i_bswap((old), (new))
183#	define e2fs_isave(old, new) e2fs_i_bswap((old), (new))
184#endif
185
186#endif /* !_UFS_EXT2FS_EXT2FS_DINODE_H_ */
187