blob: cb9b6d1469f7579256061f6de61755c0d6b63df6 [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
256 ip->i_flags &= ~XFS_INEW;
257 ip->i_flags |= XFS_IRECLAIMABLE;
258 __xfs_inode_set_reclaim_tag(pag, ip);
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000259 trace_xfs_iget_reclaim_fail(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400260 goto out_error;
261 }
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000262
Dave Chinner1a427ab2010-12-16 17:08:41 +1100263 spin_lock(&pag->pag_ici_lock);
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000264 spin_lock(&ip->i_flags_lock);
265 ip->i_flags &= ~(XFS_IRECLAIMABLE | XFS_IRECLAIM);
266 ip->i_flags |= XFS_INEW;
267 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100268 inode->i_state = I_NEW;
Dave Chinnerdcfcf202010-12-23 11:57:13 +1100269
270 ASSERT(!rwsem_is_locked(&ip->i_iolock.mr_lock));
271 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
272 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
273 &xfs_iolock_active, "xfs_iolock_active");
274
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000275 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a427ab2010-12-16 17:08:41 +1100276 spin_unlock(&pag->pag_ici_lock);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400277 } else {
278 /* If the VFS inode is being torn down, pause and try again. */
279 if (!igrab(inode)) {
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000280 trace_xfs_iget_skip(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400281 error = EAGAIN;
David Chinnerbf904242008-10-30 17:36:14 +1100282 goto out_error;
283 }
David Chinner6bfb3d02008-10-30 18:32:43 +1100284
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400285 /* We've got a live one. */
286 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100287 rcu_read_unlock();
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000288 trace_xfs_iget_hit(ip);
David Chinner6441e542008-10-30 17:21:19 +1100289 }
290
David Chinner6441e542008-10-30 17:21:19 +1100291 if (lock_flags != 0)
292 xfs_ilock(ip, lock_flags);
293
294 xfs_iflags_clear(ip, XFS_ISTALE);
David Chinner6441e542008-10-30 17:21:19 +1100295 XFS_STATS_INC(xs_ig_found);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000296
David Chinner6441e542008-10-30 17:21:19 +1100297 return 0;
298
299out_error:
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400300 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100301 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100302 return error;
303}
304
305
306static int
307xfs_iget_cache_miss(
308 struct xfs_mount *mp,
309 struct xfs_perag *pag,
310 xfs_trans_t *tp,
311 xfs_ino_t ino,
312 struct xfs_inode **ipp,
David Chinner6441e542008-10-30 17:21:19 +1100313 int flags,
Christoph Hellwig0c3dc2b2009-11-14 16:17:23 +0000314 int lock_flags)
David Chinner6441e542008-10-30 17:21:19 +1100315{
316 struct xfs_inode *ip;
317 int error;
David Chinner6441e542008-10-30 17:21:19 +1100318 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
319
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100320 ip = xfs_inode_alloc(mp, ino);
321 if (!ip)
322 return ENOMEM;
323
Dave Chinner7b6259e2010-06-24 11:35:17 +1000324 error = xfs_iread(mp, tp, ip, flags);
David Chinner6441e542008-10-30 17:21:19 +1100325 if (error)
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100326 goto out_destroy;
David Chinner6441e542008-10-30 17:21:19 +1100327
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000328 trace_xfs_iget_miss(ip);
David Chinner6441e542008-10-30 17:21:19 +1100329
330 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
331 error = ENOENT;
332 goto out_destroy;
333 }
334
335 /*
336 * Preload the radix tree so we can insert safely under the
David Chinner56e73ec2008-10-30 17:55:27 +1100337 * write spinlock. Note that we cannot sleep inside the preload
338 * region.
David Chinner6441e542008-10-30 17:21:19 +1100339 */
340 if (radix_tree_preload(GFP_KERNEL)) {
341 error = EAGAIN;
Christoph Hellwiged93ec32009-03-03 14:48:35 -0500342 goto out_destroy;
343 }
344
345 /*
346 * Because the inode hasn't been added to the radix-tree yet it can't
347 * be found by another thread, so we can do the non-sleeping lock here.
348 */
349 if (lock_flags) {
350 if (!xfs_ilock_nowait(ip, lock_flags))
351 BUG();
David Chinner6441e542008-10-30 17:21:19 +1100352 }
353
Dave Chinner1a427ab2010-12-16 17:08:41 +1100354 spin_lock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100355
356 /* insert the new inode */
357 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
358 if (unlikely(error)) {
359 WARN_ON(error != -EEXIST);
360 XFS_STATS_INC(xs_ig_dup);
361 error = EAGAIN;
David Chinner56e73ec2008-10-30 17:55:27 +1100362 goto out_preload_end;
David Chinner6441e542008-10-30 17:21:19 +1100363 }
364
365 /* These values _must_ be set before releasing the radix tree lock! */
366 ip->i_udquot = ip->i_gdquot = NULL;
367 xfs_iflags_set(ip, XFS_INEW);
368
Dave Chinner1a427ab2010-12-16 17:08:41 +1100369 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100370 radix_tree_preload_end();
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000371
David Chinner6441e542008-10-30 17:21:19 +1100372 *ipp = ip;
373 return 0;
374
David Chinner56e73ec2008-10-30 17:55:27 +1100375out_preload_end:
Dave Chinner1a427ab2010-12-16 17:08:41 +1100376 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100377 radix_tree_preload_end();
David Chinner56e73ec2008-10-30 17:55:27 +1100378 if (lock_flags)
379 xfs_iunlock(ip, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100380out_destroy:
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300381 __destroy_inode(VFS_I(ip));
382 xfs_inode_free(ip);
David Chinner6441e542008-10-30 17:21:19 +1100383 return error;
384}
385
386/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 * Look up an inode by number in the given file system.
David Chinnerda353b02007-08-28 14:00:13 +1000388 * The inode is looked up in the cache held in each AG.
David Chinnerbf904242008-10-30 17:36:14 +1100389 * If the inode is found in the cache, initialise the vfs inode
390 * if necessary.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 *
David Chinnerda353b02007-08-28 14:00:13 +1000392 * If it is not in core, read it in from the file system's device,
David Chinnerbf904242008-10-30 17:36:14 +1100393 * add it to the cache and initialise the vfs inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 *
395 * The inode is locked according to the value of the lock_flags parameter.
396 * This flag parameter indicates how and if the inode's IO lock and inode lock
397 * should be taken.
398 *
399 * mp -- the mount point structure for the current file system. It points
400 * to the inode hash table.
401 * tp -- a pointer to the current transaction if there is one. This is
402 * simply passed through to the xfs_iread() call.
403 * ino -- the number of the inode desired. This is the unique identifier
404 * within the file system for the inode being requested.
405 * lock_flags -- flags indicating how to lock the inode. See the comment
406 * for xfs_ilock() for a list of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 */
David Chinnerbf904242008-10-30 17:36:14 +1100408int
409xfs_iget(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 xfs_mount_t *mp,
411 xfs_trans_t *tp,
412 xfs_ino_t ino,
413 uint flags,
414 uint lock_flags,
Dave Chinner7b6259e2010-06-24 11:35:17 +1000415 xfs_inode_t **ipp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 xfs_inode_t *ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 int error;
David Chinnerda353b02007-08-28 14:00:13 +1000419 xfs_perag_t *pag;
420 xfs_agino_t agino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Christoph Hellwigd2767342010-10-06 18:31:23 +0000422 /* reject inode numbers outside existing AGs */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100423 if (!ino || XFS_INO_TO_AGNO(mp, ino) >= mp->m_sb.sb_agcount)
David Chinnerda353b02007-08-28 14:00:13 +1000424 return EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
David Chinnerda353b02007-08-28 14:00:13 +1000426 /* get the perag structure and ensure that it's inode capable */
Dave Chinner5017e972010-01-11 11:47:40 +0000427 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
David Chinnerda353b02007-08-28 14:00:13 +1000428 agino = XFS_INO_TO_AGINO(mp, ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430again:
David Chinner6441e542008-10-30 17:21:19 +1100431 error = 0;
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100432 rcu_read_lock();
David Chinnerda353b02007-08-28 14:00:13 +1000433 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
David Chinner6441e542008-10-30 17:21:19 +1100435 if (ip) {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100436 error = xfs_iget_cache_hit(pag, ip, ino, flags, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100437 if (error)
438 goto out_error_or_again;
439 } else {
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100440 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100441 XFS_STATS_INC(xs_ig_missed);
David Chinnerda353b02007-08-28 14:00:13 +1000442
Dave Chinner7b6259e2010-06-24 11:35:17 +1000443 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip,
David Chinner6441e542008-10-30 17:21:19 +1100444 flags, lock_flags);
445 if (error)
446 goto out_error_or_again;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 }
Dave Chinner5017e972010-01-11 11:47:40 +0000448 xfs_perag_put(pag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 *ipp = ip;
451
David Chinnerbf904242008-10-30 17:36:14 +1100452 ASSERT(ip->i_df.if_ext_max ==
453 XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000454 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 * If we have a real type for an on-disk inode, we can set ops(&unlock)
456 * now. If it's a new inode being created, xfs_ialloc will handle it.
457 */
David Chinnerbf904242008-10-30 17:36:14 +1100458 if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000459 xfs_setup_inode(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 return 0;
David Chinner6441e542008-10-30 17:21:19 +1100461
462out_error_or_again:
463 if (error == EAGAIN) {
464 delay(1);
465 goto again;
466 }
Dave Chinner5017e972010-01-11 11:47:40 +0000467 xfs_perag_put(pag);
David Chinner6441e542008-10-30 17:21:19 +1100468 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469}
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 * This is a wrapper routine around the xfs_ilock() routine
473 * used to centralize some grungy code. It is used in places
474 * that wish to lock the inode solely for reading the extents.
475 * The reason these places can't just call xfs_ilock(SHARED)
476 * is that the inode lock also guards to bringing in of the
477 * extents from disk for a file in b-tree format. If the inode
478 * is in b-tree format, then we need to lock the inode exclusively
479 * until the extents are read in. Locking it exclusively all
480 * the time would limit our parallelism unnecessarily, though.
481 * What we do instead is check to see if the extents have been
482 * read in yet, and only lock the inode exclusively if they
483 * have not.
484 *
485 * The function returns a value which should be given to the
486 * corresponding xfs_iunlock_map_shared(). This value is
487 * the mode in which the lock was actually taken.
488 */
489uint
490xfs_ilock_map_shared(
491 xfs_inode_t *ip)
492{
493 uint lock_mode;
494
495 if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
496 ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
497 lock_mode = XFS_ILOCK_EXCL;
498 } else {
499 lock_mode = XFS_ILOCK_SHARED;
500 }
501
502 xfs_ilock(ip, lock_mode);
503
504 return lock_mode;
505}
506
507/*
508 * This is simply the unlock routine to go with xfs_ilock_map_shared().
509 * All it does is call xfs_iunlock() with the given lock_mode.
510 */
511void
512xfs_iunlock_map_shared(
513 xfs_inode_t *ip,
514 unsigned int lock_mode)
515{
516 xfs_iunlock(ip, lock_mode);
517}
518
519/*
520 * The xfs inode contains 2 locks: a multi-reader lock called the
521 * i_iolock and a multi-reader lock called the i_lock. This routine
522 * allows either or both of the locks to be obtained.
523 *
524 * The 2 locks should always be ordered so that the IO lock is
525 * obtained first in order to prevent deadlock.
526 *
527 * ip -- the inode being locked
528 * lock_flags -- this parameter indicates the inode's locks
529 * to be locked. It can be:
530 * XFS_IOLOCK_SHARED,
531 * XFS_IOLOCK_EXCL,
532 * XFS_ILOCK_SHARED,
533 * XFS_ILOCK_EXCL,
534 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
535 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
536 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
537 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
538 */
539void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000540xfs_ilock(
541 xfs_inode_t *ip,
542 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
544 /*
545 * You can't set both SHARED and EXCL for the same lock,
546 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
547 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
548 */
549 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
550 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
551 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
552 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000553 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000555 if (lock_flags & XFS_IOLOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000556 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000557 else if (lock_flags & XFS_IOLOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000558 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000559
560 if (lock_flags & XFS_ILOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000561 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000562 else if (lock_flags & XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000563 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000564
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000565 trace_xfs_ilock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566}
567
568/*
569 * This is just like xfs_ilock(), except that the caller
570 * is guaranteed not to sleep. It returns 1 if it gets
571 * the requested locks and 0 otherwise. If the IO lock is
572 * obtained but the inode lock cannot be, then the IO lock
573 * is dropped before returning.
574 *
575 * ip -- the inode being locked
576 * lock_flags -- this parameter indicates the inode's locks to be
577 * to be locked. See the comment for xfs_ilock() for a list
578 * of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 */
580int
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000581xfs_ilock_nowait(
582 xfs_inode_t *ip,
583 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 /*
586 * You can't set both SHARED and EXCL for the same lock,
587 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
588 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
589 */
590 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
591 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
592 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
593 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000594 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 if (lock_flags & XFS_IOLOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000597 if (!mrtryupdate(&ip->i_iolock))
598 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 } else if (lock_flags & XFS_IOLOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000600 if (!mrtryaccess(&ip->i_iolock))
601 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 }
603 if (lock_flags & XFS_ILOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000604 if (!mrtryupdate(&ip->i_lock))
605 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 } else if (lock_flags & XFS_ILOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000607 if (!mrtryaccess(&ip->i_lock))
608 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000610 trace_xfs_ilock_nowait(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 return 1;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000612
613 out_undo_iolock:
614 if (lock_flags & XFS_IOLOCK_EXCL)
615 mrunlock_excl(&ip->i_iolock);
616 else if (lock_flags & XFS_IOLOCK_SHARED)
617 mrunlock_shared(&ip->i_iolock);
618 out:
619 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
621
622/*
623 * xfs_iunlock() is used to drop the inode locks acquired with
624 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
625 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
626 * that we know which locks to drop.
627 *
628 * ip -- the inode being unlocked
629 * lock_flags -- this parameter indicates the inode's locks to be
630 * to be unlocked. See the comment for xfs_ilock() for a list
631 * of valid values for this parameter.
632 *
633 */
634void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000635xfs_iunlock(
636 xfs_inode_t *ip,
637 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
639 /*
640 * You can't set both SHARED and EXCL for the same lock,
641 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
642 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
643 */
644 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
645 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
646 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
647 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000648 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
649 XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 ASSERT(lock_flags != 0);
651
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000652 if (lock_flags & XFS_IOLOCK_EXCL)
653 mrunlock_excl(&ip->i_iolock);
654 else if (lock_flags & XFS_IOLOCK_SHARED)
655 mrunlock_shared(&ip->i_iolock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000657 if (lock_flags & XFS_ILOCK_EXCL)
658 mrunlock_excl(&ip->i_lock);
659 else if (lock_flags & XFS_ILOCK_SHARED)
660 mrunlock_shared(&ip->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000662 if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
663 !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 /*
665 * Let the AIL know that this item has been unlocked in case
666 * it is in the AIL and anyone is waiting on it. Don't do
667 * this if the caller has asked us not to.
668 */
David Chinner783a2f62008-10-30 17:39:58 +1100669 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000670 (xfs_log_item_t*)(ip->i_itemp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000672 trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673}
674
675/*
676 * give up write locks. the i/o lock cannot be held nested
677 * if it is being demoted.
678 */
679void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000680xfs_ilock_demote(
681 xfs_inode_t *ip,
682 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
684 ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
685 ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
686
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000687 if (lock_flags & XFS_ILOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 mrdemote(&ip->i_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000689 if (lock_flags & XFS_IOLOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 mrdemote(&ip->i_iolock);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000691
692 trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693}
694
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000695#ifdef DEBUG
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000696int
697xfs_isilocked(
698 xfs_inode_t *ip,
699 uint lock_flags)
700{
Christoph Hellwigf9369722010-06-03 16:22:29 +1000701 if (lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) {
702 if (!(lock_flags & XFS_ILOCK_SHARED))
703 return !!ip->i_lock.mr_writer;
704 return rwsem_is_locked(&ip->i_lock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000705 }
706
Christoph Hellwigf9369722010-06-03 16:22:29 +1000707 if (lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) {
708 if (!(lock_flags & XFS_IOLOCK_SHARED))
709 return !!ip->i_iolock.mr_writer;
710 return rwsem_is_locked(&ip->i_iolock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000711 }
712
Christoph Hellwigf9369722010-06-03 16:22:29 +1000713 ASSERT(0);
714 return 0;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000715}
716#endif