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"
29 #include "xfs_dmapi.h"
30 #include "xfs_mount.h"
31 #include "xfs_bmap_btree.h"
32 #include "xfs_alloc_btree.h"
33 #include "xfs_ialloc_btree.h"
34 #include "xfs_dir2_sf.h"
35 #include "xfs_attr_sf.h"
36 #include "xfs_dinode.h"
37 #include "xfs_inode.h"
38 #include "xfs_btree.h"
39 #include "xfs_ialloc.h"
40 #include "xfs_quota.h"
41 #include "xfs_utils.h"
42 #include "xfs_trans_priv.h"
43 #include "xfs_inode_item.h"
45 #include "xfs_btree_trace.h"
46 #include "xfs_trace.h"
50 * Allocate and initialise an xfs_inode.
52 STATIC
struct xfs_inode
*
60 * if this didn't occur in transactions, we could use
61 * KM_MAYFAIL and return NULL here on ENOMEM. Set the
62 * code up to do this anyway.
64 ip
= kmem_zone_alloc(xfs_inode_zone
, KM_SLEEP
);
67 if (inode_init_always(mp
->m_super
, VFS_I(ip
))) {
68 kmem_zone_free(xfs_inode_zone
, ip
);
72 ASSERT(atomic_read(&ip
->i_iocount
) == 0);
73 ASSERT(atomic_read(&ip
->i_pincount
) == 0);
74 ASSERT(!spin_is_locked(&ip
->i_flags_lock
));
75 ASSERT(completion_done(&ip
->i_flush
));
76 ASSERT(!rwsem_is_locked(&ip
->i_iolock
.mr_lock
));
78 mrlock_init(&ip
->i_iolock
, MRLOCK_BARRIER
, "xfsio", ip
->i_ino
);
80 /* initialise the xfs inode */
83 memset(&ip
->i_imap
, 0, sizeof(struct xfs_imap
));
85 memset(&ip
->i_df
, 0, sizeof(xfs_ifork_t
));
87 ip
->i_update_core
= 0;
88 ip
->i_delayed_blks
= 0;
89 memset(&ip
->i_d
, 0, sizeof(xfs_icdinode_t
));
93 /* prevent anyone from using this yet */
94 VFS_I(ip
)->i_state
= I_NEW
;
101 struct xfs_inode
*ip
)
103 switch (ip
->i_d
.di_mode
& S_IFMT
) {
107 xfs_idestroy_fork(ip
, XFS_DATA_FORK
);
112 xfs_idestroy_fork(ip
, XFS_ATTR_FORK
);
116 * Only if we are shutting down the fs will we see an
117 * inode still in the AIL. If it is there, we should remove
118 * it to prevent a use-after-free from occurring.
120 xfs_log_item_t
*lip
= &ip
->i_itemp
->ili_item
;
121 struct xfs_ail
*ailp
= lip
->li_ailp
;
123 ASSERT(((lip
->li_flags
& XFS_LI_IN_AIL
) == 0) ||
124 XFS_FORCED_SHUTDOWN(ip
->i_mount
));
125 if (lip
->li_flags
& XFS_LI_IN_AIL
) {
126 spin_lock(&ailp
->xa_lock
);
127 if (lip
->li_flags
& XFS_LI_IN_AIL
)
128 xfs_trans_ail_delete(ailp
, lip
);
130 spin_unlock(&ailp
->xa_lock
);
132 xfs_inode_item_destroy(ip
);
136 /* asserts to verify all state is correct here */
137 ASSERT(atomic_read(&ip
->i_iocount
) == 0);
138 ASSERT(atomic_read(&ip
->i_pincount
) == 0);
139 ASSERT(!spin_is_locked(&ip
->i_flags_lock
));
140 ASSERT(completion_done(&ip
->i_flush
));
142 kmem_zone_free(xfs_inode_zone
, ip
);
146 * Check the validity of the inode we just found it the cache
150 struct xfs_perag
*pag
,
151 struct xfs_inode
*ip
,
153 int lock_flags
) __releases(pag
->pag_ici_lock
)
155 struct inode
*inode
= VFS_I(ip
);
156 struct xfs_mount
*mp
= ip
->i_mount
;
159 spin_lock(&ip
->i_flags_lock
);
162 * If we are racing with another cache hit that is currently
163 * instantiating this inode or currently recycling it out of
164 * reclaimabe state, wait for the initialisation to complete
167 * XXX(hch): eventually we should do something equivalent to
168 * wait_on_inode to wait for these flags to be cleared
169 * instead of polling for it.
171 if (ip
->i_flags
& (XFS_INEW
|XFS_IRECLAIM
)) {
172 trace_xfs_iget_skip(ip
);
173 XFS_STATS_INC(xs_ig_frecycle
);
179 * If lookup is racing with unlink return an error immediately.
181 if (ip
->i_d
.di_mode
== 0 && !(flags
& XFS_IGET_CREATE
)) {
187 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
188 * Need to carefully get it back into useable state.
190 if (ip
->i_flags
& XFS_IRECLAIMABLE
) {
191 trace_xfs_iget_reclaim(ip
);
194 * We need to set XFS_INEW atomically with clearing the
195 * reclaimable tag so that we do have an indicator of the
196 * inode still being initialized.
198 ip
->i_flags
|= XFS_INEW
;
199 ip
->i_flags
&= ~XFS_IRECLAIMABLE
;
200 __xfs_inode_clear_reclaim_tag(mp
, pag
, ip
);
202 spin_unlock(&ip
->i_flags_lock
);
203 read_unlock(&pag
->pag_ici_lock
);
205 error
= -inode_init_always(mp
->m_super
, inode
);
208 * Re-initializing the inode failed, and we are in deep
209 * trouble. Try to re-add it to the reclaim list.
211 read_lock(&pag
->pag_ici_lock
);
212 spin_lock(&ip
->i_flags_lock
);
214 ip
->i_flags
&= ~XFS_INEW
;
215 ip
->i_flags
|= XFS_IRECLAIMABLE
;
216 __xfs_inode_set_reclaim_tag(pag
, ip
);
217 trace_xfs_iget_reclaim(ip
);
220 inode
->i_state
= I_NEW
;
222 /* If the VFS inode is being torn down, pause and try again. */
228 /* We've got a live one. */
229 spin_unlock(&ip
->i_flags_lock
);
230 read_unlock(&pag
->pag_ici_lock
);
234 xfs_ilock(ip
, lock_flags
);
236 xfs_iflags_clear(ip
, XFS_ISTALE
);
237 XFS_STATS_INC(xs_ig_found
);
239 trace_xfs_iget_found(ip
);
243 spin_unlock(&ip
->i_flags_lock
);
244 read_unlock(&pag
->pag_ici_lock
);
251 struct xfs_mount
*mp
,
252 struct xfs_perag
*pag
,
255 struct xfs_inode
**ipp
,
260 struct xfs_inode
*ip
;
262 unsigned long first_index
, mask
;
263 xfs_agino_t agino
= XFS_INO_TO_AGINO(mp
, ino
);
265 ip
= xfs_inode_alloc(mp
, ino
);
269 error
= xfs_iread(mp
, tp
, ip
, bno
, flags
);
273 xfs_itrace_entry(ip
);
275 if ((ip
->i_d
.di_mode
== 0) && !(flags
& XFS_IGET_CREATE
)) {
281 * Preload the radix tree so we can insert safely under the
282 * write spinlock. Note that we cannot sleep inside the preload
285 if (radix_tree_preload(GFP_KERNEL
)) {
291 * Because the inode hasn't been added to the radix-tree yet it can't
292 * be found by another thread, so we can do the non-sleeping lock here.
295 if (!xfs_ilock_nowait(ip
, lock_flags
))
299 mask
= ~(((XFS_INODE_CLUSTER_SIZE(mp
) >> mp
->m_sb
.sb_inodelog
)) - 1);
300 first_index
= agino
& mask
;
301 write_lock(&pag
->pag_ici_lock
);
303 /* insert the new inode */
304 error
= radix_tree_insert(&pag
->pag_ici_root
, agino
, ip
);
305 if (unlikely(error
)) {
306 WARN_ON(error
!= -EEXIST
);
307 XFS_STATS_INC(xs_ig_dup
);
309 goto out_preload_end
;
312 /* These values _must_ be set before releasing the radix tree lock! */
313 ip
->i_udquot
= ip
->i_gdquot
= NULL
;
314 xfs_iflags_set(ip
, XFS_INEW
);
316 write_unlock(&pag
->pag_ici_lock
);
317 radix_tree_preload_end();
319 trace_xfs_iget_alloc(ip
);
324 write_unlock(&pag
->pag_ici_lock
);
325 radix_tree_preload_end();
327 xfs_iunlock(ip
, lock_flags
);
329 __destroy_inode(VFS_I(ip
));
335 * Look up an inode by number in the given file system.
336 * The inode is looked up in the cache held in each AG.
337 * If the inode is found in the cache, initialise the vfs inode
340 * If it is not in core, read it in from the file system's device,
341 * add it to the cache and initialise the vfs inode.
343 * The inode is locked according to the value of the lock_flags parameter.
344 * This flag parameter indicates how and if the inode's IO lock and inode lock
347 * mp -- the mount point structure for the current file system. It points
348 * to the inode hash table.
349 * tp -- a pointer to the current transaction if there is one. This is
350 * simply passed through to the xfs_iread() call.
351 * ino -- the number of the inode desired. This is the unique identifier
352 * within the file system for the inode being requested.
353 * lock_flags -- flags indicating how to lock the inode. See the comment
354 * for xfs_ilock() for a list of valid values.
355 * bno -- the block number starting the buffer containing the inode,
356 * if known (as by bulkstat), else 0.
373 /* the radix tree exists only in inode capable AGs */
374 if (XFS_INO_TO_AGNO(mp
, ino
) >= mp
->m_maxagi
)
377 /* get the perag structure and ensure that it's inode capable */
378 pag
= xfs_get_perag(mp
, ino
);
379 if (!pag
->pagi_inodeok
)
381 ASSERT(pag
->pag_ici_init
);
382 agino
= XFS_INO_TO_AGINO(mp
, ino
);
386 read_lock(&pag
->pag_ici_lock
);
387 ip
= radix_tree_lookup(&pag
->pag_ici_root
, agino
);
390 error
= xfs_iget_cache_hit(pag
, ip
, flags
, lock_flags
);
392 goto out_error_or_again
;
394 read_unlock(&pag
->pag_ici_lock
);
395 XFS_STATS_INC(xs_ig_missed
);
397 error
= xfs_iget_cache_miss(mp
, pag
, tp
, ino
, &ip
, bno
,
400 goto out_error_or_again
;
402 xfs_put_perag(mp
, pag
);
406 ASSERT(ip
->i_df
.if_ext_max
==
407 XFS_IFORK_DSIZE(ip
) / sizeof(xfs_bmbt_rec_t
));
409 * If we have a real type for an on-disk inode, we can set ops(&unlock)
410 * now. If it's a new inode being created, xfs_ialloc will handle it.
412 if (xfs_iflags_test(ip
, XFS_INEW
) && ip
->i_d
.di_mode
!= 0)
417 if (error
== EAGAIN
) {
421 xfs_put_perag(mp
, pag
);
426 * Decrement reference count of an inode structure and unlock it.
428 * ip -- the inode being released
429 * lock_flags -- this parameter indicates the inode's locks to be
430 * to be released. See the comment on xfs_iunlock() for a list
434 xfs_iput(xfs_inode_t
*ip
,
437 xfs_itrace_entry(ip
);
438 xfs_iunlock(ip
, lock_flags
);
443 * Special iput for brand-new inodes that are still locked
450 struct inode
*inode
= VFS_I(ip
);
452 xfs_itrace_entry(ip
);
454 if ((ip
->i_d
.di_mode
== 0)) {
455 ASSERT(!xfs_iflags_test(ip
, XFS_IRECLAIMABLE
));
456 make_bad_inode(inode
);
458 if (inode
->i_state
& I_NEW
)
459 unlock_new_inode(inode
);
461 xfs_iunlock(ip
, lock_flags
);
466 * This is called free all the memory associated with an inode.
467 * It must free the inode itself and any buffers allocated for
468 * if_extents/if_data and if_broot. It must also free the lock
469 * associated with the inode.
471 * Note: because we don't initialise everything on reallocation out
472 * of the zone, we must ensure we nullify everything correctly before
473 * freeing the structure.
477 struct xfs_inode
*ip
)
479 struct xfs_mount
*mp
= ip
->i_mount
;
480 struct xfs_perag
*pag
;
481 xfs_agino_t agino
= XFS_INO_TO_AGINO(mp
, ip
->i_ino
);
483 XFS_STATS_INC(xs_ig_reclaims
);
486 * Remove the inode from the per-AG radix tree.
488 * Because radix_tree_delete won't complain even if the item was never
489 * added to the tree assert that it's been there before to catch
490 * problems with the inode life time early on.
492 pag
= xfs_get_perag(mp
, ip
->i_ino
);
493 write_lock(&pag
->pag_ici_lock
);
494 if (!radix_tree_delete(&pag
->pag_ici_root
, agino
))
496 write_unlock(&pag
->pag_ici_lock
);
497 xfs_put_perag(mp
, pag
);
500 * Here we do an (almost) spurious inode lock in order to coordinate
501 * with inode cache radix tree lookups. This is because the lookup
502 * can reference the inodes in the cache without taking references.
504 * We make that OK here by ensuring that we wait until the inode is
505 * unlocked after the lookup before we go ahead and free it. We get
506 * both the ilock and the iolock because the code may need to drop the
507 * ilock one but will still hold the iolock.
509 xfs_ilock(ip
, XFS_ILOCK_EXCL
| XFS_IOLOCK_EXCL
);
511 xfs_iunlock(ip
, XFS_ILOCK_EXCL
| XFS_IOLOCK_EXCL
);
517 * This is a wrapper routine around the xfs_ilock() routine
518 * used to centralize some grungy code. It is used in places
519 * that wish to lock the inode solely for reading the extents.
520 * The reason these places can't just call xfs_ilock(SHARED)
521 * is that the inode lock also guards to bringing in of the
522 * extents from disk for a file in b-tree format. If the inode
523 * is in b-tree format, then we need to lock the inode exclusively
524 * until the extents are read in. Locking it exclusively all
525 * the time would limit our parallelism unnecessarily, though.
526 * What we do instead is check to see if the extents have been
527 * read in yet, and only lock the inode exclusively if they
530 * The function returns a value which should be given to the
531 * corresponding xfs_iunlock_map_shared(). This value is
532 * the mode in which the lock was actually taken.
535 xfs_ilock_map_shared(
540 if ((ip
->i_d
.di_format
== XFS_DINODE_FMT_BTREE
) &&
541 ((ip
->i_df
.if_flags
& XFS_IFEXTENTS
) == 0)) {
542 lock_mode
= XFS_ILOCK_EXCL
;
544 lock_mode
= XFS_ILOCK_SHARED
;
547 xfs_ilock(ip
, lock_mode
);
553 * This is simply the unlock routine to go with xfs_ilock_map_shared().
554 * All it does is call xfs_iunlock() with the given lock_mode.
557 xfs_iunlock_map_shared(
559 unsigned int lock_mode
)
561 xfs_iunlock(ip
, lock_mode
);
565 * The xfs inode contains 2 locks: a multi-reader lock called the
566 * i_iolock and a multi-reader lock called the i_lock. This routine
567 * allows either or both of the locks to be obtained.
569 * The 2 locks should always be ordered so that the IO lock is
570 * obtained first in order to prevent deadlock.
572 * ip -- the inode being locked
573 * lock_flags -- this parameter indicates the inode's locks
574 * to be locked. It can be:
579 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
580 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
581 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
582 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
590 * You can't set both SHARED and EXCL for the same lock,
591 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
592 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
594 ASSERT((lock_flags
& (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
)) !=
595 (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
));
596 ASSERT((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) !=
597 (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
598 ASSERT((lock_flags
& ~(XFS_LOCK_MASK
| XFS_LOCK_DEP_MASK
)) == 0);
600 if (lock_flags
& XFS_IOLOCK_EXCL
)
601 mrupdate_nested(&ip
->i_iolock
, XFS_IOLOCK_DEP(lock_flags
));
602 else if (lock_flags
& XFS_IOLOCK_SHARED
)
603 mraccess_nested(&ip
->i_iolock
, XFS_IOLOCK_DEP(lock_flags
));
605 if (lock_flags
& XFS_ILOCK_EXCL
)
606 mrupdate_nested(&ip
->i_lock
, XFS_ILOCK_DEP(lock_flags
));
607 else if (lock_flags
& XFS_ILOCK_SHARED
)
608 mraccess_nested(&ip
->i_lock
, XFS_ILOCK_DEP(lock_flags
));
610 trace_xfs_ilock(ip
, lock_flags
, _RET_IP_
);
614 * This is just like xfs_ilock(), except that the caller
615 * is guaranteed not to sleep. It returns 1 if it gets
616 * the requested locks and 0 otherwise. If the IO lock is
617 * obtained but the inode lock cannot be, then the IO lock
618 * is dropped before returning.
620 * ip -- the inode being locked
621 * lock_flags -- this parameter indicates the inode's locks to be
622 * to be locked. See the comment for xfs_ilock() for a list
631 * You can't set both SHARED and EXCL for the same lock,
632 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
633 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
635 ASSERT((lock_flags
& (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
)) !=
636 (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
));
637 ASSERT((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) !=
638 (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
639 ASSERT((lock_flags
& ~(XFS_LOCK_MASK
| XFS_LOCK_DEP_MASK
)) == 0);
641 if (lock_flags
& XFS_IOLOCK_EXCL
) {
642 if (!mrtryupdate(&ip
->i_iolock
))
644 } else if (lock_flags
& XFS_IOLOCK_SHARED
) {
645 if (!mrtryaccess(&ip
->i_iolock
))
648 if (lock_flags
& XFS_ILOCK_EXCL
) {
649 if (!mrtryupdate(&ip
->i_lock
))
650 goto out_undo_iolock
;
651 } else if (lock_flags
& XFS_ILOCK_SHARED
) {
652 if (!mrtryaccess(&ip
->i_lock
))
653 goto out_undo_iolock
;
655 trace_xfs_ilock_nowait(ip
, lock_flags
, _RET_IP_
);
659 if (lock_flags
& XFS_IOLOCK_EXCL
)
660 mrunlock_excl(&ip
->i_iolock
);
661 else if (lock_flags
& XFS_IOLOCK_SHARED
)
662 mrunlock_shared(&ip
->i_iolock
);
668 * xfs_iunlock() is used to drop the inode locks acquired with
669 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
670 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
671 * that we know which locks to drop.
673 * ip -- the inode being unlocked
674 * lock_flags -- this parameter indicates the inode's locks to be
675 * to be unlocked. See the comment for xfs_ilock() for a list
676 * of valid values for this parameter.
685 * You can't set both SHARED and EXCL for the same lock,
686 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
687 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
689 ASSERT((lock_flags
& (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
)) !=
690 (XFS_IOLOCK_SHARED
| XFS_IOLOCK_EXCL
));
691 ASSERT((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) !=
692 (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
693 ASSERT((lock_flags
& ~(XFS_LOCK_MASK
| XFS_IUNLOCK_NONOTIFY
|
694 XFS_LOCK_DEP_MASK
)) == 0);
695 ASSERT(lock_flags
!= 0);
697 if (lock_flags
& XFS_IOLOCK_EXCL
)
698 mrunlock_excl(&ip
->i_iolock
);
699 else if (lock_flags
& XFS_IOLOCK_SHARED
)
700 mrunlock_shared(&ip
->i_iolock
);
702 if (lock_flags
& XFS_ILOCK_EXCL
)
703 mrunlock_excl(&ip
->i_lock
);
704 else if (lock_flags
& XFS_ILOCK_SHARED
)
705 mrunlock_shared(&ip
->i_lock
);
707 if ((lock_flags
& (XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
)) &&
708 !(lock_flags
& XFS_IUNLOCK_NONOTIFY
) && ip
->i_itemp
) {
710 * Let the AIL know that this item has been unlocked in case
711 * it is in the AIL and anyone is waiting on it. Don't do
712 * this if the caller has asked us not to.
714 xfs_trans_unlocked_item(ip
->i_itemp
->ili_item
.li_ailp
,
715 (xfs_log_item_t
*)(ip
->i_itemp
));
717 trace_xfs_iunlock(ip
, lock_flags
, _RET_IP_
);
721 * give up write locks. the i/o lock cannot be held nested
722 * if it is being demoted.
729 ASSERT(lock_flags
& (XFS_IOLOCK_EXCL
|XFS_ILOCK_EXCL
));
730 ASSERT((lock_flags
& ~(XFS_IOLOCK_EXCL
|XFS_ILOCK_EXCL
)) == 0);
732 if (lock_flags
& XFS_ILOCK_EXCL
)
733 mrdemote(&ip
->i_lock
);
734 if (lock_flags
& XFS_IOLOCK_EXCL
)
735 mrdemote(&ip
->i_iolock
);
737 trace_xfs_ilock_demote(ip
, lock_flags
, _RET_IP_
);
742 * Debug-only routine, without additional rw_semaphore APIs, we can
743 * now only answer requests regarding whether we hold the lock for write
744 * (reader state is outside our visibility, we only track writer state).
746 * Note: this means !xfs_isilocked would give false positives, so don't do that.
753 if ((lock_flags
& (XFS_ILOCK_EXCL
|XFS_ILOCK_SHARED
)) ==
755 if (!ip
->i_lock
.mr_writer
)
759 if ((lock_flags
& (XFS_IOLOCK_EXCL
|XFS_IOLOCK_SHARED
)) ==
761 if (!ip
->i_iolock
.mr_writer
)