sys/vfs/hammer2: Remove obsolete comments for unused/reserved ondisk fields
[dragonfly.git] / sys / vfs / ufs / dinode.h
blobd26ba3c2fa148176af9ed6097555783b516f9f2f
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.
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. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
34 * @(#)dinode.h 8.3 (Berkeley) 1/21/94
35 * $FreeBSD: src/sys/ufs/ufs/dinode.h,v 1.7 1999/08/28 00:52:27 peter Exp $
38 #ifndef _VFS_UFS_DINODE_H_
39 #define _VFS_UFS_DINODE_H_
41 #include "ufs_types.h"
44 * The root inode is the root of the filesystem. Inode 0 can't be used for
45 * normal purposes and historically bad blocks were linked to inode 1, thus
46 * the root inode is 2. (Inode 1 is no longer used for this purpose, however
47 * numerous dump tapes make this assumption, so we are stuck with it).
49 #define UFS_ROOTINO ((ino_t)2)
52 * The Whiteout inode# is a dummy non-zero inode number which will
53 * never be allocated to a real file. It is used as a place holder
54 * in the directory entry which has been tagged as a DT_W entry.
55 * See the comments about UFS_ROOTINO above.
57 #define UFS_WINO ((ino_t)1)
60 * A dinode contains all the meta-data associated with a UFS file.
61 * This structure defines the on-disk format of a dinode. Since
62 * this structure describes an on-disk structure, all its fields
63 * are defined by types with precise widths.
66 #define UFS_NDADDR 12 /* Direct addresses in inode. */
67 #define UFS_NIADDR 3 /* Indirect addresses in inode. */
69 struct ufs1_dinode {
70 uint16_t di_mode; /* 0: IFMT, permissions; see below. */
71 int16_t di_nlink; /* 2: File link count. */
72 union {
73 uint16_t oldids[2]; /* 4: Ffs: old user and group ids. */
74 int32_t inumber; /* 4: Lfs: inode number. */
75 } di_u;
76 uint64_t di_size; /* 8: File byte count. */
77 uint32_t di_atime; /* 16: Last access time. */
78 uint32_t di_atimensec; /* 20: Last access time. */
79 uint32_t di_mtime; /* 24: Last modified time. */
80 uint32_t di_mtimensec; /* 28: Last modified time. */
81 uint32_t di_ctime; /* 32: Last inode change time. */
82 uint32_t di_ctimensec; /* 36: Last inode change time. */
83 ufs_daddr_t di_db[UFS_NDADDR]; /* 40: Direct disk blocks. */
84 ufs_daddr_t di_ib[UFS_NIADDR]; /* 88: Indirect disk blocks. */
85 uint32_t di_flags; /* 100: Status flags (chflags). */
86 int32_t di_blocks; /* 104: Blocks actually held. */
87 int32_t di_gen; /* 108: Generation number. */
88 uint32_t di_uid; /* 112: File owner. */
89 uint32_t di_gid; /* 116: File group. */
92 * Originally two 32-bit spare fields, set to 0. Extended by
93 * DragonFly 10-Mar-2019 to support 48-bit time fields.
95 uint16_t di_atime_ext; /* 120: 16 msb time bits */
96 uint16_t di_mtime_ext; /* 122: 16 msb time bits */
97 uint16_t di_ctime_ext; /* 124: 16 msb time bits */
98 uint16_t di_spare7E; /* 126: spare field */
102 * The di_db fields may be overlaid with other information for
103 * file types that do not have associated disk storage. Block
104 * and character devices overlay the first data block with their
105 * cdev_t value. Short symbolic links place their path in the
106 * di_db area.
108 #define di_inumber di_u.inumber
109 #define di_ogid di_u.oldids[1]
110 #define di_ouid di_u.oldids[0]
111 #define di_rdev di_db[0]
112 #define di_shortlink di_db
113 #define di_spare di_v.spare /* ext2fs */
114 #define UFS1_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs_daddr_t))
116 /* File permissions. */
117 #define IEXEC 0000100 /* Executable. */
118 #define IWRITE 0000200 /* Writeable. */
119 #define IREAD 0000400 /* Readable. */
120 #define ISVTX 0001000 /* Sticky bit. */
121 #define ISGID 0002000 /* Set-gid. */
122 #define ISUID 0004000 /* Set-uid. */
124 /* File types. */
125 #define IFMT 0170000 /* Mask of file type. */
126 #define IFIFO 0010000 /* Named pipe (fifo). */
127 #define IFCHR 0020000 /* Character device. */
128 #define IFDIR 0040000 /* Directory file. */
129 #define IFBLK 0060000 /* Block device. */
130 #define IFREG 0100000 /* Regular file. */
131 #define IFLNK 0120000 /* Symbolic link. */
132 #define IFSOCK 0140000 /* UNIX domain socket. */
133 #define IFWHT 0160000 /* Whiteout. */
135 #endif /* !_VFS_UFS_DINODE_H_ */