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