dinode.h revision 259223
1/*-
2 * Copyright (c) 2002 Networks Associates Technology, Inc.
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by Marshall
6 * Kirk McKusick and Network Associates Laboratories, the Security
7 * Research Division of Network Associates, Inc. under DARPA/SPAWAR
8 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
9 * research program
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * Copyright (c) 1982, 1989, 1993
33 *	The Regents of the University of California.  All rights reserved.
34 * (c) UNIX System Laboratories, Inc.
35 * All or some portions of this file are derived from material licensed
36 * to the University of California by American Telephone and Telegraph
37 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
38 * the permission of UNIX System Laboratories, Inc.
39 *
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
42 * are met:
43 * 1. Redistributions of source code must retain the above copyright
44 *    notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 *    notice, this list of conditions and the following disclaimer in the
47 *    documentation and/or other materials provided with the distribution.
48 * 3. The names of the authors may not be used to endorse or promote
49 *    products derived from this software without specific prior written
50 *    permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * SUCH DAMAGE.
63 *
64 *	@(#)dinode.h	8.3 (Berkeley) 1/21/94
65 * $FreeBSD: stable/10/sys/ufs/ufs/dinode.h 259223 2013-12-11 19:25:17Z pfg $
66 */
67
68#ifndef _UFS_UFS_DINODE_H_
69#define	_UFS_UFS_DINODE_H_
70
71/*
72 * The root inode is the root of the filesystem.  Inode 0 can't be used for
73 * normal purposes and historically bad blocks were linked to inode 1, thus
74 * the root inode is 2.  (Inode 1 is no longer used for this purpose, however
75 * numerous dump tapes make this assumption, so we are stuck with it).
76 */
77#define	ROOTINO	((ino_t)2)
78
79/*
80 * The Whiteout inode# is a dummy non-zero inode number which will
81 * never be allocated to a real file.  It is used as a place holder
82 * in the directory entry which has been tagged as a DT_WHT entry.
83 * See the comments about ROOTINO above.
84 */
85#define	WINO	((ino_t)1)
86
87/*
88 * The size of physical and logical block numbers and time fields in UFS.
89 */
90typedef	int32_t	ufs1_daddr_t;
91typedef	int64_t	ufs2_daddr_t;
92typedef int64_t ufs_lbn_t;
93typedef int64_t ufs_time_t;
94
95/* File permissions. */
96#define	IEXEC		0000100		/* Executable. */
97#define	IWRITE		0000200		/* Writeable. */
98#define	IREAD		0000400		/* Readable. */
99#define	ISVTX		0001000		/* Sticky bit. */
100#define	ISGID		0002000		/* Set-gid. */
101#define	ISUID		0004000		/* Set-uid. */
102
103/* File types. */
104#define	IFMT		0170000		/* Mask of file type. */
105#define	IFIFO		0010000		/* Named pipe (fifo). */
106#define	IFCHR		0020000		/* Character device. */
107#define	IFDIR		0040000		/* Directory file. */
108#define	IFBLK		0060000		/* Block device. */
109#define	IFREG		0100000		/* Regular file. */
110#define	IFLNK		0120000		/* Symbolic link. */
111#define	IFSOCK		0140000		/* UNIX domain socket. */
112#define	IFWHT		0160000		/* Whiteout. */
113
114/*
115 * A dinode contains all the meta-data associated with a UFS2 file.
116 * This structure defines the on-disk format of a dinode. Since
117 * this structure describes an on-disk structure, all its fields
118 * are defined by types with precise widths.
119 */
120
121#define	NXADDR	2			/* External addresses in inode. */
122#define	NDADDR	12			/* Direct addresses in inode. */
123#define	NIADDR	3			/* Indirect addresses in inode. */
124
125struct ufs2_dinode {
126	u_int16_t	di_mode;	/*   0: IFMT, permissions; see below. */
127	int16_t		di_nlink;	/*   2: File link count. */
128	u_int32_t	di_uid;		/*   4: File owner. */
129	u_int32_t	di_gid;		/*   8: File group. */
130	u_int32_t	di_blksize;	/*  12: Inode blocksize. */
131	u_int64_t	di_size;	/*  16: File byte count. */
132	u_int64_t	di_blocks;	/*  24: Blocks actually held. */
133	ufs_time_t	di_atime;	/*  32: Last access time. */
134	ufs_time_t	di_mtime;	/*  40: Last modified time. */
135	ufs_time_t	di_ctime;	/*  48: Last inode change time. */
136	ufs_time_t	di_birthtime;	/*  56: Inode creation time. */
137	int32_t		di_mtimensec;	/*  64: Last modified time. */
138	int32_t		di_atimensec;	/*  68: Last access time. */
139	int32_t		di_ctimensec;	/*  72: Last inode change time. */
140	int32_t		di_birthnsec;	/*  76: Inode creation time. */
141	u_int32_t	di_gen;		/*  80: Generation number. */
142	u_int32_t	di_kernflags;	/*  84: Kernel flags. */
143	u_int32_t	di_flags;	/*  88: Status flags (chflags). */
144	u_int32_t	di_extsize;	/*  92: External attributes size. */
145	ufs2_daddr_t	di_extb[NXADDR];/*  96: External attributes block. */
146	ufs2_daddr_t	di_db[NDADDR];	/* 112: Direct disk blocks. */
147	ufs2_daddr_t	di_ib[NIADDR];	/* 208: Indirect disk blocks. */
148	u_int64_t	di_modrev;	/* 232: i_modrev for NFSv4 */
149	uint32_t	di_freelink;	/* 240: SUJ: Next unlinked inode. */
150	uint32_t	di_spare[3];	/* 244: Reserved; currently unused */
151};
152
153/*
154 * The di_db fields may be overlaid with other information for
155 * file types that do not have associated disk storage. Block
156 * and character devices overlay the first data block with their
157 * dev_t value. Short symbolic links place their path in the
158 * di_db area.
159 */
160#define	di_rdev di_db[0]
161
162/*
163 * A UFS1 dinode contains all the meta-data associated with a UFS1 file.
164 * This structure defines the on-disk format of a UFS1 dinode. Since
165 * this structure describes an on-disk structure, all its fields
166 * are defined by types with precise widths.
167 */
168struct ufs1_dinode {
169	u_int16_t	di_mode;	/*   0: IFMT, permissions; see below. */
170	int16_t		di_nlink;	/*   2: File link count. */
171	uint32_t	di_freelink;	/*   4: SUJ: Next unlinked inode. */
172	u_int64_t	di_size;	/*   8: File byte count. */
173	int32_t		di_atime;	/*  16: Last access time. */
174	int32_t		di_atimensec;	/*  20: Last access time. */
175	int32_t		di_mtime;	/*  24: Last modified time. */
176	int32_t		di_mtimensec;	/*  28: Last modified time. */
177	int32_t		di_ctime;	/*  32: Last inode change time. */
178	int32_t		di_ctimensec;	/*  36: Last inode change time. */
179	ufs1_daddr_t	di_db[NDADDR];	/*  40: Direct disk blocks. */
180	ufs1_daddr_t	di_ib[NIADDR];	/*  88: Indirect disk blocks. */
181	u_int32_t	di_flags;	/* 100: Status flags (chflags). */
182	u_int32_t	di_blocks;	/* 104: Blocks actually held. */
183	u_int32_t	di_gen;		/* 108: Generation number. */
184	u_int32_t	di_uid;		/* 112: File owner. */
185	u_int32_t	di_gid;		/* 116: File group. */
186	u_int64_t	di_modrev;	/* 120: i_modrev for NFSv4 */
187};
188
189#endif /* _UFS_UFS_DINODE_H_ */
190