xref: /dragonfly/sys/vfs/ufs/dinode.h (revision 25a2db75)
1 /*-
2  * Copyright (c) 1982, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)dinode.h	8.3 (Berkeley) 1/21/94
39  * $FreeBSD: src/sys/ufs/ufs/dinode.h,v 1.7 1999/08/28 00:52:27 peter Exp $
40  * $DragonFly: src/sys/vfs/ufs/dinode.h,v 1.8 2008/08/04 18:15:47 dillon Exp $
41  */
42 
43 #ifndef _VFS_UFS_DINODE_H_
44 #define _VFS_UFS_DINODE_H_
45 
46 #include "ufs_types.h"
47 
48 /*
49  * The root inode is the root of the filesystem.  Inode 0 can't be used for
50  * normal purposes and historically bad blocks were linked to inode 1, thus
51  * the root inode is 2.  (Inode 1 is no longer used for this purpose, however
52  * numerous dump tapes make this assumption, so we are stuck with it).
53  */
54 #define	ROOTINO	((ino_t)2)
55 
56 /*
57  * The Whiteout inode# is a dummy non-zero inode number which will
58  * never be allocated to a real file.  It is used as a place holder
59  * in the directory entry which has been tagged as a DT_W entry.
60  * See the comments about ROOTINO above.
61  */
62 #define	WINO	((ino_t)1)
63 
64 /*
65  * A dinode contains all the meta-data associated with a UFS file.
66  * This structure defines the on-disk format of a dinode. Since
67  * this structure describes an on-disk structure, all its fields
68  * are defined by types with precise widths.
69  */
70 
71 #define	NDADDR	12			/* Direct addresses in inode. */
72 #define	NIADDR	3			/* Indirect addresses in inode. */
73 
74 struct ufs1_dinode {
75 	uint16_t	di_mode;	/*   0: IFMT, permissions; see below. */
76 	int16_t		di_nlink;	/*   2: File link count. */
77 	union {
78 		uint16_t oldids[2];	/*   4: Ffs: old user and group ids. */
79 		int32_t	  inumber;	/*   4: Lfs: inode number. */
80 	} di_u;
81 	uint64_t	di_size;	/*   8: File byte count. */
82 	int32_t		di_atime;	/*  16: Last access time. */
83 	int32_t		di_atimensec;	/*  20: Last access time. */
84 	int32_t		di_mtime;	/*  24: Last modified time. */
85 	int32_t		di_mtimensec;	/*  28: Last modified time. */
86 	int32_t		di_ctime;	/*  32: Last inode change time. */
87 	int32_t		di_ctimensec;	/*  36: Last inode change time. */
88 	ufs_daddr_t	di_db[NDADDR];	/*  40: Direct disk blocks. */
89 	ufs_daddr_t	di_ib[NIADDR];	/*  88: Indirect disk blocks. */
90 	uint32_t	di_flags;	/* 100: Status flags (chflags). */
91 	int32_t		di_blocks;	/* 104: Blocks actually held. */
92 	int32_t		di_gen;		/* 108: Generation number. */
93 	uint32_t	di_uid;		/* 112: File owner. */
94 	uint32_t	di_gid;		/* 116: File group. */
95 	union {				/* 120: File hierarchy modified */
96 	    int32_t	spare[2];	/*	(used by ext2fs) */
97 	} di_v;
98 };
99 
100 /*
101  * The di_db fields may be overlaid with other information for
102  * file types that do not have associated disk storage. Block
103  * and character devices overlay the first data block with their
104  * cdev_t value. Short symbolic links place their path in the
105  * di_db area.
106  */
107 #define	di_inumber	di_u.inumber
108 #define	di_ogid		di_u.oldids[1]
109 #define	di_ouid		di_u.oldids[0]
110 #define	di_rdev		di_db[0]
111 #define	di_shortlink	di_db
112 #define di_spare	di_v.spare	/* ext2fs */
113 #define	MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(ufs_daddr_t))
114 
115 /* File permissions. */
116 #define	IEXEC		0000100		/* Executable. */
117 #define	IWRITE		0000200		/* Writeable. */
118 #define	IREAD		0000400		/* Readable. */
119 #define	ISVTX		0001000		/* Sticky bit. */
120 #define	ISGID		0002000		/* Set-gid. */
121 #define	ISUID		0004000		/* Set-uid. */
122 
123 /* File types. */
124 #define	IFMT		0170000		/* Mask of file type. */
125 #define	IFIFO		0010000		/* Named pipe (fifo). */
126 #define	IFCHR		0020000		/* Character device. */
127 #define	IFDIR		0040000		/* Directory file. */
128 #define	IFBLK		0060000		/* Block device. */
129 #define	IFREG		0100000		/* Regular file. */
130 #define	IFLNK		0120000		/* Symbolic link. */
131 #define	IFSOCK		0140000		/* UNIX domain socket. */
132 #define	IFWHT		0160000		/* Whiteout. */
133 
134 #endif /* !_VFS_UFS_DINODE_H_ */
135