blob: 0fa98b1c70eab1182a6b3271cc98094a9d96925a [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"
Christoph Hellwig0b1b2132009-12-14 23:14:59 +000041#include "xfs_trace.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110042
43
44/*
Dave Chinnerdcfcf202010-12-23 11:57:13 +110045 * 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.
51 */
52static struct lock_class_key xfs_iolock_active;
53struct lock_class_key xfs_iolock_reclaimable;
54
55/*
Christoph Hellwig24f211b2008-11-28 14:23:42 +110056 * Allocate and initialise an xfs_inode.
57 */
58STATIC struct xfs_inode *
59xfs_inode_alloc(
60 struct xfs_mount *mp,
61 xfs_ino_t ino)
62{
63 struct xfs_inode *ip;
64
65 /*
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.
69 */
70 ip = kmem_zone_alloc(xfs_inode_zone, KM_SLEEP);
71 if (!ip)
72 return NULL;
Christoph Hellwig54e34622009-08-07 14:38:25 -030073 if (inode_init_always(mp->m_super, VFS_I(ip))) {
74 kmem_zone_free(xfs_inode_zone, ip);
75 return NULL;
76 }
Christoph Hellwig24f211b2008-11-28 14:23:42 +110077
Christoph Hellwig24f211b2008-11-28 14:23:42 +110078 ASSERT(atomic_read(&ip->i_pincount) == 0);
79 ASSERT(!spin_is_locked(&ip->i_flags_lock));
80 ASSERT(completion_done(&ip->i_flush));
Dave Chinner1a3e8f32010-12-17 17:29:43 +110081 ASSERT(ip->i_ino == 0);
Christoph Hellwig033da482009-10-19 04:05:26 +000082
83 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
Dave Chinnerdcfcf202010-12-23 11:57:13 +110084 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
85 &xfs_iolock_active, "xfs_iolock_active");
Christoph Hellwig24f211b2008-11-28 14:23:42 +110086
Christoph Hellwig24f211b2008-11-28 14:23:42 +110087 /* initialise the xfs inode */
88 ip->i_ino = ino;
89 ip->i_mount = mp;
90 memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
91 ip->i_afp = NULL;
92 memset(&ip->i_df, 0, sizeof(xfs_ifork_t));
93 ip->i_flags = 0;
94 ip->i_update_core = 0;
Christoph Hellwig24f211b2008-11-28 14:23:42 +110095 ip->i_delayed_blks = 0;
96 memset(&ip->i_d, 0, sizeof(xfs_icdinode_t));
97 ip->i_size = 0;
98 ip->i_new_size = 0;
99
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100100 return ip;
101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100103STATIC void
104xfs_inode_free_callback(
105 struct rcu_head *head)
106{
107 struct inode *inode = container_of(head, struct inode, i_rcu);
108 struct xfs_inode *ip = XFS_I(inode);
109
110 INIT_LIST_HEAD(&inode->i_dentry);
111 kmem_zone_free(xfs_inode_zone, ip);
112}
113
Dave Chinner2f11fea2010-07-20 17:53:25 +1000114void
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300115xfs_inode_free(
116 struct xfs_inode *ip)
117{
118 switch (ip->i_d.di_mode & S_IFMT) {
119 case S_IFREG:
120 case S_IFDIR:
121 case S_IFLNK:
122 xfs_idestroy_fork(ip, XFS_DATA_FORK);
123 break;
124 }
125
126 if (ip->i_afp)
127 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
128
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300129 if (ip->i_itemp) {
130 /*
131 * Only if we are shutting down the fs will we see an
132 * inode still in the AIL. If it is there, we should remove
133 * it to prevent a use-after-free from occurring.
134 */
135 xfs_log_item_t *lip = &ip->i_itemp->ili_item;
136 struct xfs_ail *ailp = lip->li_ailp;
137
138 ASSERT(((lip->li_flags & XFS_LI_IN_AIL) == 0) ||
139 XFS_FORCED_SHUTDOWN(ip->i_mount));
140 if (lip->li_flags & XFS_LI_IN_AIL) {
141 spin_lock(&ailp->xa_lock);
142 if (lip->li_flags & XFS_LI_IN_AIL)
143 xfs_trans_ail_delete(ailp, lip);
144 else
145 spin_unlock(&ailp->xa_lock);
146 }
147 xfs_inode_item_destroy(ip);
148 ip->i_itemp = NULL;
149 }
150
151 /* asserts to verify all state is correct here */
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300152 ASSERT(atomic_read(&ip->i_pincount) == 0);
153 ASSERT(!spin_is_locked(&ip->i_flags_lock));
154 ASSERT(completion_done(&ip->i_flush));
155
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100156 /*
157 * Because we use RCU freeing we need to ensure the inode always
158 * appears to be reclaimed with an invalid inode number when in the
159 * free state. The ip->i_flags_lock provides the barrier against lookup
160 * races.
161 */
162 spin_lock(&ip->i_flags_lock);
163 ip->i_flags = XFS_IRECLAIM;
164 ip->i_ino = 0;
165 spin_unlock(&ip->i_flags_lock);
Alex Elder92f1c002011-01-10 21:35:55 -0600166
167 call_rcu(&VFS_I(ip)->i_rcu, xfs_inode_free_callback);
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300168}
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170/*
David Chinner6441e542008-10-30 17:21:19 +1100171 * Check the validity of the inode we just found it the cache
172 */
173static int
174xfs_iget_cache_hit(
David Chinner6441e542008-10-30 17:21:19 +1100175 struct xfs_perag *pag,
176 struct xfs_inode *ip,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100177 xfs_ino_t ino,
David Chinner6441e542008-10-30 17:21:19 +1100178 int flags,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100179 int lock_flags) __releases(RCU)
David Chinner6441e542008-10-30 17:21:19 +1100180{
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400181 struct inode *inode = VFS_I(ip);
David Chinner6441e542008-10-30 17:21:19 +1100182 struct xfs_mount *mp = ip->i_mount;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400183 int error;
184
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100185 /*
186 * check for re-use of an inode within an RCU grace period due to the
187 * radix tree nodes not being updated yet. We monitor for this by
188 * setting the inode number to zero before freeing the inode structure.
189 * If the inode has been reallocated and set up, then the inode number
190 * will not match, so check for that, too.
191 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400192 spin_lock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100193 if (ip->i_ino != ino) {
194 trace_xfs_iget_skip(ip);
195 XFS_STATS_INC(xs_ig_frecycle);
196 error = EAGAIN;
197 goto out_error;
198 }
199
David Chinner6441e542008-10-30 17:21:19 +1100200
201 /*
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400202 * If we are racing with another cache hit that is currently
203 * instantiating this inode or currently recycling it out of
204 * reclaimabe state, wait for the initialisation to complete
205 * before continuing.
206 *
207 * XXX(hch): eventually we should do something equivalent to
208 * wait_on_inode to wait for these flags to be cleared
209 * instead of polling for it.
David Chinner6441e542008-10-30 17:21:19 +1100210 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400211 if (ip->i_flags & (XFS_INEW|XFS_IRECLAIM)) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000212 trace_xfs_iget_skip(ip);
David Chinner6441e542008-10-30 17:21:19 +1100213 XFS_STATS_INC(xs_ig_frecycle);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400214 error = EAGAIN;
David Chinner6441e542008-10-30 17:21:19 +1100215 goto out_error;
216 }
217
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400218 /*
219 * If lookup is racing with unlink return an error immediately.
220 */
221 if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
222 error = ENOENT;
223 goto out_error;
224 }
David Chinner6441e542008-10-30 17:21:19 +1100225
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400226 /*
227 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
228 * Need to carefully get it back into useable state.
229 */
230 if (ip->i_flags & XFS_IRECLAIMABLE) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000231 trace_xfs_iget_reclaim(ip);
David Chinner6441e542008-10-30 17:21:19 +1100232
David Chinnerbf904242008-10-30 17:36:14 +1100233 /*
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000234 * We need to set XFS_IRECLAIM to prevent xfs_reclaim_inode
235 * from stomping over us while we recycle the inode. We can't
236 * clear the radix tree reclaimable tag yet as it requires
237 * pag_ici_lock to be held exclusive.
David Chinnerbf904242008-10-30 17:36:14 +1100238 */
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000239 ip->i_flags |= XFS_IRECLAIM;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400240
241 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100242 rcu_read_unlock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400243
244 error = -inode_init_always(mp->m_super, inode);
245 if (error) {
246 /*
247 * Re-initializing the inode failed, and we are in deep
248 * trouble. Try to re-add it to the reclaim list.
249 */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100250 rcu_read_lock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400251 spin_lock(&ip->i_flags_lock);
252
Dave Chinner778e24b2011-06-23 01:34:59 +0000253 ip->i_flags &= ~(XFS_INEW | XFS_IRECLAIM);
254 ASSERT(ip->i_flags & XFS_IRECLAIMABLE);
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000255 trace_xfs_iget_reclaim_fail(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400256 goto out_error;
257 }
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000258
Dave Chinner1a427ab2010-12-16 17:08:41 +1100259 spin_lock(&pag->pag_ici_lock);
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000260 spin_lock(&ip->i_flags_lock);
Dave Chinner778e24b2011-06-23 01:34:59 +0000261
262 /*
263 * Clear the per-lifetime state in the inode as we are now
264 * effectively a new inode and need to return to the initial
265 * state before reuse occurs.
266 */
267 ip->i_flags &= ~XFS_IRECLAIM_RESET_FLAGS;
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000268 ip->i_flags |= XFS_INEW;
269 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100270 inode->i_state = I_NEW;
Dave Chinnerdcfcf202010-12-23 11:57:13 +1100271
272 ASSERT(!rwsem_is_locked(&ip->i_iolock.mr_lock));
273 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
274 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
275 &xfs_iolock_active, "xfs_iolock_active");
276
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000277 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a427ab2010-12-16 17:08:41 +1100278 spin_unlock(&pag->pag_ici_lock);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400279 } else {
280 /* If the VFS inode is being torn down, pause and try again. */
281 if (!igrab(inode)) {
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000282 trace_xfs_iget_skip(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400283 error = EAGAIN;
David Chinnerbf904242008-10-30 17:36:14 +1100284 goto out_error;
285 }
David Chinner6bfb3d02008-10-30 18:32:43 +1100286
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400287 /* We've got a live one. */
288 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100289 rcu_read_unlock();
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000290 trace_xfs_iget_hit(ip);
David Chinner6441e542008-10-30 17:21:19 +1100291 }
292
David Chinner6441e542008-10-30 17:21:19 +1100293 if (lock_flags != 0)
294 xfs_ilock(ip, lock_flags);
295
296 xfs_iflags_clear(ip, XFS_ISTALE);
David Chinner6441e542008-10-30 17:21:19 +1100297 XFS_STATS_INC(xs_ig_found);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000298
David Chinner6441e542008-10-30 17:21:19 +1100299 return 0;
300
301out_error:
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400302 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100303 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100304 return error;
305}
306
307
308static int
309xfs_iget_cache_miss(
310 struct xfs_mount *mp,
311 struct xfs_perag *pag,
312 xfs_trans_t *tp,
313 xfs_ino_t ino,
314 struct xfs_inode **ipp,
David Chinner6441e542008-10-30 17:21:19 +1100315 int flags,
Christoph Hellwig0c3dc2b2009-11-14 16:17:23 +0000316 int lock_flags)
David Chinner6441e542008-10-30 17:21:19 +1100317{
318 struct xfs_inode *ip;
319 int error;
David Chinner6441e542008-10-30 17:21:19 +1100320 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
321
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100322 ip = xfs_inode_alloc(mp, ino);
323 if (!ip)
324 return ENOMEM;
325
Dave Chinner7b6259e2010-06-24 11:35:17 +1000326 error = xfs_iread(mp, tp, ip, flags);
David Chinner6441e542008-10-30 17:21:19 +1100327 if (error)
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100328 goto out_destroy;
David Chinner6441e542008-10-30 17:21:19 +1100329
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000330 trace_xfs_iget_miss(ip);
David Chinner6441e542008-10-30 17:21:19 +1100331
332 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
333 error = ENOENT;
334 goto out_destroy;
335 }
336
337 /*
338 * Preload the radix tree so we can insert safely under the
David Chinner56e73ec2008-10-30 17:55:27 +1100339 * write spinlock. Note that we cannot sleep inside the preload
340 * region.
David Chinner6441e542008-10-30 17:21:19 +1100341 */
342 if (radix_tree_preload(GFP_KERNEL)) {
343 error = EAGAIN;
Christoph Hellwiged93ec32009-03-03 14:48:35 -0500344 goto out_destroy;
345 }
346
347 /*
348 * Because the inode hasn't been added to the radix-tree yet it can't
349 * be found by another thread, so we can do the non-sleeping lock here.
350 */
351 if (lock_flags) {
352 if (!xfs_ilock_nowait(ip, lock_flags))
353 BUG();
David Chinner6441e542008-10-30 17:21:19 +1100354 }
355
Dave Chinner1a427ab2010-12-16 17:08:41 +1100356 spin_lock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100357
358 /* insert the new inode */
359 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
360 if (unlikely(error)) {
361 WARN_ON(error != -EEXIST);
362 XFS_STATS_INC(xs_ig_dup);
363 error = EAGAIN;
David Chinner56e73ec2008-10-30 17:55:27 +1100364 goto out_preload_end;
David Chinner6441e542008-10-30 17:21:19 +1100365 }
366
367 /* These values _must_ be set before releasing the radix tree lock! */
368 ip->i_udquot = ip->i_gdquot = NULL;
369 xfs_iflags_set(ip, XFS_INEW);
370
Dave Chinner1a427ab2010-12-16 17:08:41 +1100371 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100372 radix_tree_preload_end();
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000373
David Chinner6441e542008-10-30 17:21:19 +1100374 *ipp = ip;
375 return 0;
376
David Chinner56e73ec2008-10-30 17:55:27 +1100377out_preload_end:
Dave Chinner1a427ab2010-12-16 17:08:41 +1100378 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100379 radix_tree_preload_end();
David Chinner56e73ec2008-10-30 17:55:27 +1100380 if (lock_flags)
381 xfs_iunlock(ip, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100382out_destroy:
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300383 __destroy_inode(VFS_I(ip));
384 xfs_inode_free(ip);
David Chinner6441e542008-10-30 17:21:19 +1100385 return error;
386}
387
388/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 * Look up an inode by number in the given file system.
David Chinnerda353b02007-08-28 14:00:13 +1000390 * The inode is looked up in the cache held in each AG.
David Chinnerbf904242008-10-30 17:36:14 +1100391 * If the inode is found in the cache, initialise the vfs inode
392 * if necessary.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 *
David Chinnerda353b02007-08-28 14:00:13 +1000394 * If it is not in core, read it in from the file system's device,
David Chinnerbf904242008-10-30 17:36:14 +1100395 * add it to the cache and initialise the vfs inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 *
397 * The inode is locked according to the value of the lock_flags parameter.
398 * This flag parameter indicates how and if the inode's IO lock and inode lock
399 * should be taken.
400 *
401 * mp -- the mount point structure for the current file system. It points
402 * to the inode hash table.
403 * tp -- a pointer to the current transaction if there is one. This is
404 * simply passed through to the xfs_iread() call.
405 * ino -- the number of the inode desired. This is the unique identifier
406 * within the file system for the inode being requested.
407 * lock_flags -- flags indicating how to lock the inode. See the comment
408 * for xfs_ilock() for a list of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 */
David Chinnerbf904242008-10-30 17:36:14 +1100410int
411xfs_iget(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 xfs_mount_t *mp,
413 xfs_trans_t *tp,
414 xfs_ino_t ino,
415 uint flags,
416 uint lock_flags,
Dave Chinner7b6259e2010-06-24 11:35:17 +1000417 xfs_inode_t **ipp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 xfs_inode_t *ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 int error;
David Chinnerda353b02007-08-28 14:00:13 +1000421 xfs_perag_t *pag;
422 xfs_agino_t agino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Christoph Hellwigd2767342010-10-06 18:31:23 +0000424 /* reject inode numbers outside existing AGs */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100425 if (!ino || XFS_INO_TO_AGNO(mp, ino) >= mp->m_sb.sb_agcount)
David Chinnerda353b02007-08-28 14:00:13 +1000426 return EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
David Chinnerda353b02007-08-28 14:00:13 +1000428 /* get the perag structure and ensure that it's inode capable */
Dave Chinner5017e972010-01-11 11:47:40 +0000429 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
David Chinnerda353b02007-08-28 14:00:13 +1000430 agino = XFS_INO_TO_AGINO(mp, ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432again:
David Chinner6441e542008-10-30 17:21:19 +1100433 error = 0;
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100434 rcu_read_lock();
David Chinnerda353b02007-08-28 14:00:13 +1000435 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
David Chinner6441e542008-10-30 17:21:19 +1100437 if (ip) {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100438 error = xfs_iget_cache_hit(pag, ip, ino, flags, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100439 if (error)
440 goto out_error_or_again;
441 } else {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100442 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100443 XFS_STATS_INC(xs_ig_missed);
David Chinnerda353b02007-08-28 14:00:13 +1000444
Dave Chinner7b6259e2010-06-24 11:35:17 +1000445 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip,
David Chinner6441e542008-10-30 17:21:19 +1100446 flags, lock_flags);
447 if (error)
448 goto out_error_or_again;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 }
Dave Chinner5017e972010-01-11 11:47:40 +0000450 xfs_perag_put(pag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 *ipp = ip;
453
David Chinnerbf904242008-10-30 17:36:14 +1100454 ASSERT(ip->i_df.if_ext_max ==
455 XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000456 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 * If we have a real type for an on-disk inode, we can set ops(&unlock)
458 * now. If it's a new inode being created, xfs_ialloc will handle it.
459 */
David Chinnerbf904242008-10-30 17:36:14 +1100460 if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000461 xfs_setup_inode(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 return 0;
David Chinner6441e542008-10-30 17:21:19 +1100463
464out_error_or_again:
465 if (error == EAGAIN) {
466 delay(1);
467 goto again;
468 }
Dave Chinner5017e972010-01-11 11:47:40 +0000469 xfs_perag_put(pag);
David Chinner6441e542008-10-30 17:21:19 +1100470 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471}
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 * This is a wrapper routine around the xfs_ilock() routine
475 * used to centralize some grungy code. It is used in places
476 * that wish to lock the inode solely for reading the extents.
477 * The reason these places can't just call xfs_ilock(SHARED)
478 * is that the inode lock also guards to bringing in of the
479 * extents from disk for a file in b-tree format. If the inode
480 * is in b-tree format, then we need to lock the inode exclusively
481 * until the extents are read in. Locking it exclusively all
482 * the time would limit our parallelism unnecessarily, though.
483 * What we do instead is check to see if the extents have been
484 * read in yet, and only lock the inode exclusively if they
485 * have not.
486 *
487 * The function returns a value which should be given to the
488 * corresponding xfs_iunlock_map_shared(). This value is
489 * the mode in which the lock was actually taken.
490 */
491uint
492xfs_ilock_map_shared(
493 xfs_inode_t *ip)
494{
495 uint lock_mode;
496
497 if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
498 ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
499 lock_mode = XFS_ILOCK_EXCL;
500 } else {
501 lock_mode = XFS_ILOCK_SHARED;
502 }
503
504 xfs_ilock(ip, lock_mode);
505
506 return lock_mode;
507}
508
509/*
510 * This is simply the unlock routine to go with xfs_ilock_map_shared().
511 * All it does is call xfs_iunlock() with the given lock_mode.
512 */
513void
514xfs_iunlock_map_shared(
515 xfs_inode_t *ip,
516 unsigned int lock_mode)
517{
518 xfs_iunlock(ip, lock_mode);
519}
520
521/*
522 * The xfs inode contains 2 locks: a multi-reader lock called the
523 * i_iolock and a multi-reader lock called the i_lock. This routine
524 * allows either or both of the locks to be obtained.
525 *
526 * The 2 locks should always be ordered so that the IO lock is
527 * obtained first in order to prevent deadlock.
528 *
529 * ip -- the inode being locked
530 * lock_flags -- this parameter indicates the inode's locks
531 * to be locked. It can be:
532 * XFS_IOLOCK_SHARED,
533 * XFS_IOLOCK_EXCL,
534 * XFS_ILOCK_SHARED,
535 * XFS_ILOCK_EXCL,
536 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
537 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
538 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
539 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
540 */
541void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000542xfs_ilock(
543 xfs_inode_t *ip,
544 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 /*
547 * You can't set both SHARED and EXCL for the same lock,
548 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
549 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
550 */
551 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
552 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
553 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
554 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000555 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000557 if (lock_flags & XFS_IOLOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000558 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000559 else if (lock_flags & XFS_IOLOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000560 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000561
562 if (lock_flags & XFS_ILOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000563 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000564 else if (lock_flags & XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000565 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000566
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000567 trace_xfs_ilock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
569
570/*
571 * This is just like xfs_ilock(), except that the caller
572 * is guaranteed not to sleep. It returns 1 if it gets
573 * the requested locks and 0 otherwise. If the IO lock is
574 * obtained but the inode lock cannot be, then the IO lock
575 * is dropped before returning.
576 *
577 * ip -- the inode being locked
578 * lock_flags -- this parameter indicates the inode's locks to be
579 * to be locked. See the comment for xfs_ilock() for a list
580 * of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
582int
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000583xfs_ilock_nowait(
584 xfs_inode_t *ip,
585 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 /*
588 * You can't set both SHARED and EXCL for the same lock,
589 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
590 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
591 */
592 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
593 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
594 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
595 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000596 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 if (lock_flags & XFS_IOLOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000599 if (!mrtryupdate(&ip->i_iolock))
600 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 } else if (lock_flags & XFS_IOLOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000602 if (!mrtryaccess(&ip->i_iolock))
603 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 }
605 if (lock_flags & XFS_ILOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000606 if (!mrtryupdate(&ip->i_lock))
607 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 } else if (lock_flags & XFS_ILOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000609 if (!mrtryaccess(&ip->i_lock))
610 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000612 trace_xfs_ilock_nowait(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 return 1;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000614
615 out_undo_iolock:
616 if (lock_flags & XFS_IOLOCK_EXCL)
617 mrunlock_excl(&ip->i_iolock);
618 else if (lock_flags & XFS_IOLOCK_SHARED)
619 mrunlock_shared(&ip->i_iolock);
620 out:
621 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622}
623
624/*
625 * xfs_iunlock() is used to drop the inode locks acquired with
626 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
627 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
628 * that we know which locks to drop.
629 *
630 * ip -- the inode being unlocked
631 * lock_flags -- this parameter indicates the inode's locks to be
632 * to be unlocked. See the comment for xfs_ilock() for a list
633 * of valid values for this parameter.
634 *
635 */
636void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000637xfs_iunlock(
638 xfs_inode_t *ip,
639 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
641 /*
642 * You can't set both SHARED and EXCL for the same lock,
643 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
644 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
645 */
646 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
647 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
648 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
649 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000650 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
651 XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 ASSERT(lock_flags != 0);
653
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000654 if (lock_flags & XFS_IOLOCK_EXCL)
655 mrunlock_excl(&ip->i_iolock);
656 else if (lock_flags & XFS_IOLOCK_SHARED)
657 mrunlock_shared(&ip->i_iolock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000659 if (lock_flags & XFS_ILOCK_EXCL)
660 mrunlock_excl(&ip->i_lock);
661 else if (lock_flags & XFS_ILOCK_SHARED)
662 mrunlock_shared(&ip->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000664 if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
665 !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 /*
667 * Let the AIL know that this item has been unlocked in case
668 * it is in the AIL and anyone is waiting on it. Don't do
669 * this if the caller has asked us not to.
670 */
David Chinner783a2f62008-10-30 17:39:58 +1100671 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000672 (xfs_log_item_t*)(ip->i_itemp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000674 trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675}
676
677/*
678 * give up write locks. the i/o lock cannot be held nested
679 * if it is being demoted.
680 */
681void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000682xfs_ilock_demote(
683 xfs_inode_t *ip,
684 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
686 ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
687 ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
688
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000689 if (lock_flags & XFS_ILOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 mrdemote(&ip->i_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000691 if (lock_flags & XFS_IOLOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 mrdemote(&ip->i_iolock);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000693
694 trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695}
696
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000697#ifdef DEBUG
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000698int
699xfs_isilocked(
700 xfs_inode_t *ip,
701 uint lock_flags)
702{
Christoph Hellwigf9369722010-06-03 16:22:29 +1000703 if (lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) {
704 if (!(lock_flags & XFS_ILOCK_SHARED))
705 return !!ip->i_lock.mr_writer;
706 return rwsem_is_locked(&ip->i_lock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000707 }
708
Christoph Hellwigf9369722010-06-03 16:22:29 +1000709 if (lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) {
710 if (!(lock_flags & XFS_IOLOCK_SHARED))
711 return !!ip->i_iolock.mr_writer;
712 return rwsem_is_locked(&ip->i_iolock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000713 }
714
Christoph Hellwigf9369722010-06-03 16:22:29 +1000715 ASSERT(0);
716 return 0;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000717}
718#endif