Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / vfs / ufs / inode.h
CommitLineData
984263bc
MD
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 */
41
42#ifndef _UFS_UFS_INODE_H_
43#define _UFS_UFS_INODE_H_
44
45#include <sys/lock.h>
46#include <sys/queue.h>
47#include <ufs/ufs/dinode.h>
48
49/*
50 * The size of a logical block number.
51 */
52typedef long ufs_lbn_t;
53
54/*
55 * This must agree with the definition in <ufs/ufs/dir.h>.
56 */
57#define doff_t int32_t
58
59/*
60 * The inode is used to describe each active (or recently active) file in the
61 * UFS filesystem. It is composed of two types of information. The first part
62 * is the information that is needed only while the file is active (such as
63 * the identity of the file and linkage to speed its lookup). The second part
64 * is the permanent meta-data associated with the file which is read in
65 * from the permanent dinode from long term storage when the file becomes
66 * active, and is put back when the file is no longer being used.
67 */
68struct inode {
69 struct lock i_lock; /* Inode lock. >Keep this first< */
70 LIST_ENTRY(inode) i_hash;/* Hash chain. */
71 struct vnode *i_vnode;/* Vnode associated with this inode. */
72 struct vnode *i_devvp;/* Vnode for block I/O. */
73 u_int32_t i_flag; /* flags, see below */
74 dev_t i_dev; /* Device associated with the inode. */
75 ino_t i_number; /* The identity of the inode. */
76 int i_effnlink; /* i_nlink when I/O completes */
77
78 union { /* Associated filesystem. */
79 struct fs *fs; /* FFS */
80 struct ext2_sb_info *e2fs; /* EXT2FS */
81 } inode_u;
82#define i_fs inode_u.fs
83#define i_e2fs inode_u.e2fs
84 struct dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
85 u_quad_t i_modrev; /* Revision level for NFS lease. */
86 struct lockf *i_lockf;/* Head of byte-level lock list. */
87 /*
88 * Side effects; used during directory lookup.
89 */
90 int32_t i_count; /* Size of free slot in directory. */
91 doff_t i_endoff; /* End of useful stuff in directory. */
92 doff_t i_diroff; /* Offset in dir, where we found last entry. */
93 doff_t i_offset; /* Offset of free space in directory. */
94 ino_t i_ino; /* Inode number of found directory. */
95 u_int32_t i_reclen; /* Size of found directory entry. */
96 u_int32_t i_spare[3]; /* XXX actually non-spare (for ext2fs). */
97
98 struct dirhash *i_dirhash; /* Hashing for large directories */
99 /*
100 * The on-disk dinode itself.
101 */
102 struct dinode i_din; /* 128 bytes of the on-disk dinode. */
103};
104
105#define i_atime i_din.di_atime
106#define i_atimensec i_din.di_atimensec
107#define i_blocks i_din.di_blocks
108#define i_ctime i_din.di_ctime
109#define i_ctimensec i_din.di_ctimensec
110#define i_db i_din.di_db
111#define i_flags i_din.di_flags
112#define i_gen i_din.di_gen
113#define i_gid i_din.di_gid
114#define i_ib i_din.di_ib
115#define i_mode i_din.di_mode
116#define i_mtime i_din.di_mtime
117#define i_mtimensec i_din.di_mtimensec
118#define i_nlink i_din.di_nlink
119#define i_rdev i_din.di_rdev
120#define i_shortlink i_din.di_shortlink
121#define i_size i_din.di_size
122#define i_uid i_din.di_uid
123
124/* These flags are kept in i_flag. */
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_SHLOCK 0x0020 /* File has shared lock. */
131#define IN_EXLOCK 0x0040 /* File has exclusive lock. */
132#define IN_HASHED 0x0080 /* Inode is on hash list */
133#define IN_LAZYMOD 0x0100 /* Modified, but don't write yet. */
134
135#ifdef _KERNEL
136/*
137 * Structure used to pass around logical block paths generated by
138 * ufs_getlbns and used by truncate and bmap code.
139 */
140struct indir {
141 ufs_daddr_t in_lbn; /* Logical block number. */
142 int in_off; /* Offset in buffer. */
143 int in_exists; /* Flag if the block exists. */
144};
145
146/* Convert between inode pointers and vnode pointers. */
147#define VTOI(vp) ((struct inode *)(vp)->v_data)
148#define ITOV(ip) ((ip)->i_vnode)
149
150/* Determine if soft dependencies are being done */
151#define DOINGSOFTDEP(vp) ((vp)->v_mount->mnt_flag & MNT_SOFTDEP)
152#define DOINGASYNC(vp) ((vp)->v_mount->mnt_flag & MNT_ASYNC)
153
154/* This overlays the fid structure (see mount.h). */
155struct ufid {
156 u_int16_t ufid_len; /* Length of structure. */
157 u_int16_t ufid_pad; /* Force 32-bit alignment. */
158 ino_t ufid_ino; /* File number (ino). */
159 int32_t ufid_gen; /* Generation number. */
160};
161#endif /* _KERNEL */
162
163#endif /* !_UFS_UFS_INODE_H_ */