fs/xfs/linux/xfs_vnode.h

   1 /*
   2  * Copyright (c) 2000-2002 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32 #ifndef __XFS_VNODE_H__
  33 #define __XFS_VNODE_H__
  34
  35 struct uio;
  36 struct file;
  37 struct vattr;
  38 struct page_buf_bmap_s;
  39 struct attrlist_cursor_kern;
  40
  41 /*
  42  * Vnode types (unrelated to on-disk inodes).  VNON means no type.
  43  */
  44 typedef enum vtype {
  45         VNON    = 0,
  46         VREG    = 1,
  47         VDIR    = 2,
  48         VBLK    = 3,
  49         VCHR    = 4,
  50         VLNK    = 5,
  51         VFIFO   = 6,
  52         VBAD    = 7,
  53         VSOCK   = 8
  54 } vtype_t;
  55
  56 typedef xfs_ino_t vnumber_t;
  57 typedef struct dentry vname_t;
  58 typedef bhv_head_t vn_bhv_head_t;
  59
  60 /*
  61  * MP locking protocols:
  62  *      v_flag, v_vfsp                          VN_LOCK/VN_UNLOCK
  63  *      v_type                                  read-only or fs-dependent
  64  */
  65 typedef struct vnode {
  66         __u32           v_flag;                 /* vnode flags (see below) */
  67         enum vtype      v_type;                 /* vnode type */
  68         struct vfs      *v_vfsp;                /* ptr to containing VFS */
  69         vnumber_t       v_number;               /* in-core vnode number */
  70         vn_bhv_head_t   v_bh;                   /* behavior head */
  71         spinlock_t      v_lock;                 /* VN_LOCK/VN_UNLOCK */
  72         struct inode    v_inode;                /* Linux inode */
  73 #ifdef CONFIG_XFS_VNODE_TRACING
  74         struct ktrace   *v_trace;               /* trace header structure    */
  75 #endif
  76 } vnode_t;
  77
  78 #define v_fbhv                  v_bh.bh_first          /* first behavior */
  79 #define v_fops                  v_bh.bh_first->bd_ops  /* first behavior ops */
  80
  81 #define VNODE_POSITION_BASE     BHV_POSITION_BASE       /* chain bottom */
  82 #define VNODE_POSITION_TOP      BHV_POSITION_TOP        /* chain top */
  83 #define VNODE_POSITION_INVALID  BHV_POSITION_INVALID    /* invalid pos. num */
  84
  85 typedef enum {
  86         VN_BHV_UNKNOWN,         /* not specified */
  87         VN_BHV_XFS,             /* xfs */
  88         VN_BHV_END              /* housekeeping end-of-range */
  89 } vn_bhv_t;
  90
  91 #define VNODE_POSITION_XFS      (VNODE_POSITION_BASE)
  92
  93 /*
  94  * Macros for dealing with the behavior descriptor inside of the vnode.
  95  */
  96 #define BHV_TO_VNODE(bdp)       ((vnode_t *)BHV_VOBJ(bdp))
  97 #define BHV_TO_VNODE_NULL(bdp)  ((vnode_t *)BHV_VOBJNULL(bdp))
  98
  99 #define VNODE_TO_FIRST_BHV(vp)          (BHV_HEAD_FIRST(&(vp)->v_bh))
 100 #define VN_BHV_HEAD(vp)                 ((bhv_head_t *)(&((vp)->v_bh)))
 101 #define VN_BHV_READ_LOCK(bhp)           BHV_READ_LOCK(bhp)
 102 #define VN_BHV_READ_UNLOCK(bhp)         BHV_READ_UNLOCK(bhp)
 103 #define VN_BHV_WRITE_LOCK(bhp)          BHV_WRITE_LOCK(bhp)
 104 #define VN_BHV_NOT_READ_LOCKED(bhp)     BHV_NOT_READ_LOCKED(bhp)
 105 #define VN_BHV_NOT_WRITE_LOCKED(bhp)    BHV_NOT_WRITE_LOCKED(bhp)
 106 #define vn_bhv_head_init(bhp,name)      bhv_head_init(bhp,name)
 107 #define vn_bhv_remove(bhp,bdp)          bhv_remove(bhp,bdp)
 108 #define vn_bhv_lookup(bhp,ops)          bhv_lookup(bhp,ops)
 109 #define vn_bhv_lookup_unlocked(bhp,ops) bhv_lookup_unlocked(bhp,ops)
 110
 111 /*
 112  * Vnode to Linux inode mapping.
 113  */
 114 #define LINVFS_GET_VP(inode)    ((vnode_t *)list_entry(inode, vnode_t, v_inode))
 115 #define LINVFS_GET_IP(vp)       (&(vp)->v_inode)
 116
 117 /*
 118  * Conversion between vnode types/modes and encoded type/mode as
 119  * seen by stat(2) and mknod(2).
 120  */
 121 extern enum vtype       iftovt_tab[];
 122 extern ushort           vttoif_tab[];
 123 #define IFTOVT(M)       (iftovt_tab[((M) & S_IFMT) >> 12])
 124 #define VTTOIF(T)       (vttoif_tab[(int)(T)])
 125 #define MAKEIMODE(T, M) (VTTOIF(T) | ((M) & ~S_IFMT))
 126
 127 /*
 128  * Vnode flags.
 129  */
 130 #define VINACT                 0x1      /* vnode is being inactivated   */
 131 #define VRECLM                 0x2      /* vnode is being reclaimed     */
 132 #define VWAIT                  0x4      /* waiting for VINACT/VRECLM to end */
 133 #define VMODIFIED              0x8      /* XFS inode state possibly differs */
 134                                         /* to the Linux inode state.    */
 135 #define VROOT             0x100000      /* root of its file system      */
 136 #define VNOSWAP           0x200000      /* cannot be used as virt swap device */
 137 #define VISSWAP           0x400000      /* vnode is part of virt swap device */
 138 #define VREPLICABLE       0x800000      /* Vnode can have replicated pages */
 139 #define VNONREPLICABLE   0x1000000      /* Vnode has writers. Don't replicate */
 140 #define VDOCMP           0x2000000      /* Vnode has special VOP_CMP impl. */
 141 #define VSHARE           0x4000000      /* vnode part of global cache   */
 142 #define VFRLOCKS         0x8000000      /* vnode has FR locks applied   */
 143 #define VENF_LOCKING    0x10000000      /* enf. mode FR locking in effect */
 144 #define VOPLOCK         0x20000000      /* oplock set on the vnode      */
 145
 146 typedef enum vrwlock    { VRWLOCK_NONE, VRWLOCK_READ,
 147                           VRWLOCK_WRITE, VRWLOCK_WRITE_DIRECT,
 148                           VRWLOCK_TRY_READ, VRWLOCK_TRY_WRITE } vrwlock_t;
 149
 150 /*
 151  * Return values for VOP_INACTIVE.  A return value of
 152  * VN_INACTIVE_NOCACHE implies that the file system behavior
 153  * has disassociated its state and bhv_desc_t from the vnode.
 154  */
 155 #define VN_INACTIVE_CACHE       0
 156 #define VN_INACTIVE_NOCACHE     1
 157
 158 /*
 159  * Values for the cmd code given to VOP_VNODE_CHANGE.
 160  */
 161 typedef enum vchange {
 162         VCHANGE_FLAGS_FRLOCKS           = 0,
 163         VCHANGE_FLAGS_ENF_LOCKING       = 1,
 164         VCHANGE_FLAGS_TRUNCATED         = 2,
 165         VCHANGE_FLAGS_PAGE_DIRTY        = 3,
 166         VCHANGE_FLAGS_IOEXCL_COUNT      = 4
 167 } vchange_t;
 168
 169
 170 typedef int     (*vop_open_t)(bhv_desc_t *, struct cred *);
 171 typedef ssize_t (*vop_read_t)(bhv_desc_t *, struct file *,
 172                                 const struct iovec *, unsigned long,
 173                                 loff_t *, struct cred *);
 174 typedef ssize_t (*vop_write_t)(bhv_desc_t *, struct file *,
 175                                 const struct iovec *, unsigned long,
 176                                 loff_t *, struct cred *);
 177 typedef ssize_t (*vop_sendfile_t)(bhv_desc_t *, struct file *,
 178                                 loff_t *, size_t, read_actor_t,
 179                                 void *, struct cred *);
 180 typedef int     (*vop_ioctl_t)(bhv_desc_t *, struct inode *, struct file *,
 181                                 unsigned int, unsigned long);
 182 typedef int     (*vop_getattr_t)(bhv_desc_t *, struct vattr *, int,
 183                                 struct cred *);
 184 typedef int     (*vop_setattr_t)(bhv_desc_t *, struct vattr *, int,
 185                                 struct cred *);
 186 typedef int     (*vop_access_t)(bhv_desc_t *, int, struct cred *);
 187 typedef int     (*vop_lookup_t)(bhv_desc_t *, vname_t *, vnode_t **,
 188                                 int, vnode_t *, struct cred *);
 189 typedef int     (*vop_create_t)(bhv_desc_t *, vname_t *, struct vattr *,
 190                                 vnode_t **, struct cred *);
 191 typedef int     (*vop_remove_t)(bhv_desc_t *, vname_t *, struct cred *);
 192 typedef int     (*vop_link_t)(bhv_desc_t *, vnode_t *, vname_t *,
 193                                 struct cred *);
 194 typedef int     (*vop_rename_t)(bhv_desc_t *, vname_t *, vnode_t *, vname_t *,
 195                                 struct cred *);
 196 typedef int     (*vop_mkdir_t)(bhv_desc_t *, vname_t *, struct vattr *,
 197                                 vnode_t **, struct cred *);
 198 typedef int     (*vop_rmdir_t)(bhv_desc_t *, vname_t *, struct cred *);
 199 typedef int     (*vop_readdir_t)(bhv_desc_t *, struct uio *, struct cred *,
 200                                 int *);
 201 typedef int     (*vop_symlink_t)(bhv_desc_t *, vname_t *, struct vattr *,
 202                                 char *, vnode_t **, struct cred *);
 203 typedef int     (*vop_readlink_t)(bhv_desc_t *, struct uio *, struct cred *);
 204 typedef int     (*vop_fsync_t)(bhv_desc_t *, int, struct cred *,
 205                                 xfs_off_t, xfs_off_t);
 206 typedef int     (*vop_inactive_t)(bhv_desc_t *, struct cred *);
 207 typedef int     (*vop_fid2_t)(bhv_desc_t *, struct fid *);
 208 typedef int     (*vop_release_t)(bhv_desc_t *);
 209 typedef int     (*vop_rwlock_t)(bhv_desc_t *, vrwlock_t);
 210 typedef void    (*vop_rwunlock_t)(bhv_desc_t *, vrwlock_t);
 211 typedef int     (*vop_bmap_t)(bhv_desc_t *, xfs_off_t, ssize_t, int,
 212                                 struct page_buf_bmap_s *, int *);
 213 typedef int     (*vop_reclaim_t)(bhv_desc_t *);
 214 typedef int     (*vop_attr_get_t)(bhv_desc_t *, char *, char *, int *, int,
 215                                 struct cred *);
 216 typedef int     (*vop_attr_set_t)(bhv_desc_t *, char *, char *, int, int,
 217                                 struct cred *);
 218 typedef int     (*vop_attr_remove_t)(bhv_desc_t *, char *, int, struct cred *);
 219 typedef int     (*vop_attr_list_t)(bhv_desc_t *, char *, int, int,
 220                                 struct attrlist_cursor_kern *, struct cred *);
 221 typedef void    (*vop_link_removed_t)(bhv_desc_t *, vnode_t *, int);
 222 typedef void    (*vop_vnode_change_t)(bhv_desc_t *, vchange_t, __psint_t);
 223 typedef void    (*vop_ptossvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t, int);
 224 typedef void    (*vop_pflushinvalvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t, int);
 225 typedef int     (*vop_pflushvp_t)(bhv_desc_t *, xfs_off_t, xfs_off_t,
 226                                 uint64_t, int);
 227 typedef int     (*vop_iflush_t)(bhv_desc_t *, int);
 228
 229
 230 typedef struct vnodeops {
 231         bhv_position_t  vn_position;    /* position within behavior chain */
 232         vop_open_t              vop_open;
 233         vop_read_t              vop_read;
 234         vop_write_t             vop_write;
 235         vop_sendfile_t          vop_sendfile;
 236         vop_ioctl_t             vop_ioctl;
 237         vop_getattr_t           vop_getattr;
 238         vop_setattr_t           vop_setattr;
 239         vop_access_t            vop_access;
 240         vop_lookup_t            vop_lookup;
 241         vop_create_t            vop_create;
 242         vop_remove_t            vop_remove;
 243         vop_link_t              vop_link;
 244         vop_rename_t            vop_rename;
 245         vop_mkdir_t             vop_mkdir;
 246         vop_rmdir_t             vop_rmdir;
 247         vop_readdir_t           vop_readdir;
 248         vop_symlink_t           vop_symlink;
 249         vop_readlink_t          vop_readlink;
 250         vop_fsync_t             vop_fsync;
 251         vop_inactive_t          vop_inactive;
 252         vop_fid2_t              vop_fid2;
 253         vop_rwlock_t            vop_rwlock;
 254         vop_rwunlock_t          vop_rwunlock;
 255         vop_bmap_t              vop_bmap;
 256         vop_reclaim_t           vop_reclaim;
 257         vop_attr_get_t          vop_attr_get;
 258         vop_attr_set_t          vop_attr_set;
 259         vop_attr_remove_t       vop_attr_remove;
 260         vop_attr_list_t         vop_attr_list;
 261         vop_link_removed_t      vop_link_removed;
 262         vop_vnode_change_t      vop_vnode_change;
 263         vop_ptossvp_t           vop_tosspages;
 264         vop_pflushinvalvp_t     vop_flushinval_pages;
 265         vop_pflushvp_t          vop_flush_pages;
 266         vop_release_t           vop_release;
 267         vop_iflush_t            vop_iflush;
 268 } vnodeops_t;
 269
 270 /*
 271  * VOP's.
 272  */
 273 #define _VOP_(op, vp)   (*((vnodeops_t *)(vp)->v_fops)->op)
 274
 275 #define VOP_READ(vp,file,iov,segs,offset,cr,rv)                         \
 276 {                                                                       \
 277         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 278         rv = _VOP_(vop_read, vp)((vp)->v_fbhv,file,iov,segs,offset,cr); \
 279         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 280 }
 281 #define VOP_WRITE(vp,file,iov,segs,offset,cr,rv)                        \
 282 {                                                                       \
 283         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 284         rv = _VOP_(vop_write, vp)((vp)->v_fbhv,file,iov,segs,offset,cr);\
 285         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 286 }
 287 #define VOP_SENDFILE(vp,f,of,cnt,act,targ,cr,rv)                        \
 288 {                                                                       \
 289         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 290         rv = _VOP_(vop_sendfile, vp)((vp)->v_fbhv,f,of,cnt,act,targ,cr);\
 291         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 292 }
 293 #define VOP_BMAP(vp,of,sz,rw,b,n,rv)                                    \
 294 {                                                                       \
 295         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 296         rv = _VOP_(vop_bmap, vp)((vp)->v_fbhv,of,sz,rw,b,n);            \
 297         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 298 }
 299 #define VOP_OPEN(vp, cr, rv)                                            \
 300 {                                                                       \
 301         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 302         rv = _VOP_(vop_open, vp)((vp)->v_fbhv, cr);                     \
 303         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 304 }
 305 #define VOP_GETATTR(vp, vap, f, cr, rv)                                 \
 306 {                                                                       \
 307         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 308         rv = _VOP_(vop_getattr, vp)((vp)->v_fbhv, vap, f, cr);          \
 309         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 310 }
 311 #define VOP_SETATTR(vp, vap, f, cr, rv)                                 \
 312 {                                                                       \
 313         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 314         rv = _VOP_(vop_setattr, vp)((vp)->v_fbhv, vap, f, cr);          \
 315         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 316 }
 317 #define VOP_ACCESS(vp, mode, cr, rv)                                    \
 318 {                                                                       \
 319         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 320         rv = _VOP_(vop_access, vp)((vp)->v_fbhv, mode, cr);             \
 321         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 322 }
 323 #define VOP_LOOKUP(vp,d,vpp,f,rdir,cr,rv)                               \
 324 {                                                                       \
 325         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 326         rv = _VOP_(vop_lookup, vp)((vp)->v_fbhv,d,vpp,f,rdir,cr);       \
 327         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 328 }
 329 #define VOP_CREATE(dvp,d,vap,vpp,cr,rv)                                 \
 330 {                                                                       \
 331         VN_BHV_READ_LOCK(&(dvp)->v_bh);                                 \
 332         rv = _VOP_(vop_create, dvp)((dvp)->v_fbhv,d,vap,vpp,cr);        \
 333         VN_BHV_READ_UNLOCK(&(dvp)->v_bh);                               \
 334 }
 335 #define VOP_REMOVE(dvp,d,cr,rv)                                         \
 336 {                                                                       \
 337         VN_BHV_READ_LOCK(&(dvp)->v_bh);                                 \
 338         rv = _VOP_(vop_remove, dvp)((dvp)->v_fbhv,d,cr);                \
 339         VN_BHV_READ_UNLOCK(&(dvp)->v_bh);                               \
 340 }
 341 #define VOP_LINK(tdvp,fvp,d,cr,rv)                                      \
 342 {                                                                       \
 343         VN_BHV_READ_LOCK(&(tdvp)->v_bh);                                \
 344         rv = _VOP_(vop_link, tdvp)((tdvp)->v_fbhv,fvp,d,cr);            \
 345         VN_BHV_READ_UNLOCK(&(tdvp)->v_bh);                              \
 346 }
 347 #define VOP_RENAME(fvp,fnm,tdvp,tnm,cr,rv)                              \
 348 {                                                                       \
 349         VN_BHV_READ_LOCK(&(fvp)->v_bh);                                 \
 350         rv = _VOP_(vop_rename, fvp)((fvp)->v_fbhv,fnm,tdvp,tnm,cr);     \
 351         VN_BHV_READ_UNLOCK(&(fvp)->v_bh);                               \
 352 }
 353 #define VOP_MKDIR(dp,d,vap,vpp,cr,rv)                                   \
 354 {                                                                       \
 355         VN_BHV_READ_LOCK(&(dp)->v_bh);                                  \
 356         rv = _VOP_(vop_mkdir, dp)((dp)->v_fbhv,d,vap,vpp,cr);           \
 357         VN_BHV_READ_UNLOCK(&(dp)->v_bh);                                \
 358 }
 359 #define VOP_RMDIR(dp,d,cr,rv)                                           \
 360 {                                                                       \
 361         VN_BHV_READ_LOCK(&(dp)->v_bh);                                  \
 362         rv = _VOP_(vop_rmdir, dp)((dp)->v_fbhv,d,cr);                   \
 363         VN_BHV_READ_UNLOCK(&(dp)->v_bh);                                \
 364 }
 365 #define VOP_READDIR(vp,uiop,cr,eofp,rv)                                 \
 366 {                                                                       \
 367         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 368         rv = _VOP_(vop_readdir, vp)((vp)->v_fbhv,uiop,cr,eofp);         \
 369         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 370 }
 371 #define VOP_SYMLINK(dvp,d,vap,tnm,vpp,cr,rv)                            \
 372 {                                                                       \
 373         VN_BHV_READ_LOCK(&(dvp)->v_bh);                                 \
 374         rv = _VOP_(vop_symlink, dvp) ((dvp)->v_fbhv,d,vap,tnm,vpp,cr); \
 375         VN_BHV_READ_UNLOCK(&(dvp)->v_bh);                               \
 376 }
 377 #define VOP_READLINK(vp,uiop,cr,rv)                                     \
 378 {                                                                       \
 379         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 380         rv = _VOP_(vop_readlink, vp)((vp)->v_fbhv,uiop,cr);             \
 381         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 382 }
 383 #define VOP_FSYNC(vp,f,cr,b,e,rv)                                       \
 384 {                                                                       \
 385         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 386         rv = _VOP_(vop_fsync, vp)((vp)->v_fbhv,f,cr,b,e);               \
 387         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 388 }
 389 #define VOP_INACTIVE(vp, cr, rv)                                        \
 390 {       /* vnode not reference-able, so no need to lock chain */        \
 391         rv = _VOP_(vop_inactive, vp)((vp)->v_fbhv, cr);                 \
 392 }
 393 #define VOP_RELEASE(vp, rv)                                             \
 394 {                                                                       \
 395         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 396         rv = _VOP_(vop_release, vp)((vp)->v_fbhv);                      \
 397         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 398 }
 399 #define VOP_FID2(vp, fidp, rv)                                          \
 400 {                                                                       \
 401         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 402         rv = _VOP_(vop_fid2, vp)((vp)->v_fbhv, fidp);                   \
 403         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 404 }
 405 #define VOP_RWLOCK(vp,i)                                                \
 406 {                                                                       \
 407         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 408         (void)_VOP_(vop_rwlock, vp)((vp)->v_fbhv, i);                   \
 409         /* "allow" is done by rwunlock */                               \
 410 }
 411 #define VOP_RWLOCK_TRY(vp,i)                                            \
 412         _VOP_(vop_rwlock, vp)((vp)->v_fbhv, i)
 413
 414 #define VOP_RWUNLOCK(vp,i)                                              \
 415 {       /* "prevent" was done by rwlock */                              \
 416         (void)_VOP_(vop_rwunlock, vp)((vp)->v_fbhv, i);                 \
 417         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 418 }
 419 #define VOP_RECLAIM(vp, rv)                                             \
 420 {       /* vnode not reference-able, so no need to lock chain */        \
 421         rv = _VOP_(vop_reclaim, vp)((vp)->v_fbhv);                      \
 422 }
 423 #define VOP_ATTR_GET(vp, name, val, vallenp, fl, cred, rv)              \
 424 {                                                                       \
 425         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 426         rv = _VOP_(vop_attr_get, vp)((vp)->v_fbhv,name,val,vallenp,fl,cred); \
 427         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 428 }
 429 #define VOP_ATTR_SET(vp, name, val, vallen, fl, cred, rv)               \
 430 {                                                                       \
 431         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 432         rv = _VOP_(vop_attr_set, vp)((vp)->v_fbhv,name,val,vallen,fl,cred); \
 433         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 434 }
 435 #define VOP_ATTR_REMOVE(vp, name, flags, cred, rv)                      \
 436 {                                                                       \
 437         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 438         rv = _VOP_(vop_attr_remove, vp)((vp)->v_fbhv,name,flags,cred);  \
 439         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 440 }
 441 #define VOP_ATTR_LIST(vp, buf, buflen, fl, cursor, cred, rv)            \
 442 {                                                                       \
 443         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 444         rv = _VOP_(vop_attr_list, vp)((vp)->v_fbhv,buf,buflen,fl,cursor,cred);\
 445         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 446 }
 447 #define VOP_LINK_REMOVED(vp, dvp, linkzero)                             \
 448 {                                                                       \
 449         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 450         (void)_VOP_(vop_link_removed, vp)((vp)->v_fbhv, dvp, linkzero); \
 451         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 452 }
 453 #define VOP_VNODE_CHANGE(vp, cmd, val)                                  \
 454 {                                                                       \
 455         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 456         (void)_VOP_(vop_vnode_change, vp)((vp)->v_fbhv,cmd,val);        \
 457         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 458 }
 459 /*
 460  * These are page cache functions that now go thru VOPs.
 461  * 'last' parameter is unused and left in for IRIX compatibility
 462  */
 463 #define VOP_TOSS_PAGES(vp, first, last, fiopt)                          \
 464 {                                                                       \
 465         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 466         _VOP_(vop_tosspages, vp)((vp)->v_fbhv,first, last, fiopt);      \
 467         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 468 }
 469 /*
 470  * 'last' parameter is unused and left in for IRIX compatibility
 471  */
 472 #define VOP_FLUSHINVAL_PAGES(vp, first, last, fiopt)                    \
 473 {                                                                       \
 474         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 475         _VOP_(vop_flushinval_pages, vp)((vp)->v_fbhv,first,last,fiopt); \
 476         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 477 }
 478 /*
 479  * 'last' parameter is unused and left in for IRIX compatibility
 480  */
 481 #define VOP_FLUSH_PAGES(vp, first, last, flags, fiopt, rv)              \
 482 {                                                                       \
 483         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 484         rv = _VOP_(vop_flush_pages, vp)((vp)->v_fbhv,first,last,flags,fiopt);\
 485         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 486 }
 487 #define VOP_IOCTL(vp, inode, filp, cmd, arg, rv)                        \
 488 {                                                                       \
 489         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 490         rv = _VOP_(vop_ioctl, vp)((vp)->v_fbhv,inode,filp,cmd,arg);     \
 491         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 492 }
 493 #define VOP_IFLUSH(vp, flags, rv)                                       \
 494 {                                                                       \
 495         VN_BHV_READ_LOCK(&(vp)->v_bh);                                  \
 496         rv = _VOP_(vop_iflush, vp)((vp)->v_fbhv, flags);                \
 497         VN_BHV_READ_UNLOCK(&(vp)->v_bh);                                \
 498 }
 499
 500 /*
 501  * Flags for VOP_IFLUSH call
 502  */
 503
 504 #define FLUSH_SYNC              1       /* wait for flush to complete   */
 505 #define FLUSH_INODE             2       /* flush the inode itself       */
 506 #define FLUSH_LOG               4       /* force the last log entry for
 507                                          * this inode out to disk       */
 508
 509 /*
 510  * Flush/Invalidate options for VOP_TOSS_PAGES, VOP_FLUSHINVAL_PAGES and
 511  *      VOP_FLUSH_PAGES.
 512  */
 513 #define FI_NONE                 0       /* none */
 514 #define FI_REMAPF               1       /* Do a remapf prior to the operation */
 515 #define FI_REMAPF_LOCKED        2       /* Do a remapf prior to the operation.
 516                                            Prevent VM access to the pages until
 517                                            the operation completes. */
 518
 519 /*
 520  * Vnode attributes.  va_mask indicates those attributes the caller
 521  * wants to set (setattr) or extract (getattr).
 522  */
 523 typedef struct vattr {
 524         int             va_mask;        /* bit-mask of attributes */
 525         vtype_t         va_type;        /* vnode type (for create) */
 526         mode_t          va_mode;        /* file access mode */
 527         uid_t           va_uid;         /* owner user id */
 528         gid_t           va_gid;         /* owner group id */
 529         xfs_dev_t       va_fsid;        /* file system id (dev for now) */
 530         xfs_ino_t       va_nodeid;      /* node id */
 531         nlink_t         va_nlink;       /* number of references to file */
 532         xfs_off_t       va_size;        /* file size in bytes */
 533         timespec_t      va_atime;       /* time of last access */
 534         timespec_t      va_mtime;       /* time of last modification */
 535         timespec_t      va_ctime;       /* time file ``created'' */
 536         xfs_dev_t       va_rdev;        /* device the file represents */
 537         u_long          va_blksize;     /* fundamental block size */
 538         __int64_t       va_nblocks;     /* # of blocks allocated */
 539         u_long          va_vcode;       /* version code */
 540         u_long          va_xflags;      /* random extended file flags */
 541         u_long          va_extsize;     /* file extent size */
 542         u_long          va_nextents;    /* number of extents in file */
 543         u_long          va_anextents;   /* number of attr extents in file */
 544         int             va_projid;      /* project id */
 545         u_int           va_gencount;    /* object generation count */
 546 } vattr_t;
 547
 548 /*
 549  * setattr or getattr attributes
 550  */
 551 #define XFS_AT_TYPE             0x00000001
 552 #define XFS_AT_MODE             0x00000002
 553 #define XFS_AT_UID              0x00000004
 554 #define XFS_AT_GID              0x00000008
 555 #define XFS_AT_FSID             0x00000010
 556 #define XFS_AT_NODEID           0x00000020
 557 #define XFS_AT_NLINK            0x00000040
 558 #define XFS_AT_SIZE             0x00000080
 559 #define XFS_AT_ATIME            0x00000100
 560 #define XFS_AT_MTIME            0x00000200
 561 #define XFS_AT_CTIME            0x00000400
 562 #define XFS_AT_RDEV             0x00000800
 563 #define XFS_AT_BLKSIZE          0x00001000
 564 #define XFS_AT_NBLOCKS          0x00002000
 565 #define XFS_AT_VCODE            0x00004000
 566 #define XFS_AT_MAC              0x00008000
 567 #define XFS_AT_UPDATIME         0x00010000
 568 #define XFS_AT_UPDMTIME         0x00020000
 569 #define XFS_AT_UPDCTIME         0x00040000
 570 #define XFS_AT_ACL              0x00080000
 571 #define XFS_AT_CAP              0x00100000
 572 #define XFS_AT_INF              0x00200000
 573 #define XFS_AT_XFLAGS           0x00400000
 574 #define XFS_AT_EXTSIZE          0x00800000
 575 #define XFS_AT_NEXTENTS         0x01000000
 576 #define XFS_AT_ANEXTENTS        0x02000000
 577 #define XFS_AT_PROJID           0x04000000
 578 #define XFS_AT_SIZE_NOPERM      0x08000000
 579 #define XFS_AT_GENCOUNT         0x10000000
 580
 581 #define XFS_AT_ALL      (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
 582                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
 583                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
 584                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|XFS_AT_MAC|\
 585                 XFS_AT_ACL|XFS_AT_CAP|XFS_AT_INF|XFS_AT_XFLAGS|XFS_AT_EXTSIZE|\
 586                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_PROJID|XFS_AT_GENCOUNT)
 587
 588 #define XFS_AT_STAT     (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
 589                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
 590                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
 591                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_PROJID)
 592
 593 #define XFS_AT_TIMES    (XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME)
 594
 595 #define XFS_AT_UPDTIMES (XFS_AT_UPDATIME|XFS_AT_UPDMTIME|XFS_AT_UPDCTIME)
 596
 597 #define XFS_AT_NOSET    (XFS_AT_NLINK|XFS_AT_RDEV|XFS_AT_FSID|XFS_AT_NODEID|\
 598                 XFS_AT_TYPE|XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|\
 599                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_GENCOUNT)
 600
 601 #define VREAD           00400
 602 #define VWRITE          00200
 603 #define VEXEC           00100
 604 #define VSGID           02000           /* set group id on execution */
 605 #define MODEMASK        07777           /* mode bits plus permission bits */
 606
 607 /*
 608  * Check whether mandatory file locking is enabled.
 609  */
 610 #define MANDLOCK(vp, mode)      \
 611         ((vp)->v_type == VREG && ((mode) & (VSGID|(VEXEC>>3))) == VSGID)
 612
 613 extern void     vn_init(void);
 614 extern int      vn_wait(struct vnode *);
 615 extern vnode_t  *vn_initialize(struct inode *);
 616
 617 /*
 618  * Acquiring and invalidating vnodes:
 619  *
 620  *      if (vn_get(vp, version, 0))
 621  *              ...;
 622  *      vn_purge(vp, version);
 623  *
 624  * vn_get and vn_purge must be called with vmap_t arguments, sampled
 625  * while a lock that the vnode's VOP_RECLAIM function acquires is
 626  * held, to ensure that the vnode sampled with the lock held isn't
 627  * recycled (VOP_RECLAIMed) or deallocated between the release of the lock
 628  * and the subsequent vn_get or vn_purge.
 629  */
 630
 631 /*
 632  * vnode_map structures _must_ match vn_epoch and vnode structure sizes.
 633  */
 634 typedef struct vnode_map {
 635         vfs_t           *v_vfsp;
 636         vnumber_t       v_number;               /* in-core vnode number */
 637         xfs_ino_t       v_ino;                  /* inode #      */
 638 } vmap_t;
 639
 640 #define VMAP(vp, vmap)  {(vmap).v_vfsp   = (vp)->v_vfsp,        \
 641                          (vmap).v_number = (vp)->v_number,      \
 642                          (vmap).v_ino    = (vp)->v_inode.i_ino; }
 643
 644 extern void     vn_purge(struct vnode *, vmap_t *);
 645 extern vnode_t  *vn_get(struct vnode *, vmap_t *);
 646 extern int      vn_revalidate(struct vnode *);
 647 extern void     vn_remove(struct vnode *);
 648
 649 static inline int vn_count(struct vnode *vp)
 650 {
 651         return atomic_read(&LINVFS_GET_IP(vp)->i_count);
 652 }
 653
 654 /*
 655  * Vnode reference counting functions (and macros for compatibility).
 656  */
 657 extern vnode_t  *vn_hold(struct vnode *);
 658 extern void     vn_rele(struct vnode *);
 659
 660 #if defined(CONFIG_XFS_VNODE_TRACING)
 661
 662 #define VN_HOLD(vp)             \
 663         ((void)vn_hold(vp), \
 664           vn_trace_hold(vp, __FILE__, __LINE__, (inst_t *)__return_address))
 665 #define VN_RELE(vp)             \
 666           (vn_trace_rele(vp, __FILE__, __LINE__, (inst_t *)__return_address), \
 667            iput(LINVFS_GET_IP(vp)))
 668
 669 #else   /* ! (defined(CONFIG_XFS_VNODE_TRACING)) */
 670
 671 #define VN_HOLD(vp)             ((void)vn_hold(vp))
 672 #define VN_RELE(vp)             (iput(LINVFS_GET_IP(vp)))
 673
 674 #endif  /* ! (defined(CONFIG_XFS_VNODE_TRACING)) */
 675
 676 /*
 677  * Vname handling macros.
 678  */
 679 #define VNAME(dentry)           ((char *) (dentry)->d_name.name)
 680 #define VNAMELEN(dentry)        ((dentry)->d_name.len)
 681 #define VNAME_TO_VNODE(dentry)  (LINVFS_GET_VP((dentry)->d_inode))
 682
 683 /*
 684  * Vnode spinlock manipulation.
 685  */
 686 #define VN_LOCK(vp)             mutex_spinlock(&(vp)->v_lock)
 687 #define VN_UNLOCK(vp, s)        mutex_spinunlock(&(vp)->v_lock, s)
 688 #define VN_FLAGSET(vp,b)        vn_flagset(vp,b)
 689 #define VN_FLAGCLR(vp,b)        vn_flagclr(vp,b)
 690
 691 static __inline__ void vn_flagset(struct vnode *vp, uint flag)
 692 {
 693         spin_lock(&vp->v_lock);
 694         vp->v_flag |= flag;
 695         spin_unlock(&vp->v_lock);
 696 }
 697
 698 static __inline__ void vn_flagclr(struct vnode *vp, uint flag)
 699 {
 700         spin_lock(&vp->v_lock);
 701         vp->v_flag &= ~flag;
 702         spin_unlock(&vp->v_lock);
 703 }
 704
 705 /*
 706  * Some useful predicates.
 707  */
 708 #define VN_MAPPED(vp)   \
 709         (!list_empty(&(LINVFS_GET_IP(vp)->i_mapping->i_mmap)) || \
 710         (!list_empty(&(LINVFS_GET_IP(vp)->i_mapping->i_mmap_shared))))
 711 #define VN_CACHED(vp)   (LINVFS_GET_IP(vp)->i_mapping->nrpages)
 712 #define VN_DIRTY(vp)    (!list_empty(&(LINVFS_GET_IP(vp)->i_mapping->dirty_pages)))
 713 #define VMODIFY(vp)     { VN_FLAGSET(vp, VMODIFIED); \
 714                         mark_inode_dirty(LINVFS_GET_IP(vp)); }
 715 #define VUNMODIFY(vp)   VN_FLAGCLR(vp, VMODIFIED)
 716
 717 /*
 718  * Flags to VOP_SETATTR/VOP_GETATTR.
 719  */
 720 #define ATTR_UTIME      0x01    /* non-default utime(2) request */
 721 #define ATTR_EXEC       0x02    /* invocation from exec(2) */
 722 #define ATTR_COMM       0x04    /* yield common vp attributes */
 723 #define ATTR_DMI        0x08    /* invocation from a DMI function */
 724 #define ATTR_LAZY       0x80    /* set/get attributes lazily */
 725 #define ATTR_NONBLOCK   0x100   /* return EAGAIN if operation would block */
 726 #define ATTR_NOLOCK     0x200   /* Don't grab any conflicting locks */
 727 #define ATTR_NOSIZETOK  0x400   /* Don't get the DVN_SIZE_READ token */
 728
 729 /*
 730  * Flags to VOP_FSYNC and VOP_RECLAIM.
 731  */
 732 #define FSYNC_NOWAIT    0       /* asynchronous flush */
 733 #define FSYNC_WAIT      0x1     /* synchronous fsync or forced reclaim */
 734 #define FSYNC_INVAL     0x2     /* flush and invalidate cached data */
 735 #define FSYNC_DATA      0x4     /* synchronous fsync of data only */
 736
 737 #if (defined(CONFIG_XFS_VNODE_TRACING))
 738
 739 #define VNODE_TRACE_SIZE        16              /* number of trace entries */
 740
 741 /*
 742  * Tracing entries.
 743  */
 744 #define VNODE_KTRACE_ENTRY      1
 745 #define VNODE_KTRACE_EXIT       2
 746 #define VNODE_KTRACE_HOLD       3
 747 #define VNODE_KTRACE_REF        4
 748 #define VNODE_KTRACE_RELE       5
 749
 750 extern void vn_trace_entry(struct vnode *, char *, inst_t *);
 751 extern void vn_trace_exit(struct vnode *, char *, inst_t *);
 752 extern void vn_trace_hold(struct vnode *, char *, int, inst_t *);
 753 extern void vn_trace_ref(struct vnode *, char *, int, inst_t *);
 754 extern void vn_trace_rele(struct vnode *, char *, int, inst_t *);
 755 #define VN_TRACE(vp)            \
 756         vn_trace_ref(vp, __FILE__, __LINE__, (inst_t *)__return_address)
 757
 758 #else   /* ! (defined(CONFIG_XFS_VNODE_TRACING)) */
 759
 760 #define vn_trace_entry(a,b,c)
 761 #define vn_trace_exit(a,b,c)
 762 #define vn_trace_hold(a,b,c,d)
 763 #define vn_trace_ref(a,b,c,d)
 764 #define vn_trace_rele(a,b,c,d)
 765 #define VN_TRACE(vp)
 766
 767 #endif  /* ! (defined(CONFIG_XFS_VNODE_TRACING)) */
 768
 769 #endif  /* __XFS_VNODE_H__ */