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