blob: 3631783b2b5385ee939a61e5cafd5b06ef6b0a45 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include "xfs.h"
Nathan Scotta844f452005-11-02 14:38:42 +110019#include "xfs_fs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include "xfs_types.h"
Christoph Hellwigef14f0c2009-06-10 17:07:47 +020021#include "xfs_acl.h"
Nathan Scotta844f452005-11-02 14:38:42 +110022#include "xfs_bit.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include "xfs_log.h"
Nathan Scotta844f452005-11-02 14:38:42 +110024#include "xfs_inum.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include "xfs_trans.h"
26#include "xfs_sb.h"
27#include "xfs_ag.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include "xfs_mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include "xfs_bmap_btree.h"
Nathan Scotta844f452005-11-02 14:38:42 +110030#include "xfs_alloc_btree.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "xfs_ialloc_btree.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include "xfs_dinode.h"
33#include "xfs_inode.h"
Nathan Scotta844f452005-11-02 14:38:42 +110034#include "xfs_btree.h"
35#include "xfs_ialloc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include "xfs_quota.h"
37#include "xfs_utils.h"
David Chinner783a2f62008-10-30 17:39:58 +110038#include "xfs_trans_priv.h"
39#include "xfs_inode_item.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110040#include "xfs_bmap.h"
41#include "xfs_btree_trace.h"
Christoph Hellwig0b1b2132009-12-14 23:14:59 +000042#include "xfs_trace.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110043
44
45/*
Dave Chinnerdcfcf202010-12-23 11:57:13 +110046 * Define xfs inode iolock lockdep classes. We need to ensure that all active
47 * inodes are considered the same for lockdep purposes, including inodes that
48 * are recycled through the XFS_IRECLAIMABLE state. This is the the only way to
49 * guarantee the locks are considered the same when there are multiple lock
50 * initialisation siteѕ. Also, define a reclaimable inode class so it is
51 * obvious in lockdep reports which class the report is against.
52 */
53static struct lock_class_key xfs_iolock_active;
54struct lock_class_key xfs_iolock_reclaimable;
55
56/*
Christoph Hellwig24f211b2008-11-28 14:23:42 +110057 * Allocate and initialise an xfs_inode.
58 */
59STATIC struct xfs_inode *
60xfs_inode_alloc(
61 struct xfs_mount *mp,
62 xfs_ino_t ino)
63{
64 struct xfs_inode *ip;
65
66 /*
67 * if this didn't occur in transactions, we could use
68 * KM_MAYFAIL and return NULL here on ENOMEM. Set the
69 * code up to do this anyway.
70 */
71 ip = kmem_zone_alloc(xfs_inode_zone, KM_SLEEP);
72 if (!ip)
73 return NULL;
Christoph Hellwig54e34622009-08-07 14:38:25 -030074 if (inode_init_always(mp->m_super, VFS_I(ip))) {
75 kmem_zone_free(xfs_inode_zone, ip);
76 return NULL;
77 }
Christoph Hellwig24f211b2008-11-28 14:23:42 +110078
79 ASSERT(atomic_read(&ip->i_iocount) == 0);
80 ASSERT(atomic_read(&ip->i_pincount) == 0);
81 ASSERT(!spin_is_locked(&ip->i_flags_lock));
82 ASSERT(completion_done(&ip->i_flush));
Dave Chinner1a3e8f32010-12-17 17:29:43 +110083 ASSERT(ip->i_ino == 0);
Christoph Hellwig033da482009-10-19 04:05:26 +000084
85 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
Dave Chinnerdcfcf202010-12-23 11:57:13 +110086 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
87 &xfs_iolock_active, "xfs_iolock_active");
Christoph Hellwig24f211b2008-11-28 14:23:42 +110088
Christoph Hellwig24f211b2008-11-28 14:23:42 +110089 /* initialise the xfs inode */
90 ip->i_ino = ino;
91 ip->i_mount = mp;
92 memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
93 ip->i_afp = NULL;
94 memset(&ip->i_df, 0, sizeof(xfs_ifork_t));
95 ip->i_flags = 0;
96 ip->i_update_core = 0;
Christoph Hellwig24f211b2008-11-28 14:23:42 +110097 ip->i_delayed_blks = 0;
98 memset(&ip->i_d, 0, sizeof(xfs_icdinode_t));
99 ip->i_size = 0;
100 ip->i_new_size = 0;
101
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100102 return ip;
103}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Nick Pigginfa0d7e32011-01-07 17:49:49 +1100105STATIC void
106xfs_inode_free_callback(
107 struct rcu_head *head)
108{
109 struct inode *inode = container_of(head, struct inode, i_rcu);
110 struct xfs_inode *ip = XFS_I(inode);
111
112 INIT_LIST_HEAD(&inode->i_dentry);
113 kmem_zone_free(xfs_inode_zone, ip);
114}
115
Dave Chinner2f11fea2010-07-20 17:53:25 +1000116void
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300117xfs_inode_free(
118 struct xfs_inode *ip)
119{
120 switch (ip->i_d.di_mode & S_IFMT) {
121 case S_IFREG:
122 case S_IFDIR:
123 case S_IFLNK:
124 xfs_idestroy_fork(ip, XFS_DATA_FORK);
125 break;
126 }
127
128 if (ip->i_afp)
129 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
130
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300131 if (ip->i_itemp) {
132 /*
133 * Only if we are shutting down the fs will we see an
134 * inode still in the AIL. If it is there, we should remove
135 * it to prevent a use-after-free from occurring.
136 */
137 xfs_log_item_t *lip = &ip->i_itemp->ili_item;
138 struct xfs_ail *ailp = lip->li_ailp;
139
140 ASSERT(((lip->li_flags & XFS_LI_IN_AIL) == 0) ||
141 XFS_FORCED_SHUTDOWN(ip->i_mount));
142 if (lip->li_flags & XFS_LI_IN_AIL) {
143 spin_lock(&ailp->xa_lock);
144 if (lip->li_flags & XFS_LI_IN_AIL)
145 xfs_trans_ail_delete(ailp, lip);
146 else
147 spin_unlock(&ailp->xa_lock);
148 }
149 xfs_inode_item_destroy(ip);
150 ip->i_itemp = NULL;
151 }
152
153 /* asserts to verify all state is correct here */
154 ASSERT(atomic_read(&ip->i_iocount) == 0);
155 ASSERT(atomic_read(&ip->i_pincount) == 0);
156 ASSERT(!spin_is_locked(&ip->i_flags_lock));
157 ASSERT(completion_done(&ip->i_flush));
158
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100159 /*
160 * Because we use RCU freeing we need to ensure the inode always
161 * appears to be reclaimed with an invalid inode number when in the
162 * free state. The ip->i_flags_lock provides the barrier against lookup
163 * races.
164 */
165 spin_lock(&ip->i_flags_lock);
166 ip->i_flags = XFS_IRECLAIM;
167 ip->i_ino = 0;
168 spin_unlock(&ip->i_flags_lock);
Alex Elder92f1c002011-01-10 21:35:55 -0600169
170 call_rcu(&VFS_I(ip)->i_rcu, xfs_inode_free_callback);
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300171}
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/*
David Chinner6441e542008-10-30 17:21:19 +1100174 * Check the validity of the inode we just found it the cache
175 */
176static int
177xfs_iget_cache_hit(
David Chinner6441e542008-10-30 17:21:19 +1100178 struct xfs_perag *pag,
179 struct xfs_inode *ip,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100180 xfs_ino_t ino,
David Chinner6441e542008-10-30 17:21:19 +1100181 int flags,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100182 int lock_flags) __releases(RCU)
David Chinner6441e542008-10-30 17:21:19 +1100183{
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400184 struct inode *inode = VFS_I(ip);
David Chinner6441e542008-10-30 17:21:19 +1100185 struct xfs_mount *mp = ip->i_mount;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400186 int error;
187
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100188 /*
189 * check for re-use of an inode within an RCU grace period due to the
190 * radix tree nodes not being updated yet. We monitor for this by
191 * setting the inode number to zero before freeing the inode structure.
192 * If the inode has been reallocated and set up, then the inode number
193 * will not match, so check for that, too.
194 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400195 spin_lock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100196 if (ip->i_ino != ino) {
197 trace_xfs_iget_skip(ip);
198 XFS_STATS_INC(xs_ig_frecycle);
199 error = EAGAIN;
200 goto out_error;
201 }
202
David Chinner6441e542008-10-30 17:21:19 +1100203
204 /*
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400205 * If we are racing with another cache hit that is currently
206 * instantiating this inode or currently recycling it out of
207 * reclaimabe state, wait for the initialisation to complete
208 * before continuing.
209 *
210 * XXX(hch): eventually we should do something equivalent to
211 * wait_on_inode to wait for these flags to be cleared
212 * instead of polling for it.
David Chinner6441e542008-10-30 17:21:19 +1100213 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400214 if (ip->i_flags & (XFS_INEW|XFS_IRECLAIM)) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000215 trace_xfs_iget_skip(ip);
David Chinner6441e542008-10-30 17:21:19 +1100216 XFS_STATS_INC(xs_ig_frecycle);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400217 error = EAGAIN;
David Chinner6441e542008-10-30 17:21:19 +1100218 goto out_error;
219 }
220
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400221 /*
222 * If lookup is racing with unlink return an error immediately.
223 */
224 if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
225 error = ENOENT;
226 goto out_error;
227 }
David Chinner6441e542008-10-30 17:21:19 +1100228
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400229 /*
230 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
231 * Need to carefully get it back into useable state.
232 */
233 if (ip->i_flags & XFS_IRECLAIMABLE) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000234 trace_xfs_iget_reclaim(ip);
David Chinner6441e542008-10-30 17:21:19 +1100235
David Chinnerbf904242008-10-30 17:36:14 +1100236 /*
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000237 * We need to set XFS_IRECLAIM to prevent xfs_reclaim_inode
238 * from stomping over us while we recycle the inode. We can't
239 * clear the radix tree reclaimable tag yet as it requires
240 * pag_ici_lock to be held exclusive.
David Chinnerbf904242008-10-30 17:36:14 +1100241 */
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000242 ip->i_flags |= XFS_IRECLAIM;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400243
244 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100245 rcu_read_unlock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400246
247 error = -inode_init_always(mp->m_super, inode);
248 if (error) {
249 /*
250 * Re-initializing the inode failed, and we are in deep
251 * trouble. Try to re-add it to the reclaim list.
252 */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100253 rcu_read_lock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400254 spin_lock(&ip->i_flags_lock);
255
Dave Chinner778e24b2011-06-23 01:34:59 +0000256 ip->i_flags &= ~(XFS_INEW | XFS_IRECLAIM);
257 ASSERT(ip->i_flags & XFS_IRECLAIMABLE);
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000258 trace_xfs_iget_reclaim_fail(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400259 goto out_error;
260 }
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000261
Dave Chinner1a427ab2010-12-16 17:08:41 +1100262 spin_lock(&pag->pag_ici_lock);
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000263 spin_lock(&ip->i_flags_lock);
Dave Chinner778e24b2011-06-23 01:34:59 +0000264
265 /*
266 * Clear the per-lifetime state in the inode as we are now
267 * effectively a new inode and need to return to the initial
268 * state before reuse occurs.
269 */
270 ip->i_flags &= ~XFS_IRECLAIM_RESET_FLAGS;
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000271 ip->i_flags |= XFS_INEW;
272 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100273 inode->i_state = I_NEW;
Dave Chinnerdcfcf202010-12-23 11:57:13 +1100274
275 ASSERT(!rwsem_is_locked(&ip->i_iolock.mr_lock));
276 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
277 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
278 &xfs_iolock_active, "xfs_iolock_active");
279
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000280 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a427ab2010-12-16 17:08:41 +1100281 spin_unlock(&pag->pag_ici_lock);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400282 } else {
283 /* If the VFS inode is being torn down, pause and try again. */
284 if (!igrab(inode)) {
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000285 trace_xfs_iget_skip(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400286 error = EAGAIN;
David Chinnerbf904242008-10-30 17:36:14 +1100287 goto out_error;
288 }
David Chinner6bfb3d02008-10-30 18:32:43 +1100289
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400290 /* We've got a live one. */
291 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100292 rcu_read_unlock();
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000293 trace_xfs_iget_hit(ip);
David Chinner6441e542008-10-30 17:21:19 +1100294 }
295
David Chinner6441e542008-10-30 17:21:19 +1100296 if (lock_flags != 0)
297 xfs_ilock(ip, lock_flags);
298
299 xfs_iflags_clear(ip, XFS_ISTALE);
David Chinner6441e542008-10-30 17:21:19 +1100300 XFS_STATS_INC(xs_ig_found);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000301
David Chinner6441e542008-10-30 17:21:19 +1100302 return 0;
303
304out_error:
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400305 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100306 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100307 return error;
308}
309
310
311static int
312xfs_iget_cache_miss(
313 struct xfs_mount *mp,
314 struct xfs_perag *pag,
315 xfs_trans_t *tp,
316 xfs_ino_t ino,
317 struct xfs_inode **ipp,
David Chinner6441e542008-10-30 17:21:19 +1100318 int flags,
Christoph Hellwig0c3dc2b2009-11-14 16:17:23 +0000319 int lock_flags)
David Chinner6441e542008-10-30 17:21:19 +1100320{
321 struct xfs_inode *ip;
322 int error;
David Chinner6441e542008-10-30 17:21:19 +1100323 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
324
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100325 ip = xfs_inode_alloc(mp, ino);
326 if (!ip)
327 return ENOMEM;
328
Dave Chinner7b6259e2010-06-24 11:35:17 +1000329 error = xfs_iread(mp, tp, ip, flags);
David Chinner6441e542008-10-30 17:21:19 +1100330 if (error)
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100331 goto out_destroy;
David Chinner6441e542008-10-30 17:21:19 +1100332
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000333 trace_xfs_iget_miss(ip);
David Chinner6441e542008-10-30 17:21:19 +1100334
335 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
336 error = ENOENT;
337 goto out_destroy;
338 }
339
340 /*
341 * Preload the radix tree so we can insert safely under the
David Chinner56e73ec2008-10-30 17:55:27 +1100342 * write spinlock. Note that we cannot sleep inside the preload
343 * region.
David Chinner6441e542008-10-30 17:21:19 +1100344 */
345 if (radix_tree_preload(GFP_KERNEL)) {
346 error = EAGAIN;
Christoph Hellwiged93ec32009-03-03 14:48:35 -0500347 goto out_destroy;
348 }
349
350 /*
351 * Because the inode hasn't been added to the radix-tree yet it can't
352 * be found by another thread, so we can do the non-sleeping lock here.
353 */
354 if (lock_flags) {
355 if (!xfs_ilock_nowait(ip, lock_flags))
356 BUG();
David Chinner6441e542008-10-30 17:21:19 +1100357 }
358
Dave Chinner1a427ab2010-12-16 17:08:41 +1100359 spin_lock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100360
361 /* insert the new inode */
362 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
363 if (unlikely(error)) {
364 WARN_ON(error != -EEXIST);
365 XFS_STATS_INC(xs_ig_dup);
366 error = EAGAIN;
David Chinner56e73ec2008-10-30 17:55:27 +1100367 goto out_preload_end;
David Chinner6441e542008-10-30 17:21:19 +1100368 }
369
370 /* These values _must_ be set before releasing the radix tree lock! */
371 ip->i_udquot = ip->i_gdquot = NULL;
372 xfs_iflags_set(ip, XFS_INEW);
373
Dave Chinner1a427ab2010-12-16 17:08:41 +1100374 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100375 radix_tree_preload_end();
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000376
David Chinner6441e542008-10-30 17:21:19 +1100377 *ipp = ip;
378 return 0;
379
David Chinner56e73ec2008-10-30 17:55:27 +1100380out_preload_end:
Dave Chinner1a427ab2010-12-16 17:08:41 +1100381 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100382 radix_tree_preload_end();
David Chinner56e73ec2008-10-30 17:55:27 +1100383 if (lock_flags)
384 xfs_iunlock(ip, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100385out_destroy:
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300386 __destroy_inode(VFS_I(ip));
387 xfs_inode_free(ip);
David Chinner6441e542008-10-30 17:21:19 +1100388 return error;
389}
390
391/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 * Look up an inode by number in the given file system.
David Chinnerda353b02007-08-28 14:00:13 +1000393 * The inode is looked up in the cache held in each AG.
David Chinnerbf904242008-10-30 17:36:14 +1100394 * If the inode is found in the cache, initialise the vfs inode
395 * if necessary.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 *
David Chinnerda353b02007-08-28 14:00:13 +1000397 * If it is not in core, read it in from the file system's device,
David Chinnerbf904242008-10-30 17:36:14 +1100398 * add it to the cache and initialise the vfs inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 *
400 * The inode is locked according to the value of the lock_flags parameter.
401 * This flag parameter indicates how and if the inode's IO lock and inode lock
402 * should be taken.
403 *
404 * mp -- the mount point structure for the current file system. It points
405 * to the inode hash table.
406 * tp -- a pointer to the current transaction if there is one. This is
407 * simply passed through to the xfs_iread() call.
408 * ino -- the number of the inode desired. This is the unique identifier
409 * within the file system for the inode being requested.
410 * lock_flags -- flags indicating how to lock the inode. See the comment
411 * for xfs_ilock() for a list of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 */
David Chinnerbf904242008-10-30 17:36:14 +1100413int
414xfs_iget(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 xfs_mount_t *mp,
416 xfs_trans_t *tp,
417 xfs_ino_t ino,
418 uint flags,
419 uint lock_flags,
Dave Chinner7b6259e2010-06-24 11:35:17 +1000420 xfs_inode_t **ipp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 xfs_inode_t *ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 int error;
David Chinnerda353b02007-08-28 14:00:13 +1000424 xfs_perag_t *pag;
425 xfs_agino_t agino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Christoph Hellwigd2767342010-10-06 18:31:23 +0000427 /* reject inode numbers outside existing AGs */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100428 if (!ino || XFS_INO_TO_AGNO(mp, ino) >= mp->m_sb.sb_agcount)
David Chinnerda353b02007-08-28 14:00:13 +1000429 return EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
David Chinnerda353b02007-08-28 14:00:13 +1000431 /* get the perag structure and ensure that it's inode capable */
Dave Chinner5017e972010-01-11 11:47:40 +0000432 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
David Chinnerda353b02007-08-28 14:00:13 +1000433 agino = XFS_INO_TO_AGINO(mp, ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435again:
David Chinner6441e542008-10-30 17:21:19 +1100436 error = 0;
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100437 rcu_read_lock();
David Chinnerda353b02007-08-28 14:00:13 +1000438 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
David Chinner6441e542008-10-30 17:21:19 +1100440 if (ip) {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100441 error = xfs_iget_cache_hit(pag, ip, ino, flags, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100442 if (error)
443 goto out_error_or_again;
444 } else {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100445 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100446 XFS_STATS_INC(xs_ig_missed);
David Chinnerda353b02007-08-28 14:00:13 +1000447
Dave Chinner7b6259e2010-06-24 11:35:17 +1000448 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip,
David Chinner6441e542008-10-30 17:21:19 +1100449 flags, lock_flags);
450 if (error)
451 goto out_error_or_again;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 }
Dave Chinner5017e972010-01-11 11:47:40 +0000453 xfs_perag_put(pag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 *ipp = ip;
456
David Chinnerbf904242008-10-30 17:36:14 +1100457 ASSERT(ip->i_df.if_ext_max ==
458 XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000459 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 * If we have a real type for an on-disk inode, we can set ops(&unlock)
461 * now. If it's a new inode being created, xfs_ialloc will handle it.
462 */
David Chinnerbf904242008-10-30 17:36:14 +1100463 if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000464 xfs_setup_inode(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return 0;
David Chinner6441e542008-10-30 17:21:19 +1100466
467out_error_or_again:
468 if (error == EAGAIN) {
469 delay(1);
470 goto again;
471 }
Dave Chinner5017e972010-01-11 11:47:40 +0000472 xfs_perag_put(pag);
David Chinner6441e542008-10-30 17:21:19 +1100473 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474}
475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 * This is a wrapper routine around the xfs_ilock() routine
478 * used to centralize some grungy code. It is used in places
479 * that wish to lock the inode solely for reading the extents.
480 * The reason these places can't just call xfs_ilock(SHARED)
481 * is that the inode lock also guards to bringing in of the
482 * extents from disk for a file in b-tree format. If the inode
483 * is in b-tree format, then we need to lock the inode exclusively
484 * until the extents are read in. Locking it exclusively all
485 * the time would limit our parallelism unnecessarily, though.
486 * What we do instead is check to see if the extents have been
487 * read in yet, and only lock the inode exclusively if they
488 * have not.
489 *
490 * The function returns a value which should be given to the
491 * corresponding xfs_iunlock_map_shared(). This value is
492 * the mode in which the lock was actually taken.
493 */
494uint
495xfs_ilock_map_shared(
496 xfs_inode_t *ip)
497{
498 uint lock_mode;
499
500 if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
501 ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
502 lock_mode = XFS_ILOCK_EXCL;
503 } else {
504 lock_mode = XFS_ILOCK_SHARED;
505 }
506
507 xfs_ilock(ip, lock_mode);
508
509 return lock_mode;
510}
511
512/*
513 * This is simply the unlock routine to go with xfs_ilock_map_shared().
514 * All it does is call xfs_iunlock() with the given lock_mode.
515 */
516void
517xfs_iunlock_map_shared(
518 xfs_inode_t *ip,
519 unsigned int lock_mode)
520{
521 xfs_iunlock(ip, lock_mode);
522}
523
524/*
525 * The xfs inode contains 2 locks: a multi-reader lock called the
526 * i_iolock and a multi-reader lock called the i_lock. This routine
527 * allows either or both of the locks to be obtained.
528 *
529 * The 2 locks should always be ordered so that the IO lock is
530 * obtained first in order to prevent deadlock.
531 *
532 * ip -- the inode being locked
533 * lock_flags -- this parameter indicates the inode's locks
534 * to be locked. It can be:
535 * XFS_IOLOCK_SHARED,
536 * XFS_IOLOCK_EXCL,
537 * XFS_ILOCK_SHARED,
538 * XFS_ILOCK_EXCL,
539 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
540 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
541 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
542 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
543 */
544void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000545xfs_ilock(
546 xfs_inode_t *ip,
547 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
549 /*
550 * You can't set both SHARED and EXCL for the same lock,
551 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
552 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
553 */
554 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
555 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
556 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
557 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000558 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000560 if (lock_flags & XFS_IOLOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000561 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000562 else if (lock_flags & XFS_IOLOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000563 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000564
565 if (lock_flags & XFS_ILOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000566 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000567 else if (lock_flags & XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000568 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000569
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000570 trace_xfs_ilock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
573/*
574 * This is just like xfs_ilock(), except that the caller
575 * is guaranteed not to sleep. It returns 1 if it gets
576 * the requested locks and 0 otherwise. If the IO lock is
577 * obtained but the inode lock cannot be, then the IO lock
578 * is dropped before returning.
579 *
580 * ip -- the inode being locked
581 * lock_flags -- this parameter indicates the inode's locks to be
582 * to be locked. See the comment for xfs_ilock() for a list
583 * of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 */
585int
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000586xfs_ilock_nowait(
587 xfs_inode_t *ip,
588 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 /*
591 * You can't set both SHARED and EXCL for the same lock,
592 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
593 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
594 */
595 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
596 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
597 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
598 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000599 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 if (lock_flags & XFS_IOLOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000602 if (!mrtryupdate(&ip->i_iolock))
603 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 } else if (lock_flags & XFS_IOLOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000605 if (!mrtryaccess(&ip->i_iolock))
606 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 }
608 if (lock_flags & XFS_ILOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000609 if (!mrtryupdate(&ip->i_lock))
610 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 } else if (lock_flags & XFS_ILOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000612 if (!mrtryaccess(&ip->i_lock))
613 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000615 trace_xfs_ilock_nowait(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 return 1;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000617
618 out_undo_iolock:
619 if (lock_flags & XFS_IOLOCK_EXCL)
620 mrunlock_excl(&ip->i_iolock);
621 else if (lock_flags & XFS_IOLOCK_SHARED)
622 mrunlock_shared(&ip->i_iolock);
623 out:
624 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625}
626
627/*
628 * xfs_iunlock() is used to drop the inode locks acquired with
629 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
630 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
631 * that we know which locks to drop.
632 *
633 * ip -- the inode being unlocked
634 * lock_flags -- this parameter indicates the inode's locks to be
635 * to be unlocked. See the comment for xfs_ilock() for a list
636 * of valid values for this parameter.
637 *
638 */
639void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000640xfs_iunlock(
641 xfs_inode_t *ip,
642 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
644 /*
645 * You can't set both SHARED and EXCL for the same lock,
646 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
647 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
648 */
649 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
650 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
651 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
652 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000653 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
654 XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 ASSERT(lock_flags != 0);
656
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000657 if (lock_flags & XFS_IOLOCK_EXCL)
658 mrunlock_excl(&ip->i_iolock);
659 else if (lock_flags & XFS_IOLOCK_SHARED)
660 mrunlock_shared(&ip->i_iolock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000662 if (lock_flags & XFS_ILOCK_EXCL)
663 mrunlock_excl(&ip->i_lock);
664 else if (lock_flags & XFS_ILOCK_SHARED)
665 mrunlock_shared(&ip->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000667 if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
668 !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 /*
670 * Let the AIL know that this item has been unlocked in case
671 * it is in the AIL and anyone is waiting on it. Don't do
672 * this if the caller has asked us not to.
673 */
David Chinner783a2f62008-10-30 17:39:58 +1100674 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000675 (xfs_log_item_t*)(ip->i_itemp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000677 trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678}
679
680/*
681 * give up write locks. the i/o lock cannot be held nested
682 * if it is being demoted.
683 */
684void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000685xfs_ilock_demote(
686 xfs_inode_t *ip,
687 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688{
689 ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
690 ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
691
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000692 if (lock_flags & XFS_ILOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 mrdemote(&ip->i_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000694 if (lock_flags & XFS_IOLOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 mrdemote(&ip->i_iolock);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000696
697 trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698}
699
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000700#ifdef DEBUG
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000701int
702xfs_isilocked(
703 xfs_inode_t *ip,
704 uint lock_flags)
705{
Christoph Hellwigf9369722010-06-03 16:22:29 +1000706 if (lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) {
707 if (!(lock_flags & XFS_ILOCK_SHARED))
708 return !!ip->i_lock.mr_writer;
709 return rwsem_is_locked(&ip->i_lock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000710 }
711
Christoph Hellwigf9369722010-06-03 16:22:29 +1000712 if (lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) {
713 if (!(lock_flags & XFS_IOLOCK_SHARED))
714 return !!ip->i_iolock.mr_writer;
715 return rwsem_is_locked(&ip->i_iolock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000716 }
717
Christoph Hellwigf9369722010-06-03 16:22:29 +1000718 ASSERT(0);
719 return 0;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000720}
721#endif