blob: a7cf7139f9ad778b60fdd146fd8c7a404db4d60b [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));
Christoph Hellwig474fce02011-12-18 20:00:09 +000080 ASSERT(!xfs_isiflocked(ip));
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
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100110 kmem_zone_free(xfs_inode_zone, ip);
111}
112
Dave Chinner2f11fea2010-07-20 17:53:25 +1000113void
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300114xfs_inode_free(
115 struct xfs_inode *ip)
116{
117 switch (ip->i_d.di_mode & S_IFMT) {
118 case S_IFREG:
119 case S_IFDIR:
120 case S_IFLNK:
121 xfs_idestroy_fork(ip, XFS_DATA_FORK);
122 break;
123 }
124
125 if (ip->i_afp)
126 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
127
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300128 if (ip->i_itemp) {
129 /*
130 * Only if we are shutting down the fs will we see an
131 * inode still in the AIL. If it is there, we should remove
132 * it to prevent a use-after-free from occurring.
133 */
134 xfs_log_item_t *lip = &ip->i_itemp->ili_item;
135 struct xfs_ail *ailp = lip->li_ailp;
136
137 ASSERT(((lip->li_flags & XFS_LI_IN_AIL) == 0) ||
138 XFS_FORCED_SHUTDOWN(ip->i_mount));
139 if (lip->li_flags & XFS_LI_IN_AIL) {
140 spin_lock(&ailp->xa_lock);
141 if (lip->li_flags & XFS_LI_IN_AIL)
142 xfs_trans_ail_delete(ailp, lip);
143 else
144 spin_unlock(&ailp->xa_lock);
145 }
146 xfs_inode_item_destroy(ip);
147 ip->i_itemp = NULL;
148 }
149
150 /* asserts to verify all state is correct here */
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300151 ASSERT(atomic_read(&ip->i_pincount) == 0);
152 ASSERT(!spin_is_locked(&ip->i_flags_lock));
Christoph Hellwig474fce02011-12-18 20:00:09 +0000153 ASSERT(!xfs_isiflocked(ip));
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300154
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100155 /*
156 * Because we use RCU freeing we need to ensure the inode always
157 * appears to be reclaimed with an invalid inode number when in the
158 * free state. The ip->i_flags_lock provides the barrier against lookup
159 * races.
160 */
161 spin_lock(&ip->i_flags_lock);
162 ip->i_flags = XFS_IRECLAIM;
163 ip->i_ino = 0;
164 spin_unlock(&ip->i_flags_lock);
Alex Elder92f1c002011-01-10 21:35:55 -0600165
166 call_rcu(&VFS_I(ip)->i_rcu, xfs_inode_free_callback);
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300167}
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169/*
David Chinner6441e542008-10-30 17:21:19 +1100170 * Check the validity of the inode we just found it the cache
171 */
172static int
173xfs_iget_cache_hit(
David Chinner6441e542008-10-30 17:21:19 +1100174 struct xfs_perag *pag,
175 struct xfs_inode *ip,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100176 xfs_ino_t ino,
David Chinner6441e542008-10-30 17:21:19 +1100177 int flags,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100178 int lock_flags) __releases(RCU)
David Chinner6441e542008-10-30 17:21:19 +1100179{
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400180 struct inode *inode = VFS_I(ip);
David Chinner6441e542008-10-30 17:21:19 +1100181 struct xfs_mount *mp = ip->i_mount;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400182 int error;
183
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100184 /*
185 * check for re-use of an inode within an RCU grace period due to the
186 * radix tree nodes not being updated yet. We monitor for this by
187 * setting the inode number to zero before freeing the inode structure.
188 * If the inode has been reallocated and set up, then the inode number
189 * will not match, so check for that, too.
190 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400191 spin_lock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100192 if (ip->i_ino != ino) {
193 trace_xfs_iget_skip(ip);
194 XFS_STATS_INC(xs_ig_frecycle);
195 error = EAGAIN;
196 goto out_error;
197 }
198
David Chinner6441e542008-10-30 17:21:19 +1100199
200 /*
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400201 * If we are racing with another cache hit that is currently
202 * instantiating this inode or currently recycling it out of
203 * reclaimabe state, wait for the initialisation to complete
204 * before continuing.
205 *
206 * XXX(hch): eventually we should do something equivalent to
207 * wait_on_inode to wait for these flags to be cleared
208 * instead of polling for it.
David Chinner6441e542008-10-30 17:21:19 +1100209 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400210 if (ip->i_flags & (XFS_INEW|XFS_IRECLAIM)) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000211 trace_xfs_iget_skip(ip);
David Chinner6441e542008-10-30 17:21:19 +1100212 XFS_STATS_INC(xs_ig_frecycle);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400213 error = EAGAIN;
David Chinner6441e542008-10-30 17:21:19 +1100214 goto out_error;
215 }
216
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400217 /*
218 * If lookup is racing with unlink return an error immediately.
219 */
220 if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
221 error = ENOENT;
222 goto out_error;
223 }
David Chinner6441e542008-10-30 17:21:19 +1100224
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400225 /*
226 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
227 * Need to carefully get it back into useable state.
228 */
229 if (ip->i_flags & XFS_IRECLAIMABLE) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000230 trace_xfs_iget_reclaim(ip);
David Chinner6441e542008-10-30 17:21:19 +1100231
David Chinnerbf904242008-10-30 17:36:14 +1100232 /*
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000233 * We need to set XFS_IRECLAIM to prevent xfs_reclaim_inode
234 * from stomping over us while we recycle the inode. We can't
235 * clear the radix tree reclaimable tag yet as it requires
236 * pag_ici_lock to be held exclusive.
David Chinnerbf904242008-10-30 17:36:14 +1100237 */
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000238 ip->i_flags |= XFS_IRECLAIM;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400239
240 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100241 rcu_read_unlock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400242
243 error = -inode_init_always(mp->m_super, inode);
244 if (error) {
245 /*
246 * Re-initializing the inode failed, and we are in deep
247 * trouble. Try to re-add it to the reclaim list.
248 */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100249 rcu_read_lock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400250 spin_lock(&ip->i_flags_lock);
251
Dave Chinner778e24b2011-06-23 01:34:59 +0000252 ip->i_flags &= ~(XFS_INEW | XFS_IRECLAIM);
253 ASSERT(ip->i_flags & XFS_IRECLAIMABLE);
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000254 trace_xfs_iget_reclaim_fail(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400255 goto out_error;
256 }
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000257
Dave Chinner1a427ab2010-12-16 17:08:41 +1100258 spin_lock(&pag->pag_ici_lock);
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000259 spin_lock(&ip->i_flags_lock);
Dave Chinner778e24b2011-06-23 01:34:59 +0000260
261 /*
262 * Clear the per-lifetime state in the inode as we are now
263 * effectively a new inode and need to return to the initial
264 * state before reuse occurs.
265 */
266 ip->i_flags &= ~XFS_IRECLAIM_RESET_FLAGS;
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000267 ip->i_flags |= XFS_INEW;
268 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100269 inode->i_state = I_NEW;
Dave Chinnerdcfcf202010-12-23 11:57:13 +1100270
271 ASSERT(!rwsem_is_locked(&ip->i_iolock.mr_lock));
272 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
273 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
274 &xfs_iolock_active, "xfs_iolock_active");
275
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000276 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a427ab2010-12-16 17:08:41 +1100277 spin_unlock(&pag->pag_ici_lock);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400278 } else {
279 /* If the VFS inode is being torn down, pause and try again. */
280 if (!igrab(inode)) {
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000281 trace_xfs_iget_skip(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400282 error = EAGAIN;
David Chinnerbf904242008-10-30 17:36:14 +1100283 goto out_error;
284 }
David Chinner6bfb3d02008-10-30 18:32:43 +1100285
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400286 /* We've got a live one. */
287 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100288 rcu_read_unlock();
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000289 trace_xfs_iget_hit(ip);
David Chinner6441e542008-10-30 17:21:19 +1100290 }
291
David Chinner6441e542008-10-30 17:21:19 +1100292 if (lock_flags != 0)
293 xfs_ilock(ip, lock_flags);
294
295 xfs_iflags_clear(ip, XFS_ISTALE);
David Chinner6441e542008-10-30 17:21:19 +1100296 XFS_STATS_INC(xs_ig_found);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000297
David Chinner6441e542008-10-30 17:21:19 +1100298 return 0;
299
300out_error:
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400301 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100302 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100303 return error;
304}
305
306
307static int
308xfs_iget_cache_miss(
309 struct xfs_mount *mp,
310 struct xfs_perag *pag,
311 xfs_trans_t *tp,
312 xfs_ino_t ino,
313 struct xfs_inode **ipp,
David Chinner6441e542008-10-30 17:21:19 +1100314 int flags,
Christoph Hellwig0c3dc2b2009-11-14 16:17:23 +0000315 int lock_flags)
David Chinner6441e542008-10-30 17:21:19 +1100316{
317 struct xfs_inode *ip;
318 int error;
David Chinner6441e542008-10-30 17:21:19 +1100319 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
320
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100321 ip = xfs_inode_alloc(mp, ino);
322 if (!ip)
323 return ENOMEM;
324
Dave Chinner7b6259e2010-06-24 11:35:17 +1000325 error = xfs_iread(mp, tp, ip, flags);
David Chinner6441e542008-10-30 17:21:19 +1100326 if (error)
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100327 goto out_destroy;
David Chinner6441e542008-10-30 17:21:19 +1100328
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000329 trace_xfs_iget_miss(ip);
David Chinner6441e542008-10-30 17:21:19 +1100330
331 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
332 error = ENOENT;
333 goto out_destroy;
334 }
335
336 /*
337 * Preload the radix tree so we can insert safely under the
David Chinner56e73ec2008-10-30 17:55:27 +1100338 * write spinlock. Note that we cannot sleep inside the preload
339 * region.
David Chinner6441e542008-10-30 17:21:19 +1100340 */
341 if (radix_tree_preload(GFP_KERNEL)) {
342 error = EAGAIN;
Christoph Hellwiged93ec32009-03-03 14:48:35 -0500343 goto out_destroy;
344 }
345
346 /*
347 * Because the inode hasn't been added to the radix-tree yet it can't
348 * be found by another thread, so we can do the non-sleeping lock here.
349 */
350 if (lock_flags) {
351 if (!xfs_ilock_nowait(ip, lock_flags))
352 BUG();
David Chinner6441e542008-10-30 17:21:19 +1100353 }
354
Dave Chinner1a427ab2010-12-16 17:08:41 +1100355 spin_lock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100356
357 /* insert the new inode */
358 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
359 if (unlikely(error)) {
360 WARN_ON(error != -EEXIST);
361 XFS_STATS_INC(xs_ig_dup);
362 error = EAGAIN;
David Chinner56e73ec2008-10-30 17:55:27 +1100363 goto out_preload_end;
David Chinner6441e542008-10-30 17:21:19 +1100364 }
365
366 /* These values _must_ be set before releasing the radix tree lock! */
367 ip->i_udquot = ip->i_gdquot = NULL;
368 xfs_iflags_set(ip, XFS_INEW);
369
Dave Chinner1a427ab2010-12-16 17:08:41 +1100370 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100371 radix_tree_preload_end();
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000372
David Chinner6441e542008-10-30 17:21:19 +1100373 *ipp = ip;
374 return 0;
375
David Chinner56e73ec2008-10-30 17:55:27 +1100376out_preload_end:
Dave Chinner1a427ab2010-12-16 17:08:41 +1100377 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100378 radix_tree_preload_end();
David Chinner56e73ec2008-10-30 17:55:27 +1100379 if (lock_flags)
380 xfs_iunlock(ip, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100381out_destroy:
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300382 __destroy_inode(VFS_I(ip));
383 xfs_inode_free(ip);
David Chinner6441e542008-10-30 17:21:19 +1100384 return error;
385}
386
387/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 * Look up an inode by number in the given file system.
David Chinnerda353b02007-08-28 14:00:13 +1000389 * The inode is looked up in the cache held in each AG.
David Chinnerbf904242008-10-30 17:36:14 +1100390 * If the inode is found in the cache, initialise the vfs inode
391 * if necessary.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 *
David Chinnerda353b02007-08-28 14:00:13 +1000393 * If it is not in core, read it in from the file system's device,
David Chinnerbf904242008-10-30 17:36:14 +1100394 * add it to the cache and initialise the vfs inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 *
396 * The inode is locked according to the value of the lock_flags parameter.
397 * This flag parameter indicates how and if the inode's IO lock and inode lock
398 * should be taken.
399 *
400 * mp -- the mount point structure for the current file system. It points
401 * to the inode hash table.
402 * tp -- a pointer to the current transaction if there is one. This is
403 * simply passed through to the xfs_iread() call.
404 * ino -- the number of the inode desired. This is the unique identifier
405 * within the file system for the inode being requested.
406 * lock_flags -- flags indicating how to lock the inode. See the comment
407 * for xfs_ilock() for a list of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 */
David Chinnerbf904242008-10-30 17:36:14 +1100409int
410xfs_iget(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 xfs_mount_t *mp,
412 xfs_trans_t *tp,
413 xfs_ino_t ino,
414 uint flags,
415 uint lock_flags,
Dave Chinner7b6259e2010-06-24 11:35:17 +1000416 xfs_inode_t **ipp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 xfs_inode_t *ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 int error;
David Chinnerda353b02007-08-28 14:00:13 +1000420 xfs_perag_t *pag;
421 xfs_agino_t agino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Christoph Hellwigd2767342010-10-06 18:31:23 +0000423 /* reject inode numbers outside existing AGs */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100424 if (!ino || XFS_INO_TO_AGNO(mp, ino) >= mp->m_sb.sb_agcount)
David Chinnerda353b02007-08-28 14:00:13 +1000425 return EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
David Chinnerda353b02007-08-28 14:00:13 +1000427 /* get the perag structure and ensure that it's inode capable */
Dave Chinner5017e972010-01-11 11:47:40 +0000428 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
David Chinnerda353b02007-08-28 14:00:13 +1000429 agino = XFS_INO_TO_AGINO(mp, ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
431again:
David Chinner6441e542008-10-30 17:21:19 +1100432 error = 0;
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100433 rcu_read_lock();
David Chinnerda353b02007-08-28 14:00:13 +1000434 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
David Chinner6441e542008-10-30 17:21:19 +1100436 if (ip) {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100437 error = xfs_iget_cache_hit(pag, ip, ino, flags, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100438 if (error)
439 goto out_error_or_again;
440 } else {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100441 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100442 XFS_STATS_INC(xs_ig_missed);
David Chinnerda353b02007-08-28 14:00:13 +1000443
Dave Chinner7b6259e2010-06-24 11:35:17 +1000444 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip,
David Chinner6441e542008-10-30 17:21:19 +1100445 flags, lock_flags);
446 if (error)
447 goto out_error_or_again;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 }
Dave Chinner5017e972010-01-11 11:47:40 +0000449 xfs_perag_put(pag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 *ipp = ip;
452
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000453 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 * If we have a real type for an on-disk inode, we can set ops(&unlock)
455 * now. If it's a new inode being created, xfs_ialloc will handle it.
456 */
David Chinnerbf904242008-10-30 17:36:14 +1100457 if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000458 xfs_setup_inode(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 return 0;
David Chinner6441e542008-10-30 17:21:19 +1100460
461out_error_or_again:
462 if (error == EAGAIN) {
463 delay(1);
464 goto again;
465 }
Dave Chinner5017e972010-01-11 11:47:40 +0000466 xfs_perag_put(pag);
David Chinner6441e542008-10-30 17:21:19 +1100467 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468}
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 * This is a wrapper routine around the xfs_ilock() routine
472 * used to centralize some grungy code. It is used in places
473 * that wish to lock the inode solely for reading the extents.
474 * The reason these places can't just call xfs_ilock(SHARED)
475 * is that the inode lock also guards to bringing in of the
476 * extents from disk for a file in b-tree format. If the inode
477 * is in b-tree format, then we need to lock the inode exclusively
478 * until the extents are read in. Locking it exclusively all
479 * the time would limit our parallelism unnecessarily, though.
480 * What we do instead is check to see if the extents have been
481 * read in yet, and only lock the inode exclusively if they
482 * have not.
483 *
484 * The function returns a value which should be given to the
485 * corresponding xfs_iunlock_map_shared(). This value is
486 * the mode in which the lock was actually taken.
487 */
488uint
489xfs_ilock_map_shared(
490 xfs_inode_t *ip)
491{
492 uint lock_mode;
493
494 if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
495 ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
496 lock_mode = XFS_ILOCK_EXCL;
497 } else {
498 lock_mode = XFS_ILOCK_SHARED;
499 }
500
501 xfs_ilock(ip, lock_mode);
502
503 return lock_mode;
504}
505
506/*
507 * This is simply the unlock routine to go with xfs_ilock_map_shared().
508 * All it does is call xfs_iunlock() with the given lock_mode.
509 */
510void
511xfs_iunlock_map_shared(
512 xfs_inode_t *ip,
513 unsigned int lock_mode)
514{
515 xfs_iunlock(ip, lock_mode);
516}
517
518/*
519 * The xfs inode contains 2 locks: a multi-reader lock called the
520 * i_iolock and a multi-reader lock called the i_lock. This routine
521 * allows either or both of the locks to be obtained.
522 *
523 * The 2 locks should always be ordered so that the IO lock is
524 * obtained first in order to prevent deadlock.
525 *
526 * ip -- the inode being locked
527 * lock_flags -- this parameter indicates the inode's locks
528 * to be locked. It can be:
529 * XFS_IOLOCK_SHARED,
530 * XFS_IOLOCK_EXCL,
531 * XFS_ILOCK_SHARED,
532 * XFS_ILOCK_EXCL,
533 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
534 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
535 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
536 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
537 */
538void
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000539xfs_ilock(
540 xfs_inode_t *ip,
541 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
543 /*
544 * You can't set both SHARED and EXCL for the same lock,
545 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
546 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
547 */
548 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
549 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
550 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
551 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000552 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000554 if (lock_flags & XFS_IOLOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000555 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000556 else if (lock_flags & XFS_IOLOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000557 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000558
559 if (lock_flags & XFS_ILOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000560 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000561 else if (lock_flags & XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000562 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000563
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000564 trace_xfs_ilock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
567/*
568 * This is just like xfs_ilock(), except that the caller
569 * is guaranteed not to sleep. It returns 1 if it gets
570 * the requested locks and 0 otherwise. If the IO lock is
571 * obtained but the inode lock cannot be, then the IO lock
572 * is dropped before returning.
573 *
574 * ip -- the inode being locked
575 * lock_flags -- this parameter indicates the inode's locks to be
576 * to be locked. See the comment for xfs_ilock() for a list
577 * of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 */
579int
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000580xfs_ilock_nowait(
581 xfs_inode_t *ip,
582 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 /*
585 * You can't set both SHARED and EXCL for the same lock,
586 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
587 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
588 */
589 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
590 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
591 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
592 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000593 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 if (lock_flags & XFS_IOLOCK_EXCL) {
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000596 if (!mrtryupdate(&ip->i_iolock))
597 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 } else if (lock_flags & XFS_IOLOCK_SHARED) {
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000599 if (!mrtryaccess(&ip->i_iolock))
600 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 }
602 if (lock_flags & XFS_ILOCK_EXCL) {
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000603 if (!mrtryupdate(&ip->i_lock))
604 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 } else if (lock_flags & XFS_ILOCK_SHARED) {
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000606 if (!mrtryaccess(&ip->i_lock))
607 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000609 trace_xfs_ilock_nowait(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 return 1;
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000611
612 out_undo_iolock:
613 if (lock_flags & XFS_IOLOCK_EXCL)
614 mrunlock_excl(&ip->i_iolock);
615 else if (lock_flags & XFS_IOLOCK_SHARED)
616 mrunlock_shared(&ip->i_iolock);
617 out:
618 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619}
620
621/*
622 * xfs_iunlock() is used to drop the inode locks acquired with
623 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
624 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
625 * that we know which locks to drop.
626 *
627 * ip -- the inode being unlocked
628 * lock_flags -- this parameter indicates the inode's locks to be
629 * to be unlocked. See the comment for xfs_ilock() for a list
630 * of valid values for this parameter.
631 *
632 */
633void
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000634xfs_iunlock(
635 xfs_inode_t *ip,
636 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
638 /*
639 * You can't set both SHARED and EXCL for the same lock,
640 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
641 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
642 */
643 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
644 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
645 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
646 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000647 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
648 XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 ASSERT(lock_flags != 0);
650
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000651 if (lock_flags & XFS_IOLOCK_EXCL)
652 mrunlock_excl(&ip->i_iolock);
653 else if (lock_flags & XFS_IOLOCK_SHARED)
654 mrunlock_shared(&ip->i_iolock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000656 if (lock_flags & XFS_ILOCK_EXCL)
657 mrunlock_excl(&ip->i_lock);
658 else if (lock_flags & XFS_ILOCK_SHARED)
659 mrunlock_shared(&ip->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000661 if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
662 !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 /*
664 * Let the AIL know that this item has been unlocked in case
665 * it is in the AIL and anyone is waiting on it. Don't do
666 * this if the caller has asked us not to.
667 */
David Chinner783a2f62008-10-30 17:39:58 +1100668 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000669 (xfs_log_item_t*)(ip->i_itemp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000671 trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672}
673
674/*
675 * give up write locks. the i/o lock cannot be held nested
676 * if it is being demoted.
677 */
678void
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000679xfs_ilock_demote(
680 xfs_inode_t *ip,
681 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
683 ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
684 ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
685
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000686 if (lock_flags & XFS_ILOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 mrdemote(&ip->i_lock);
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000688 if (lock_flags & XFS_IOLOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 mrdemote(&ip->i_iolock);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000690
691 trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692}
693
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000694#ifdef DEBUG
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000695int
696xfs_isilocked(
697 xfs_inode_t *ip,
698 uint lock_flags)
699{
Christoph Hellwigf9369722010-06-03 16:22:29 +1000700 if (lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) {
701 if (!(lock_flags & XFS_ILOCK_SHARED))
702 return !!ip->i_lock.mr_writer;
703 return rwsem_is_locked(&ip->i_lock.mr_lock);
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000704 }
705
Christoph Hellwigf9369722010-06-03 16:22:29 +1000706 if (lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) {
707 if (!(lock_flags & XFS_IOLOCK_SHARED))
708 return !!ip->i_iolock.mr_writer;
709 return rwsem_is_locked(&ip->i_iolock.mr_lock);
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000710 }
711
Christoph Hellwigf9369722010-06-03 16:22:29 +1000712 ASSERT(0);
713 return 0;
Christoph Hellwig579aa9ca2008-04-22 17:34:00 +1000714}
715#endif
Christoph Hellwig474fce02011-12-18 20:00:09 +0000716
717void
718__xfs_iflock(
719 struct xfs_inode *ip)
720{
721 wait_queue_head_t *wq = bit_waitqueue(&ip->i_flags, __XFS_IFLOCK_BIT);
722 DEFINE_WAIT_BIT(wait, &ip->i_flags, __XFS_IFLOCK_BIT);
723
724 do {
725 prepare_to_wait_exclusive(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
726 if (xfs_isiflocked(ip))
727 io_schedule();
728 } while (!xfs_iflock_nowait(ip));
729
730 finish_wait(wq, &wait.wait);
731}