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 static inline struct vnode *vn_from_inode(struct inode *inode)
 120 {
 121         return (vnode_t *)list_entry(inode, vnode_t, v_inode);
 122 }
 123 static inline struct inode *vn_to_inode(struct vnode *vnode)
 124 {
 125         return &vnode->v_inode;
 126 }
 127
 128 /*
 129  * Vnode flags.
 130  */
 131 #define VMODIFIED              0x8      /* XFS inode state possibly differs */
 132                                         /* to the Linux inode state.    */
 133
 134 /*
 135  * Values for the VOP_RWLOCK and VOP_RWUNLOCK flags parameter.
 136  */
 137 typedef enum vrwlock {
 138         VRWLOCK_NONE,
 139         VRWLOCK_READ,
 140         VRWLOCK_WRITE,
 141         VRWLOCK_WRITE_DIRECT,
 142         VRWLOCK_TRY_READ,
 143         VRWLOCK_TRY_WRITE
 144 } vrwlock_t;
 145
 146 /*
 147  * Return values for VOP_INACTIVE.  A return value of
 148  * VN_INACTIVE_NOCACHE implies that the file system behavior
 149  * has disassociated its state and bhv_desc_t from the vnode.
 150  */
 151 #define VN_INACTIVE_CACHE       0
 152 #define VN_INACTIVE_NOCACHE     1
 153
 154 /*
 155  * Values for the cmd code given to VOP_VNODE_CHANGE.
 156  */
 157 typedef enum vchange {
 158         VCHANGE_FLAGS_FRLOCKS           = 0,
 159         VCHANGE_FLAGS_ENF_LOCKING       = 1,
 160         VCHANGE_FLAGS_TRUNCATED         = 2,
 161         VCHANGE_FLAGS_PAGE_DIRTY        = 3,
 162         VCHANGE_FLAGS_IOEXCL_COUNT      = 4
 163 } vchange_t;
 164
 165
 166 typedef int     (*vop_open_t)(bhv_desc_t *, struct cred *);
 167 typedef ssize_t (*vop_read_t)(bhv_desc_t *, struct kiocb *,
 168                                 const struct iovec *, unsigned int,
 169                                 loff_t *, int, struct cred *);
 170 typedef ssize_t (*vop_write_t)(bhv_desc_t *, struct kiocb *,
 171                                 const struct iovec *, unsigned int,
 172                                 loff_t *, int, struct cred *);
 173 typedef ssize_t (*vop_sendfile_t)(bhv_desc_t *, struct file *,
 174                                 loff_t *, int, size_t, read_actor_t,
 175                                 void *, struct cred *);
 176 typedef ssize_t (*vop_splice_read_t)(bhv_desc_t *, struct file *, loff_t *,
 177                                 struct pipe_inode_info *, size_t, int, int,
 178                                 struct cred *);
 179 typedef ssize_t (*vop_splice_write_t)(bhv_desc_t *, struct pipe_inode_info *,
 180                                 struct file *, loff_t *, size_t, int, int,
 181                                 struct cred *);
 182 typedef int     (*vop_ioctl_t)(bhv_desc_t *, struct inode *, struct file *,
 183                                 int, unsigned int, void __user *);
 184 typedef int     (*vop_getattr_t)(bhv_desc_t *, struct vattr *, int,
 185                                 struct cred *);
 186 typedef int     (*vop_setattr_t)(bhv_desc_t *, struct vattr *, int,
 187                                 struct cred *);
 188 typedef int     (*vop_access_t)(bhv_desc_t *, int, struct cred *);
 189 typedef int     (*vop_lookup_t)(bhv_desc_t *, vname_t *, vnode_t **,
 190                                 int, vnode_t *, struct cred *);
 191 typedef int     (*vop_create_t)(bhv_desc_t *, vname_t *, struct vattr *,
 192                                 vnode_t **, struct cred *);
 193 typedef int     (*vop_remove_t)(bhv_desc_t *, vname_t *, struct cred *);
 194 typedef int     (*vop_link_t)(bhv_desc_t *, vnode_t *, vname_t *,
 195                                 struct cred *);
 196 typedef int     (*vop_rename_t)(bhv_desc_t *, vname_t *, vnode_t *, vname_t *,
 197                                 struct cred *);
 198 typedef int     (*vop_mkdir_t)(bhv_desc_t *, vname_t *, struct vattr *,
 199                                 vnode_t **, struct cred *);
 200 typedef int     (*vop_rmdir_t)(bhv_desc_t *, vname_t *, struct cred *);
 201 typedef int     (*vop_readdir_t)(bhv_desc_t *, struct uio *, struct cred *,
 202                                 int *);
 203 typedef int     (*vop_symlink_t)(bhv_desc_t *, vname_t *, struct vattr *,
 204                                 char *, vnode_t **, struct cred *);
 205 typedef int     (*vop_readlink_t)(bhv_desc_t *, struct uio *, int,
 206                                 struct cred *);
 207 typedef int     (*vop_fsync_t)(bhv_desc_t *, int, struct cred *,
 208                                 xfs_off_t, xfs_off_t);
 209 typedef int     (*vop_inactive_t)(bhv_desc_t *, struct cred *);
 210 typedef int     (*vop_fid2_t)(bhv_desc_t *, struct fid *);
 211 typedef int     (*vop_release_t)(bhv_desc_t *);
 212 typedef int     (*vop_rwlock_t)(bhv_desc_t *, vrwlock_t);
 213 typedef void    (*vop_rwunlock_t)(bhv_desc_t *, vrwlock_t);
 214 typedef int     (*vop_bmap_t)(bhv_desc_t *, xfs_off_t, ssize_t, int,
 215                                 struct xfs_iomap *, int *);
 216 typedef int     (*vop_reclaim_t)(bhv_desc_t *);
 217 typedef int     (*vop_attr_get_t)(bhv_desc_t *, const char *, char *, int *,
 218                                 int, struct cred *);
 219 typedef int     (*vop_attr_set_t)(bhv_desc_t *, const char *, char *, int,
 220                                 int, struct cred *);
 221 typedef int     (*vop_attr_remove_t)(bhv_desc_t *, const char *,
 222                                 int, struct cred *);
 223 typedef int     (*vop_attr_list_t)(bhv_desc_t *, char *, int, int,
 224                                 struct attrlist_cursor_kern *, struct cred *);
 225 typedef void    (*vop_link_removed_t)(bhv_desc_t *, vnode_t *, int);
 226 typedef void    (*vop_vnode_change_t)(bhv_desc_t *, vchange_t, __psint_t);
 227 typedef void    (*vop_ptossvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t, int);
 228 typedef void    (*vop_pflushinvalvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t, int);
 229 typedef int     (*vop_pflushvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t,
 230                                 uint64_t, int);
 231 typedef int     (*vop_iflush_t)(bhv_desc_t *, int);
 232
 233
 234 typedef struct vnodeops {
 235         bhv_position_t  vn_position;    /* position within behavior chain */
 236         vop_open_t              vop_open;
 237         vop_read_t              vop_read;
 238         vop_write_t             vop_write;
 239         vop_sendfile_t          vop_sendfile;
 240         vop_splice_read_t       vop_splice_read;
 241         vop_splice_write_t      vop_splice_write;
 242         vop_ioctl_t             vop_ioctl;
 243         vop_getattr_t           vop_getattr;
 244         vop_setattr_t           vop_setattr;
 245         vop_access_t            vop_access;
 246         vop_lookup_t            vop_lookup;
 247         vop_create_t            vop_create;
 248         vop_remove_t            vop_remove;
 249         vop_link_t              vop_link;
 250         vop_rename_t            vop_rename;
 251         vop_mkdir_t             vop_mkdir;
 252         vop_rmdir_t             vop_rmdir;
 253         vop_readdir_t           vop_readdir;
 254         vop_symlink_t           vop_symlink;
 255         vop_readlink_t          vop_readlink;
 256         vop_fsync_t             vop_fsync;
 257         vop_inactive_t          vop_inactive;
 258         vop_fid2_t              vop_fid2;
 259         vop_rwlock_t            vop_rwlock;
 260         vop_rwunlock_t          vop_rwunlock;
 261         vop_bmap_t              vop_bmap;
 262         vop_reclaim_t           vop_reclaim;
 263         vop_attr_get_t          vop_attr_get;
 264         vop_attr_set_t          vop_attr_set;
 265         vop_attr_remove_t       vop_attr_remove;
 266         vop_attr_list_t         vop_attr_list;
 267         vop_link_removed_t      vop_link_removed;
 268         vop_vnode_change_t      vop_vnode_change;
 269         vop_ptossvp_t           vop_tosspages;
 270         vop_pflushinvalvp_t     vop_flushinval_pages;
 271         vop_pflushvp_t          vop_flush_pages;
 272         vop_release_t           vop_release;
 273         vop_iflush_t            vop_iflush;
 274 } vnodeops_t;
 275
 276 /*
 277  * VOP's.
 278  */
 279 #define _VOP_(op, vp)   (*((vnodeops_t *)(vp)->v_fops)->op)
 280
 281 #define VOP_READ(vp,file,iov,segs,offset,ioflags,cr,rv)                 \
 282         rv = _VOP_(vop_read, vp)((vp)->v_fbhv,file,iov,segs,offset,ioflags,cr)
 283 #define VOP_WRITE(vp,file,iov,segs,offset,ioflags,cr,rv)                \
 284         rv = _VOP_(vop_write, vp)((vp)->v_fbhv,file,iov,segs,offset,ioflags,cr)
 285 #define VOP_SENDFILE(vp,f,off,ioflags,cnt,act,targ,cr,rv)               \
 286         rv = _VOP_(vop_sendfile, vp)((vp)->v_fbhv,f,off,ioflags,cnt,act,targ,cr)
 287 #define VOP_SPLICE_READ(vp,f,o,pipe,cnt,fl,iofl,cr,rv)                  \
 288         rv = _VOP_(vop_splice_read, vp)((vp)->v_fbhv,f,o,pipe,cnt,fl,iofl,cr)
 289 #define VOP_SPLICE_WRITE(vp,f,o,pipe,cnt,fl,iofl,cr,rv)                 \
 290         rv = _VOP_(vop_splice_write, vp)((vp)->v_fbhv,f,o,pipe,cnt,fl,iofl,cr)
 291 #define VOP_BMAP(vp,of,sz,rw,b,n,rv)                                    \
 292         rv = _VOP_(vop_bmap, vp)((vp)->v_fbhv,of,sz,rw,b,n)
 293 #define VOP_OPEN(vp, cr, rv)                                            \
 294         rv = _VOP_(vop_open, vp)((vp)->v_fbhv, cr)
 295 #define VOP_GETATTR(vp, vap, f, cr, rv)                                 \
 296         rv = _VOP_(vop_getattr, vp)((vp)->v_fbhv, vap, f, cr)
 297 #define VOP_SETATTR(vp, vap, f, cr, rv)                                 \
 298         rv = _VOP_(vop_setattr, vp)((vp)->v_fbhv, vap, f, cr)
 299 #define VOP_ACCESS(vp, mode, cr, rv)                                    \
 300         rv = _VOP_(vop_access, vp)((vp)->v_fbhv, mode, cr)
 301 #define VOP_LOOKUP(vp,d,vpp,f,rdir,cr,rv)                               \
 302         rv = _VOP_(vop_lookup, vp)((vp)->v_fbhv,d,vpp,f,rdir,cr)
 303 #define VOP_CREATE(dvp,d,vap,vpp,cr,rv)                                 \
 304         rv = _VOP_(vop_create, dvp)((dvp)->v_fbhv,d,vap,vpp,cr)
 305 #define VOP_REMOVE(dvp,d,cr,rv)                                         \
 306         rv = _VOP_(vop_remove, dvp)((dvp)->v_fbhv,d,cr)
 307 #define VOP_LINK(tdvp,fvp,d,cr,rv)                                      \
 308         rv = _VOP_(vop_link, tdvp)((tdvp)->v_fbhv,fvp,d,cr)
 309 #define VOP_RENAME(fvp,fnm,tdvp,tnm,cr,rv)                              \
 310         rv = _VOP_(vop_rename, fvp)((fvp)->v_fbhv,fnm,tdvp,tnm,cr)
 311 #define VOP_MKDIR(dp,d,vap,vpp,cr,rv)                                   \
 312         rv = _VOP_(vop_mkdir, dp)((dp)->v_fbhv,d,vap,vpp,cr)
 313 #define VOP_RMDIR(dp,d,cr,rv)                                           \
 314         rv = _VOP_(vop_rmdir, dp)((dp)->v_fbhv,d,cr)
 315 #define VOP_READDIR(vp,uiop,cr,eofp,rv)                                 \
 316         rv = _VOP_(vop_readdir, vp)((vp)->v_fbhv,uiop,cr,eofp)
 317 #define VOP_SYMLINK(dvp,d,vap,tnm,vpp,cr,rv)                            \
 318         rv = _VOP_(vop_symlink, dvp) ((dvp)->v_fbhv,d,vap,tnm,vpp,cr)
 319 #define VOP_READLINK(vp,uiop,fl,cr,rv)                                  \
 320         rv = _VOP_(vop_readlink, vp)((vp)->v_fbhv,uiop,fl,cr)
 321 #define VOP_FSYNC(vp,f,cr,b,e,rv)                                       \
 322         rv = _VOP_(vop_fsync, vp)((vp)->v_fbhv,f,cr,b,e)
 323 #define VOP_INACTIVE(vp, cr, rv)                                        \
 324         rv = _VOP_(vop_inactive, vp)((vp)->v_fbhv, cr)
 325 #define VOP_RELEASE(vp, rv)                                             \
 326         rv = _VOP_(vop_release, vp)((vp)->v_fbhv)
 327 #define VOP_FID2(vp, fidp, rv)                                          \
 328         rv = _VOP_(vop_fid2, vp)((vp)->v_fbhv, fidp)
 329 #define VOP_RWLOCK(vp,i)                                                \
 330         (void)_VOP_(vop_rwlock, vp)((vp)->v_fbhv, i)
 331 #define VOP_RWLOCK_TRY(vp,i)                                            \
 332         _VOP_(vop_rwlock, vp)((vp)->v_fbhv, i)
 333 #define VOP_RWUNLOCK(vp,i)                                              \
 334         (void)_VOP_(vop_rwunlock, vp)((vp)->v_fbhv, i)
 335 #define VOP_FRLOCK(vp,c,fl,flags,offset,fr,rv)                          \
 336         rv = _VOP_(vop_frlock, vp)((vp)->v_fbhv,c,fl,flags,offset,fr)
 337 #define VOP_RECLAIM(vp, rv)                                             \
 338         rv = _VOP_(vop_reclaim, vp)((vp)->v_fbhv)
 339 #define VOP_ATTR_GET(vp, name, val, vallenp, fl, cred, rv)              \
 340         rv = _VOP_(vop_attr_get, vp)((vp)->v_fbhv,name,val,vallenp,fl,cred)
 341 #define VOP_ATTR_SET(vp, name, val, vallen, fl, cred, rv)               \
 342         rv = _VOP_(vop_attr_set, vp)((vp)->v_fbhv,name,val,vallen,fl,cred)
 343 #define VOP_ATTR_REMOVE(vp, name, flags, cred, rv)                      \
 344         rv = _VOP_(vop_attr_remove, vp)((vp)->v_fbhv,name,flags,cred)
 345 #define VOP_ATTR_LIST(vp, buf, buflen, fl, cursor, cred, rv)            \
 346         rv = _VOP_(vop_attr_list, vp)((vp)->v_fbhv,buf,buflen,fl,cursor,cred)
 347 #define VOP_LINK_REMOVED(vp, dvp, linkzero)                             \
 348         (void)_VOP_(vop_link_removed, vp)((vp)->v_fbhv, dvp, linkzero)
 349 #define VOP_VNODE_CHANGE(vp, cmd, val)                                  \
 350         (void)_VOP_(vop_vnode_change, vp)((vp)->v_fbhv,cmd,val)
 351 /*
 352  * These are page cache functions that now go thru VOPs.
 353  * 'last' parameter is unused and left in for IRIX compatibility
 354  */
 355 #define VOP_TOSS_PAGES(vp, first, last, fiopt)                          \
 356         _VOP_(vop_tosspages, vp)((vp)->v_fbhv,first, last, fiopt)
 357 /*
 358  * 'last' parameter is unused and left in for IRIX compatibility
 359  */
 360 #define VOP_FLUSHINVAL_PAGES(vp, first, last, fiopt)                    \
 361         _VOP_(vop_flushinval_pages, vp)((vp)->v_fbhv,first,last,fiopt)
 362 /*
 363  * 'last' parameter is unused and left in for IRIX compatibility
 364  */
 365 #define VOP_FLUSH_PAGES(vp, first, last, flags, fiopt, rv)              \
 366         rv = _VOP_(vop_flush_pages, vp)((vp)->v_fbhv,first,last,flags,fiopt)
 367 #define VOP_IOCTL(vp, inode, filp, fl, cmd, arg, rv)                    \
 368         rv = _VOP_(vop_ioctl, vp)((vp)->v_fbhv,inode,filp,fl,cmd,arg)
 369 #define VOP_IFLUSH(vp, flags, rv)                                       \
 370         rv = _VOP_(vop_iflush, vp)((vp)->v_fbhv, flags)
 371
 372 /*
 373  * Flags for read/write calls - same values as IRIX
 374  */
 375 #define IO_ISAIO        0x00001         /* don't wait for completion */
 376 #define IO_ISDIRECT     0x00004         /* bypass page cache */
 377 #define IO_INVIS        0x00020         /* don't update inode timestamps */
 378
 379 /*
 380  * Flags for VOP_IFLUSH call
 381  */
 382 #define FLUSH_SYNC              1       /* wait for flush to complete   */
 383 #define FLUSH_INODE             2       /* flush the inode itself       */
 384 #define FLUSH_LOG               4       /* force the last log entry for
 385                                          * this inode out to disk       */
 386
 387 /*
 388  * Flush/Invalidate options for VOP_TOSS_PAGES, VOP_FLUSHINVAL_PAGES and
 389  *      VOP_FLUSH_PAGES.
 390  */
 391 #define FI_NONE                 0       /* none */
 392 #define FI_REMAPF               1       /* Do a remapf prior to the operation */
 393 #define FI_REMAPF_LOCKED        2       /* Do a remapf prior to the operation.
 394                                            Prevent VM access to the pages until
 395                                            the operation completes. */
 396
 397 /*
 398  * Vnode attributes.  va_mask indicates those attributes the caller
 399  * wants to set or extract.
 400  */
 401 typedef struct vattr {
 402         int             va_mask;        /* bit-mask of attributes present */
 403         mode_t          va_mode;        /* file access mode and type */
 404         xfs_nlink_t     va_nlink;       /* number of references to file */
 405         uid_t           va_uid;         /* owner user id */
 406         gid_t           va_gid;         /* owner group id */
 407         xfs_ino_t       va_nodeid;      /* file id */
 408         xfs_off_t       va_size;        /* file size in bytes */
 409         u_long          va_blocksize;   /* blocksize preferred for i/o */
 410         struct timespec va_atime;       /* time of last access */
 411         struct timespec va_mtime;       /* time of last modification */
 412         struct timespec va_ctime;       /* time file changed */
 413         u_int           va_gen;         /* generation number of file */
 414         xfs_dev_t       va_rdev;        /* device the special file represents */
 415         __int64_t       va_nblocks;     /* number of blocks allocated */
 416         u_long          va_xflags;      /* random extended file flags */
 417         u_long          va_extsize;     /* file extent size */
 418         u_long          va_nextents;    /* number of extents in file */
 419         u_long          va_anextents;   /* number of attr extents in file */
 420         prid_t          va_projid;      /* project id */
 421 } vattr_t;
 422
 423 /*
 424  * setattr or getattr attributes
 425  */
 426 #define XFS_AT_TYPE             0x00000001
 427 #define XFS_AT_MODE             0x00000002
 428 #define XFS_AT_UID              0x00000004
 429 #define XFS_AT_GID              0x00000008
 430 #define XFS_AT_FSID             0x00000010
 431 #define XFS_AT_NODEID           0x00000020
 432 #define XFS_AT_NLINK            0x00000040
 433 #define XFS_AT_SIZE             0x00000080
 434 #define XFS_AT_ATIME            0x00000100
 435 #define XFS_AT_MTIME            0x00000200
 436 #define XFS_AT_CTIME            0x00000400
 437 #define XFS_AT_RDEV             0x00000800
 438 #define XFS_AT_BLKSIZE          0x00001000
 439 #define XFS_AT_NBLOCKS          0x00002000
 440 #define XFS_AT_VCODE            0x00004000
 441 #define XFS_AT_MAC              0x00008000
 442 #define XFS_AT_UPDATIME         0x00010000
 443 #define XFS_AT_UPDMTIME         0x00020000
 444 #define XFS_AT_UPDCTIME         0x00040000
 445 #define XFS_AT_ACL              0x00080000
 446 #define XFS_AT_CAP              0x00100000
 447 #define XFS_AT_INF              0x00200000
 448 #define XFS_AT_XFLAGS           0x00400000
 449 #define XFS_AT_EXTSIZE          0x00800000
 450 #define XFS_AT_NEXTENTS         0x01000000
 451 #define XFS_AT_ANEXTENTS        0x02000000
 452 #define XFS_AT_PROJID           0x04000000
 453 #define XFS_AT_SIZE_NOPERM      0x08000000
 454 #define XFS_AT_GENCOUNT         0x10000000
 455
 456 #define XFS_AT_ALL      (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
 457                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
 458                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
 459                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|XFS_AT_MAC|\
 460                 XFS_AT_ACL|XFS_AT_CAP|XFS_AT_INF|XFS_AT_XFLAGS|XFS_AT_EXTSIZE|\
 461                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_PROJID|XFS_AT_GENCOUNT)
 462
 463 #define XFS_AT_STAT     (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
 464                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
 465                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
 466                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_PROJID)
 467
 468 #define XFS_AT_TIMES    (XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME)
 469
 470 #define XFS_AT_UPDTIMES (XFS_AT_UPDATIME|XFS_AT_UPDMTIME|XFS_AT_UPDCTIME)
 471
 472 #define XFS_AT_NOSET    (XFS_AT_NLINK|XFS_AT_RDEV|XFS_AT_FSID|XFS_AT_NODEID|\
 473                 XFS_AT_TYPE|XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|\
 474                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_GENCOUNT)
 475
 476 /*
 477  *  Modes.
 478  */
 479 #define VSUID   S_ISUID         /* set user id on execution */
 480 #define VSGID   S_ISGID         /* set group id on execution */
 481 #define VSVTX   S_ISVTX         /* save swapped text even after use */
 482 #define VREAD   S_IRUSR         /* read, write, execute permissions */
 483 #define VWRITE  S_IWUSR
 484 #define VEXEC   S_IXUSR
 485
 486 #define MODEMASK S_IALLUGO      /* mode bits plus permission bits */
 487
 488 /*
 489  * Check whether mandatory file locking is enabled.
 490  */
 491 #define MANDLOCK(vp, mode)      \
 492         (VN_ISREG(vp) && ((mode) & (VSGID|(VEXEC>>3))) == VSGID)
 493
 494 extern void     vn_init(void);
 495 extern vnode_t  *vn_initialize(struct inode *);
 496
 497 /*
 498  * vnode_map structures _must_ match vn_epoch and vnode structure sizes.
 499  */
 500 typedef struct vnode_map {
 501         vfs_t           *v_vfsp;
 502         vnumber_t       v_number;               /* in-core vnode number */
 503         xfs_ino_t       v_ino;                  /* inode #      */
 504 } vmap_t;
 505
 506 #define VMAP(vp, vmap)  {(vmap).v_vfsp   = (vp)->v_vfsp,        \
 507                          (vmap).v_number = (vp)->v_number,      \
 508                          (vmap).v_ino    = (vp)->v_inode.i_ino; }
 509
 510 extern int      vn_revalidate(struct vnode *);
 511 extern int      __vn_revalidate(struct vnode *, vattr_t *);
 512 extern void     vn_revalidate_core(struct vnode *, vattr_t *);
 513
 514 extern void     vn_iowait(struct vnode *vp);
 515 extern void     vn_iowake(struct vnode *vp);
 516
 517 static inline int vn_count(struct vnode *vp)
 518 {
 519         return atomic_read(&vn_to_inode(vp)->i_count);
 520 }
 521
 522 /*
 523  * Vnode reference counting functions (and macros for compatibility).
 524  */
 525 extern vnode_t  *vn_hold(struct vnode *);
 526
 527 #if defined(XFS_VNODE_TRACE)
 528 #define VN_HOLD(vp)             \
 529         ((void)vn_hold(vp),     \
 530           vn_trace_hold(vp, __FILE__, __LINE__, (inst_t *)__return_address))
 531 #define VN_RELE(vp)             \
 532           (vn_trace_rele(vp, __FILE__, __LINE__, (inst_t *)__return_address), \
 533            iput(vn_to_inode(vp)))
 534 #else
 535 #define VN_HOLD(vp)             ((void)vn_hold(vp))
 536 #define VN_RELE(vp)             (iput(vn_to_inode(vp)))
 537 #endif
 538
 539 static inline struct vnode *vn_grab(struct vnode *vp)
 540 {
 541         struct inode *inode = igrab(vn_to_inode(vp));
 542         return inode ? vn_from_inode(inode) : NULL;
 543 }
 544
 545 /*
 546  * Vname handling macros.
 547  */
 548 #define VNAME(dentry)           ((char *) (dentry)->d_name.name)
 549 #define VNAMELEN(dentry)        ((dentry)->d_name.len)
 550 #define VNAME_TO_VNODE(dentry)  (vn_from_inode((dentry)->d_inode))
 551
 552 /*
 553  * Vnode spinlock manipulation.
 554  */
 555 #define VN_LOCK(vp)             mutex_spinlock(&(vp)->v_lock)
 556 #define VN_UNLOCK(vp, s)        mutex_spinunlock(&(vp)->v_lock, s)
 557 #define VN_FLAGSET(vp,b)        vn_flagset(vp,b)
 558 #define VN_FLAGCLR(vp,b)        vn_flagclr(vp,b)
 559
 560 static __inline__ void vn_flagset(struct vnode *vp, uint flag)
 561 {
 562         spin_lock(&vp->v_lock);
 563         vp->v_flag |= flag;
 564         spin_unlock(&vp->v_lock);
 565 }
 566
 567 static __inline__ void vn_flagclr(struct vnode *vp, uint flag)
 568 {
 569         spin_lock(&vp->v_lock);
 570         vp->v_flag &= ~flag;
 571         spin_unlock(&vp->v_lock);
 572 }
 573
 574 /*
 575  * Dealing with bad inodes
 576  */
 577 static inline void vn_mark_bad(struct vnode *vp)
 578 {
 579         make_bad_inode(vn_to_inode(vp));
 580 }
 581
 582 static inline int VN_BAD(struct vnode *vp)
 583 {
 584         return is_bad_inode(vn_to_inode(vp));
 585 }
 586
 587 /*
 588  * Extracting atime values in various formats
 589  */
 590 static inline void vn_atime_to_bstime(struct vnode *vp, xfs_bstime_t *bs_atime)
 591 {
 592         bs_atime->tv_sec = vp->v_inode.i_atime.tv_sec;
 593         bs_atime->tv_nsec = vp->v_inode.i_atime.tv_nsec;
 594 }
 595
 596 static inline void vn_atime_to_timespec(struct vnode *vp, struct timespec *ts)
 597 {
 598         *ts = vp->v_inode.i_atime;
 599 }
 600
 601 static inline void vn_atime_to_time_t(struct vnode *vp, time_t *tt)
 602 {
 603         *tt = vp->v_inode.i_atime.tv_sec;
 604 }
 605
 606 /*
 607  * Some useful predicates.
 608  */
 609 #define VN_MAPPED(vp)   mapping_mapped(vn_to_inode(vp)->i_mapping)
 610 #define VN_CACHED(vp)   (vn_to_inode(vp)->i_mapping->nrpages)
 611 #define VN_DIRTY(vp)    mapping_tagged(vn_to_inode(vp)->i_mapping, \
 612                                         PAGECACHE_TAG_DIRTY)
 613 #define VMODIFY(vp)     VN_FLAGSET(vp, VMODIFIED)
 614 #define VUNMODIFY(vp)   VN_FLAGCLR(vp, VMODIFIED)
 615
 616 /*
 617  * Flags to VOP_SETATTR/VOP_GETATTR.
 618  */
 619 #define ATTR_UTIME      0x01    /* non-default utime(2) request */
 620 #define ATTR_DMI        0x08    /* invocation from a DMI function */
 621 #define ATTR_LAZY       0x80    /* set/get attributes lazily */
 622 #define ATTR_NONBLOCK   0x100   /* return EAGAIN if operation would block */
 623 #define ATTR_NOLOCK     0x200   /* Don't grab any conflicting locks */
 624 #define ATTR_NOSIZETOK  0x400   /* Don't get the SIZE token */
 625
 626 /*
 627  * Flags to VOP_FSYNC and VOP_RECLAIM.
 628  */
 629 #define FSYNC_NOWAIT    0       /* asynchronous flush */
 630 #define FSYNC_WAIT      0x1     /* synchronous fsync or forced reclaim */
 631 #define FSYNC_INVAL     0x2     /* flush and invalidate cached data */
 632 #define FSYNC_DATA      0x4     /* synchronous fsync of data only */
 633
 634 /*
 635  * Tracking vnode activity.
 636  */
 637 #if defined(XFS_VNODE_TRACE)
 638
 639 #define VNODE_TRACE_SIZE        16              /* number of trace entries */
 640 #define VNODE_KTRACE_ENTRY      1
 641 #define VNODE_KTRACE_EXIT       2
 642 #define VNODE_KTRACE_HOLD       3
 643 #define VNODE_KTRACE_REF        4
 644 #define VNODE_KTRACE_RELE       5
 645
 646 extern void vn_trace_entry(struct vnode *, const char *, inst_t *);
 647 extern void vn_trace_exit(struct vnode *, const char *, inst_t *);
 648 extern void vn_trace_hold(struct vnode *, char *, int, inst_t *);
 649 extern void vn_trace_ref(struct vnode *, char *, int, inst_t *);
 650 extern void vn_trace_rele(struct vnode *, char *, int, inst_t *);
 651
 652 #define VN_TRACE(vp)            \
 653         vn_trace_ref(vp, __FILE__, __LINE__, (inst_t *)__return_address)
 654 #else
 655 #define vn_trace_entry(a,b,c)
 656 #define vn_trace_exit(a,b,c)
 657 #define vn_trace_hold(a,b,c,d)
 658 #define vn_trace_ref(a,b,c,d)
 659 #define vn_trace_rele(a,b,c,d)
 660 #define VN_TRACE(vp)
 661 #endif
 662
 663 #endif  /* __XFS_VNODE_H__ */