bsd/ufs/ufs/dinode.h

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