sys/ufs/ufs/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 _UFS_UFS_INODE_H_
  39 #define _UFS_UFS_INODE_H_
  40
  41 #include <sys/lock.h>
  42 #include <sys/queue.h>
  43 #include <ufs/ufs/dinode.h>
  44
  45 /*
  46  * This must agree with the definition in <ufs/ufs/dir.h>.
  47  */
  48 #define doff_t          int32_t
  49
  50 /*
  51  * The inode is used to describe each active (or recently active) file in the
  52  * UFS filesystem. It is composed of two types of information. The first part
  53  * is the information that is needed only while the file is active (such as
  54  * the identity of the file and linkage to speed its lookup). The second part
  55  * is the permanent meta-data associated with the file which is read in
  56  * from the permanent dinode from long term storage when the file becomes
  57  * active, and is put back when the file is no longer being used.
  58  *
  59  * An inode may only be changed while holding either the exclusive
  60  * vnode lock or the shared vnode lock and the vnode interlock. We use
  61  * the latter only for "read" and "get" operations that require
  62  * changing i_flag, or a timestamp. This locking protocol allows executing
  63  * those operations without having to upgrade the vnode lock from shared to
  64  * exclusive.
  65  */
  66 struct inode {
  67         TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */
  68         struct  vnode  *i_vnode;/* Vnode associated with this inode. */
  69         struct  ufsmount *i_ump;/* Ufsmount point associated with this inode. */
  70         u_int32_t i_flag;       /* flags, see below */
  71         struct cdev *i_dev;     /* Device associated with the inode. */
  72         ino_t     i_number;     /* The identity of the inode. */
  73         int       i_effnlink;   /* i_nlink when I/O completes */
  74
  75         struct   fs *i_fs;      /* Associated filesystem superblock. */
  76         struct   dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
  77         u_quad_t i_modrev;      /* Revision level for NFS lease. */
  78         /*
  79          * Side effects; used during directory lookup.
  80          */
  81         int32_t   i_count;      /* Size of free slot in directory. */
  82         doff_t    i_endoff;     /* End of useful stuff in directory. */
  83         doff_t    i_diroff;     /* Offset in dir, where we found last entry. */
  84         doff_t    i_offset;     /* Offset of free space in directory. */
  85
  86         union {
  87                 struct dirhash *dirhash; /* Hashing for large directories. */
  88                 daddr_t *snapblklist;    /* Collect expunged snapshot blocks. */
  89         } i_un;
  90
  91         /*
  92          * Data for extended attribute modification.
  93          */
  94         u_char    *i_ea_area;   /* Pointer to malloced copy of EA area */
  95         unsigned  i_ea_len;     /* Length of i_ea_area */
  96         int       i_ea_error;   /* First errno in transaction */
  97
  98         /*
  99          * Copies from the on-disk dinode itself.
 100          */
 101         u_int16_t i_mode;       /* IFMT, permissions; see below. */
 102         int16_t   i_nlink;      /* File link count. */
 103         u_int64_t i_size;       /* File byte count. */
 104         u_int32_t i_flags;      /* Status flags (chflags). */
 105         int64_t   i_gen;        /* Generation number. */
 106         u_int32_t i_uid;        /* File owner. */
 107         u_int32_t i_gid;        /* File group. */
 108         /*
 109          * The real copy of the on-disk inode.
 110          */
 111         union {
 112                 struct ufs1_dinode *din1;       /* UFS1 on-disk dinode. */
 113                 struct ufs2_dinode *din2;       /* UFS2 on-disk dinode. */
 114         } dinode_u;
 115
 116         /*
 117          * i_ea_refs is added at the end of the structure to
 118          * keep struct inode layout on releng branch.
 119          */
 120         int       i_ea_refs;    /* Number of users of EA area */
 121 };
 122 /*
 123  * These flags are kept in i_flag.
 124  */
 125 #define IN_ACCESS       0x0001          /* Access time update request. */
 126 #define IN_CHANGE       0x0002          /* Inode change time update request. */
 127 #define IN_UPDATE       0x0004          /* Modification time update request. */
 128 #define IN_MODIFIED     0x0008          /* Inode has been modified. */
 129 #define IN_RENAME       0x0010          /* Inode is being renamed. */
 130 #define IN_LAZYMOD      0x0040          /* Modified, but don't write yet. */
 131 #define IN_SPACECOUNTED 0x0080          /* Blocks to be freed in free count. */
 132 #define IN_LAZYACCESS   0x0100          /* Process IN_ACCESS after the
 133                                            suspension finished */
 134 #define IN_EA_LOCKED    0x0200
 135 #define IN_EA_LOCKWAIT  0x0400
 136
 137 #define i_devvp i_ump->um_devvp
 138 #define i_umbufobj i_ump->um_bo
 139 #define i_dirhash i_un.dirhash
 140 #define i_snapblklist i_un.snapblklist
 141 #define i_din1 dinode_u.din1
 142 #define i_din2 dinode_u.din2
 143
 144 #ifdef _KERNEL
 145 /*
 146  * The DIP macro is used to access fields in the dinode that are
 147  * not cached in the inode itself.
 148  */
 149 #define DIP(ip, field) \
 150         (((ip)->i_ump->um_fstype == UFS1) ? \
 151         (ip)->i_din1->d##field : (ip)->i_din2->d##field)
 152 #define DIP_SET(ip, field, val) do { \
 153         if ((ip)->i_ump->um_fstype == UFS1) \
 154                 (ip)->i_din1->d##field = (val); \
 155         else \
 156                 (ip)->i_din2->d##field = (val); \
 157         } while (0)
 158
 159 #define MAXSYMLINKLEN(ip) \
 160         ((ip)->i_ump->um_fstype == UFS1) ? \
 161         ((NDADDR + NIADDR) * sizeof(ufs1_daddr_t)) : \
 162         ((NDADDR + NIADDR) * sizeof(ufs2_daddr_t))
 163 #define SHORTLINK(ip) \
 164         (((ip)->i_ump->um_fstype == UFS1) ? \
 165         (caddr_t)(ip)->i_din1->di_db : (caddr_t)(ip)->i_din2->di_db)
 166
 167 /*
 168  * Structure used to pass around logical block paths generated by
 169  * ufs_getlbns and used by truncate and bmap code.
 170  */
 171 struct indir {
 172         ufs2_daddr_t in_lbn;            /* Logical block number. */
 173         int     in_off;                 /* Offset in buffer. */
 174         int     in_exists;              /* Flag if the block exists. */
 175 };
 176
 177 /* Convert between inode pointers and vnode pointers. */
 178 #define VTOI(vp)        ((struct inode *)(vp)->v_data)
 179 #define ITOV(ip)        ((ip)->i_vnode)
 180
 181 /* Determine if soft dependencies are being done */
 182 #define DOINGSOFTDEP(vp)        ((vp)->v_mount->mnt_flag & MNT_SOFTDEP)
 183 #define DOINGASYNC(vp)          ((vp)->v_mount->mnt_kern_flag & MNTK_ASYNC)
 184
 185 /* This overlays the fid structure (see mount.h). */
 186 struct ufid {
 187         u_int16_t ufid_len;     /* Length of structure. */
 188         u_int16_t ufid_pad;     /* Force 32-bit alignment. */
 189         ino_t     ufid_ino;     /* File number (ino). */
 190         int32_t   ufid_gen;     /* Generation number. */
 191 };
 192 #endif /* _KERNEL */
 193
 194 #endif /* !_UFS_UFS_INODE_H_ */