linux 2.6.16.38 w/ vs2.0.3-rc1
[linux-2.6.git] / fs / xfs / linux-2.6 / xfs_vnode.h
1 /*
2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
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.
8  *
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.
13  *
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
17  *
18  * Portions Copyright (c) 1989, 1993
19  *      The Regents of the University of California.  All rights reserved.
20  *
21  * Redistribution and use in source and binary forms, with or without
22  * modification, are permitted provided that the following conditions
23  * are met:
24  * 1. Redistributions of source code must retain the above copyright
25  *    notice, this list of conditions and the following disclaimer.
26  * 2. Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in the
28  *    documentation and/or other materials provided with the distribution.
29  * 3. Neither the name of the University nor the names of its contributors
30  *    may be used to endorse or promote products derived from this software
31  *    without specific prior written permission.
32  *
33  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
34  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
35  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
37  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
41  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
42  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43  * SUCH DAMAGE.
44  */
45 #ifndef __XFS_VNODE_H__
46 #define __XFS_VNODE_H__
47
48 struct uio;
49 struct file;
50 struct vattr;
51 struct xfs_iomap;
52 struct attrlist_cursor_kern;
53
54
55 typedef xfs_ino_t vnumber_t;
56 typedef struct dentry vname_t;
57 typedef bhv_head_t vn_bhv_head_t;
58
59 /*
60  * MP locking protocols:
61  *      v_flag, v_vfsp                          VN_LOCK/VN_UNLOCK
62  */
63 typedef struct vnode {
64         __u32           v_flag;                 /* vnode flags (see below) */
65         struct vfs      *v_vfsp;                /* ptr to containing VFS */
66         vnumber_t       v_number;               /* in-core vnode number */
67         vn_bhv_head_t   v_bh;                   /* behavior head */
68         spinlock_t      v_lock;                 /* VN_LOCK/VN_UNLOCK */
69         atomic_t        v_iocount;              /* outstanding I/O count */
70 #ifdef XFS_VNODE_TRACE
71         struct ktrace   *v_trace;               /* trace header structure    */
72 #endif
73         struct inode    v_inode;                /* Linux inode */
74         /* inode MUST be last */
75 } vnode_t;
76
77 #define VN_ISLNK(vp)    S_ISLNK((vp)->v_inode.i_mode)
78 #define VN_ISREG(vp)    S_ISREG((vp)->v_inode.i_mode)
79 #define VN_ISDIR(vp)    S_ISDIR((vp)->v_inode.i_mode)
80 #define VN_ISCHR(vp)    S_ISCHR((vp)->v_inode.i_mode)
81 #define VN_ISBLK(vp)    S_ISBLK((vp)->v_inode.i_mode)
82
83 #define v_fbhv                  v_bh.bh_first          /* first behavior */
84 #define v_fops                  v_bh.bh_first->bd_ops  /* first behavior ops */
85
86 #define VNODE_POSITION_BASE     BHV_POSITION_BASE       /* chain bottom */
87 #define VNODE_POSITION_TOP      BHV_POSITION_TOP        /* chain top */
88 #define VNODE_POSITION_INVALID  BHV_POSITION_INVALID    /* invalid pos. num */
89
90 typedef enum {
91         VN_BHV_UNKNOWN,         /* not specified */
92         VN_BHV_XFS,             /* xfs */
93         VN_BHV_DM,              /* data migration */
94         VN_BHV_QM,              /* quota manager */
95         VN_BHV_IO,              /* IO path */
96         VN_BHV_END              /* housekeeping end-of-range */
97 } vn_bhv_t;
98
99 #define VNODE_POSITION_XFS      (VNODE_POSITION_BASE)
100 #define VNODE_POSITION_DM       (VNODE_POSITION_BASE+10)
101 #define VNODE_POSITION_QM       (VNODE_POSITION_BASE+20)
102 #define VNODE_POSITION_IO       (VNODE_POSITION_BASE+30)
103
104 /*
105  * Macros for dealing with the behavior descriptor inside of the vnode.
106  */
107 #define BHV_TO_VNODE(bdp)       ((vnode_t *)BHV_VOBJ(bdp))
108 #define BHV_TO_VNODE_NULL(bdp)  ((vnode_t *)BHV_VOBJNULL(bdp))
109
110 #define VN_BHV_HEAD(vp)                 ((bhv_head_t *)(&((vp)->v_bh)))
111 #define vn_bhv_head_init(bhp,name)      bhv_head_init(bhp,name)
112 #define vn_bhv_remove(bhp,bdp)          bhv_remove(bhp,bdp)
113 #define vn_bhv_lookup(bhp,ops)          bhv_lookup(bhp,ops)
114 #define vn_bhv_lookup_unlocked(bhp,ops) bhv_lookup_unlocked(bhp,ops)
115
116 /*
117  * Vnode to Linux inode mapping.
118  */
119 #define LINVFS_GET_VP(inode)    ((vnode_t *)list_entry(inode, vnode_t, v_inode))
120 #define LINVFS_GET_IP(vp)       (&(vp)->v_inode)
121
122 /*
123  * Vnode flags.
124  */
125 #define VMODIFIED              0x8      /* XFS inode state possibly differs */
126                                         /* to the Linux inode state.    */
127
128 /*
129  * Values for the VOP_RWLOCK and VOP_RWUNLOCK flags parameter.
130  */
131 typedef enum vrwlock {
132         VRWLOCK_NONE,
133         VRWLOCK_READ,
134         VRWLOCK_WRITE,
135         VRWLOCK_WRITE_DIRECT,
136         VRWLOCK_TRY_READ,
137         VRWLOCK_TRY_WRITE
138 } vrwlock_t;
139
140 /*
141  * Return values for VOP_INACTIVE.  A return value of
142  * VN_INACTIVE_NOCACHE implies that the file system behavior
143  * has disassociated its state and bhv_desc_t from the vnode.
144  */
145 #define VN_INACTIVE_CACHE       0
146 #define VN_INACTIVE_NOCACHE     1
147
148 /*
149  * Values for the cmd code given to VOP_VNODE_CHANGE.
150  */
151 typedef enum vchange {
152         VCHANGE_FLAGS_FRLOCKS           = 0,
153         VCHANGE_FLAGS_ENF_LOCKING       = 1,
154         VCHANGE_FLAGS_TRUNCATED         = 2,
155         VCHANGE_FLAGS_PAGE_DIRTY        = 3,
156         VCHANGE_FLAGS_IOEXCL_COUNT      = 4
157 } vchange_t;
158
159
160 typedef int     (*vop_open_t)(bhv_desc_t *, struct cred *);
161 typedef ssize_t (*vop_read_t)(bhv_desc_t *, struct kiocb *,
162                                 const struct iovec *, unsigned int,
163                                 loff_t *, int, struct cred *);
164 typedef ssize_t (*vop_write_t)(bhv_desc_t *, struct kiocb *,
165                                 const struct iovec *, unsigned int,
166                                 loff_t *, int, struct cred *);
167 typedef ssize_t (*vop_sendfile_t)(bhv_desc_t *, struct file *,
168                                 loff_t *, int, size_t, read_actor_t,
169                                 void *, struct cred *);
170 typedef int     (*vop_ioctl_t)(bhv_desc_t *, struct inode *, struct file *,
171                                 int, unsigned int, void __user *);
172 typedef int     (*vop_getattr_t)(bhv_desc_t *, struct vattr *, int,
173                                 struct cred *);
174 typedef int     (*vop_setattr_t)(bhv_desc_t *, struct vattr *, int,
175                                 struct cred *);
176 typedef int     (*vop_access_t)(bhv_desc_t *, int, struct cred *);
177 typedef int     (*vop_lookup_t)(bhv_desc_t *, vname_t *, vnode_t **,
178                                 int, vnode_t *, struct cred *);
179 typedef int     (*vop_create_t)(bhv_desc_t *, vname_t *, struct vattr *,
180                                 vnode_t **, struct cred *);
181 typedef int     (*vop_remove_t)(bhv_desc_t *, vname_t *, struct cred *);
182 typedef int     (*vop_link_t)(bhv_desc_t *, vnode_t *, vname_t *,
183                                 struct cred *);
184 typedef int     (*vop_rename_t)(bhv_desc_t *, vname_t *, vnode_t *, vname_t *,
185                                 struct cred *);
186 typedef int     (*vop_mkdir_t)(bhv_desc_t *, vname_t *, struct vattr *,
187                                 vnode_t **, struct cred *);
188 typedef int     (*vop_rmdir_t)(bhv_desc_t *, vname_t *, struct cred *);
189 typedef int     (*vop_readdir_t)(bhv_desc_t *, struct uio *, struct cred *,
190                                 int *);
191 typedef int     (*vop_symlink_t)(bhv_desc_t *, vname_t *, struct vattr *,
192                                 char *, vnode_t **, struct cred *);
193 typedef int     (*vop_readlink_t)(bhv_desc_t *, struct uio *, int,
194                                 struct cred *);
195 typedef int     (*vop_fsync_t)(bhv_desc_t *, int, struct cred *,
196                                 xfs_off_t, xfs_off_t);
197 typedef int     (*vop_inactive_t)(bhv_desc_t *, struct cred *);
198 typedef int     (*vop_fid2_t)(bhv_desc_t *, struct fid *);
199 typedef int     (*vop_release_t)(bhv_desc_t *);
200 typedef int     (*vop_rwlock_t)(bhv_desc_t *, vrwlock_t);
201 typedef void    (*vop_rwunlock_t)(bhv_desc_t *, vrwlock_t);
202 typedef int     (*vop_bmap_t)(bhv_desc_t *, xfs_off_t, ssize_t, int,
203                                 struct xfs_iomap *, int *);
204 typedef int     (*vop_reclaim_t)(bhv_desc_t *);
205 typedef int     (*vop_attr_get_t)(bhv_desc_t *, const char *, char *, int *,
206                                 int, struct cred *);
207 typedef int     (*vop_attr_set_t)(bhv_desc_t *, const char *, char *, int,
208                                 int, struct cred *);
209 typedef int     (*vop_attr_remove_t)(bhv_desc_t *, const char *,
210                                 int, struct cred *);
211 typedef int     (*vop_attr_list_t)(bhv_desc_t *, char *, int, int,
212                                 struct attrlist_cursor_kern *, struct cred *);
213 typedef void    (*vop_link_removed_t)(bhv_desc_t *, vnode_t *, int);
214 typedef void    (*vop_vnode_change_t)(bhv_desc_t *, vchange_t, __psint_t);
215 typedef void    (*vop_ptossvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t, int);
216 typedef void    (*vop_pflushinvalvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t, int);
217 typedef int     (*vop_pflushvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t,
218                                 uint64_t, int);
219 typedef int     (*vop_iflush_t)(bhv_desc_t *, int);
220
221
222 typedef struct vnodeops {
223         bhv_position_t  vn_position;    /* position within behavior chain */
224         vop_open_t              vop_open;
225         vop_read_t              vop_read;
226         vop_write_t             vop_write;
227         vop_sendfile_t          vop_sendfile;
228         vop_ioctl_t             vop_ioctl;
229         vop_getattr_t           vop_getattr;
230         vop_setattr_t           vop_setattr;
231         vop_access_t            vop_access;
232         vop_lookup_t            vop_lookup;
233         vop_create_t            vop_create;
234         vop_remove_t            vop_remove;
235         vop_link_t              vop_link;
236         vop_rename_t            vop_rename;
237         vop_mkdir_t             vop_mkdir;
238         vop_rmdir_t             vop_rmdir;
239         vop_readdir_t           vop_readdir;
240         vop_symlink_t           vop_symlink;
241         vop_readlink_t          vop_readlink;
242         vop_fsync_t             vop_fsync;
243         vop_inactive_t          vop_inactive;
244         vop_fid2_t              vop_fid2;
245         vop_rwlock_t            vop_rwlock;
246         vop_rwunlock_t          vop_rwunlock;
247         vop_bmap_t              vop_bmap;
248         vop_reclaim_t           vop_reclaim;
249         vop_attr_get_t          vop_attr_get;
250         vop_attr_set_t          vop_attr_set;
251         vop_attr_remove_t       vop_attr_remove;
252         vop_attr_list_t         vop_attr_list;
253         vop_link_removed_t      vop_link_removed;
254         vop_vnode_change_t      vop_vnode_change;
255         vop_ptossvp_t           vop_tosspages;
256         vop_pflushinvalvp_t     vop_flushinval_pages;
257         vop_pflushvp_t          vop_flush_pages;
258         vop_release_t           vop_release;
259         vop_iflush_t            vop_iflush;
260 } vnodeops_t;
261
262 /*
263  * VOP's.
264  */
265 #define _VOP_(op, vp)   (*((vnodeops_t *)(vp)->v_fops)->op)
266
267 #define VOP_READ(vp,file,iov,segs,offset,ioflags,cr,rv)                 \
268         rv = _VOP_(vop_read, vp)((vp)->v_fbhv,file,iov,segs,offset,ioflags,cr)
269 #define VOP_WRITE(vp,file,iov,segs,offset,ioflags,cr,rv)                \
270         rv = _VOP_(vop_write, vp)((vp)->v_fbhv,file,iov,segs,offset,ioflags,cr)
271 #define VOP_SENDFILE(vp,f,off,ioflags,cnt,act,targ,cr,rv)               \
272         rv = _VOP_(vop_sendfile, vp)((vp)->v_fbhv,f,off,ioflags,cnt,act,targ,cr)
273 #define VOP_BMAP(vp,of,sz,rw,b,n,rv)                                    \
274         rv = _VOP_(vop_bmap, vp)((vp)->v_fbhv,of,sz,rw,b,n)
275 #define VOP_OPEN(vp, cr, rv)                                            \
276         rv = _VOP_(vop_open, vp)((vp)->v_fbhv, cr)
277 #define VOP_GETATTR(vp, vap, f, cr, rv)                                 \
278         rv = _VOP_(vop_getattr, vp)((vp)->v_fbhv, vap, f, cr)
279 #define VOP_SETATTR(vp, vap, f, cr, rv)                                 \
280         rv = _VOP_(vop_setattr, vp)((vp)->v_fbhv, vap, f, cr)
281 #define VOP_ACCESS(vp, mode, cr, rv)                                    \
282         rv = _VOP_(vop_access, vp)((vp)->v_fbhv, mode, cr)
283 #define VOP_LOOKUP(vp,d,vpp,f,rdir,cr,rv)                               \
284         rv = _VOP_(vop_lookup, vp)((vp)->v_fbhv,d,vpp,f,rdir,cr)
285 #define VOP_CREATE(dvp,d,vap,vpp,cr,rv)                                 \
286         rv = _VOP_(vop_create, dvp)((dvp)->v_fbhv,d,vap,vpp,cr)
287 #define VOP_REMOVE(dvp,d,cr,rv)                                         \
288         rv = _VOP_(vop_remove, dvp)((dvp)->v_fbhv,d,cr)
289 #define VOP_LINK(tdvp,fvp,d,cr,rv)                                      \
290         rv = _VOP_(vop_link, tdvp)((tdvp)->v_fbhv,fvp,d,cr)
291 #define VOP_RENAME(fvp,fnm,tdvp,tnm,cr,rv)                              \
292         rv = _VOP_(vop_rename, fvp)((fvp)->v_fbhv,fnm,tdvp,tnm,cr)
293 #define VOP_MKDIR(dp,d,vap,vpp,cr,rv)                                   \
294         rv = _VOP_(vop_mkdir, dp)((dp)->v_fbhv,d,vap,vpp,cr)
295 #define VOP_RMDIR(dp,d,cr,rv)                                           \
296         rv = _VOP_(vop_rmdir, dp)((dp)->v_fbhv,d,cr)
297 #define VOP_READDIR(vp,uiop,cr,eofp,rv)                                 \
298         rv = _VOP_(vop_readdir, vp)((vp)->v_fbhv,uiop,cr,eofp)
299 #define VOP_SYMLINK(dvp,d,vap,tnm,vpp,cr,rv)                            \
300         rv = _VOP_(vop_symlink, dvp) ((dvp)->v_fbhv,d,vap,tnm,vpp,cr)
301 #define VOP_READLINK(vp,uiop,fl,cr,rv)                                  \
302         rv = _VOP_(vop_readlink, vp)((vp)->v_fbhv,uiop,fl,cr)
303 #define VOP_FSYNC(vp,f,cr,b,e,rv)                                       \
304         rv = _VOP_(vop_fsync, vp)((vp)->v_fbhv,f,cr,b,e)
305 #define VOP_INACTIVE(vp, cr, rv)                                        \
306         rv = _VOP_(vop_inactive, vp)((vp)->v_fbhv, cr)
307 #define VOP_RELEASE(vp, rv)                                             \
308         rv = _VOP_(vop_release, vp)((vp)->v_fbhv)
309 #define VOP_FID2(vp, fidp, rv)                                          \
310         rv = _VOP_(vop_fid2, vp)((vp)->v_fbhv, fidp)
311 #define VOP_RWLOCK(vp,i)                                                \
312         (void)_VOP_(vop_rwlock, vp)((vp)->v_fbhv, i)
313 #define VOP_RWLOCK_TRY(vp,i)                                            \
314         _VOP_(vop_rwlock, vp)((vp)->v_fbhv, i)
315 #define VOP_RWUNLOCK(vp,i)                                              \
316         (void)_VOP_(vop_rwunlock, vp)((vp)->v_fbhv, i)
317 #define VOP_FRLOCK(vp,c,fl,flags,offset,fr,rv)                          \
318         rv = _VOP_(vop_frlock, vp)((vp)->v_fbhv,c,fl,flags,offset,fr)
319 #define VOP_RECLAIM(vp, rv)                                             \
320         rv = _VOP_(vop_reclaim, vp)((vp)->v_fbhv)
321 #define VOP_ATTR_GET(vp, name, val, vallenp, fl, cred, rv)              \
322         rv = _VOP_(vop_attr_get, vp)((vp)->v_fbhv,name,val,vallenp,fl,cred)
323 #define VOP_ATTR_SET(vp, name, val, vallen, fl, cred, rv)               \
324         rv = _VOP_(vop_attr_set, vp)((vp)->v_fbhv,name,val,vallen,fl,cred)
325 #define VOP_ATTR_REMOVE(vp, name, flags, cred, rv)                      \
326         rv = _VOP_(vop_attr_remove, vp)((vp)->v_fbhv,name,flags,cred)
327 #define VOP_ATTR_LIST(vp, buf, buflen, fl, cursor, cred, rv)            \
328         rv = _VOP_(vop_attr_list, vp)((vp)->v_fbhv,buf,buflen,fl,cursor,cred)
329 #define VOP_LINK_REMOVED(vp, dvp, linkzero)                             \
330         (void)_VOP_(vop_link_removed, vp)((vp)->v_fbhv, dvp, linkzero)
331 #define VOP_VNODE_CHANGE(vp, cmd, val)                                  \
332         (void)_VOP_(vop_vnode_change, vp)((vp)->v_fbhv,cmd,val)
333 /*
334  * These are page cache functions that now go thru VOPs.
335  * 'last' parameter is unused and left in for IRIX compatibility
336  */
337 #define VOP_TOSS_PAGES(vp, first, last, fiopt)                          \
338         _VOP_(vop_tosspages, vp)((vp)->v_fbhv,first, last, fiopt)
339 /*
340  * 'last' parameter is unused and left in for IRIX compatibility
341  */
342 #define VOP_FLUSHINVAL_PAGES(vp, first, last, fiopt)                    \
343         _VOP_(vop_flushinval_pages, vp)((vp)->v_fbhv,first,last,fiopt)
344 /*
345  * 'last' parameter is unused and left in for IRIX compatibility
346  */
347 #define VOP_FLUSH_PAGES(vp, first, last, flags, fiopt, rv)              \
348         rv = _VOP_(vop_flush_pages, vp)((vp)->v_fbhv,first,last,flags,fiopt)
349 #define VOP_IOCTL(vp, inode, filp, fl, cmd, arg, rv)                    \
350         rv = _VOP_(vop_ioctl, vp)((vp)->v_fbhv,inode,filp,fl,cmd,arg)
351 #define VOP_IFLUSH(vp, flags, rv)                                       \
352         rv = _VOP_(vop_iflush, vp)((vp)->v_fbhv, flags)
353
354 /*
355  * Flags for read/write calls - same values as IRIX
356  */
357 #define IO_ISAIO        0x00001         /* don't wait for completion */
358 #define IO_ISDIRECT     0x00004         /* bypass page cache */
359 #define IO_INVIS        0x00020         /* don't update inode timestamps */
360
361 /*
362  * Flags for VOP_IFLUSH call
363  */
364 #define FLUSH_SYNC              1       /* wait for flush to complete   */
365 #define FLUSH_INODE             2       /* flush the inode itself       */
366 #define FLUSH_LOG               4       /* force the last log entry for
367                                          * this inode out to disk       */
368
369 /*
370  * Flush/Invalidate options for VOP_TOSS_PAGES, VOP_FLUSHINVAL_PAGES and
371  *      VOP_FLUSH_PAGES.
372  */
373 #define FI_NONE                 0       /* none */
374 #define FI_REMAPF               1       /* Do a remapf prior to the operation */
375 #define FI_REMAPF_LOCKED        2       /* Do a remapf prior to the operation.
376                                            Prevent VM access to the pages until
377                                            the operation completes. */
378
379 /*
380  * Vnode attributes.  va_mask indicates those attributes the caller
381  * wants to set or extract.
382  */
383 typedef struct vattr {
384         int             va_mask;        /* bit-mask of attributes present */
385         mode_t          va_mode;        /* file access mode and type */
386         xfs_nlink_t     va_nlink;       /* number of references to file */
387         uid_t           va_uid;         /* owner user id */
388         gid_t           va_gid;         /* owner group id */
389         xid_t           va_xid;         /* owner group id */
390         xfs_ino_t       va_nodeid;      /* file id */
391         xfs_off_t       va_size;        /* file size in bytes */
392         u_long          va_blocksize;   /* blocksize preferred for i/o */
393         struct timespec va_atime;       /* time of last access */
394         struct timespec va_mtime;       /* time of last modification */
395         struct timespec va_ctime;       /* time file changed */
396         u_int           va_gen;         /* generation number of file */
397         xfs_dev_t       va_rdev;        /* device the special file represents */
398         __int64_t       va_nblocks;     /* number of blocks allocated */
399         u_long          va_xflags;      /* random extended file flags */
400         u_long          va_extsize;     /* file extent size */
401         u_long          va_nextents;    /* number of extents in file */
402         u_long          va_anextents;   /* number of attr extents in file */
403         prid_t          va_projid;      /* project id */
404 } vattr_t;
405
406 /*
407  * setattr or getattr attributes
408  */
409 #define XFS_AT_TYPE             0x00000001
410 #define XFS_AT_MODE             0x00000002
411 #define XFS_AT_UID              0x00000004
412 #define XFS_AT_GID              0x00000008
413 #define XFS_AT_FSID             0x00000010
414 #define XFS_AT_NODEID           0x00000020
415 #define XFS_AT_NLINK            0x00000040
416 #define XFS_AT_SIZE             0x00000080
417 #define XFS_AT_ATIME            0x00000100
418 #define XFS_AT_MTIME            0x00000200
419 #define XFS_AT_CTIME            0x00000400
420 #define XFS_AT_RDEV             0x00000800
421 #define XFS_AT_BLKSIZE          0x00001000
422 #define XFS_AT_NBLOCKS          0x00002000
423 #define XFS_AT_VCODE            0x00004000
424 #define XFS_AT_MAC              0x00008000
425 #define XFS_AT_UPDATIME         0x00010000
426 #define XFS_AT_UPDMTIME         0x00020000
427 #define XFS_AT_UPDCTIME         0x00040000
428 #define XFS_AT_ACL              0x00080000
429 #define XFS_AT_CAP              0x00100000
430 #define XFS_AT_INF              0x00200000
431 #define XFS_AT_XFLAGS           0x00400000
432 #define XFS_AT_EXTSIZE          0x00800000
433 #define XFS_AT_NEXTENTS         0x01000000
434 #define XFS_AT_ANEXTENTS        0x02000000
435 #define XFS_AT_PROJID           0x04000000
436 #define XFS_AT_SIZE_NOPERM      0x08000000
437 #define XFS_AT_GENCOUNT         0x10000000
438 #define XFS_AT_XID              0x20000000
439
440 #define XFS_AT_ALL      (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
441                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
442                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
443                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|XFS_AT_MAC|\
444                 XFS_AT_ACL|XFS_AT_CAP|XFS_AT_INF|XFS_AT_XFLAGS|XFS_AT_EXTSIZE|\
445                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_PROJID|XFS_AT_GENCOUNT\
446                 XFS_AT_XID)
447
448 #define XFS_AT_STAT     (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
449                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
450                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
451                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_PROJID)
452
453 #define XFS_AT_TIMES    (XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME)
454
455 #define XFS_AT_UPDTIMES (XFS_AT_UPDATIME|XFS_AT_UPDMTIME|XFS_AT_UPDCTIME)
456
457 #define XFS_AT_NOSET    (XFS_AT_NLINK|XFS_AT_RDEV|XFS_AT_FSID|XFS_AT_NODEID|\
458                 XFS_AT_TYPE|XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|\
459                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_GENCOUNT)
460
461 /*
462  *  Modes.
463  */
464 #define VSUID   S_ISUID         /* set user id on execution */
465 #define VSGID   S_ISGID         /* set group id on execution */
466 #define VSVTX   S_ISVTX         /* save swapped text even after use */
467 #define VREAD   S_IRUSR         /* read, write, execute permissions */
468 #define VWRITE  S_IWUSR
469 #define VEXEC   S_IXUSR
470
471 #define MODEMASK S_IALLUGO      /* mode bits plus permission bits */
472
473 /*
474  * Check whether mandatory file locking is enabled.
475  */
476 #define MANDLOCK(vp, mode)      \
477         (VN_ISREG(vp) && ((mode) & (VSGID|(VEXEC>>3))) == VSGID)
478
479 extern void     vn_init(void);
480 extern vnode_t  *vn_initialize(struct inode *);
481
482 /*
483  * vnode_map structures _must_ match vn_epoch and vnode structure sizes.
484  */
485 typedef struct vnode_map {
486         vfs_t           *v_vfsp;
487         vnumber_t       v_number;               /* in-core vnode number */
488         xfs_ino_t       v_ino;                  /* inode #      */
489 } vmap_t;
490
491 #define VMAP(vp, vmap)  {(vmap).v_vfsp   = (vp)->v_vfsp,        \
492                          (vmap).v_number = (vp)->v_number,      \
493                          (vmap).v_ino    = (vp)->v_inode.i_ino; }
494
495 extern int      vn_revalidate(struct vnode *);
496 extern void     vn_revalidate_core(struct vnode *, vattr_t *);
497
498 extern void     vn_iowait(struct vnode *vp);
499 extern void     vn_iowake(struct vnode *vp);
500
501 static inline int vn_count(struct vnode *vp)
502 {
503         return atomic_read(&LINVFS_GET_IP(vp)->i_count);
504 }
505
506 /*
507  * Vnode reference counting functions (and macros for compatibility).
508  */
509 extern vnode_t  *vn_hold(struct vnode *);
510
511 #if defined(XFS_VNODE_TRACE)
512 #define VN_HOLD(vp)             \
513         ((void)vn_hold(vp),     \
514           vn_trace_hold(vp, __FILE__, __LINE__, (inst_t *)__return_address))
515 #define VN_RELE(vp)             \
516           (vn_trace_rele(vp, __FILE__, __LINE__, (inst_t *)__return_address), \
517            iput(LINVFS_GET_IP(vp)))
518 #else
519 #define VN_HOLD(vp)             ((void)vn_hold(vp))
520 #define VN_RELE(vp)             (iput(LINVFS_GET_IP(vp)))
521 #endif
522
523 static inline struct vnode *vn_grab(struct vnode *vp)
524 {
525         struct inode *inode = igrab(LINVFS_GET_IP(vp));
526         return inode ? LINVFS_GET_VP(inode) : NULL;
527 }
528
529 /*
530  * Vname handling macros.
531  */
532 #define VNAME(dentry)           ((char *) (dentry)->d_name.name)
533 #define VNAMELEN(dentry)        ((dentry)->d_name.len)
534 #define VNAME_TO_VNODE(dentry)  (LINVFS_GET_VP((dentry)->d_inode))
535
536 /*
537  * Vnode spinlock manipulation.
538  */
539 #define VN_LOCK(vp)             mutex_spinlock(&(vp)->v_lock)
540 #define VN_UNLOCK(vp, s)        mutex_spinunlock(&(vp)->v_lock, s)
541 #define VN_FLAGSET(vp,b)        vn_flagset(vp,b)
542 #define VN_FLAGCLR(vp,b)        vn_flagclr(vp,b)
543
544 static __inline__ void vn_flagset(struct vnode *vp, uint flag)
545 {
546         spin_lock(&vp->v_lock);
547         vp->v_flag |= flag;
548         spin_unlock(&vp->v_lock);
549 }
550
551 static __inline__ void vn_flagclr(struct vnode *vp, uint flag)
552 {
553         spin_lock(&vp->v_lock);
554         vp->v_flag &= ~flag;
555         spin_unlock(&vp->v_lock);
556 }
557
558 /*
559  * Dealing with bad inodes
560  */
561 static inline void vn_mark_bad(struct vnode *vp)
562 {
563         make_bad_inode(LINVFS_GET_IP(vp));
564 }
565
566 static inline int VN_BAD(struct vnode *vp)
567 {
568         return is_bad_inode(LINVFS_GET_IP(vp));
569 }
570
571 /*
572  * Extracting atime values in various formats
573  */
574 static inline void vn_atime_to_bstime(struct vnode *vp, xfs_bstime_t *bs_atime)
575 {
576         bs_atime->tv_sec = vp->v_inode.i_atime.tv_sec;
577         bs_atime->tv_nsec = vp->v_inode.i_atime.tv_nsec;
578 }
579
580 static inline void vn_atime_to_timespec(struct vnode *vp, struct timespec *ts)
581 {
582         *ts = vp->v_inode.i_atime;
583 }
584
585 static inline void vn_atime_to_time_t(struct vnode *vp, time_t *tt)
586 {
587         *tt = vp->v_inode.i_atime.tv_sec;
588 }
589
590 /*
591  * Some useful predicates.
592  */
593 #define VN_MAPPED(vp)   mapping_mapped(LINVFS_GET_IP(vp)->i_mapping)
594 #define VN_CACHED(vp)   (LINVFS_GET_IP(vp)->i_mapping->nrpages)
595 #define VN_DIRTY(vp)    mapping_tagged(LINVFS_GET_IP(vp)->i_mapping, \
596                                         PAGECACHE_TAG_DIRTY)
597 #define VMODIFY(vp)     VN_FLAGSET(vp, VMODIFIED)
598 #define VUNMODIFY(vp)   VN_FLAGCLR(vp, VMODIFIED)
599
600 /*
601  * Flags to VOP_SETATTR/VOP_GETATTR.
602  */
603 #define ATTR_UTIME      0x01    /* non-default utime(2) request */
604 #define ATTR_DMI        0x08    /* invocation from a DMI function */
605 #define ATTR_LAZY       0x80    /* set/get attributes lazily */
606 #define ATTR_NONBLOCK   0x100   /* return EAGAIN if operation would block */
607 #define ATTR_NOLOCK     0x200   /* Don't grab any conflicting locks */
608 #define ATTR_NOSIZETOK  0x400   /* Don't get the SIZE token */
609
610 /*
611  * Flags to VOP_FSYNC and VOP_RECLAIM.
612  */
613 #define FSYNC_NOWAIT    0       /* asynchronous flush */
614 #define FSYNC_WAIT      0x1     /* synchronous fsync or forced reclaim */
615 #define FSYNC_INVAL     0x2     /* flush and invalidate cached data */
616 #define FSYNC_DATA      0x4     /* synchronous fsync of data only */
617
618 /*
619  * Tracking vnode activity.
620  */
621 #if defined(XFS_VNODE_TRACE)
622
623 #define VNODE_TRACE_SIZE        16              /* number of trace entries */
624 #define VNODE_KTRACE_ENTRY      1
625 #define VNODE_KTRACE_EXIT       2
626 #define VNODE_KTRACE_HOLD       3
627 #define VNODE_KTRACE_REF        4
628 #define VNODE_KTRACE_RELE       5
629
630 extern void vn_trace_entry(struct vnode *, const char *, inst_t *);
631 extern void vn_trace_exit(struct vnode *, const char *, inst_t *);
632 extern void vn_trace_hold(struct vnode *, char *, int, inst_t *);
633 extern void vn_trace_ref(struct vnode *, char *, int, inst_t *);
634 extern void vn_trace_rele(struct vnode *, char *, int, inst_t *);
635
636 #define VN_TRACE(vp)            \
637         vn_trace_ref(vp, __FILE__, __LINE__, (inst_t *)__return_address)
638 #else
639 #define vn_trace_entry(a,b,c)
640 #define vn_trace_exit(a,b,c)
641 #define vn_trace_hold(a,b,c,d)
642 #define vn_trace_ref(a,b,c,d)
643 #define vn_trace_rele(a,b,c,d)
644 #define VN_TRACE(vp)
645 #endif
646
647 #endif  /* __XFS_VNODE_H__ */