2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 #ifndef __XFS_VNODE_H__
19 #define __XFS_VNODE_H__
25 struct attrlist_cursor_kern;
27 typedef struct dentry bhv_vname_t;
28 typedef __u64 bhv_vnumber_t;
30 typedef struct bhv_vnode {
31 bhv_vnumber_t v_number; /* in-core vnode number */
32 #ifdef XFS_VNODE_TRACE
33 struct ktrace *v_trace; /* trace header structure */
35 struct inode v_inode; /* Linux inode */
36 /* inode MUST be last */
39 #define VN_ISLNK(vp) S_ISLNK((vp)->v_inode.i_mode)
40 #define VN_ISREG(vp) S_ISREG((vp)->v_inode.i_mode)
41 #define VN_ISDIR(vp) S_ISDIR((vp)->v_inode.i_mode)
42 #define VN_ISCHR(vp) S_ISCHR((vp)->v_inode.i_mode)
43 #define VN_ISBLK(vp) S_ISBLK((vp)->v_inode.i_mode)
46 * Vnode to Linux inode mapping.
48 static inline struct bhv_vnode *vn_from_inode(struct inode *inode)
50 return container_of(inode, bhv_vnode_t, v_inode);
52 static inline struct inode *vn_to_inode(struct bhv_vnode *vnode)
54 return &vnode->v_inode;
58 * Values for the vop_rwlock/rwunlock flags parameter.
60 typedef enum bhv_vrwlock {
70 * Return values for xfs_inactive. A return value of
71 * VN_INACTIVE_NOCACHE implies that the file system behavior
72 * has disassociated its state and bhv_desc_t from the vnode.
74 #define VN_INACTIVE_CACHE 0
75 #define VN_INACTIVE_NOCACHE 1
78 * Flags for read/write calls - same values as IRIX
80 #define IO_ISAIO 0x00001 /* don't wait for completion */
81 #define IO_ISDIRECT 0x00004 /* bypass page cache */
82 #define IO_INVIS 0x00020 /* don't update inode timestamps */
85 * Flags for vop_iflush call
87 #define FLUSH_SYNC 1 /* wait for flush to complete */
88 #define FLUSH_INODE 2 /* flush the inode itself */
89 #define FLUSH_LOG 4 /* force the last log entry for
90 * this inode out to disk */
93 * Flush/Invalidate options for vop_toss/flush/flushinval_pages.
95 #define FI_NONE 0 /* none */
96 #define FI_REMAPF 1 /* Do a remapf prior to the operation */
97 #define FI_REMAPF_LOCKED 2 /* Do a remapf prior to the operation.
98 Prevent VM access to the pages until
99 the operation completes. */
102 * Vnode attributes. va_mask indicates those attributes the caller
103 * wants to set or extract.
105 typedef struct bhv_vattr {
106 int va_mask; /* bit-mask of attributes present */
107 mode_t va_mode; /* file access mode and type */
108 xfs_nlink_t va_nlink; /* number of references to file */
109 uid_t va_uid; /* owner user id */
110 gid_t va_gid; /* owner group id */
111 xfs_ino_t va_nodeid; /* file id */
112 xfs_off_t va_size; /* file size in bytes */
113 u_long va_blocksize; /* blocksize preferred for i/o */
114 struct timespec va_atime; /* time of last access */
115 struct timespec va_mtime; /* time of last modification */
116 struct timespec va_ctime; /* time file changed */
117 u_int va_gen; /* generation number of file */
118 xfs_dev_t va_rdev; /* device the special file represents */
119 __int64_t va_nblocks; /* number of blocks allocated */
120 u_long va_xflags; /* random extended file flags */
121 u_long va_extsize; /* file extent size */
122 u_long va_nextents; /* number of extents in file */
123 u_long va_anextents; /* number of attr extents in file */
124 prid_t va_projid; /* project id */
128 * setattr or getattr attributes
130 #define XFS_AT_TYPE 0x00000001
131 #define XFS_AT_MODE 0x00000002
132 #define XFS_AT_UID 0x00000004
133 #define XFS_AT_GID 0x00000008
134 #define XFS_AT_FSID 0x00000010
135 #define XFS_AT_NODEID 0x00000020
136 #define XFS_AT_NLINK 0x00000040
137 #define XFS_AT_SIZE 0x00000080
138 #define XFS_AT_ATIME 0x00000100
139 #define XFS_AT_MTIME 0x00000200
140 #define XFS_AT_CTIME 0x00000400
141 #define XFS_AT_RDEV 0x00000800
142 #define XFS_AT_BLKSIZE 0x00001000
143 #define XFS_AT_NBLOCKS 0x00002000
144 #define XFS_AT_VCODE 0x00004000
145 #define XFS_AT_MAC 0x00008000
146 #define XFS_AT_UPDATIME 0x00010000
147 #define XFS_AT_UPDMTIME 0x00020000
148 #define XFS_AT_UPDCTIME 0x00040000
149 #define XFS_AT_ACL 0x00080000
150 #define XFS_AT_CAP 0x00100000
151 #define XFS_AT_INF 0x00200000
152 #define XFS_AT_XFLAGS 0x00400000
153 #define XFS_AT_EXTSIZE 0x00800000
154 #define XFS_AT_NEXTENTS 0x01000000
155 #define XFS_AT_ANEXTENTS 0x02000000
156 #define XFS_AT_PROJID 0x04000000
157 #define XFS_AT_SIZE_NOPERM 0x08000000
158 #define XFS_AT_GENCOUNT 0x10000000
160 #define XFS_AT_ALL (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
161 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
162 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
163 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|XFS_AT_MAC|\
164 XFS_AT_ACL|XFS_AT_CAP|XFS_AT_INF|XFS_AT_XFLAGS|XFS_AT_EXTSIZE|\
165 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_PROJID|XFS_AT_GENCOUNT)
167 #define XFS_AT_STAT (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
168 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
169 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
170 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_PROJID)
172 #define XFS_AT_TIMES (XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME)
174 #define XFS_AT_UPDTIMES (XFS_AT_UPDATIME|XFS_AT_UPDMTIME|XFS_AT_UPDCTIME)
176 #define XFS_AT_NOSET (XFS_AT_NLINK|XFS_AT_RDEV|XFS_AT_FSID|XFS_AT_NODEID|\
177 XFS_AT_TYPE|XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|\
178 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_GENCOUNT)
183 #define VSUID S_ISUID /* set user id on execution */
184 #define VSGID S_ISGID /* set group id on execution */
185 #define VSVTX S_ISVTX /* save swapped text even after use */
186 #define VREAD S_IRUSR /* read, write, execute permissions */
187 #define VWRITE S_IWUSR
188 #define VEXEC S_IXUSR
190 #define MODEMASK S_IALLUGO /* mode bits plus permission bits */
193 * Check whether mandatory file locking is enabled.
195 #define MANDLOCK(vp, mode) \
196 (VN_ISREG(vp) && ((mode) & (VSGID|(VEXEC>>3))) == VSGID)
198 extern void vn_init(void);
199 extern bhv_vnode_t *vn_initialize(struct inode *);
200 extern int vn_revalidate(struct bhv_vnode *);
201 extern int __vn_revalidate(struct bhv_vnode *, bhv_vattr_t *);
202 extern void vn_revalidate_core(struct bhv_vnode *, bhv_vattr_t *);
205 * Yeah, these don't take vnode anymore at all, all this should be
206 * cleaned up at some point.
208 extern void vn_iowait(struct xfs_inode *ip);
209 extern void vn_iowake(struct xfs_inode *ip);
210 extern void vn_ioerror(struct xfs_inode *ip, int error, char *f, int l);
212 static inline int vn_count(struct bhv_vnode *vp)
214 return atomic_read(&vn_to_inode(vp)->i_count);
218 * Vnode reference counting functions (and macros for compatibility).
220 extern bhv_vnode_t *vn_hold(struct bhv_vnode *);
222 #if defined(XFS_VNODE_TRACE)
223 #define VN_HOLD(vp) \
224 ((void)vn_hold(vp), \
225 vn_trace_hold(vp, __FILE__, __LINE__, (inst_t *)__return_address))
226 #define VN_RELE(vp) \
227 (vn_trace_rele(vp, __FILE__, __LINE__, (inst_t *)__return_address), \
228 iput(vn_to_inode(vp)))
230 #define VN_HOLD(vp) ((void)vn_hold(vp))
231 #define VN_RELE(vp) (iput(vn_to_inode(vp)))
234 static inline struct bhv_vnode *vn_grab(struct bhv_vnode *vp)
236 struct inode *inode = igrab(vn_to_inode(vp));
237 return inode ? vn_from_inode(inode) : NULL;
241 * Vname handling macros.
243 #define VNAME(dentry) ((char *) (dentry)->d_name.name)
244 #define VNAMELEN(dentry) ((dentry)->d_name.len)
245 #define VNAME_TO_VNODE(dentry) (vn_from_inode((dentry)->d_inode))
248 * Dealing with bad inodes
250 static inline void vn_mark_bad(struct bhv_vnode *vp)
252 make_bad_inode(vn_to_inode(vp));
255 static inline int VN_BAD(struct bhv_vnode *vp)
257 return is_bad_inode(vn_to_inode(vp));
261 * Extracting atime values in various formats
263 static inline void vn_atime_to_bstime(bhv_vnode_t *vp, xfs_bstime_t *bs_atime)
265 bs_atime->tv_sec = vp->v_inode.i_atime.tv_sec;
266 bs_atime->tv_nsec = vp->v_inode.i_atime.tv_nsec;
269 static inline void vn_atime_to_timespec(bhv_vnode_t *vp, struct timespec *ts)
271 *ts = vp->v_inode.i_atime;
274 static inline void vn_atime_to_time_t(bhv_vnode_t *vp, time_t *tt)
276 *tt = vp->v_inode.i_atime.tv_sec;
280 * Some useful predicates.
282 #define VN_MAPPED(vp) mapping_mapped(vn_to_inode(vp)->i_mapping)
283 #define VN_CACHED(vp) (vn_to_inode(vp)->i_mapping->nrpages)
284 #define VN_DIRTY(vp) mapping_tagged(vn_to_inode(vp)->i_mapping, \
288 * Flags to vop_setattr/getattr.
290 #define ATTR_UTIME 0x01 /* non-default utime(2) request */
291 #define ATTR_DMI 0x08 /* invocation from a DMI function */
292 #define ATTR_LAZY 0x80 /* set/get attributes lazily */
293 #define ATTR_NONBLOCK 0x100 /* return EAGAIN if operation would block */
294 #define ATTR_NOLOCK 0x200 /* Don't grab any conflicting locks */
295 #define ATTR_NOSIZETOK 0x400 /* Don't get the SIZE token */
298 * Flags to vop_fsync/reclaim.
300 #define FSYNC_NOWAIT 0 /* asynchronous flush */
301 #define FSYNC_WAIT 0x1 /* synchronous fsync or forced reclaim */
302 #define FSYNC_INVAL 0x2 /* flush and invalidate cached data */
303 #define FSYNC_DATA 0x4 /* synchronous fsync of data only */
306 * Tracking vnode activity.
308 #if defined(XFS_VNODE_TRACE)
310 #define VNODE_TRACE_SIZE 16 /* number of trace entries */
311 #define VNODE_KTRACE_ENTRY 1
312 #define VNODE_KTRACE_EXIT 2
313 #define VNODE_KTRACE_HOLD 3
314 #define VNODE_KTRACE_REF 4
315 #define VNODE_KTRACE_RELE 5
317 extern void vn_trace_entry(struct bhv_vnode *, const char *, inst_t *);
318 extern void vn_trace_exit(struct bhv_vnode *, const char *, inst_t *);
319 extern void vn_trace_hold(struct bhv_vnode *, char *, int, inst_t *);
320 extern void vn_trace_ref(struct bhv_vnode *, char *, int, inst_t *);
321 extern void vn_trace_rele(struct bhv_vnode *, char *, int, inst_t *);
323 #define VN_TRACE(vp) \
324 vn_trace_ref(vp, __FILE__, __LINE__, (inst_t *)__return_address)
326 #define vn_trace_entry(a,b,c)
327 #define vn_trace_exit(a,b,c)
328 #define vn_trace_hold(a,b,c,d)
329 #define vn_trace_ref(a,b,c,d)
330 #define vn_trace_rele(a,b,c,d)
334 #endif /* __XFS_VNODE_H__ */