2 * Copyright (c) 2000-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
20 #include "xfs_types.h"
25 #include "xfs_trans.h"
28 #include "xfs_mount.h"
29 #include "xfs_bmap_btree.h"
30 #include "xfs_alloc_btree.h"
31 #include "xfs_ialloc_btree.h"
32 #include "xfs_dinode.h"
33 #include "xfs_inode.h"
34 #include "xfs_btree.h"
35 #include "xfs_ialloc.h"
36 #include "xfs_quota.h"
37 #include "xfs_utils.h"
38 #include "xfs_trans_priv.h"
39 #include "xfs_inode_item.h"
41 #include "xfs_trace.h"
45 * Define xfs inode iolock lockdep classes. We need to ensure that all active
46 * inodes are considered the same for lockdep purposes, including inodes that
47 * are recycled through the XFS_IRECLAIMABLE state. This is the the only way to
48 * guarantee the locks are considered the same when there are multiple lock
49 * initialisation siteѕ. Also, define a reclaimable inode class so it is
50 * obvious in lockdep reports which class the report is against.
52 static struct lock_class_key xfs_iolock_active
;
53 struct lock_class_key xfs_iolock_reclaimable
;
56 * Allocate and initialise an xfs_inode.
58 STATIC
struct xfs_inode
*
66 * if this didn't occur in transactions, we could use
67 * KM_MAYFAIL and return NULL here on ENOMEM. Set the
68 * code up to do this anyway.
70 ip
= kmem_zone_alloc(xfs_inode_zone
, KM_SLEEP
);
73 if (inode_init_always(mp
->m_super
, VFS_I(ip
))) {
74 kmem_zone_free(xfs_inode_zone
, ip
);
78 ASSERT(atomic_read(&ip
->i_pincount
) == 0);
79 ASSERT(!spin_is_locked(&ip
->i_flags_lock
));
80 ASSERT(!xfs_isiflocked(ip
));
81 ASSERT(ip
->i_ino
== 0);
83 mrlock_init(&ip
->i_iolock
, MRLOCK_BARRIER
, "xfsio", ip
->i_ino
);
84 lockdep_set_class_and_name(&ip
->i_iolock
.mr_lock
,
85 &xfs_iolock_active
, "xfs_iolock_active");
87 /* initialise the xfs inode */
90 memset(&ip
->i_imap
, 0, sizeof(struct xfs_imap
));
92 memset(&ip
->i_df
, 0, sizeof(xfs_ifork_t
));
94 ip
->i_update_core
= 0;
95 ip
->i_delayed_blks
= 0;
96 memset(&ip
->i_d
, 0, sizeof(xfs_icdinode_t
));
102 xfs_inode_free_callback(
103 struct rcu_head
*head
)
105 struct inode
*inode
= container_of(head
, struct inode
, i_rcu
);
106 struct xfs_inode
*ip
= XFS_I(inode
);
108 kmem_zone_free(xfs_inode_zone
, ip
);
113 struct xfs_inode
*ip
)
115 switch (ip
->i_d
.di_mode
& S_IFMT
) {
119 xfs_idestroy_fork(ip
, XFS_DATA_FORK
);
124 xfs_idestroy_fork(ip
, XFS_ATTR_FORK
);
128 * Only if we are shutting down the fs will we see an
129 * inode still in the AIL. If it is there, we should remove
130 * it to prevent a use-after-free from occurring.
132 xfs_log_item_t
*lip
= &ip
->i_itemp
->ili_item
;
133 struct xfs_ail
*ailp
= lip
->li_ailp
;
135 ASSERT(((lip
->li_flags
& XFS_LI_IN_AIL
) == 0) ||
136 XFS_FORCED_SHUTDOWN(ip
->i_mount
));
137 if (lip
->li_flags
& XFS_LI_IN_AIL
) {
138 spin_lock(&ailp
->xa_lock
);
139 if (lip
->li_flags
& XFS_LI_IN_AIL
)
140 xfs_trans_ail_delete(ailp
, lip
);
142 spin_unlock(&ailp
->xa_lock
);
144 xfs_inode_item_destroy(ip
);
148 /* asserts to verify all state is correct here */
149 ASSERT(atomic_read(&ip
->i_pincount
) == 0);
150 ASSERT(!spin_is_locked(&ip
->i_flags_lock
));
151 ASSERT(!xfs_isiflocked(ip
));
154 * Because we use RCU freeing we need to ensure the inode always
155 * appears to be reclaimed with an invalid inode number when in the
156 * free state. The ip->i_flags_lock provides the barrier against lookup
159 spin_lock(&ip
->i_flags_lock
);
160 ip
->i_flags
= XFS_IRECLAIM
;
162 spin_unlock(&ip
->i_flags_lock
);
164 call_rcu(&VFS_I(ip
)->i_rcu
, xfs_inode_free_callback
);
168 * Check the validity of the inode we just found it the cache
172 struct xfs_perag
*pag
,
173 struct xfs_inode
*ip
,
176 int lock_flags
) __releases(RCU
)
178 struct inode
*inode
= VFS_I(ip
);
179 struct xfs_mount
*mp
= ip
->i_mount
;
183 * check for re-use of an inode within an RCU grace period due to the
184 * radix tree nodes not being updated yet. We monitor for this by
185 * setting the inode number to zero before freeing the inode structure.
186 * If the inode has been reallocated and set up, then the inode number
187 * will not match, so check for that, too.
189 spin_lock(&ip
->i_flags_lock
);
190 if (ip
->i_ino
!= ino
) {
191 trace_xfs_iget_skip(ip
);
192 XFS_STATS_INC(xs_ig_frecycle
);
199 * If we are racing with another cache hit that is currently
200 * instantiating this inode or currently recycling it out of
201 * reclaimabe state, wait for the initialisation to complete
204 * XXX(hch): eventually we should do something equivalent to
205 * wait_on_inode to wait for these flags to be cleared
206 * instead of polling for it.
208 if (ip
->i_flags
& (XFS_INEW
|XFS_IRECLAIM
)) {
209 trace_xfs_iget_skip(ip
);
210 XFS_STATS_INC(xs_ig_frecycle
);
216 * If lookup is racing with unlink return an error immediately.
218 if (ip
->i_d
.di_mode
== 0 && !(flags
& XFS_IGET_CREATE
)) {
224 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
225 * Need to carefully get it back into useable state.
227 if (ip
->i_flags
& XFS_IRECLAIMABLE
) {
228 trace_xfs_iget_reclaim(ip
);
231 * We need to set XFS_IRECLAIM to prevent xfs_reclaim_inode
232 * from stomping over us while we recycle the inode. We can't
233 * clear the radix tree reclaimable tag yet as it requires
234 * pag_ici_lock to be held exclusive.
236 ip
->i_flags
|= XFS_IRECLAIM
;
238 spin_unlock(&ip
->i_flags_lock
);
241 error
= -inode_init_always(mp
->m_super
, inode
);
244 * Re-initializing the inode failed, and we are in deep
245 * trouble. Try to re-add it to the reclaim list.
248 spin_lock(&ip
->i_flags_lock
);
250 ip
->i_flags
&= ~(XFS_INEW
| XFS_IRECLAIM
);
251 ASSERT(ip
->i_flags
& XFS_IRECLAIMABLE
);
252 trace_xfs_iget_reclaim_fail(ip
);
256 spin_lock(&pag
->pag_ici_lock
);
257 spin_lock(&ip
->i_flags_lock
);
260 * Clear the per-lifetime state in the inode as we are now
261 * effectively a new inode and need to return to the initial
262 * state before reuse occurs.
264 ip
->i_flags
&= ~XFS_IRECLAIM_RESET_FLAGS
;
265 ip
->i_flags
|= XFS_INEW
;
266 __xfs_inode_clear_reclaim_tag(mp
, pag
, ip
);
267 inode
->i_state
= I_NEW
;
269 ASSERT(!rwsem_is_locked(&ip
->i_iolock
.mr_lock
));
270 mrlock_init(&ip
->i_iolock
, MRLOCK_BARRIER
, "xfsio", ip
->i_ino
);
271 lockdep_set_class_and_name(&ip
->i_iolock
.mr_lock
,
272 &xfs_iolock_active
, "xfs_iolock_active");
274 spin_unlock(&ip
->i_flags_lock
);
275 spin_unlock(&pag
->pag_ici_lock
);
277 /* If the VFS inode is being torn down, pause and try again. */
279 trace_xfs_iget_skip(ip
);
284 /* We've got a live one. */
285 spin_unlock(&ip
->i_flags_lock
);
287 trace_xfs_iget_hit(ip
);
291 xfs_ilock(ip
, lock_flags
);
293 xfs_iflags_clear(ip
, XFS_ISTALE
);
294 XFS_STATS_INC(xs_ig_found
);
299 spin_unlock(&ip
->i_flags_lock
);
307 struct xfs_mount
*mp
,
308 struct xfs_perag
*pag
,
311 struct xfs_inode
**ipp
,
315 struct xfs_inode
*ip
;
317 xfs_agino_t agino
= XFS_INO_TO_AGINO(mp
, ino
);
319 ip
= xfs_inode_alloc(mp
, ino
);
323 error
= xfs_iread(mp
, tp
, ip
, flags
);
327 trace_xfs_iget_miss(ip
);
329 if ((ip
->i_d
.di_mode
== 0) && !(flags
& XFS_IGET_CREATE
)) {
335 * Preload the radix tree so we can insert safely under the
336 * write spinlock. Note that we cannot sleep inside the preload
339 if (radix_tree_preload(GFP_KERNEL
)) {
345 * Because the inode hasn't been added to the radix-tree yet it can't
346 * be found by another thread, so we can do the non-sleeping lock here.
349 if (!xfs_ilock_nowait(ip
, lock_flags
))
353 spin_lock(&pag
->pag_ici_lock
);
355 /* insert the new inode */
356 error
= radix_tree_insert(&pag
->pag_ici_root
, agino
, ip
);
357 if (unlikely(error
)) {
358 WARN_ON(error
!= -EEXIST
);
359 XFS_STATS_INC(xs_ig_dup
);
361 goto out_preload_end
;
364 /* These values _must_ be set before releasing the radix tree lock! */
365 ip
->i_udquot
= ip
->i_gdquot
= NULL
;
366 xfs_iflags_set(ip
, XFS_INEW
);
368 spin_unlock(&pag
->pag_ici_lock
);
369 radix_tree_preload_end();
375 spin_unlock(&pag
->pag_ici_lock
);
376 radix_tree_preload_end();
378 xfs_iunlock(ip
, lock_flags
);
380 __destroy_inode(VFS_I(ip
));
386 * Look up an inode by number in the given file system.
387 * The inode is looked up in the cache held in each AG.
388 * If the inode is found in the cache, initialise the vfs inode
391 * If it is not in core, read it in from the file system's device,
392 * add it to the cache and initialise the vfs inode.
394 * The inode is locked according to the value of the lock_flags parameter.
395 * This flag parameter indicates how and if the inode's IO lock and inode lock
398 * mp -- the mount point structure for the current file system. It points
399 * to the inode hash table.
400 * tp -- a pointer to the current transaction if there is one. This is
401 * simply passed through to the xfs_iread() call.
402 * ino -- the number of the inode desired. This is the unique identifier
403 * within the file system for the inode being requested.
404 * lock_flags -- flags indicating how to lock the inode. See the comment
405 * for xfs_ilock() for a list of valid values.
421 /* reject inode numbers outside existing AGs */
422 if (!ino
|| XFS_INO_TO_AGNO(mp
, ino
) >= mp
->m_sb
.sb_agcount
)
425 /* get the perag structure and ensure that it's inode capable */
426 pag
= xfs_perag_get(mp
, XFS_INO_TO_AGNO(mp
, ino
));
427 agino
= XFS_INO_TO_AGINO(mp
, ino
);
432 ip
= radix_tree_lookup(&pag
->pag_ici_root
, agino
);
435 error
= xfs_iget_cache_hit(pag
, ip
, ino
, flags
, lock_flags
);
437 goto out_error_or_again
;
440 XFS_STATS_INC(xs_ig_missed
);
442 error
= xfs_iget_cache_miss(mp
, pag
, tp
, ino
, &ip
,
445 goto out_error_or_again
;
452 * If we have a real type for an on-disk inode, we can set ops(&unlock)
453 * now. If it's a new inode being created, xfs_ialloc will handle it.
455 if (xfs_iflags_test(ip
, XFS_INEW
) && ip
->i_d
.di_mode
!= 0)
460 if (error
== EAGAIN
) {
469 * This is a wrapper routine around the xfs_ilock() routine
470 * used to centralize some grungy code. It is used in places
471 * that wish to lock the inode solely for reading the extents.
472 * The reason these places can't just call xfs_ilock(SHARED)
473 * is that the inode lock also guards to bringing in of the
474 * extents from disk for a file in b-tree format. If the inode
475 * is in b-tree format, then we need to lock the inode exclusively
476 * until the extents are read in. Locking it exclusively all
477 * the time would limit our parallelism unnecessarily, though.
478 * What we do instead is check to see if the extents have been
479 * read in yet, and only lock the inode exclusively if they
482 * The function returns a value which should be given to the
483 * corresponding xfs_iunlock_map_shared(). This value is
484 * the mode in which the lock was actually taken.
487 xfs_ilock_map_shared(
492 if ((ip
->i_d
.di_format
== XFS_DINODE_FMT_BTREE
) &&
493 ((ip
->i_df
.if_flags
& XFS_IFEXTENTS
) == 0)) {
494 lock_mode
= XFS_ILOCK_EXCL
;
496 lock_mode
= XFS_ILOCK_SHARED
;
499 xfs_ilock(ip
, lock_mode
);
505 * This is simply the unlock routine to go with xfs_ilock_map_shared().
506 * All it does is call xfs_iunlock() with the given lock_mode.
509 xfs_iunlock_map_shared(
511 unsigned int lock_mode
)
513 xfs_iunlock(ip
, lock_mode
);
517 * The xfs inode contains 2 locks: a multi-reader lock called the
518 * i_iolock and a multi-reader lock called the i_lock. This routine
519 * allows either or both of the locks to be obtained.
521 * The 2 locks should always be ordered so that the IO lock is
522 * obtained first in order to prevent deadlock.
524 * ip -- the inode being locked
525 * lock_flags -- this parameter indicates the inode's locks
526 * to be locked. It can be:
531 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
532 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
533 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
534 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
542 * You can't set both SHARED and EXCL for the same lock,
543 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
544 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
546 ASSERT((lock_flags
& (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
)) !=
547 (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
));
548 ASSERT((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) !=
549 (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
550 ASSERT((lock_flags
& ~(XFS_LOCK_MASK
| XFS_LOCK_DEP_MASK
)) == 0);
552 if (lock_flags
& XFS_IOLOCK_EXCL
)
553 mrupdate_nested(&ip
->i_iolock
, XFS_IOLOCK_DEP(lock_flags
));
554 else if (lock_flags
& XFS_IOLOCK_SHARED
)
555 mraccess_nested(&ip
->i_iolock
, XFS_IOLOCK_DEP(lock_flags
));
557 if (lock_flags
& XFS_ILOCK_EXCL
)
558 mrupdate_nested(&ip
->i_lock
, XFS_ILOCK_DEP(lock_flags
));
559 else if (lock_flags
& XFS_ILOCK_SHARED
)
560 mraccess_nested(&ip
->i_lock
, XFS_ILOCK_DEP(lock_flags
));
562 trace_xfs_ilock(ip
, lock_flags
, _RET_IP_
);
566 * This is just like xfs_ilock(), except that the caller
567 * is guaranteed not to sleep. It returns 1 if it gets
568 * the requested locks and 0 otherwise. If the IO lock is
569 * obtained but the inode lock cannot be, then the IO lock
570 * is dropped before returning.
572 * ip -- the inode being locked
573 * lock_flags -- this parameter indicates the inode's locks to be
574 * to be locked. See the comment for xfs_ilock() for a list
583 * You can't set both SHARED and EXCL for the same lock,
584 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
585 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
587 ASSERT((lock_flags
& (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
)) !=
588 (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
));
589 ASSERT((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) !=
590 (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
591 ASSERT((lock_flags
& ~(XFS_LOCK_MASK
| XFS_LOCK_DEP_MASK
)) == 0);
593 if (lock_flags
& XFS_IOLOCK_EXCL
) {
594 if (!mrtryupdate(&ip
->i_iolock
))
596 } else if (lock_flags
& XFS_IOLOCK_SHARED
) {
597 if (!mrtryaccess(&ip
->i_iolock
))
600 if (lock_flags
& XFS_ILOCK_EXCL
) {
601 if (!mrtryupdate(&ip
->i_lock
))
602 goto out_undo_iolock
;
603 } else if (lock_flags
& XFS_ILOCK_SHARED
) {
604 if (!mrtryaccess(&ip
->i_lock
))
605 goto out_undo_iolock
;
607 trace_xfs_ilock_nowait(ip
, lock_flags
, _RET_IP_
);
611 if (lock_flags
& XFS_IOLOCK_EXCL
)
612 mrunlock_excl(&ip
->i_iolock
);
613 else if (lock_flags
& XFS_IOLOCK_SHARED
)
614 mrunlock_shared(&ip
->i_iolock
);
620 * xfs_iunlock() is used to drop the inode locks acquired with
621 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
622 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
623 * that we know which locks to drop.
625 * ip -- the inode being unlocked
626 * lock_flags -- this parameter indicates the inode's locks to be
627 * to be unlocked. See the comment for xfs_ilock() for a list
628 * of valid values for this parameter.
637 * You can't set both SHARED and EXCL for the same lock,
638 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
639 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
641 ASSERT((lock_flags
& (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
)) !=
642 (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
));
643 ASSERT((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) !=
644 (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
645 ASSERT((lock_flags
& ~(XFS_LOCK_MASK
| XFS_LOCK_DEP_MASK
)) == 0);
646 ASSERT(lock_flags
!= 0);
648 if (lock_flags
& XFS_IOLOCK_EXCL
)
649 mrunlock_excl(&ip
->i_iolock
);
650 else if (lock_flags
& XFS_IOLOCK_SHARED
)
651 mrunlock_shared(&ip
->i_iolock
);
653 if (lock_flags
& XFS_ILOCK_EXCL
)
654 mrunlock_excl(&ip
->i_lock
);
655 else if (lock_flags
& XFS_ILOCK_SHARED
)
656 mrunlock_shared(&ip
->i_lock
);
658 trace_xfs_iunlock(ip
, lock_flags
, _RET_IP_
);
662 * give up write locks. the i/o lock cannot be held nested
663 * if it is being demoted.
670 ASSERT(lock_flags
& (XFS_IOLOCK_EXCL
|XFS_ILOCK_EXCL
));
671 ASSERT((lock_flags
& ~(XFS_IOLOCK_EXCL
|XFS_ILOCK_EXCL
)) == 0);
673 if (lock_flags
& XFS_ILOCK_EXCL
)
674 mrdemote(&ip
->i_lock
);
675 if (lock_flags
& XFS_IOLOCK_EXCL
)
676 mrdemote(&ip
->i_iolock
);
678 trace_xfs_ilock_demote(ip
, lock_flags
, _RET_IP_
);
687 if (lock_flags
& (XFS_ILOCK_EXCL
|XFS_ILOCK_SHARED
)) {
688 if (!(lock_flags
& XFS_ILOCK_SHARED
))
689 return !!ip
->i_lock
.mr_writer
;
690 return rwsem_is_locked(&ip
->i_lock
.mr_lock
);
693 if (lock_flags
& (XFS_IOLOCK_EXCL
|XFS_IOLOCK_SHARED
)) {
694 if (!(lock_flags
& XFS_IOLOCK_SHARED
))
695 return !!ip
->i_iolock
.mr_writer
;
696 return rwsem_is_locked(&ip
->i_iolock
.mr_lock
);
706 struct xfs_inode
*ip
)
708 wait_queue_head_t
*wq
= bit_waitqueue(&ip
->i_flags
, __XFS_IFLOCK_BIT
);
709 DEFINE_WAIT_BIT(wait
, &ip
->i_flags
, __XFS_IFLOCK_BIT
);
712 prepare_to_wait_exclusive(wq
, &wait
.wait
, TASK_UNINTERRUPTIBLE
);
713 if (xfs_isiflocked(ip
))
715 } while (!xfs_iflock_nowait(ip
));
717 finish_wait(wq
, &wait
.wait
);