blob: 1bb4365e8c25470d8686996401d7996ce1d3b244 [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"
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "xfs_log.h"
Nathan Scotta844f452005-11-02 14:38:42 +110023#include "xfs_inum.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include "xfs_trans.h"
25#include "xfs_sb.h"
26#include "xfs_ag.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include "xfs_mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include "xfs_bmap_btree.h"
Nathan Scotta844f452005-11-02 14:38:42 +110029#include "xfs_alloc_btree.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "xfs_ialloc_btree.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "xfs_dinode.h"
32#include "xfs_inode.h"
Nathan Scotta844f452005-11-02 14:38:42 +110033#include "xfs_btree.h"
34#include "xfs_ialloc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include "xfs_quota.h"
36#include "xfs_utils.h"
David Chinner783a2f62008-10-30 17:39:58 +110037#include "xfs_trans_priv.h"
38#include "xfs_inode_item.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110039#include "xfs_bmap.h"
Christoph Hellwig0b1b2132009-12-14 23:14:59 +000040#include "xfs_trace.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110041
42
43/*
Dave Chinnerdcfcf202010-12-23 11:57:13 +110044 * Define xfs inode iolock lockdep classes. We need to ensure that all active
45 * inodes are considered the same for lockdep purposes, including inodes that
46 * are recycled through the XFS_IRECLAIMABLE state. This is the the only way to
47 * guarantee the locks are considered the same when there are multiple lock
48 * initialisation siteѕ. Also, define a reclaimable inode class so it is
49 * obvious in lockdep reports which class the report is against.
50 */
51static struct lock_class_key xfs_iolock_active;
52struct lock_class_key xfs_iolock_reclaimable;
53
54/*
Christoph Hellwig24f211b2008-11-28 14:23:42 +110055 * Allocate and initialise an xfs_inode.
56 */
57STATIC struct xfs_inode *
58xfs_inode_alloc(
59 struct xfs_mount *mp,
60 xfs_ino_t ino)
61{
62 struct xfs_inode *ip;
63
64 /*
65 * if this didn't occur in transactions, we could use
66 * KM_MAYFAIL and return NULL here on ENOMEM. Set the
67 * code up to do this anyway.
68 */
69 ip = kmem_zone_alloc(xfs_inode_zone, KM_SLEEP);
70 if (!ip)
71 return NULL;
Christoph Hellwig54e34622009-08-07 14:38:25 -030072 if (inode_init_always(mp->m_super, VFS_I(ip))) {
73 kmem_zone_free(xfs_inode_zone, ip);
74 return NULL;
75 }
Christoph Hellwig24f211b2008-11-28 14:23:42 +110076
Christoph Hellwig24f211b2008-11-28 14:23:42 +110077 ASSERT(atomic_read(&ip->i_pincount) == 0);
78 ASSERT(!spin_is_locked(&ip->i_flags_lock));
Christoph Hellwig474fce02011-12-18 20:00:09 +000079 ASSERT(!xfs_isiflocked(ip));
Dave Chinner1a3e8f32010-12-17 17:29:43 +110080 ASSERT(ip->i_ino == 0);
Christoph Hellwig033da482009-10-19 04:05:26 +000081
82 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
Dave Chinnerdcfcf202010-12-23 11:57:13 +110083 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
84 &xfs_iolock_active, "xfs_iolock_active");
Christoph Hellwig24f211b2008-11-28 14:23:42 +110085
Christoph Hellwig24f211b2008-11-28 14:23:42 +110086 /* initialise the xfs inode */
87 ip->i_ino = ino;
88 ip->i_mount = mp;
89 memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
90 ip->i_afp = NULL;
91 memset(&ip->i_df, 0, sizeof(xfs_ifork_t));
92 ip->i_flags = 0;
Christoph Hellwig24f211b2008-11-28 14:23:42 +110093 ip->i_delayed_blks = 0;
94 memset(&ip->i_d, 0, sizeof(xfs_icdinode_t));
Christoph Hellwig24f211b2008-11-28 14:23:42 +110095
Christoph Hellwig24f211b2008-11-28 14:23:42 +110096 return ip;
97}
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +110099STATIC void
100xfs_inode_free_callback(
101 struct rcu_head *head)
102{
103 struct inode *inode = container_of(head, struct inode, i_rcu);
104 struct xfs_inode *ip = XFS_I(inode);
105
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100106 kmem_zone_free(xfs_inode_zone, ip);
107}
108
Dave Chinner2f11fea2010-07-20 17:53:25 +1000109void
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300110xfs_inode_free(
111 struct xfs_inode *ip)
112{
113 switch (ip->i_d.di_mode & S_IFMT) {
114 case S_IFREG:
115 case S_IFDIR:
116 case S_IFLNK:
117 xfs_idestroy_fork(ip, XFS_DATA_FORK);
118 break;
119 }
120
121 if (ip->i_afp)
122 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
123
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300124 if (ip->i_itemp) {
Christoph Hellwig32ce90a2012-04-23 15:58:32 +1000125 ASSERT(!(ip->i_itemp->ili_item.li_flags & XFS_LI_IN_AIL));
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300126 xfs_inode_item_destroy(ip);
127 ip->i_itemp = NULL;
128 }
129
130 /* asserts to verify all state is correct here */
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300131 ASSERT(atomic_read(&ip->i_pincount) == 0);
132 ASSERT(!spin_is_locked(&ip->i_flags_lock));
Christoph Hellwig474fce02011-12-18 20:00:09 +0000133 ASSERT(!xfs_isiflocked(ip));
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300134
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100135 /*
136 * Because we use RCU freeing we need to ensure the inode always
137 * appears to be reclaimed with an invalid inode number when in the
138 * free state. The ip->i_flags_lock provides the barrier against lookup
139 * races.
140 */
141 spin_lock(&ip->i_flags_lock);
142 ip->i_flags = XFS_IRECLAIM;
143 ip->i_ino = 0;
144 spin_unlock(&ip->i_flags_lock);
Alex Elder92f1c002011-01-10 21:35:55 -0600145
146 call_rcu(&VFS_I(ip)->i_rcu, xfs_inode_free_callback);
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300147}
148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149/*
David Chinner6441e542008-10-30 17:21:19 +1100150 * Check the validity of the inode we just found it the cache
151 */
152static int
153xfs_iget_cache_hit(
David Chinner6441e542008-10-30 17:21:19 +1100154 struct xfs_perag *pag,
155 struct xfs_inode *ip,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100156 xfs_ino_t ino,
David Chinner6441e542008-10-30 17:21:19 +1100157 int flags,
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100158 int lock_flags) __releases(RCU)
David Chinner6441e542008-10-30 17:21:19 +1100159{
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400160 struct inode *inode = VFS_I(ip);
David Chinner6441e542008-10-30 17:21:19 +1100161 struct xfs_mount *mp = ip->i_mount;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400162 int error;
163
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100164 /*
165 * check for re-use of an inode within an RCU grace period due to the
166 * radix tree nodes not being updated yet. We monitor for this by
167 * setting the inode number to zero before freeing the inode structure.
168 * If the inode has been reallocated and set up, then the inode number
169 * will not match, so check for that, too.
170 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400171 spin_lock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100172 if (ip->i_ino != ino) {
173 trace_xfs_iget_skip(ip);
174 XFS_STATS_INC(xs_ig_frecycle);
175 error = EAGAIN;
176 goto out_error;
177 }
178
David Chinner6441e542008-10-30 17:21:19 +1100179
180 /*
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400181 * If we are racing with another cache hit that is currently
182 * instantiating this inode or currently recycling it out of
183 * reclaimabe state, wait for the initialisation to complete
184 * before continuing.
185 *
186 * XXX(hch): eventually we should do something equivalent to
187 * wait_on_inode to wait for these flags to be cleared
188 * instead of polling for it.
David Chinner6441e542008-10-30 17:21:19 +1100189 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400190 if (ip->i_flags & (XFS_INEW|XFS_IRECLAIM)) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000191 trace_xfs_iget_skip(ip);
David Chinner6441e542008-10-30 17:21:19 +1100192 XFS_STATS_INC(xs_ig_frecycle);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400193 error = EAGAIN;
David Chinner6441e542008-10-30 17:21:19 +1100194 goto out_error;
195 }
196
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400197 /*
198 * If lookup is racing with unlink return an error immediately.
199 */
200 if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
201 error = ENOENT;
202 goto out_error;
203 }
David Chinner6441e542008-10-30 17:21:19 +1100204
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400205 /*
206 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
207 * Need to carefully get it back into useable state.
208 */
209 if (ip->i_flags & XFS_IRECLAIMABLE) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000210 trace_xfs_iget_reclaim(ip);
David Chinner6441e542008-10-30 17:21:19 +1100211
David Chinnerbf904242008-10-30 17:36:14 +1100212 /*
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000213 * We need to set XFS_IRECLAIM to prevent xfs_reclaim_inode
214 * from stomping over us while we recycle the inode. We can't
215 * clear the radix tree reclaimable tag yet as it requires
216 * pag_ici_lock to be held exclusive.
David Chinnerbf904242008-10-30 17:36:14 +1100217 */
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000218 ip->i_flags |= XFS_IRECLAIM;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400219
220 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100221 rcu_read_unlock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400222
223 error = -inode_init_always(mp->m_super, inode);
224 if (error) {
225 /*
226 * Re-initializing the inode failed, and we are in deep
227 * trouble. Try to re-add it to the reclaim list.
228 */
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100229 rcu_read_lock();
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400230 spin_lock(&ip->i_flags_lock);
231
Dave Chinner778e24b2011-06-23 01:34:59 +0000232 ip->i_flags &= ~(XFS_INEW | XFS_IRECLAIM);
233 ASSERT(ip->i_flags & XFS_IRECLAIMABLE);
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000234 trace_xfs_iget_reclaim_fail(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400235 goto out_error;
236 }
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000237
Dave Chinner1a427ab2010-12-16 17:08:41 +1100238 spin_lock(&pag->pag_ici_lock);
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000239 spin_lock(&ip->i_flags_lock);
Dave Chinner778e24b2011-06-23 01:34:59 +0000240
241 /*
242 * Clear the per-lifetime state in the inode as we are now
243 * effectively a new inode and need to return to the initial
244 * state before reuse occurs.
245 */
246 ip->i_flags &= ~XFS_IRECLAIM_RESET_FLAGS;
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000247 ip->i_flags |= XFS_INEW;
248 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100249 inode->i_state = I_NEW;
Dave Chinnerdcfcf202010-12-23 11:57:13 +1100250
251 ASSERT(!rwsem_is_locked(&ip->i_iolock.mr_lock));
252 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
253 lockdep_set_class_and_name(&ip->i_iolock.mr_lock,
254 &xfs_iolock_active, "xfs_iolock_active");
255
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000256 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a427ab2010-12-16 17:08:41 +1100257 spin_unlock(&pag->pag_ici_lock);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400258 } else {
259 /* If the VFS inode is being torn down, pause and try again. */
260 if (!igrab(inode)) {
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000261 trace_xfs_iget_skip(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400262 error = EAGAIN;
David Chinnerbf904242008-10-30 17:36:14 +1100263 goto out_error;
264 }
David Chinner6bfb3d02008-10-30 18:32:43 +1100265
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400266 /* We've got a live one. */
267 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100268 rcu_read_unlock();
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000269 trace_xfs_iget_hit(ip);
David Chinner6441e542008-10-30 17:21:19 +1100270 }
271
David Chinner6441e542008-10-30 17:21:19 +1100272 if (lock_flags != 0)
273 xfs_ilock(ip, lock_flags);
274
Dave Chinner5132ba82012-03-22 05:15:10 +0000275 xfs_iflags_clear(ip, XFS_ISTALE | XFS_IDONTCACHE);
David Chinner6441e542008-10-30 17:21:19 +1100276 XFS_STATS_INC(xs_ig_found);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000277
David Chinner6441e542008-10-30 17:21:19 +1100278 return 0;
279
280out_error:
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400281 spin_unlock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100282 rcu_read_unlock();
David Chinner6441e542008-10-30 17:21:19 +1100283 return error;
284}
285
286
287static int
288xfs_iget_cache_miss(
289 struct xfs_mount *mp,
290 struct xfs_perag *pag,
291 xfs_trans_t *tp,
292 xfs_ino_t ino,
293 struct xfs_inode **ipp,
David Chinner6441e542008-10-30 17:21:19 +1100294 int flags,
Christoph Hellwig0c3dc2b2009-11-14 16:17:23 +0000295 int lock_flags)
David Chinner6441e542008-10-30 17:21:19 +1100296{
297 struct xfs_inode *ip;
298 int error;
David Chinner6441e542008-10-30 17:21:19 +1100299 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
Dave Chinner5132ba82012-03-22 05:15:10 +0000300 int iflags;
David Chinner6441e542008-10-30 17:21:19 +1100301
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100302 ip = xfs_inode_alloc(mp, ino);
303 if (!ip)
304 return ENOMEM;
305
Dave Chinner7b6259e2010-06-24 11:35:17 +1000306 error = xfs_iread(mp, tp, ip, flags);
David Chinner6441e542008-10-30 17:21:19 +1100307 if (error)
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100308 goto out_destroy;
David Chinner6441e542008-10-30 17:21:19 +1100309
Christoph Hellwigd2e078c2010-06-24 11:50:22 +1000310 trace_xfs_iget_miss(ip);
David Chinner6441e542008-10-30 17:21:19 +1100311
312 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
313 error = ENOENT;
314 goto out_destroy;
315 }
316
317 /*
318 * Preload the radix tree so we can insert safely under the
David Chinner56e73ec2008-10-30 17:55:27 +1100319 * write spinlock. Note that we cannot sleep inside the preload
Peter Watkins3ba31602012-05-07 16:11:37 -0400320 * region. Since we can be called from transaction context, don't
321 * recurse into the file system.
David Chinner6441e542008-10-30 17:21:19 +1100322 */
Peter Watkins3ba31602012-05-07 16:11:37 -0400323 if (radix_tree_preload(GFP_NOFS)) {
David Chinner6441e542008-10-30 17:21:19 +1100324 error = EAGAIN;
Christoph Hellwiged93ec32009-03-03 14:48:35 -0500325 goto out_destroy;
326 }
327
328 /*
329 * Because the inode hasn't been added to the radix-tree yet it can't
330 * be found by another thread, so we can do the non-sleeping lock here.
331 */
332 if (lock_flags) {
333 if (!xfs_ilock_nowait(ip, lock_flags))
334 BUG();
David Chinner6441e542008-10-30 17:21:19 +1100335 }
336
Dave Chinnerf30d5002012-03-07 04:50:25 +0000337 /*
338 * These values must be set before inserting the inode into the radix
339 * tree as the moment it is inserted a concurrent lookup (allowed by the
340 * RCU locking mechanism) can find it and that lookup must see that this
341 * is an inode currently under construction (i.e. that XFS_INEW is set).
342 * The ip->i_flags_lock that protects the XFS_INEW flag forms the
343 * memory barrier that ensures this detection works correctly at lookup
344 * time.
345 */
Dave Chinner5132ba82012-03-22 05:15:10 +0000346 iflags = XFS_INEW;
347 if (flags & XFS_IGET_DONTCACHE)
348 iflags |= XFS_IDONTCACHE;
Dave Chinnerf30d5002012-03-07 04:50:25 +0000349 ip->i_udquot = ip->i_gdquot = NULL;
Dave Chinner5132ba82012-03-22 05:15:10 +0000350 xfs_iflags_set(ip, iflags);
David Chinner6441e542008-10-30 17:21:19 +1100351
352 /* insert the new inode */
Dave Chinnerf30d5002012-03-07 04:50:25 +0000353 spin_lock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100354 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
355 if (unlikely(error)) {
356 WARN_ON(error != -EEXIST);
357 XFS_STATS_INC(xs_ig_dup);
358 error = EAGAIN;
David Chinner56e73ec2008-10-30 17:55:27 +1100359 goto out_preload_end;
David Chinner6441e542008-10-30 17:21:19 +1100360 }
Dave Chinner1a427ab2010-12-16 17:08:41 +1100361 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100362 radix_tree_preload_end();
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000363
David Chinner6441e542008-10-30 17:21:19 +1100364 *ipp = ip;
365 return 0;
366
David Chinner56e73ec2008-10-30 17:55:27 +1100367out_preload_end:
Dave Chinner1a427ab2010-12-16 17:08:41 +1100368 spin_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100369 radix_tree_preload_end();
David Chinner56e73ec2008-10-30 17:55:27 +1100370 if (lock_flags)
371 xfs_iunlock(ip, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100372out_destroy:
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300373 __destroy_inode(VFS_I(ip));
374 xfs_inode_free(ip);
David Chinner6441e542008-10-30 17:21:19 +1100375 return error;
376}
377
378/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 * Look up an inode by number in the given file system.
David Chinnerda353b02007-08-28 14:00:13 +1000380 * The inode is looked up in the cache held in each AG.
David Chinnerbf904242008-10-30 17:36:14 +1100381 * If the inode is found in the cache, initialise the vfs inode
382 * if necessary.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 *
David Chinnerda353b02007-08-28 14:00:13 +1000384 * If it is not in core, read it in from the file system's device,
David Chinnerbf904242008-10-30 17:36:14 +1100385 * add it to the cache and initialise the vfs inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 *
387 * The inode is locked according to the value of the lock_flags parameter.
388 * This flag parameter indicates how and if the inode's IO lock and inode lock
389 * should be taken.
390 *
391 * mp -- the mount point structure for the current file system. It points
392 * to the inode hash table.
393 * tp -- a pointer to the current transaction if there is one. This is
394 * simply passed through to the xfs_iread() call.
395 * ino -- the number of the inode desired. This is the unique identifier
396 * within the file system for the inode being requested.
397 * lock_flags -- flags indicating how to lock the inode. See the comment
398 * for xfs_ilock() for a list of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 */
David Chinnerbf904242008-10-30 17:36:14 +1100400int
401xfs_iget(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 xfs_mount_t *mp,
403 xfs_trans_t *tp,
404 xfs_ino_t ino,
405 uint flags,
406 uint lock_flags,
Dave Chinner7b6259e2010-06-24 11:35:17 +1000407 xfs_inode_t **ipp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 xfs_inode_t *ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 int error;
David Chinnerda353b02007-08-28 14:00:13 +1000411 xfs_perag_t *pag;
412 xfs_agino_t agino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Alex Elderad637a12012-02-16 22:01:00 +0000414 /*
415 * xfs_reclaim_inode() uses the ILOCK to ensure an inode
416 * doesn't get freed while it's being referenced during a
417 * radix tree traversal here. It assumes this function
418 * aqcuires only the ILOCK (and therefore it has no need to
419 * involve the IOLOCK in this synchronization).
420 */
421 ASSERT((lock_flags & (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED)) == 0);
422
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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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 Hellwig579aa9c2008-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));
Christoph Hellwig5b03ff12012-02-20 02:31:22 +0000647 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 ASSERT(lock_flags != 0);
649
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000650 if (lock_flags & XFS_IOLOCK_EXCL)
651 mrunlock_excl(&ip->i_iolock);
652 else if (lock_flags & XFS_IOLOCK_SHARED)
653 mrunlock_shared(&ip->i_iolock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000655 if (lock_flags & XFS_ILOCK_EXCL)
656 mrunlock_excl(&ip->i_lock);
657 else if (lock_flags & XFS_ILOCK_SHARED)
658 mrunlock_shared(&ip->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000660 trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
663/*
664 * give up write locks. the i/o lock cannot be held nested
665 * if it is being demoted.
666 */
667void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000668xfs_ilock_demote(
669 xfs_inode_t *ip,
670 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671{
672 ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
673 ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
674
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000675 if (lock_flags & XFS_ILOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 mrdemote(&ip->i_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000677 if (lock_flags & XFS_IOLOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 mrdemote(&ip->i_iolock);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000679
680 trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681}
682
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000683#ifdef DEBUG
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000684int
685xfs_isilocked(
686 xfs_inode_t *ip,
687 uint lock_flags)
688{
Christoph Hellwigf9369722010-06-03 16:22:29 +1000689 if (lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) {
690 if (!(lock_flags & XFS_ILOCK_SHARED))
691 return !!ip->i_lock.mr_writer;
692 return rwsem_is_locked(&ip->i_lock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000693 }
694
Christoph Hellwigf9369722010-06-03 16:22:29 +1000695 if (lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) {
696 if (!(lock_flags & XFS_IOLOCK_SHARED))
697 return !!ip->i_iolock.mr_writer;
698 return rwsem_is_locked(&ip->i_iolock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000699 }
700
Christoph Hellwigf9369722010-06-03 16:22:29 +1000701 ASSERT(0);
702 return 0;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000703}
704#endif
Christoph Hellwig474fce02011-12-18 20:00:09 +0000705
706void
707__xfs_iflock(
708 struct xfs_inode *ip)
709{
710 wait_queue_head_t *wq = bit_waitqueue(&ip->i_flags, __XFS_IFLOCK_BIT);
711 DEFINE_WAIT_BIT(wait, &ip->i_flags, __XFS_IFLOCK_BIT);
712
713 do {
714 prepare_to_wait_exclusive(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
715 if (xfs_isiflocked(ip))
716 io_schedule();
717 } while (!xfs_iflock_nowait(ip));
718
719 finish_wait(wq, &wait.wait);
720}