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/param.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/queue.h>
  45
  46 #include <fs/ext2fs/ext2_extents.h>
  47
  48 /*
  49  * This must agree with the definition in <ufs/ufs/dir.h>.
  50  */
  51 #define doff_t          int32_t
  52
  53 #define NDADDR  12                      /* Direct addresses in inode. */
  54 #define NIADDR  3                       /* Indirect addresses in inode. */
  55
  56 /*
  57  * The size of physical and logical block numbers in EXT2FS.
  58  */
  59 typedef uint32_t e2fs_daddr_t;
  60 typedef int64_t e2fs_lbn_t;
  61 typedef int64_t e4fs_daddr_t;
  62
  63 /*
  64  * The inode is used to describe each active (or recently active) file in the
  65  * EXT2FS filesystem. It is composed of two types of information. The first
  66  * part is the information that is needed only while the file is active (such
  67  * as the identity of the file and linkage to speed its lookup). The second
  68  * part is the permanent meta-data associated with the file which is read in
  69  * from the permanent dinode from long term storage when the file becomes
  70  * active, and is put back when the file is no longer being used.
  71  */
  72 struct inode {
  73         struct  vnode  *i_vnode;/* Vnode associated with this inode. */
  74         struct  ext2mount *i_ump;
  75         uint32_t i_flag;        /* flags, see below */
  76         ino_t     i_number;     /* The identity of the inode. */
  77
  78         struct  m_ext2fs *i_e2fs;       /* EXT2FS */
  79         u_quad_t i_modrev;      /* Revision level for NFS lease. */
  80         /*
  81          * Side effects; used during directory lookup.
  82          */
  83         int32_t  i_count;       /* Size of free slot in directory. */
  84         doff_t   i_endoff;      /* End of useful stuff in directory. */
  85         doff_t   i_diroff;      /* Offset in dir, where we found last entry. */
  86         doff_t   i_offset;      /* Offset of free space in directory. */
  87
  88         uint32_t i_block_group;
  89         uint32_t i_next_alloc_block;
  90         uint32_t i_next_alloc_goal;
  91
  92         /* Fields from struct dinode in UFS. */
  93         uint16_t        i_mode;         /* IFMT, permissions; see below. */
  94         int16_t         i_nlink;        /* File link count. */
  95         uint32_t        i_uid;          /* File owner. */
  96         uint32_t        i_gid;          /* File group. */
  97         uint64_t        i_size;         /* File byte count. */
  98         uint64_t        i_blocks;       /* Blocks actually held. */
  99         int32_t         i_atime;        /* Last access time. */
 100         int32_t         i_mtime;        /* Last modified time. */
 101         int32_t         i_ctime;        /* Last inode change time. */
 102         int32_t         i_birthtime;    /* Inode creation time. */
 103         int32_t         i_mtimensec;    /* Last modified time. */
 104         int32_t         i_atimensec;    /* Last access time. */
 105         int32_t         i_ctimensec;    /* Last inode change time. */
 106         int32_t         i_birthnsec;    /* Inode creation time. */
 107         uint32_t        i_gen;          /* Generation number. */
 108         uint32_t        i_flags;        /* Status flags (chflags). */
 109         uint32_t        i_db[NDADDR];   /* Direct disk blocks. */
 110         uint32_t        i_ib[NIADDR];   /* Indirect disk blocks. */
 111
 112         struct ext4_extent_cache i_ext_cache; /* cache for ext4 extent */
 113 };
 114
 115 /*
 116  * The di_db fields may be overlaid with other information for
 117  * file types that do not have associated disk storage. Block
 118  * and character devices overlay the first data block with their
 119  * dev_t value. Short symbolic links place their path in the
 120  * di_db area.
 121  */
 122 #define i_shortlink     i_db
 123 #define i_rdev          i_db[0]
 124
 125 /* File permissions. */
 126 #define IEXEC           0000100         /* Executable. */
 127 #define IWRITE          0000200         /* Writeable. */
 128 #define IREAD           0000400         /* Readable. */
 129 #define ISVTX           0001000         /* Sticky bit. */
 130 #define ISGID           0002000         /* Set-gid. */
 131 #define ISUID           0004000         /* Set-uid. */
 132
 133 /* File types. */
 134 #define IFMT            0170000         /* Mask of file type. */
 135 #define IFIFO           0010000         /* Named pipe (fifo). */
 136 #define IFCHR           0020000         /* Character device. */
 137 #define IFDIR           0040000         /* Directory file. */
 138 #define IFBLK           0060000         /* Block device. */
 139 #define IFREG           0100000         /* Regular file. */
 140 #define IFLNK           0120000         /* Symbolic link. */
 141 #define IFSOCK          0140000         /* UNIX domain socket. */
 142 #define IFWHT           0160000         /* Whiteout. */
 143
 144 /* These flags are kept in i_flag. */
 145 #define IN_ACCESS       0x0001          /* Access time update request. */
 146 #define IN_CHANGE       0x0002          /* Inode change time update request. */
 147 #define IN_UPDATE       0x0004          /* Modification time update request. */
 148 #define IN_MODIFIED     0x0008          /* Inode has been modified. */
 149 #define IN_RENAME       0x0010          /* Inode is being renamed. */
 150 #define IN_HASHED       0x0020          /* Inode is on hash list */
 151 #define IN_LAZYMOD      0x0040          /* Modified, but don't write yet. */
 152 #define IN_SPACECOUNTED 0x0080          /* Blocks to be freed in free count. */
 153 #define IN_LAZYACCESS   0x0100          /* Process IN_ACCESS after the
 154                                             suspension finished */
 155
 156 #define i_devvp i_ump->um_devvp
 157
 158 #ifdef _KERNEL
 159 /*
 160  * Structure used to pass around logical block paths generated by
 161  * ext2_getlbns and used by truncate and bmap code.
 162  */
 163 struct indir {
 164         e2fs_lbn_t in_lbn;              /* Logical block number. */
 165         int     in_off;                 /* Offset in buffer. */
 166 };
 167
 168 /* Convert between inode pointers and vnode pointers. */
 169 #define VTOI(vp)        ((struct inode *)(vp)->v_data)
 170 #define ITOV(ip)        ((ip)->i_vnode)
 171
 172 /* This overlays the fid structure (see mount.h). */
 173 struct ufid {
 174         uint16_t ufid_len;      /* Length of structure. */
 175         uint16_t ufid_pad;      /* Force 32-bit alignment. */
 176         ino_t    ufid_ino;      /* File number (ino). */
 177         uint32_t ufid_gen;      /* Generation number. */
 178 };
 179 #endif /* _KERNEL */
 180
 181 #endif /* !_FS_EXT2FS_INODE_H_ */