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