2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
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.
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.
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
18 #ifndef __XFS_INODE_H__
19 #define __XFS_INODE_H__
21 #include "xfs_inode_buf.h"
22 #include "xfs_inode_fork.h"
25 * Kernel only inode definitions
32 struct xfs_inode_log_item;
37 typedef struct xfs_inode {
38 /* Inode linking and identification information. */
39 struct xfs_mount *i_mount; /* fs mount struct ptr */
40 struct xfs_dquot *i_udquot; /* user dquot */
41 struct xfs_dquot *i_gdquot; /* group dquot */
42 struct xfs_dquot *i_pdquot; /* project dquot */
44 /* Inode location stuff */
45 xfs_ino_t i_ino; /* inode number (agno/agino)*/
46 struct xfs_imap i_imap; /* location for xfs_imap() */
48 /* Extent information. */
49 xfs_ifork_t *i_afp; /* attribute fork pointer */
50 xfs_ifork_t i_df; /* data fork */
52 /* operations vectors */
53 const struct xfs_dir_ops *d_ops; /* directory ops vector */
55 /* Transaction and locking information. */
56 struct xfs_inode_log_item *i_itemp; /* logging information */
57 mrlock_t i_lock; /* inode lock */
58 mrlock_t i_iolock; /* inode IO lock */
59 mrlock_t i_mmaplock; /* inode mmap IO lock */
60 atomic_t i_pincount; /* inode pin count */
61 spinlock_t i_flags_lock; /* inode i_flags lock */
62 /* Miscellaneous state. */
63 unsigned long i_flags; /* see defined flags below */
64 unsigned int i_delayed_blks; /* count of delay alloc blks */
66 struct xfs_icdinode i_d; /* most of ondisk inode */
69 struct inode i_vnode; /* embedded VFS inode */
72 /* Convert from vfs inode to xfs inode */
73 static inline struct xfs_inode *XFS_I(struct inode *inode)
75 return container_of(inode, struct xfs_inode, i_vnode);
78 /* convert from xfs inode to vfs inode */
79 static inline struct inode *VFS_I(struct xfs_inode *ip)
85 * For regular files we only update the on-disk filesize when actually
86 * writing data back to disk. Until then only the copy in the VFS inode
89 static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
91 if (S_ISREG(VFS_I(ip)->i_mode))
92 return i_size_read(VFS_I(ip));
93 return ip->i_d.di_size;
97 * If this I/O goes past the on-disk inode size update it unless it would
98 * be past the current in-core inode size.
100 static inline xfs_fsize_t
101 xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
103 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
105 if (new_size > i_size || new_size < 0)
107 return new_size > ip->i_d.di_size ? new_size : 0;
111 * i_flags helper functions
114 __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
116 ip->i_flags |= flags;
120 xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
122 spin_lock(&ip->i_flags_lock);
123 __xfs_iflags_set(ip, flags);
124 spin_unlock(&ip->i_flags_lock);
128 xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
130 spin_lock(&ip->i_flags_lock);
131 ip->i_flags &= ~flags;
132 spin_unlock(&ip->i_flags_lock);
136 __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
138 return (ip->i_flags & flags);
142 xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
145 spin_lock(&ip->i_flags_lock);
146 ret = __xfs_iflags_test(ip, flags);
147 spin_unlock(&ip->i_flags_lock);
152 xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
156 spin_lock(&ip->i_flags_lock);
157 ret = ip->i_flags & flags;
159 ip->i_flags &= ~flags;
160 spin_unlock(&ip->i_flags_lock);
165 xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
169 spin_lock(&ip->i_flags_lock);
170 ret = ip->i_flags & flags;
172 ip->i_flags |= flags;
173 spin_unlock(&ip->i_flags_lock);
178 * Project quota id helpers (previously projid was 16bit only
179 * and using two 16bit values to hold new 32bit projid was chosen
180 * to retain compatibility with "old" filesystems).
183 xfs_get_projid(struct xfs_inode *ip)
185 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo;
189 xfs_set_projid(struct xfs_inode *ip,
192 ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16);
193 ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff);
197 xfs_get_initial_prid(struct xfs_inode *dp)
199 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
200 return xfs_get_projid(dp);
202 return XFS_PROJID_DEFAULT;
206 * In-core inode flags.
208 #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
209 #define XFS_ISTALE (1 << 1) /* inode has been staled */
210 #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
211 #define XFS_INEW (1 << 3) /* inode has just been allocated */
212 #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
213 #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
214 #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
215 #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
216 #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
217 #define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
218 #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
219 #define XFS_IEOFBLOCKS (1 << 10)/* has the preallocblocks tag set */
222 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
223 * inode lookup. This prevents unintended behaviour on the new inode from
226 #define XFS_IRECLAIM_RESET_FLAGS \
227 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
228 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
231 * Synchronize processes attempting to flush the in-core inode back to disk.
234 extern void __xfs_iflock(struct xfs_inode *ip);
236 static inline int xfs_iflock_nowait(struct xfs_inode *ip)
238 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
241 static inline void xfs_iflock(struct xfs_inode *ip)
243 if (!xfs_iflock_nowait(ip))
247 static inline void xfs_ifunlock(struct xfs_inode *ip)
249 xfs_iflags_clear(ip, XFS_IFLOCK);
251 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
254 static inline int xfs_isiflocked(struct xfs_inode *ip)
256 return xfs_iflags_test(ip, XFS_IFLOCK);
260 * Flags for inode locking.
261 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
262 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
264 #define XFS_IOLOCK_EXCL (1<<0)
265 #define XFS_IOLOCK_SHARED (1<<1)
266 #define XFS_ILOCK_EXCL (1<<2)
267 #define XFS_ILOCK_SHARED (1<<3)
268 #define XFS_MMAPLOCK_EXCL (1<<4)
269 #define XFS_MMAPLOCK_SHARED (1<<5)
271 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
272 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
273 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
275 #define XFS_LOCK_FLAGS \
276 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
277 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
278 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
279 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
280 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
281 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
285 * Flags for lockdep annotations.
287 * XFS_LOCK_PARENT - for directory operations that require locking a
288 * parent directory inode and a child entry inode. IOLOCK requires nesting,
289 * MMAPLOCK does not support this class, ILOCK requires a single subclass
290 * to differentiate parent from child.
292 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
293 * inodes do not participate in the normal lock order, and thus have their
296 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
297 * with xfs_lock_inodes(). This flag is used as the starting subclass
298 * and each subsequent lock acquired will increment the subclass by one.
299 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
300 * limited to the subclasses we can represent via nesting. We need at least
301 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
302 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
303 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
304 * 8 subclasses supported by lockdep.
306 * This also means we have to number the sub-classes in the lowest bits of
307 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
308 * mask and we can't use bit-masking to build the subclasses. What a mess.
313 * 16-19 XFS_IOLOCK_SHIFT dependencies
314 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
315 * 24-31 XFS_ILOCK_SHIFT dependencies
320 * 4-7 PARENT subclass values
328 * 0-4 subclass values
329 * 5 PARENT subclass (not nestable)
330 * 6 RTBITMAP subclass (not nestable)
331 * 7 RTSUM subclass (not nestable)
334 #define XFS_IOLOCK_SHIFT 16
335 #define XFS_IOLOCK_PARENT_VAL 4
336 #define XFS_IOLOCK_MAX_SUBCLASS (XFS_IOLOCK_PARENT_VAL - 1)
337 #define XFS_IOLOCK_DEP_MASK 0x000f0000
338 #define XFS_IOLOCK_PARENT (XFS_IOLOCK_PARENT_VAL << XFS_IOLOCK_SHIFT)
340 #define XFS_MMAPLOCK_SHIFT 20
341 #define XFS_MMAPLOCK_NUMORDER 0
342 #define XFS_MMAPLOCK_MAX_SUBCLASS 3
343 #define XFS_MMAPLOCK_DEP_MASK 0x00f00000
345 #define XFS_ILOCK_SHIFT 24
346 #define XFS_ILOCK_PARENT_VAL 5
347 #define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
348 #define XFS_ILOCK_RTBITMAP_VAL 6
349 #define XFS_ILOCK_RTSUM_VAL 7
350 #define XFS_ILOCK_DEP_MASK 0xff000000
351 #define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
352 #define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
353 #define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
355 #define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
356 XFS_MMAPLOCK_DEP_MASK | \
359 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
361 #define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
362 >> XFS_MMAPLOCK_SHIFT)
363 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
367 * For multiple groups support: if S_ISGID bit is set in the parent
368 * directory, group of new file is set to that of the parent, and
369 * new subdirectory gets S_ISGID bit from parent.
371 #define XFS_INHERIT_GID(pip) \
372 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
373 (VFS_I(pip)->i_mode & S_ISGID))
375 int xfs_release(struct xfs_inode *ip);
376 void xfs_inactive(struct xfs_inode *ip);
377 int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
378 struct xfs_inode **ipp, struct xfs_name *ci_name);
379 int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
380 umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp);
381 int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry,
382 umode_t mode, struct xfs_inode **ipp);
383 int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
384 struct xfs_inode *ip);
385 int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
386 struct xfs_name *target_name);
387 int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
388 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
389 struct xfs_name *target_name,
390 struct xfs_inode *target_ip, unsigned int flags);
392 void xfs_ilock(xfs_inode_t *, uint);
393 int xfs_ilock_nowait(xfs_inode_t *, uint);
394 void xfs_iunlock(xfs_inode_t *, uint);
395 void xfs_ilock_demote(xfs_inode_t *, uint);
396 int xfs_isilocked(xfs_inode_t *, uint);
397 uint xfs_ilock_data_map_shared(struct xfs_inode *);
398 uint xfs_ilock_attr_map_shared(struct xfs_inode *);
400 uint xfs_ip2xflags(struct xfs_inode *);
401 int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
402 struct xfs_defer_ops *);
403 int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
405 void xfs_iext_realloc(xfs_inode_t *, int, int);
407 void xfs_iunpin_wait(xfs_inode_t *);
408 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
410 int xfs_iflush(struct xfs_inode *, struct xfs_buf **);
411 void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);
413 xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
415 int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
416 xfs_nlink_t, xfs_dev_t, prid_t, int,
417 struct xfs_inode **, int *);
419 /* from xfs_file.c */
420 enum xfs_prealloc_flags {
421 XFS_PREALLOC_SET = (1 << 1),
422 XFS_PREALLOC_CLEAR = (1 << 2),
423 XFS_PREALLOC_SYNC = (1 << 3),
424 XFS_PREALLOC_INVISIBLE = (1 << 4),
427 int xfs_update_prealloc_flags(struct xfs_inode *ip,
428 enum xfs_prealloc_flags flags);
429 int xfs_zero_eof(struct xfs_inode *ip, xfs_off_t offset,
430 xfs_fsize_t isize, bool *did_zeroing);
431 int xfs_zero_range(struct xfs_inode *ip, xfs_off_t pos, xfs_off_t count,
433 loff_t __xfs_seek_hole_data(struct inode *inode, loff_t start,
434 loff_t eof, int whence);
437 /* from xfs_iops.c */
438 extern void xfs_setup_inode(struct xfs_inode *ip);
439 extern void xfs_setup_iops(struct xfs_inode *ip);
442 * When setting up a newly allocated inode, we need to call
443 * xfs_finish_inode_setup() once the inode is fully instantiated at
444 * the VFS level to prevent the rest of the world seeing the inode
445 * before we've completed instantiation. Otherwise we can do it
446 * the moment the inode lookup is complete.
448 static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
450 xfs_iflags_clear(ip, XFS_INEW);
452 unlock_new_inode(VFS_I(ip));
455 static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
459 xfs_finish_inode_setup(ip);
464 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
466 trace_xfs_ihold(ip, _THIS_IP_); \
471 trace_xfs_irele(ip, _THIS_IP_); \
475 extern struct kmem_zone *xfs_inode_zone;
477 #endif /* __XFS_INODE_H__ */