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