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