sys/fs/ext2fs/inode.h

   1 /*-
   2  * Copyright (c) 1982, 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)inode.h     8.9 (Berkeley) 5/14/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _FS_EXT2FS_INODE_H_
  39 #define _FS_EXT2FS_INODE_H_
  40
  41 #include <sys/lock.h>
  42 #include <sys/queue.h>
  43
  44 #define NDADDR  12                      /* Direct addresses in inode. */
  45 #define NIADDR  3                       /* Indirect addresses in inode. */
  46
  47 /*
  48  * This must agree with the definition in <ufs/ufs/dir.h>.
  49  */
  50 #define doff_t          int32_t
  51
  52 /*
  53  * The inode is used to describe each active (or recently active) file in the
  54  * EXT2FS filesystem. It is composed of two types of information. The first
  55  * part is the information that is needed only while the file is active (such
  56  * as the identity of the file and linkage to speed its lookup). The second
  57  * part is the permanent meta-data associated with the file which is read in
  58  * from the permanent dinode from long term storage when the file becomes
  59  * active, and is put back when the file is no longer being used.
  60  */
  61 struct inode {
  62         struct  vnode  *i_vnode;/* Vnode associated with this inode. */
  63         struct  ext2mount *i_ump;
  64         uint32_t i_flag;        /* flags, see below */
  65         ino_t     i_number;     /* The identity of the inode. */
  66
  67         struct  m_ext2fs *i_e2fs;       /* EXT2FS */
  68         u_quad_t i_modrev;      /* Revision level for NFS lease. */
  69         /*
  70          * Side effects; used during directory lookup.
  71          */
  72         int32_t  i_count;       /* Size of free slot in directory. */
  73         doff_t   i_endoff;      /* End of useful stuff in directory. */
  74         doff_t   i_diroff;      /* Offset in dir, where we found last entry. */
  75         doff_t   i_offset;      /* Offset of free space in directory. */
  76
  77         uint32_t i_block_group;
  78         uint32_t i_next_alloc_block;
  79         uint32_t i_next_alloc_goal;
  80         uint32_t i_prealloc_block;
  81         uint32_t i_prealloc_count;
  82
  83         /* Fields from struct dinode in UFS. */
  84         uint16_t        i_mode;         /* IFMT, permissions; see below. */
  85         int16_t         i_nlink;        /* File link count. */
  86         uint64_t        i_size;         /* File byte count. */
  87         int32_t         i_atime;        /* Last access time. */
  88         int32_t         i_atimensec;    /* Last access time. */
  89         int32_t         i_mtime;        /* Last modified time. */
  90         int32_t         i_mtimensec;    /* Last modified time. */
  91         int32_t         i_ctime;        /* Last inode change time. */
  92         int32_t         i_ctimensec;    /* Last inode change time. */
  93         int32_t         i_db[NDADDR];   /* Direct disk blocks. */
  94         int32_t         i_ib[NIADDR];   /* Indirect disk blocks. */
  95         uint32_t        i_flags;        /* Status flags (chflags). */
  96         int32_t         i_blocks;       /* Blocks actually held. */
  97         int32_t         i_gen;          /* Generation number. */
  98         uint32_t        i_uid;          /* File owner. */
  99         uint32_t        i_gid;          /* File group. */
 100 };
 101
 102 /*
 103  * The di_db fields may be overlaid with other information for
 104  * file types that do not have associated disk storage. Block
 105  * and character devices overlay the first data block with their
 106  * dev_t value. Short symbolic links place their path in the
 107  * di_db area.
 108  */
 109 #define i_shortlink     i_db
 110 #define i_rdev          i_db[0]
 111 #define MAXSYMLINKLEN   ((NDADDR + NIADDR) * sizeof(int32_t))
 112
 113 /* File permissions. */
 114 #define IEXEC           0000100         /* Executable. */
 115 #define IWRITE          0000200         /* Writeable. */
 116 #define IREAD           0000400         /* Readable. */
 117 #define ISVTX           0001000         /* Sticky bit. */
 118 #define ISGID           0002000         /* Set-gid. */
 119 #define ISUID           0004000         /* Set-uid. */
 120
 121 /* File types. */
 122 #define IFMT            0170000         /* Mask of file type. */
 123 #define IFIFO           0010000         /* Named pipe (fifo). */
 124 #define IFCHR           0020000         /* Character device. */
 125 #define IFDIR           0040000         /* Directory file. */
 126 #define IFBLK           0060000         /* Block device. */
 127 #define IFREG           0100000         /* Regular file. */
 128 #define IFLNK           0120000         /* Symbolic link. */
 129 #define IFSOCK          0140000         /* UNIX domain socket. */
 130 #define IFWHT           0160000         /* Whiteout. */
 131
 132 /* These flags are kept in i_flag. */
 133 #define IN_ACCESS       0x0001          /* Access time update request. */
 134 #define IN_CHANGE       0x0002          /* Inode change time update request. */
 135 #define IN_UPDATE       0x0004          /* Modification time update request. */
 136 #define IN_MODIFIED     0x0008          /* Inode has been modified. */
 137 #define IN_RENAME       0x0010          /* Inode is being renamed. */
 138 #define IN_HASHED       0x0020          /* Inode is on hash list */
 139 #define IN_LAZYMOD      0x0040          /* Modified, but don't write yet. */
 140 #define IN_SPACECOUNTED 0x0080          /* Blocks to be freed in free count. */
 141 #define IN_LAZYACCESS   0x0100          /* Process IN_ACCESS after the
 142                                             suspension finished */
 143
 144 #define i_devvp i_ump->um_devvp
 145
 146 #ifdef _KERNEL
 147 /*
 148  * Structure used to pass around logical block paths generated by
 149  * ext2_getlbns and used by truncate and bmap code.
 150  */
 151 struct indir {
 152         int32_t in_lbn;                 /* Logical block number. */
 153         int     in_off;                 /* Offset in buffer. */
 154         int     in_exists;              /* Flag if the block exists. */
 155 };
 156
 157 /* Convert between inode pointers and vnode pointers. */
 158 #define VTOI(vp)        ((struct inode *)(vp)->v_data)
 159 #define ITOV(ip)        ((ip)->i_vnode)
 160
 161 /* Check whether the MNTK_ASYNC flag has been set for a mount point */
 162 #define DOINGASYNC(vp)          ((vp)->v_mount->mnt_kern_flag & MNTK_ASYNC)
 163
 164 /* This overlays the fid structure (see mount.h). */
 165 struct ufid {
 166         uint16_t ufid_len;      /* Length of structure. */
 167         uint16_t ufid_pad;      /* Force 32-bit alignment. */
 168         ino_t    ufid_ino;      /* File number (ino). */
 169         int32_t  ufid_gen;      /* Generation number. */
 170 };
 171 #endif /* _KERNEL */
 172
 173 #endif /* !_FS_EXT2FS_INODE_H_ */