usr/src/sys/ufs/ufs/inode.h

/*
 * Copyright (c) 1982, 1989 The Regents of the University of California.
 * All rights reserved.
 *
 * %sccs.include.redist.c%
 *
 *      @(#)inode.h     7.22 (Berkeley) %G%
 */

#include <ufs/ufs/dinode.h>

/*
 * The inode is used to describe each active (or recently active)
 * file in the UFS filesystem. It is composed of two types of
 * information. The first part is the information that is needed
 * only while the file is active (such as the identity of the file
 * and linkage to speed its lookup). The second part is the
 * permannent meta-data associated with the file which is read
 * in from the permanent dinode from long term storage when the
 * file becomes active, and is put back when the file is no longer
 * being used.
 */
struct inode {
        struct  inode *i_chain[2]; /* hash chain, MUST be first */
        struct  vnode *i_vnode; /* vnode associated with this inode */
        struct  vnode *i_devvp; /* vnode for block I/O */
        u_long  i_flag;         /* see below */
        dev_t   i_dev;          /* device where inode resides */
        short   i_pad;
        ino_t   i_number;       /* the identity of the inode */
        union {                 /* associated filesystem */
                struct  fs *fs;         /* FFS */
                struct  lfs *lfs;       /* LFS */
        } inode_u;
#define i_fs    inode_u.fs
#define i_lfs   inode_u.lfs
        struct  dquot *i_dquot[MAXQUOTAS]; /* pointer to dquot structures */
        struct  lockf *i_lockf; /* head of byte-level lock list */
        u_quad_t i_modrev;      /* revision level for lease */
        pid_t   i_lockholder;   /* DEBUG: holder of inode lock */
        pid_t   i_lockwaiter;   /* DEBUG: latest blocked for inode lock */
        /*
         * Side effects; used during directory lookup.
         */
        off_t   i_endoff;       /* end of useful stuff in directory */
        long    i_diroff;       /* offset in dir, where we found last entry */
        long    i_offset;       /* offset of free space in directory */
        long    i_count;        /* size of free slot in directory */
        ino_t   i_ino;          /* inode number of found directory */
        u_long  i_reclen;       /* size of found directory entry */
        /*
         * the on-disk dinode itself.
         */
        struct  dinode i_din;   /* the on-disk dinode */
        long    i_spare[12];    /* spares to round up to 256 bytes */
};

#define i_mode          i_din.di_mode
#define i_nlink         i_din.di_nlink
#define i_uid           i_din.di_uid
#define i_gid           i_din.di_gid
#ifdef _NOQUAD
#define i_size  i_din.di_qsize.val[_QUAD_LOWWORD]
#else
#define i_size  i_din.di_qsize
#endif
#if defined(tahoe) /* ugh! -- must be fixed */
#undef i_size
#define i_size          i_din.di_qsize.val[0]
#endif
#define i_db            i_din.di_db
#define i_ib            i_din.di_ib
#define i_atime         i_din.di_atime
#define i_mtime         i_din.di_mtime
#define i_ctime         i_din.di_ctime
#define i_blocks        i_din.di_blocks
#define i_rdev          i_din.di_db[0]
#define i_flags         i_din.di_flags
#define i_gen           i_din.di_gen
#define i_forw          i_chain[0]
#define i_back          i_chain[1]

/* flags */
#define ILOCKED         0x0001          /* inode is locked */
#define IWANT           0x0002          /* some process waiting on lock */
#define IRENAME         0x0004          /* inode is being renamed */
#define IUPD            0x0010          /* file has been modified */
#define IACC            0x0020          /* inode access time to be updated */
#define ICHG            0x0040          /* inode has been changed */
#define IMOD            0x0080          /* inode has been modified */
#define ISHLOCK         0x0100          /* file has shared lock */
#define IEXLOCK         0x0200          /* file has exclusive lock */
#define ILWAIT          0x0400          /* someone waiting on file lock */

#ifdef KERNEL
/* Convert between inode pointers and vnode pointers. */
#define VTOI(vp)        ((struct inode *)(vp)->v_data)
#define ITOV(ip)        ((ip)->i_vnode)

/* Lock and unlock inodes. */
#ifdef notdef
#define ILOCK(ip) { \
        while ((ip)->i_flag & ILOCKED) { \
                (ip)->i_flag |= IWANT; \
                (void) sleep((caddr_t)(ip), PINOD); \
        } \
        (ip)->i_flag |= ILOCKED; \
}

#define IUNLOCK(ip) { \
        (ip)->i_flag &= ~ILOCKED; \
        if ((ip)->i_flag&IWANT) { \
                (ip)->i_flag &= ~IWANT; \
                wakeup((caddr_t)(ip)); \
        } \
}
#else
#define ILOCK(ip)       ufs_ilock(ip)
#define IUNLOCK(ip)     ufs_iunlock(ip)
#endif

#define ITIMES(ip, t1, t2) { \
        if ((ip)->i_flag&(IUPD|IACC|ICHG)) { \
                (ip)->i_flag |= IMOD; \
                if ((ip)->i_flag&IACC) \
                        (ip)->i_atime = (t1)->tv_sec; \
                if ((ip)->i_flag&IUPD) { \
                        (ip)->i_mtime = (t2)->tv_sec; \
                        INCRQUAD((ip)->i_modrev); \
                } \
                if ((ip)->i_flag&ICHG) \
                        (ip)->i_ctime = time.tv_sec; \
                (ip)->i_flag &= ~(IACC|IUPD|ICHG); \
        } \
}

/* This overlays the fid structure (see mount.h). */
struct ufid {
        u_short ufid_len;       /* length of structure */
        u_short ufid_pad;       /* force long alignment */
        ino_t   ufid_ino;       /* file number (ino) */
        long    ufid_gen;       /* generation number */
};
#endif /* KERNEL */