xref: /netbsd/sys/ufs/ufs/dinode.h (revision c4a72b64)
1 /*	$NetBSD: dinode.h,v 1.14 2002/09/28 20:11:09 dbj 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. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the University of
23  *	California, Berkeley and its contributors.
24  * 4. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	@(#)dinode.h	8.9 (Berkeley) 3/29/95
41  */
42 
43 #ifndef	_UFS_UFS_DINODE_H_
44 #define	_UFS_UFS_DINODE_H_
45 
46 /*
47  * The root inode is the root of the file system.  Inode 0 can't be used for
48  * normal purposes and historically bad blocks were linked to inode 1, thus
49  * the root inode is 2.  (Inode 1 is no longer used for this purpose, however
50  * numerous dump tapes make this assumption, so we are stuck with it).
51  */
52 #define	ROOTINO	((ino_t)2)
53 
54 /*
55  * The Whiteout inode# is a dummy non-zero inode number which will
56  * never be allocated to a real file.  It is used as a place holder
57  * in the directory entry which has been tagged as a DT_W entry.
58  * See the comments about ROOTINO above.
59  */
60 #define	WINO	((ino_t)1)
61 
62 /*
63  * A dinode contains all the meta-data associated with a UFS file.
64  * This structure defines the on-disk format of a dinode. Since
65  * this structure describes an on-disk structure, all its fields
66  * are defined by types with precise widths.
67  */
68 
69 typedef int32_t ufs_daddr_t;
70 typedef long ufs_lbn_t;
71 
72 #define	NDADDR	12			/* Direct addresses in inode. */
73 #define	NIADDR	3			/* Indirect addresses in inode. */
74 
75 struct dinode {
76 	u_int16_t	di_mode;	/*   0: IFMT, permissions; see below. */
77 	int16_t		di_nlink;	/*   2: File link count. */
78 	union {
79 		u_int16_t oldids[2];	/*   4: Ffs: old user and group ids. */
80 		u_int32_t inumber;	/*   4: Lfs: inode number. */
81 	} di_u;
82 	u_int64_t	di_size;	/*   8: File byte count. */
83 	int32_t		di_atime;	/*  16: Last access time. */
84 	int32_t		di_atimensec;	/*  20: Last access time. */
85 	int32_t		di_mtime;	/*  24: Last modified time. */
86 	int32_t		di_mtimensec;	/*  28: Last modified time. */
87 	int32_t		di_ctime;	/*  32: Last inode change time. */
88 	int32_t		di_ctimensec;	/*  36: Last inode change time. */
89 	ufs_daddr_t	di_db[NDADDR];	/*  40: Direct disk blocks. */
90 	ufs_daddr_t	di_ib[NIADDR];	/*  88: Indirect disk blocks. */
91 	u_int32_t	di_flags;	/* 100: Status flags (chflags). */
92 	u_int32_t	di_blocks;	/* 104: Blocks actually held. */
93 	int32_t		di_gen;		/* 108: Generation number. */
94 	u_int32_t	di_uid;		/* 112: File owner. */
95 	u_int32_t	di_gid;		/* 116: File group. */
96 	int32_t		di_spare[2];	/* 120: Reserved; currently unused */
97 };
98 
99 /*
100  * The di_db fields may be overlaid with other information for
101  * file types that do not have associated disk storage. Block
102  * and character devices overlay the first data block with their
103  * dev_t value. Short symbolic links place their path in the
104  * di_db area.
105  */
106 #define	di_inumber	di_u.inumber
107 #define	di_ogid		di_u.oldids[1]
108 #define	di_ouid		di_u.oldids[0]
109 #define	di_rdev		di_db[0]
110 #define	di_shortlink	di_db
111 #define	MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(ufs_daddr_t))
112 
113 /* NeXT used to keep short symlinks in the inode even when using
114  * FS_42INODEFMT.  In that case fs->fs_maxsymlinklen is probably -1,
115  * but short symlinks were stored in inodes shorter than this:
116  */
117 #define	APPLEUFS_MAXSYMLINKLEN 60
118 
119 /* File permissions. */
120 #define	IEXEC		0000100		/* Executable. */
121 #define	IWRITE		0000200		/* Writeable. */
122 #define	IREAD		0000400		/* Readable. */
123 #define	ISVTX		0001000		/* Sticky bit. */
124 #define	ISGID		0002000		/* Set-gid. */
125 #define	ISUID		0004000		/* Set-uid. */
126 
127 /* File types. */
128 #define	IFMT		0170000		/* Mask of file type. */
129 #define	IFIFO		0010000		/* Named pipe (fifo). */
130 #define	IFCHR		0020000		/* Character device. */
131 #define	IFDIR		0040000		/* Directory file. */
132 #define	IFBLK		0060000		/* Block device. */
133 #define	IFREG		0100000		/* Regular file. */
134 #define	IFLNK		0120000		/* Symbolic link. */
135 #define	IFSOCK		0140000		/* UNIX domain socket. */
136 #define	IFWHT		0160000		/* Whiteout. */
137 
138 /* Size of the on-disk inode. */
139 #define	DINODE_SIZE	(sizeof(struct dinode))		/* 128 */
140 
141 #endif /* !_UFS_UFS_DINODE_H_ */
142