Some cleanup after addition of TRIM support.
[dragonfly.git] / sys / vfs / gnu / ext2fs / 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/gnu/ext2fs/inode.h,v 1.3 2006/09/10 01:26:40 dillon Exp $
41  */
42
43 #ifndef _VFS_GNU_EXT2FS_INODE_H_
44 #define _VFS_GNU_EXT2FS_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 ext2_lbn_t;
66
67 /*
68  * This must agree with the definition in "dir.h"
69  */
70 #define doff_t          int32_t
71
72 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
73
74 /*
75  * An EXT2FS inode is basically a UFS inode with some spare fields
76  * redefined and a different superblock structure.
77  */
78 struct inode {
79         struct inode    *i_next;/* Hash chain */
80         struct  vnode  *i_vnode;/* Vnode associated with this inode. */
81         struct  vnode  *i_devvp;/* Vnode for block I/O. */
82         uint32_t i_flag;        /* flags, see below */
83         cdev_t    i_dev;        /* Device associated with the inode. */
84         ino_t     i_number;     /* The identity of the inode. */
85         int       i_effnlink;   /* i_nlink when I/O completes */
86
87         struct  ext2_sb_info *i_e2fs;   /* EXT2FS */
88         struct   ext2_dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
89         u_quad_t i_modrev;      /* Revision level for NFS lease. */
90         struct   lockf i_lockf;/* Head of byte-level lock list. */
91         /*
92          * Side effects; used during directory lookup.
93          */
94         int32_t   i_count;      /* Size of free slot in directory. */
95         doff_t    i_endoff;     /* End of useful stuff in directory. */
96         doff_t    i_diroff;     /* Offset in dir, where we found last entry. */
97         doff_t    i_offset;     /* Offset of free space in directory. */
98         ino_t     i_ino;        /* Inode number of found directory. */
99         uint32_t i_reclen;      /* Size of found directory entry. */
100         uint32_t i_spare[3];    /* XXX actually non-spare (for ext2fs). */
101
102         struct dirhash *i_dirhash; /* Hashing for large directories */
103         /*
104          * The on-disk dinode itself (128 bytes)
105          */
106         struct  ext2_dinode i_din;
107 };
108
109 #ifndef NO_I_DEFINES
110
111 #define i_atime         i_din.di_atime
112 #define i_atimensec     i_din.di_atimensec
113 #define i_blocks        i_din.di_blocks
114 #define i_ctime         i_din.di_ctime
115 #define i_ctimensec     i_din.di_ctimensec
116 #define i_db            i_din.di_db
117 #define i_flags         i_din.di_flags
118 #define i_gen           i_din.di_gen
119 #define i_gid           i_din.di_gid
120 #define i_ib            i_din.di_ib
121 #define i_mode          i_din.di_mode
122 #define i_mtime         i_din.di_mtime
123 #define i_mtimensec     i_din.di_mtimensec
124 #define i_nlink         i_din.di_nlink
125 #define i_rdev          i_din.di_rdev
126 #define i_shortlink     i_din.di_shortlink
127 #define i_size          i_din.di_size
128 #define i_uid           i_din.di_uid
129
130 #endif
131
132 #endif
133
134 /* These flags are kept in i_flag. */
135 #define IN_ACCESS       0x0001          /* Access time update request. */
136 #define IN_CHANGE       0x0002          /* Inode change time update request. */
137 #define IN_UPDATE       0x0004          /* Modification time update request. */
138 #define IN_MODIFIED     0x0008          /* Inode has been modified. */
139 #define IN_RENAME       0x0010          /* Inode is being renamed. */
140 #define IN_SHLOCK       0x0020          /* File has shared lock. */
141 #define IN_EXLOCK       0x0040          /* File has exclusive lock. */
142 #define IN_HASHED       0x0080          /* Inode is on hash list */
143 #define IN_LAZYMOD      0x0100          /* Modified, but don't write yet. */
144
145 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
146
147 /*
148  * Structure used to pass around logical block paths generated by
149  * ext2_getlbns and used by truncate and bmap code.
150  */
151 struct indir {
152         ext2_daddr_t in_lbn;            /* Logical block number. */
153         int     in_off;                 /* Offset in buffer. */
154         int     in_exists;              /* Flag if the block exists. */
155 };
156
157 /* Convert between inode pointers and vnode pointers. */
158 #define VTOI(vp)        ((struct inode *)(vp)->v_data)
159 #define ITOV(ip)        ((ip)->i_vnode)
160
161 /* Determine if soft dependencies are being done */
162 #define DOINGSOFTDEP(vp)        ((vp)->v_mount->mnt_flag & MNT_SOFTDEP)
163 #define DOINGASYNC(vp)          ((vp)->v_mount->mnt_flag & MNT_ASYNC)
164
165 /* This overlays the fid structure (see mount.h). */
166 struct ufid {
167         uint16_t ufid_len;      /* Length of structure. */
168         uint16_t ufid_pad;      /* Force 32-bit alignment. */
169         ino_t     ufid_ino;     /* File number (ino). */
170         int32_t   ufid_gen;     /* Generation number. */
171 };
172 #endif /* _KERNEL || _KERNEL_STRUCTURES */
173
174 #endif /* !_VFS_GNU_EXT2FS_INODE_H_ */