bsd/ufs/ufs/dinode.h

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