xref: /openbsd/sys/ufs/ufs/dinode.h (revision d06c4e1f)
1 /*	$OpenBSD: dinode.h,v 1.19 2020/05/28 15:48:29 otto Exp $	*/
2 /*	$NetBSD: dinode.h,v 1.7 1995/06/15 23:22:48 cgd Exp $	*/
3 
4 /*
5  * Copyright (c) 1982, 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  * (c) UNIX System Laboratories, Inc.
8  * All or some portions of this file are derived from material licensed
9  * to the University of California by American Telephone and Telegraph
10  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
11  * the permission of UNIX System Laboratories, Inc.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)dinode.h	8.9 (Berkeley) 3/29/95
38  */
39 
40 #ifndef _UFS_DINODE_H_
41 #define _UFS_DINODE_H_
42 
43 /*
44  * UFS directories use 32bit inode numbers internally, regardless
45  * of what the system on top of it uses.
46  */
47 typedef u_int32_t	ufsino_t;
48 
49 /*
50  * The root inode is the root of the file system.  Inode 0 can't be used for
51  * normal purposes and historically bad blocks were linked to inode 1, thus
52  * the root inode is 2.  (Inode 1 is no longer used for this purpose, however
53  * numerous dump tapes make this assumption, so we are stuck with it).
54  */
55 #define	ROOTINO	((ufsino_t)2)
56 
57 /*
58  * A dinode contains all the meta-data associated with a UFS file.
59  * This structure defines the on-disk format of a dinode. Since
60  * this structure describes an on-disk structure, all its fields
61  * are defined by types with precise widths.
62  */
63 #define	NXADDR	2			/* External addresses in inode */
64 #define	NDADDR	12			/* Direct addresses in inode. */
65 #define	NIADDR	3			/* Indirect addresses in inode. */
66 
67 struct	ufs1_dinode {
68 	u_int16_t	di_mode;	/*   0: IFMT, permissions; see below. */
69 	int16_t		di_nlink;	/*   2: File link count. */
70 	union {
71 		u_int16_t oldids[2];	/*   4: Ffs: old user and group ids. */
72 		u_int32_t inumber;	/*   4: Lfs: inode number. */
73 	} di_u;
74 	u_int64_t	di_size;	/*   8: File byte count. */
75 	int32_t		di_atime;	/*  16: Last access time. */
76 	int32_t		di_atimensec;	/*  20: Last access time. */
77 	int32_t		di_mtime;	/*  24: Last modified time. */
78 	int32_t		di_mtimensec;	/*  28: Last modified time. */
79 	int32_t		di_ctime;	/*  32: Last inode change time. */
80 	int32_t		di_ctimensec;	/*  36: Last inode change time. */
81 	int32_t		di_db[NDADDR];	/*  40: Direct disk blocks. */
82 	int32_t		di_ib[NIADDR];	/*  88: Indirect disk blocks. */
83 	u_int32_t	di_flags;	/* 100: Status flags (chflags). */
84 	int32_t		di_blocks;	/* 104: Blocks actually held. */
85 	u_int32_t	di_gen;		/* 108: Generation number. */
86 	u_int32_t	di_uid;		/* 112: File owner. */
87 	u_int32_t	di_gid;		/* 116: File group. */
88 	int32_t		di_spare[2];	/* 120: Reserved; currently unused */
89 };
90 
91 struct ufs2_dinode {
92 	u_int16_t	di_mode;	/*   0: IFMT, permissions; see below. */
93 	int16_t		di_nlink;	/*   2: File link count. */
94 	u_int32_t	di_uid;		/*   4: File owner. */
95 	u_int32_t	di_gid;		/*   8: File group. */
96 	u_int32_t	di_blksize;	/*  12: Inode blocksize. */
97 	u_int64_t	di_size;	/*  16: File byte count. */
98 	u_int64_t	di_blocks;	/*  24: Bytes actually held. */
99 	int64_t		di_atime;	/*  32: Last access time. */
100 	int64_t		di_mtime;	/*  40: Last modified time. */
101 	int64_t		di_ctime;	/*  48: Last inode change time. */
102 	int64_t		di_birthtime;	/*  56: Inode creation time. */
103 	int32_t		di_mtimensec;	/*  64: Last modified time. */
104 	int32_t		di_atimensec;	/*  68: Last access time. */
105 	int32_t		di_ctimensec;	/*  72: Last inode change time. */
106 	int32_t		di_birthnsec;	/*  76: Inode creation time. */
107 	int32_t		di_gen;		/*  80: Generation number. */
108 	u_int32_t	di_kernflags;	/*  84: Kernel flags. */
109 	u_int32_t	di_flags;	/*  88: Status flags (chflags). */
110 	int32_t		di_extsize;	/*  92: External attributes block. */
111 	int64_t		di_extb[NXADDR];/*  96: External attributes block. */
112 	int64_t		di_db[NDADDR];	/* 112: Direct disk blocks. */
113 	int64_t		di_ib[NIADDR];	/* 208: Indirect disk blocks. */
114 	int64_t		di_spare[3];	/* 232: Reserved; currently unused */
115 };
116 
117 /*
118  * The di_db fields may be overlaid with other information for
119  * file types that do not have associated disk storage. Block
120  * and character devices overlay the first data block with their
121  * dev_t value. Short symbolic links place their path in the
122  * di_db area.
123  */
124 #define	di_inumber	di_u.inumber
125 #define	di_ogid		di_u.oldids[1]
126 #define	di_ouid		di_u.oldids[0]
127 #define	di_rdev		di_db[0]
128 #define	di_shortlink	di_db
129 
130 #define MAXSYMLINKLEN_UFS1	((NDADDR + NIADDR) * sizeof(int32_t))
131 #define MAXSYMLINKLEN_UFS2	((NDADDR + NIADDR) * sizeof(int64_t))
132 
133 #define MAXSYMLINKLEN(ip) \
134 	((ip)->i_ump->um_fstype == UM_UFS1) ? \
135 	MAXSYMLINKLEN_UFS1 : MAXSYMLINKLEN_UFS2
136 
137 /* File permissions. */
138 #define	IEXEC		0000100		/* Executable. */
139 #define	IWRITE		0000200		/* Writeable. */
140 #define	IREAD		0000400		/* Readable. */
141 #define	ISVTX		0001000		/* Sticky bit. */
142 #define	ISGID		0002000		/* Set-gid. */
143 #define	ISUID		0004000		/* Set-uid. */
144 
145 /* File types. */
146 #define	IFMT		0170000		/* Mask of file type. */
147 #define	IFIFO		0010000		/* Named pipe (fifo). */
148 #define	IFCHR		0020000		/* Character device. */
149 #define	IFDIR		0040000		/* Directory file. */
150 #define	IFBLK		0060000		/* Block device. */
151 #define	IFREG		0100000		/* Regular file. */
152 #define	IFLNK		0120000		/* Symbolic link. */
153 #define	IFSOCK		0140000		/* UNIX domain socket. */
154 #define	IFWHT		0160000		/* Whiteout. */
155 
156 #endif /* _UFS_DINODE_H_ */
157