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 struct inode {
  60         TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */
  61         struct  vnode  *i_vnode;/* Vnode associated with this inode. */
  62         struct  ufsmount *i_ump;/* Ufsmount point associated with this inode. */
  63         u_int32_t i_flag;       /* flags, see below */
  64         struct cdev *i_dev;     /* Device associated with the inode. */
  65         ino_t     i_number;     /* The identity of the inode. */
  66         int       i_effnlink;   /* i_nlink when I/O completes */
  67
  68         struct   fs *i_fs;      /* Associated filesystem superblock. */
  69         struct   dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
  70         u_quad_t i_modrev;      /* Revision level for NFS lease. */
  71         struct   lockf *i_lockf;/* Head of byte-level lock list. */
  72         /*
  73          * Side effects; used during directory lookup.
  74          */
  75         int32_t   i_count;      /* Size of free slot in directory. */
  76         doff_t    i_endoff;     /* End of useful stuff in directory. */
  77         doff_t    i_diroff;     /* Offset in dir, where we found last entry. */
  78         doff_t    i_offset;     /* Offset of free space in directory. */
  79         ino_t     i_ino;        /* Inode number of found directory. */
  80         u_int32_t i_reclen;     /* Size of found directory entry. */
  81
  82         union {
  83                 struct dirhash *dirhash; /* Hashing for large directories. */
  84                 daddr_t *snapblklist;    /* Collect expunged snapshot blocks. */
  85         } i_un;
  86
  87         /*
  88          * Data for extended attribute modification.
  89          */
  90         u_char    *i_ea_area;   /* Pointer to malloced copy of EA area */
  91         unsigned  i_ea_len;     /* Length of i_ea_area */
  92         int       i_ea_error;   /* First errno in transaction */
  93
  94         /*
  95          * Copies from the on-disk dinode itself.
  96          */
  97         u_int16_t i_mode;       /* IFMT, permissions; see below. */
  98         int16_t   i_nlink;      /* File link count. */
  99         u_int64_t i_size;       /* File byte count. */
 100         u_int32_t i_flags;      /* Status flags (chflags). */
 101         int64_t   i_gen;        /* Generation number. */
 102         u_int32_t i_uid;        /* File owner. */
 103         u_int32_t i_gid;        /* File group. */
 104         /*
 105          * The real copy of the on-disk inode.
 106          */
 107         union {
 108                 struct ufs1_dinode *din1;       /* UFS1 on-disk dinode. */
 109                 struct ufs2_dinode *din2;       /* UFS2 on-disk dinode. */
 110         } dinode_u;
 111 };
 112 /*
 113  * These flags are kept in i_flag.
 114  */
 115 #define IN_ACCESS       0x0001          /* Access time update request. */
 116 #define IN_CHANGE       0x0002          /* Inode change time update request. */
 117 #define IN_UPDATE       0x0004          /* Modification time update request. */
 118 #define IN_MODIFIED     0x0008          /* Inode has been modified. */
 119 #define IN_RENAME       0x0010          /* Inode is being renamed. */
 120 #define IN_LAZYMOD      0x0040          /* Modified, but don't write yet. */
 121 #define IN_SPACECOUNTED 0x0080          /* Blocks to be freed in free count. */
 122
 123 #define i_devvp i_ump->um_devvp
 124 #define i_umbufobj i_ump->um_bo
 125 #define i_dirhash i_un.dirhash
 126 #define i_snapblklist i_un.snapblklist
 127 #define i_din1 dinode_u.din1
 128 #define i_din2 dinode_u.din2
 129
 130 #ifdef _KERNEL
 131 /*
 132  * The DIP macro is used to access fields in the dinode that are
 133  * not cached in the inode itself.
 134  */
 135 #define DIP(ip, field) \
 136         (((ip)->i_ump->um_fstype == UFS1) ? \
 137         (ip)->i_din1->d##field : (ip)->i_din2->d##field)
 138 #define DIP_SET(ip, field, val) do { \
 139         if ((ip)->i_ump->um_fstype == UFS1) \
 140                 (ip)->i_din1->d##field = (val); \
 141         else \
 142                 (ip)->i_din2->d##field = (val); \
 143         } while (0)
 144
 145 #define MAXSYMLINKLEN(ip) \
 146         ((ip)->i_ump->um_fstype == UFS1) ? \
 147         ((NDADDR + NIADDR) * sizeof(ufs1_daddr_t)) : \
 148         ((NDADDR + NIADDR) * sizeof(ufs2_daddr_t))
 149 #define SHORTLINK(ip) \
 150         (((ip)->i_ump->um_fstype == UFS1) ? \
 151         (caddr_t)(ip)->i_din1->di_db : (caddr_t)(ip)->i_din2->di_db)
 152
 153 /*
 154  * Structure used to pass around logical block paths generated by
 155  * ufs_getlbns and used by truncate and bmap code.
 156  */
 157 struct indir {
 158         ufs2_daddr_t in_lbn;            /* Logical block number. */
 159         int     in_off;                 /* Offset in buffer. */
 160         int     in_exists;              /* Flag if the block exists. */
 161 };
 162
 163 /* Convert between inode pointers and vnode pointers. */
 164 #define VTOI(vp)        ((struct inode *)(vp)->v_data)
 165 #define ITOV(ip)        ((ip)->i_vnode)
 166
 167 /* Determine if soft dependencies are being done */
 168 #define DOINGSOFTDEP(vp)        ((vp)->v_mount->mnt_flag & MNT_SOFTDEP)
 169 #define DOINGASYNC(vp)          ((vp)->v_mount->mnt_flag & MNT_ASYNC)
 170
 171 /* This overlays the fid structure (see mount.h). */
 172 struct ufid {
 173         u_int16_t ufid_len;     /* Length of structure. */
 174         u_int16_t ufid_pad;     /* Force 32-bit alignment. */
 175         ino_t     ufid_ino;     /* File number (ino). */
 176         int32_t   ufid_gen;     /* Generation number. */
 177 };
 178 #endif /* _KERNEL */
 179
 180 #endif /* !_UFS_UFS_INODE_H_ */