1/*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*
30 * Copyright (c) 1982, 1989, 1993
31 *	The Regents of the University of California.  All rights reserved.
32 * (c) UNIX System Laboratories, Inc.
33 * All or some portions of this file are derived from material licensed
34 * to the University of California by American Telephone and Telegraph
35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
36 * the permission of UNIX System Laboratories, Inc.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 *    notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 *    notice, this list of conditions and the following disclaimer in the
45 *    documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 *    must display the following acknowledgement:
48 *	This product includes software developed by the University of
49 *	California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 *    may be used to endorse or promote products derived from this software
52 *    without specific prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 *
66 *	@(#)dinode.h	8.9 (Berkeley) 3/29/95
67 */
68#ifndef _UFS_DINODE_H_
69#define _UFS_DINODE_H_
70
71#include <sys/appleapiopts.h>
72
73
74#ifdef __APPLE_API_UNSTABLE
75/*
76 * The root inode is the root of the file system.  Inode 0 can't be used for
77 * normal purposes and historically bad blocks were linked to inode 1, thus
78 * the root inode is 2.  (Inode 1 is no longer used for this purpose, however
79 * numerous dump tapes make this assumption, so we are stuck with it).
80 */
81#define	ROOTINO	((ino_t)2)
82
83/*
84 * The Whiteout inode# is a dummy non-zero inode number which will
85 * never be allocated to a real file.  It is used as a place holder
86 * in the directory entry which has been tagged as a DT_W entry.
87 * See the comments about ROOTINO above.
88 */
89#define	WINO	((ino_t)1)
90
91/*
92 * A dinode contains all the meta-data associated with a UFS file.
93 * This structure defines the on-disk format of a dinode. Since
94 * this structure describes an on-disk structure, all its fields
95 * are defined by types with precise widths.
96 */
97
98#define	NDADDR	12			/* Direct addresses in inode. */
99#define	NIADDR	3			/* Indirect addresses in inode. */
100
101typedef int32_t 	ufs_daddr_t;
102
103struct dinode {
104	u_int16_t	di_mode;	/*   0: IFMT, permissions; see below. */
105	int16_t		di_nlink;	/*   2: File link count. */
106	union {
107		u_int16_t oldids[2];	/*   4: Ffs: old user and group ids. */
108		int32_t	  inumber;	/*   4: Lfs: inode number. */
109	} di_u;
110	u_int64_t	di_size;	/*   8: File byte count. */
111	int32_t		di_atime;	/*  16: Last access time. */
112	int32_t		di_atimensec;	/*  20: Last access time. */
113	int32_t		di_mtime;	/*  24: Last modified time. */
114	int32_t		di_mtimensec;	/*  28: Last modified time. */
115	int32_t		di_ctime;	/*  32: Last inode change time. */
116	int32_t		di_ctimensec;	/*  36: Last inode change time. */
117	ufs_daddr_t	di_db[NDADDR];	/*  40: Direct disk blocks. */
118	ufs_daddr_t	di_ib[NIADDR];	/*  88: Indirect disk blocks. */
119	u_int32_t	di_flags;	/* 100: Status flags (chflags). */
120	u_int32_t	di_blocks;	/* 104: Blocks actually held. */
121	int32_t		di_gen;		/* 108: Generation number. */
122	u_int32_t	di_uid;		/* 112: File owner. */
123	u_int32_t	di_gid;		/* 116: File group. */
124	int32_t		di_spare[2];	/* 120: Reserved; currently unused */
125};
126
127/*
128 * The di_db fields may be overlaid with other information for
129 * file types that do not have associated disk storage. Block
130 * and character devices overlay the first data block with their
131 * dev_t value. Short symbolic links place their path in the
132 * di_db area.
133 */
134#define	di_inumber	di_u.inumber
135#define	di_ogid		di_u.oldids[1]
136#define	di_ouid		di_u.oldids[0]
137#define	di_rdev		di_db[0]
138#define	di_shortlink	di_db
139#define	MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(ufs_daddr_t))
140
141/* File permissions. */
142#define	IEXEC		0000100		/* Executable. */
143#define	IWRITE		0000200		/* Writeable. */
144#define	IREAD		0000400		/* Readable. */
145#define	ISVTX		0001000		/* Sticky bit. */
146#define	ISGID		0002000		/* Set-gid. */
147#define	ISUID		0004000		/* Set-uid. */
148
149/* File types. */
150#define	IFMT		0170000		/* Mask of file type. */
151#define	IFIFO		0010000		/* Named pipe (fifo). */
152#define	IFCHR		0020000		/* Character device. */
153#define	IFDIR		0040000		/* Directory file. */
154#define	IFBLK		0060000		/* Block device. */
155#define	IFREG		0100000		/* Regular file. */
156#define	IFLNK		0120000		/* Symbolic link. */
157#define	IFSOCK		0140000		/* UNIX domain socket. */
158#define	IFWHT		0160000		/* Whiteout. */
159
160#endif /* __APPLE_API_UNSTABLE */
161#endif /* ! _UFS_DINODE_H_ */
162