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_cowfp
; /* copy on write extents */
51 xfs_ifork_t i_df
; /* data fork */
53 /* operations vectors */
54 const struct xfs_dir_ops
*d_ops
; /* directory ops vector */
56 /* Transaction and locking information. */
57 struct xfs_inode_log_item
*i_itemp
; /* logging information */
58 mrlock_t i_lock
; /* inode 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 */
68 xfs_extnum_t i_cnextents
; /* # of extents in cow fork */
69 unsigned int i_cformat
; /* format of cow fork */
72 struct inode i_vnode
; /* embedded VFS inode */
75 /* Convert from vfs inode to xfs inode */
76 static inline struct xfs_inode
*XFS_I(struct inode
*inode
)
78 return container_of(inode
, struct xfs_inode
, i_vnode
);
81 /* convert from xfs inode to vfs inode */
82 static inline struct inode
*VFS_I(struct xfs_inode
*ip
)
88 * For regular files we only update the on-disk filesize when actually
89 * writing data back to disk. Until then only the copy in the VFS inode
92 static inline xfs_fsize_t
XFS_ISIZE(struct xfs_inode
*ip
)
94 if (S_ISREG(VFS_I(ip
)->i_mode
))
95 return i_size_read(VFS_I(ip
));
96 return ip
->i_d
.di_size
;
100 * If this I/O goes past the on-disk inode size update it unless it would
101 * be past the current in-core inode size.
103 static inline xfs_fsize_t
104 xfs_new_eof(struct xfs_inode
*ip
, xfs_fsize_t new_size
)
106 xfs_fsize_t i_size
= i_size_read(VFS_I(ip
));
108 if (new_size
> i_size
|| new_size
< 0)
110 return new_size
> ip
->i_d
.di_size
? new_size
: 0;
114 * i_flags helper functions
117 __xfs_iflags_set(xfs_inode_t
*ip
, unsigned short flags
)
119 ip
->i_flags
|= flags
;
123 xfs_iflags_set(xfs_inode_t
*ip
, unsigned short flags
)
125 spin_lock(&ip
->i_flags_lock
);
126 __xfs_iflags_set(ip
, flags
);
127 spin_unlock(&ip
->i_flags_lock
);
131 xfs_iflags_clear(xfs_inode_t
*ip
, unsigned short flags
)
133 spin_lock(&ip
->i_flags_lock
);
134 ip
->i_flags
&= ~flags
;
135 spin_unlock(&ip
->i_flags_lock
);
139 __xfs_iflags_test(xfs_inode_t
*ip
, unsigned short flags
)
141 return (ip
->i_flags
& flags
);
145 xfs_iflags_test(xfs_inode_t
*ip
, unsigned short flags
)
148 spin_lock(&ip
->i_flags_lock
);
149 ret
= __xfs_iflags_test(ip
, flags
);
150 spin_unlock(&ip
->i_flags_lock
);
155 xfs_iflags_test_and_clear(xfs_inode_t
*ip
, unsigned short flags
)
159 spin_lock(&ip
->i_flags_lock
);
160 ret
= ip
->i_flags
& flags
;
162 ip
->i_flags
&= ~flags
;
163 spin_unlock(&ip
->i_flags_lock
);
168 xfs_iflags_test_and_set(xfs_inode_t
*ip
, unsigned short flags
)
172 spin_lock(&ip
->i_flags_lock
);
173 ret
= ip
->i_flags
& flags
;
175 ip
->i_flags
|= flags
;
176 spin_unlock(&ip
->i_flags_lock
);
181 * Project quota id helpers (previously projid was 16bit only
182 * and using two 16bit values to hold new 32bit projid was chosen
183 * to retain compatibility with "old" filesystems).
186 xfs_get_projid(struct xfs_inode
*ip
)
188 return (prid_t
)ip
->i_d
.di_projid_hi
<< 16 | ip
->i_d
.di_projid_lo
;
192 xfs_set_projid(struct xfs_inode
*ip
,
195 ip
->i_d
.di_projid_hi
= (__uint16_t
) (projid
>> 16);
196 ip
->i_d
.di_projid_lo
= (__uint16_t
) (projid
& 0xffff);
200 xfs_get_initial_prid(struct xfs_inode
*dp
)
202 if (dp
->i_d
.di_flags
& XFS_DIFLAG_PROJINHERIT
)
203 return xfs_get_projid(dp
);
205 return XFS_PROJID_DEFAULT
;
208 static inline bool xfs_is_reflink_inode(struct xfs_inode
*ip
)
210 return ip
->i_d
.di_flags2
& XFS_DIFLAG2_REFLINK
;
214 * In-core inode flags.
216 #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
217 #define XFS_ISTALE (1 << 1) /* inode has been staled */
218 #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
219 #define XFS_INEW (1 << 3) /* inode has just been allocated */
220 #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
221 #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
222 #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
223 #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
224 #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
225 #define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
226 #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
227 #define XFS_IEOFBLOCKS (1 << 10)/* has the preallocblocks tag set */
229 * If this unlinked inode is in the middle of recovery, don't let drop_inode
230 * truncate and free the inode. This can happen if we iget the inode during
231 * log recovery to replay a bmap operation on the inode.
233 #define XFS_IRECOVERY (1 << 11)
236 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
237 * inode lookup. This prevents unintended behaviour on the new inode from
240 #define XFS_IRECLAIM_RESET_FLAGS \
241 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
242 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
245 * Synchronize processes attempting to flush the in-core inode back to disk.
248 static inline int xfs_isiflocked(struct xfs_inode
*ip
)
250 return xfs_iflags_test(ip
, XFS_IFLOCK
);
253 extern void __xfs_iflock(struct xfs_inode
*ip
);
255 static inline int xfs_iflock_nowait(struct xfs_inode
*ip
)
257 return !xfs_iflags_test_and_set(ip
, XFS_IFLOCK
);
260 static inline void xfs_iflock(struct xfs_inode
*ip
)
262 if (!xfs_iflock_nowait(ip
))
266 static inline void xfs_ifunlock(struct xfs_inode
*ip
)
268 ASSERT(xfs_isiflocked(ip
));
269 xfs_iflags_clear(ip
, XFS_IFLOCK
);
271 wake_up_bit(&ip
->i_flags
, __XFS_IFLOCK_BIT
);
275 * Flags for inode locking.
276 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
277 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
279 #define XFS_IOLOCK_EXCL (1<<0)
280 #define XFS_IOLOCK_SHARED (1<<1)
281 #define XFS_ILOCK_EXCL (1<<2)
282 #define XFS_ILOCK_SHARED (1<<3)
283 #define XFS_MMAPLOCK_EXCL (1<<4)
284 #define XFS_MMAPLOCK_SHARED (1<<5)
286 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
287 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
288 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
290 #define XFS_LOCK_FLAGS \
291 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
292 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
293 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
294 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
295 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
296 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
300 * Flags for lockdep annotations.
302 * XFS_LOCK_PARENT - for directory operations that require locking a
303 * parent directory inode and a child entry inode. IOLOCK requires nesting,
304 * MMAPLOCK does not support this class, ILOCK requires a single subclass
305 * to differentiate parent from child.
307 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
308 * inodes do not participate in the normal lock order, and thus have their
311 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
312 * with xfs_lock_inodes(). This flag is used as the starting subclass
313 * and each subsequent lock acquired will increment the subclass by one.
314 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
315 * limited to the subclasses we can represent via nesting. We need at least
316 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
317 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
318 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
319 * 8 subclasses supported by lockdep.
321 * This also means we have to number the sub-classes in the lowest bits of
322 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
323 * mask and we can't use bit-masking to build the subclasses. What a mess.
328 * 16-19 XFS_IOLOCK_SHIFT dependencies
329 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
330 * 24-31 XFS_ILOCK_SHIFT dependencies
343 * 0-4 subclass values
344 * 5 PARENT subclass (not nestable)
345 * 6 RTBITMAP subclass (not nestable)
346 * 7 RTSUM subclass (not nestable)
349 #define XFS_IOLOCK_SHIFT 16
350 #define XFS_IOLOCK_MAX_SUBCLASS 3
351 #define XFS_IOLOCK_DEP_MASK 0x000f0000
353 #define XFS_MMAPLOCK_SHIFT 20
354 #define XFS_MMAPLOCK_NUMORDER 0
355 #define XFS_MMAPLOCK_MAX_SUBCLASS 3
356 #define XFS_MMAPLOCK_DEP_MASK 0x00f00000
358 #define XFS_ILOCK_SHIFT 24
359 #define XFS_ILOCK_PARENT_VAL 5
360 #define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
361 #define XFS_ILOCK_RTBITMAP_VAL 6
362 #define XFS_ILOCK_RTSUM_VAL 7
363 #define XFS_ILOCK_DEP_MASK 0xff000000
364 #define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
365 #define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
366 #define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
368 #define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
369 XFS_MMAPLOCK_DEP_MASK | \
372 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
374 #define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
375 >> XFS_MMAPLOCK_SHIFT)
376 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
380 * For multiple groups support: if S_ISGID bit is set in the parent
381 * directory, group of new file is set to that of the parent, and
382 * new subdirectory gets S_ISGID bit from parent.
384 #define XFS_INHERIT_GID(pip) \
385 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
386 (VFS_I(pip)->i_mode & S_ISGID))
388 int xfs_release(struct xfs_inode
*ip
);
389 void xfs_inactive(struct xfs_inode
*ip
);
390 int xfs_lookup(struct xfs_inode
*dp
, struct xfs_name
*name
,
391 struct xfs_inode
**ipp
, struct xfs_name
*ci_name
);
392 int xfs_create(struct xfs_inode
*dp
, struct xfs_name
*name
,
393 umode_t mode
, xfs_dev_t rdev
, struct xfs_inode
**ipp
);
394 int xfs_create_tmpfile(struct xfs_inode
*dp
, struct dentry
*dentry
,
395 umode_t mode
, struct xfs_inode
**ipp
);
396 int xfs_remove(struct xfs_inode
*dp
, struct xfs_name
*name
,
397 struct xfs_inode
*ip
);
398 int xfs_link(struct xfs_inode
*tdp
, struct xfs_inode
*sip
,
399 struct xfs_name
*target_name
);
400 int xfs_rename(struct xfs_inode
*src_dp
, struct xfs_name
*src_name
,
401 struct xfs_inode
*src_ip
, struct xfs_inode
*target_dp
,
402 struct xfs_name
*target_name
,
403 struct xfs_inode
*target_ip
, unsigned int flags
);
405 void xfs_ilock(xfs_inode_t
*, uint
);
406 int xfs_ilock_nowait(xfs_inode_t
*, uint
);
407 void xfs_iunlock(xfs_inode_t
*, uint
);
408 void xfs_ilock_demote(xfs_inode_t
*, uint
);
409 int xfs_isilocked(xfs_inode_t
*, uint
);
410 uint
xfs_ilock_data_map_shared(struct xfs_inode
*);
411 uint
xfs_ilock_attr_map_shared(struct xfs_inode
*);
413 uint
xfs_ip2xflags(struct xfs_inode
*);
414 int xfs_ifree(struct xfs_trans
*, xfs_inode_t
*,
415 struct xfs_defer_ops
*);
416 int xfs_itruncate_extents(struct xfs_trans
**, struct xfs_inode
*,
418 void xfs_iext_realloc(xfs_inode_t
*, int, int);
420 void xfs_iunpin_wait(xfs_inode_t
*);
421 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
423 int xfs_iflush(struct xfs_inode
*, struct xfs_buf
**);
424 void xfs_lock_two_inodes(xfs_inode_t
*, xfs_inode_t
*, uint
);
426 xfs_extlen_t
xfs_get_extsz_hint(struct xfs_inode
*ip
);
427 xfs_extlen_t
xfs_get_cowextsz_hint(struct xfs_inode
*ip
);
429 int xfs_dir_ialloc(struct xfs_trans
**, struct xfs_inode
*, umode_t
,
430 xfs_nlink_t
, xfs_dev_t
, prid_t
, int,
431 struct xfs_inode
**, int *);
433 /* from xfs_file.c */
434 enum xfs_prealloc_flags
{
435 XFS_PREALLOC_SET
= (1 << 1),
436 XFS_PREALLOC_CLEAR
= (1 << 2),
437 XFS_PREALLOC_SYNC
= (1 << 3),
438 XFS_PREALLOC_INVISIBLE
= (1 << 4),
441 int xfs_update_prealloc_flags(struct xfs_inode
*ip
,
442 enum xfs_prealloc_flags flags
);
443 int xfs_zero_eof(struct xfs_inode
*ip
, xfs_off_t offset
,
444 xfs_fsize_t isize
, bool *did_zeroing
);
445 int xfs_zero_range(struct xfs_inode
*ip
, xfs_off_t pos
, xfs_off_t count
,
447 loff_t
__xfs_seek_hole_data(struct inode
*inode
, loff_t start
,
448 loff_t eof
, int whence
);
451 /* from xfs_iops.c */
452 extern void xfs_setup_inode(struct xfs_inode
*ip
);
453 extern void xfs_setup_iops(struct xfs_inode
*ip
);
456 * When setting up a newly allocated inode, we need to call
457 * xfs_finish_inode_setup() once the inode is fully instantiated at
458 * the VFS level to prevent the rest of the world seeing the inode
459 * before we've completed instantiation. Otherwise we can do it
460 * the moment the inode lookup is complete.
462 static inline void xfs_finish_inode_setup(struct xfs_inode
*ip
)
464 xfs_iflags_clear(ip
, XFS_INEW
);
466 unlock_new_inode(VFS_I(ip
));
469 static inline void xfs_setup_existing_inode(struct xfs_inode
*ip
)
473 xfs_finish_inode_setup(ip
);
478 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
480 trace_xfs_ihold(ip, _THIS_IP_); \
485 trace_xfs_irele(ip, _THIS_IP_); \
489 extern struct kmem_zone
*xfs_inode_zone
;
491 /* The default CoW extent size hint. */
492 #define XFS_DEFAULT_COWEXTSZ_HINT 32
494 #endif /* __XFS_INODE_H__ */