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 #ifndef __XFS_VNODE_H__
  19 #define __XFS_VNODE_H__
  20
  21 struct file;
  22 struct bhv_vfs;
  23 struct bhv_vattr;
  24 struct xfs_iomap;
  25 struct attrlist_cursor_kern;
  26
  27 typedef struct dentry   bhv_vname_t;
  28 typedef __u64           bhv_vnumber_t;
  29 typedef struct inode    bhv_vnode_t;
  30
  31 #define VN_ISLNK(vp)    S_ISLNK((vp)->i_mode)
  32 #define VN_ISREG(vp)    S_ISREG((vp)->i_mode)
  33 #define VN_ISDIR(vp)    S_ISDIR((vp)->i_mode)
  34 #define VN_ISCHR(vp)    S_ISCHR((vp)->i_mode)
  35 #define VN_ISBLK(vp)    S_ISBLK((vp)->i_mode)
  36
  37 /*
  38  * Vnode to Linux inode mapping.
  39  */
  40 static inline bhv_vnode_t *vn_from_inode(struct inode *inode)
  41 {
  42         return inode;
  43 }
  44 static inline struct inode *vn_to_inode(bhv_vnode_t *vnode)
  45 {
  46         return vnode;
  47 }
  48
  49 /*
  50  * Values for the vop_rwlock/rwunlock flags parameter.
  51  */
  52 typedef enum bhv_vrwlock {
  53         VRWLOCK_NONE,
  54         VRWLOCK_READ,
  55         VRWLOCK_WRITE,
  56         VRWLOCK_WRITE_DIRECT,
  57         VRWLOCK_TRY_READ,
  58         VRWLOCK_TRY_WRITE
  59 } bhv_vrwlock_t;
  60
  61 /*
  62  * Return values for xfs_inactive.  A return value of
  63  * VN_INACTIVE_NOCACHE implies that the file system behavior
  64  * has disassociated its state and bhv_desc_t from the vnode.
  65  */
  66 #define VN_INACTIVE_CACHE       0
  67 #define VN_INACTIVE_NOCACHE     1
  68
  69 /*
  70  * Flags for read/write calls - same values as IRIX
  71  */
  72 #define IO_ISAIO        0x00001         /* don't wait for completion */
  73 #define IO_ISDIRECT     0x00004         /* bypass page cache */
  74 #define IO_INVIS        0x00020         /* don't update inode timestamps */
  75
  76 /*
  77  * Flags for vop_iflush call
  78  */
  79 #define FLUSH_SYNC              1       /* wait for flush to complete   */
  80 #define FLUSH_INODE             2       /* flush the inode itself       */
  81 #define FLUSH_LOG               4       /* force the last log entry for
  82                                          * this inode out to disk       */
  83
  84 /*
  85  * Flush/Invalidate options for vop_toss/flush/flushinval_pages.
  86  */
  87 #define FI_NONE                 0       /* none */
  88 #define FI_REMAPF               1       /* Do a remapf prior to the operation */
  89 #define FI_REMAPF_LOCKED        2       /* Do a remapf prior to the operation.
  90                                            Prevent VM access to the pages until
  91                                            the operation completes. */
  92
  93 /*
  94  * Vnode attributes.  va_mask indicates those attributes the caller
  95  * wants to set or extract.
  96  */
  97 typedef struct bhv_vattr {
  98         int             va_mask;        /* bit-mask of attributes present */
  99         mode_t          va_mode;        /* file access mode and type */
 100         xfs_nlink_t     va_nlink;       /* number of references to file */
 101         uid_t           va_uid;         /* owner user id */
 102         gid_t           va_gid;         /* owner group id */
 103         xfs_ino_t       va_nodeid;      /* file id */
 104         xfs_off_t       va_size;        /* file size in bytes */
 105         u_long          va_blocksize;   /* blocksize preferred for i/o */
 106         struct timespec va_atime;       /* time of last access */
 107         struct timespec va_mtime;       /* time of last modification */
 108         struct timespec va_ctime;       /* time file changed */
 109         u_int           va_gen;         /* generation number of file */
 110         xfs_dev_t       va_rdev;        /* device the special file represents */
 111         __int64_t       va_nblocks;     /* number of blocks allocated */
 112         u_long          va_xflags;      /* random extended file flags */
 113         u_long          va_extsize;     /* file extent size */
 114         u_long          va_nextents;    /* number of extents in file */
 115         u_long          va_anextents;   /* number of attr extents in file */
 116         prid_t          va_projid;      /* project id */
 117 } bhv_vattr_t;
 118
 119 /*
 120  * setattr or getattr attributes
 121  */
 122 #define XFS_AT_TYPE             0x00000001
 123 #define XFS_AT_MODE             0x00000002
 124 #define XFS_AT_UID              0x00000004
 125 #define XFS_AT_GID              0x00000008
 126 #define XFS_AT_FSID             0x00000010
 127 #define XFS_AT_NODEID           0x00000020
 128 #define XFS_AT_NLINK            0x00000040
 129 #define XFS_AT_SIZE             0x00000080
 130 #define XFS_AT_ATIME            0x00000100
 131 #define XFS_AT_MTIME            0x00000200
 132 #define XFS_AT_CTIME            0x00000400
 133 #define XFS_AT_RDEV             0x00000800
 134 #define XFS_AT_BLKSIZE          0x00001000
 135 #define XFS_AT_NBLOCKS          0x00002000
 136 #define XFS_AT_VCODE            0x00004000
 137 #define XFS_AT_MAC              0x00008000
 138 #define XFS_AT_UPDATIME         0x00010000
 139 #define XFS_AT_UPDMTIME         0x00020000
 140 #define XFS_AT_UPDCTIME         0x00040000
 141 #define XFS_AT_ACL              0x00080000
 142 #define XFS_AT_CAP              0x00100000
 143 #define XFS_AT_INF              0x00200000
 144 #define XFS_AT_XFLAGS           0x00400000
 145 #define XFS_AT_EXTSIZE          0x00800000
 146 #define XFS_AT_NEXTENTS         0x01000000
 147 #define XFS_AT_ANEXTENTS        0x02000000
 148 #define XFS_AT_PROJID           0x04000000
 149 #define XFS_AT_SIZE_NOPERM      0x08000000
 150 #define XFS_AT_GENCOUNT         0x10000000
 151
 152 #define XFS_AT_ALL      (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
 153                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
 154                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
 155                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|XFS_AT_MAC|\
 156                 XFS_AT_ACL|XFS_AT_CAP|XFS_AT_INF|XFS_AT_XFLAGS|XFS_AT_EXTSIZE|\
 157                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_PROJID|XFS_AT_GENCOUNT)
 158
 159 #define XFS_AT_STAT     (XFS_AT_TYPE|XFS_AT_MODE|XFS_AT_UID|XFS_AT_GID|\
 160                 XFS_AT_FSID|XFS_AT_NODEID|XFS_AT_NLINK|XFS_AT_SIZE|\
 161                 XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME|XFS_AT_RDEV|\
 162                 XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_PROJID)
 163
 164 #define XFS_AT_TIMES    (XFS_AT_ATIME|XFS_AT_MTIME|XFS_AT_CTIME)
 165
 166 #define XFS_AT_UPDTIMES (XFS_AT_UPDATIME|XFS_AT_UPDMTIME|XFS_AT_UPDCTIME)
 167
 168 #define XFS_AT_NOSET    (XFS_AT_NLINK|XFS_AT_RDEV|XFS_AT_FSID|XFS_AT_NODEID|\
 169                 XFS_AT_TYPE|XFS_AT_BLKSIZE|XFS_AT_NBLOCKS|XFS_AT_VCODE|\
 170                 XFS_AT_NEXTENTS|XFS_AT_ANEXTENTS|XFS_AT_GENCOUNT)
 171
 172 /*
 173  *  Modes.
 174  */
 175 #define VSUID   S_ISUID         /* set user id on execution */
 176 #define VSGID   S_ISGID         /* set group id on execution */
 177 #define VSVTX   S_ISVTX         /* save swapped text even after use */
 178 #define VREAD   S_IRUSR         /* read, write, execute permissions */
 179 #define VWRITE  S_IWUSR
 180 #define VEXEC   S_IXUSR
 181
 182 #define MODEMASK S_IALLUGO      /* mode bits plus permission bits */
 183
 184 /*
 185  * Check whether mandatory file locking is enabled.
 186  */
 187 #define MANDLOCK(vp, mode)      \
 188         (VN_ISREG(vp) && ((mode) & (VSGID|(VEXEC>>3))) == VSGID)
 189
 190 extern void     vn_init(void);
 191 extern bhv_vnode_t      *vn_initialize(struct inode *);
 192 extern int      vn_revalidate(bhv_vnode_t *);
 193 extern int      __vn_revalidate(bhv_vnode_t *, bhv_vattr_t *);
 194 extern void     vn_revalidate_core(bhv_vnode_t *, bhv_vattr_t *);
 195
 196 /*
 197  * Yeah, these don't take vnode anymore at all, all this should be
 198  * cleaned up at some point.
 199  */
 200 extern void     vn_iowait(struct xfs_inode *ip);
 201 extern void     vn_iowake(struct xfs_inode *ip);
 202 extern void     vn_ioerror(struct xfs_inode *ip, int error, char *f, int l);
 203
 204 static inline int vn_count(bhv_vnode_t *vp)
 205 {
 206         return atomic_read(&vn_to_inode(vp)->i_count);
 207 }
 208
 209 /*
 210  * Vnode reference counting functions (and macros for compatibility).
 211  */
 212 extern bhv_vnode_t      *vn_hold(bhv_vnode_t *);
 213
 214 #if defined(XFS_VNODE_TRACE)
 215 #define VN_HOLD(vp)             \
 216         ((void)vn_hold(vp),     \
 217           vn_trace_hold(xfs_vtoi(vp), __FILE__, __LINE__, (inst_t *)__return_address))
 218 #define VN_RELE(vp)             \
 219           (vn_trace_rele(xfs_vtoi(vp), __FILE__, __LINE__, (inst_t *)__return_address), \
 220            iput(vn_to_inode(vp)))
 221 #else
 222 #define VN_HOLD(vp)             ((void)vn_hold(vp))
 223 #define VN_RELE(vp)             (iput(vn_to_inode(vp)))
 224 #endif
 225
 226 static inline bhv_vnode_t *vn_grab(bhv_vnode_t *vp)
 227 {
 228         struct inode *inode = igrab(vn_to_inode(vp));
 229         return inode ? vn_from_inode(inode) : NULL;
 230 }
 231
 232 /*
 233  * Vname handling macros.
 234  */
 235 #define VNAME(dentry)           ((char *) (dentry)->d_name.name)
 236 #define VNAMELEN(dentry)        ((dentry)->d_name.len)
 237 #define VNAME_TO_VNODE(dentry)  (vn_from_inode((dentry)->d_inode))
 238
 239 /*
 240  * Dealing with bad inodes
 241  */
 242 static inline void vn_mark_bad(bhv_vnode_t *vp)
 243 {
 244         make_bad_inode(vn_to_inode(vp));
 245 }
 246
 247 static inline int VN_BAD(bhv_vnode_t *vp)
 248 {
 249         return is_bad_inode(vn_to_inode(vp));
 250 }
 251
 252 /*
 253  * Extracting atime values in various formats
 254  */
 255 static inline void vn_atime_to_bstime(bhv_vnode_t *vp, xfs_bstime_t *bs_atime)
 256 {
 257         bs_atime->tv_sec = vp->i_atime.tv_sec;
 258         bs_atime->tv_nsec = vp->i_atime.tv_nsec;
 259 }
 260
 261 static inline void vn_atime_to_timespec(bhv_vnode_t *vp, struct timespec *ts)
 262 {
 263         *ts = vp->i_atime;
 264 }
 265
 266 static inline void vn_atime_to_time_t(bhv_vnode_t *vp, time_t *tt)
 267 {
 268         *tt = vp->i_atime.tv_sec;
 269 }
 270
 271 /*
 272  * Some useful predicates.
 273  */
 274 #define VN_MAPPED(vp)   mapping_mapped(vn_to_inode(vp)->i_mapping)
 275 #define VN_CACHED(vp)   (vn_to_inode(vp)->i_mapping->nrpages)
 276 #define VN_DIRTY(vp)    mapping_tagged(vn_to_inode(vp)->i_mapping, \
 277                                         PAGECACHE_TAG_DIRTY)
 278
 279 /*
 280  * Flags to vop_setattr/getattr.
 281  */
 282 #define ATTR_UTIME      0x01    /* non-default utime(2) request */
 283 #define ATTR_DMI        0x08    /* invocation from a DMI function */
 284 #define ATTR_LAZY       0x80    /* set/get attributes lazily */
 285 #define ATTR_NONBLOCK   0x100   /* return EAGAIN if operation would block */
 286 #define ATTR_NOLOCK     0x200   /* Don't grab any conflicting locks */
 287 #define ATTR_NOSIZETOK  0x400   /* Don't get the SIZE token */
 288
 289 /*
 290  * Flags to vop_fsync/reclaim.
 291  */
 292 #define FSYNC_NOWAIT    0       /* asynchronous flush */
 293 #define FSYNC_WAIT      0x1     /* synchronous fsync or forced reclaim */
 294 #define FSYNC_INVAL     0x2     /* flush and invalidate cached data */
 295 #define FSYNC_DATA      0x4     /* synchronous fsync of data only */
 296
 297 /*
 298  * Tracking vnode activity.
 299  */
 300 #if defined(XFS_VNODE_TRACE)
 301
 302 #define VNODE_TRACE_SIZE        16              /* number of trace entries */
 303 #define VNODE_KTRACE_ENTRY      1
 304 #define VNODE_KTRACE_EXIT       2
 305 #define VNODE_KTRACE_HOLD       3
 306 #define VNODE_KTRACE_REF        4
 307 #define VNODE_KTRACE_RELE       5
 308
 309 extern void vn_trace_entry(struct xfs_inode *, const char *, inst_t *);
 310 extern void vn_trace_exit(struct xfs_inode *, const char *, inst_t *);
 311 extern void vn_trace_hold(struct xfs_inode *, char *, int, inst_t *);
 312 extern void vn_trace_ref(struct xfs_inode *, char *, int, inst_t *);
 313 extern void vn_trace_rele(struct xfs_inode *, char *, int, inst_t *);
 314 #else
 315 #define vn_trace_entry(a,b,c)
 316 #define vn_trace_exit(a,b,c)
 317 #define vn_trace_hold(a,b,c,d)
 318 #define vn_trace_ref(a,b,c,d)
 319 #define vn_trace_rele(a,b,c,d)
 320 #endif
 321
 322 #endif  /* __XFS_VNODE_H__ */