sys/vfs/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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)inode.h     8.9 (Berkeley) 5/14/95
  39  * $FreeBSD: src/sys/ufs/ufs/inode.h,v 1.28.2.2 2001/09/29 12:52:52 iedowse Exp $
  40  * $DragonFly: src/sys/vfs/ufs/inode.h,v 1.9 2004/12/30 07:01:52 cpressey Exp $
  41  */
  42
  43 #ifndef _UFS_UFS_INODE_H_
  44 #define _UFS_UFS_INODE_H_
  45
  46 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  47
  48 #ifndef _SYS_LOCK_H_
  49 #include <sys/lock.h>
  50 #endif
  51 #ifndef _SYS_LOCKF_H
  52 #include <sys/lockf.h>
  53 #endif
  54
  55 #endif
  56
  57 #ifndef _SYS_QUEUE_H_
  58 #include <sys/queue.h>
  59 #endif
  60 #include "dinode.h"
  61
  62 /*
  63  * The size of a logical block number.
  64  */
  65 typedef long ufs_lbn_t;
  66
  67 /*
  68  * This must agree with the definition in <ufs/ufs/dir.h>.
  69  */
  70 #define doff_t          int32_t
  71
  72 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  73
  74 /*
  75  * The inode is used to describe each active (or recently active) file in the
  76  * UFS filesystem. It is composed of two types of information. The first part
  77  * is the information that is needed only while the file is active (such as
  78  * the identity of the file and linkage to speed its lookup). The second part
  79  * is the permanent meta-data associated with the file which is read in
  80  * from the permanent dinode from long term storage when the file becomes
  81  * active, and is put back when the file is no longer being used.
  82  */
  83 struct inode {
  84         struct inode    *i_next;/* Hash chain */
  85         struct  vnode  *i_vnode;/* Vnode associated with this inode. */
  86         struct  vnode  *i_devvp;/* Vnode for block I/O. */
  87         uint32_t i_flag;        /* flags, see below */
  88         dev_t     i_dev;        /* Device associated with the inode. */
  89         ino_t     i_number;     /* The identity of the inode. */
  90         int       i_effnlink;   /* i_nlink when I/O completes */
  91
  92         union {                 /* Associated filesystem. */
  93                 struct  fs *fs;         /* FFS */
  94                 struct  ext2_sb_info *e2fs;     /* EXT2FS */
  95         } inode_u;
  96 #define i_fs    inode_u.fs
  97 #define i_e2fs  inode_u.e2fs
  98         struct   dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
  99         u_quad_t i_modrev;      /* Revision level for NFS lease. */
 100         struct   lockf i_lockf;/* Head of byte-level lock list. */
 101         /*
 102          * Side effects; used during directory lookup.
 103          */
 104         int32_t   i_count;      /* Size of free slot in directory. */
 105         doff_t    i_endoff;     /* End of useful stuff in directory. */
 106         doff_t    i_diroff;     /* Offset in dir, where we found last entry. */
 107         doff_t    i_offset;     /* Offset of free space in directory. */
 108         ino_t     i_ino;        /* Inode number of found directory. */
 109         uint32_t i_reclen;      /* Size of found directory entry. */
 110         uint32_t i_spare[3];    /* XXX actually non-spare (for ext2fs). */
 111
 112         struct dirhash *i_dirhash; /* Hashing for large directories */
 113         /*
 114          * The on-disk dinode itself.
 115          */
 116         struct  dinode i_din;   /* 128 bytes of the on-disk dinode. */
 117 };
 118
 119 #define i_atime         i_din.di_atime
 120 #define i_atimensec     i_din.di_atimensec
 121 #define i_blocks        i_din.di_blocks
 122 #define i_ctime         i_din.di_ctime
 123 #define i_ctimensec     i_din.di_ctimensec
 124 #define i_db            i_din.di_db
 125 #define i_flags         i_din.di_flags
 126 #define i_gen           i_din.di_gen
 127 #define i_gid           i_din.di_gid
 128 #define i_ib            i_din.di_ib
 129 #define i_mode          i_din.di_mode
 130 #define i_mtime         i_din.di_mtime
 131 #define i_mtimensec     i_din.di_mtimensec
 132 #define i_nlink         i_din.di_nlink
 133 #define i_rdev          i_din.di_rdev
 134 #define i_shortlink     i_din.di_shortlink
 135 #define i_size          i_din.di_size
 136 #define i_uid           i_din.di_uid
 137
 138 #endif
 139
 140 /* These flags are kept in i_flag. */
 141 #define IN_ACCESS       0x0001          /* Access time update request. */
 142 #define IN_CHANGE       0x0002          /* Inode change time update request. */
 143 #define IN_UPDATE       0x0004          /* Modification time update request. */
 144 #define IN_MODIFIED     0x0008          /* Inode has been modified. */
 145 #define IN_RENAME       0x0010          /* Inode is being renamed. */
 146 #define IN_SHLOCK       0x0020          /* File has shared lock. */
 147 #define IN_EXLOCK       0x0040          /* File has exclusive lock. */
 148 #define IN_HASHED       0x0080          /* Inode is on hash list */
 149 #define IN_LAZYMOD      0x0100          /* Modified, but don't write yet. */
 150
 151 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 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         ufs_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         uint16_t ufid_len;      /* Length of structure. */
 174         uint16_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 || _KERNEL_STRUCTURES */
 179
 180 #endif /* !_UFS_UFS_INODE_H_ */