blob: 75df75f43d48bf94f0e463aad56df8dc7f73dbfb [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_dir2.h"
29#include "xfs_dmapi.h"
30#include "xfs_mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "xfs_bmap_btree.h"
Nathan Scotta844f452005-11-02 14:38:42 +110032#include "xfs_alloc_btree.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include "xfs_ialloc_btree.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include "xfs_dir2_sf.h"
Nathan Scotta844f452005-11-02 14:38:42 +110035#include "xfs_attr_sf.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include "xfs_dinode.h"
37#include "xfs_inode.h"
Nathan Scotta844f452005-11-02 14:38:42 +110038#include "xfs_btree.h"
39#include "xfs_ialloc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include "xfs_quota.h"
41#include "xfs_utils.h"
David Chinner783a2f62008-10-30 17:39:58 +110042#include "xfs_trans_priv.h"
43#include "xfs_inode_item.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110044#include "xfs_bmap.h"
45#include "xfs_btree_trace.h"
Christoph Hellwig0b1b2132009-12-14 23:14:59 +000046#include "xfs_trace.h"
Christoph Hellwig24f211b2008-11-28 14:23:42 +110047
48
49/*
50 * Allocate and initialise an xfs_inode.
51 */
52STATIC struct xfs_inode *
53xfs_inode_alloc(
54 struct xfs_mount *mp,
55 xfs_ino_t ino)
56{
57 struct xfs_inode *ip;
58
59 /*
60 * if this didn't occur in transactions, we could use
61 * KM_MAYFAIL and return NULL here on ENOMEM. Set the
62 * code up to do this anyway.
63 */
64 ip = kmem_zone_alloc(xfs_inode_zone, KM_SLEEP);
65 if (!ip)
66 return NULL;
Christoph Hellwig54e34622009-08-07 14:38:25 -030067 if (inode_init_always(mp->m_super, VFS_I(ip))) {
68 kmem_zone_free(xfs_inode_zone, ip);
69 return NULL;
70 }
Christoph Hellwig24f211b2008-11-28 14:23:42 +110071
72 ASSERT(atomic_read(&ip->i_iocount) == 0);
73 ASSERT(atomic_read(&ip->i_pincount) == 0);
74 ASSERT(!spin_is_locked(&ip->i_flags_lock));
75 ASSERT(completion_done(&ip->i_flush));
Christoph Hellwig033da482009-10-19 04:05:26 +000076
77 mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
Christoph Hellwig24f211b2008-11-28 14:23:42 +110078
Christoph Hellwig24f211b2008-11-28 14:23:42 +110079 /* initialise the xfs inode */
80 ip->i_ino = ino;
81 ip->i_mount = mp;
82 memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
83 ip->i_afp = NULL;
84 memset(&ip->i_df, 0, sizeof(xfs_ifork_t));
85 ip->i_flags = 0;
86 ip->i_update_core = 0;
Christoph Hellwig24f211b2008-11-28 14:23:42 +110087 ip->i_delayed_blks = 0;
88 memset(&ip->i_d, 0, sizeof(xfs_icdinode_t));
89 ip->i_size = 0;
90 ip->i_new_size = 0;
91
Dave Chinner705db3f2009-04-06 18:40:17 +020092 /* prevent anyone from using this yet */
Christoph Hellwigeaff8072009-12-17 14:25:01 +010093 VFS_I(ip)->i_state = I_NEW;
Christoph Hellwig24f211b2008-11-28 14:23:42 +110094
95 return ip;
96}
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Christoph Hellwigb36ec042009-08-07 14:38:34 -030098STATIC void
99xfs_inode_free(
100 struct xfs_inode *ip)
101{
102 switch (ip->i_d.di_mode & S_IFMT) {
103 case S_IFREG:
104 case S_IFDIR:
105 case S_IFLNK:
106 xfs_idestroy_fork(ip, XFS_DATA_FORK);
107 break;
108 }
109
110 if (ip->i_afp)
111 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
112
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300113 if (ip->i_itemp) {
114 /*
115 * Only if we are shutting down the fs will we see an
116 * inode still in the AIL. If it is there, we should remove
117 * it to prevent a use-after-free from occurring.
118 */
119 xfs_log_item_t *lip = &ip->i_itemp->ili_item;
120 struct xfs_ail *ailp = lip->li_ailp;
121
122 ASSERT(((lip->li_flags & XFS_LI_IN_AIL) == 0) ||
123 XFS_FORCED_SHUTDOWN(ip->i_mount));
124 if (lip->li_flags & XFS_LI_IN_AIL) {
125 spin_lock(&ailp->xa_lock);
126 if (lip->li_flags & XFS_LI_IN_AIL)
127 xfs_trans_ail_delete(ailp, lip);
128 else
129 spin_unlock(&ailp->xa_lock);
130 }
131 xfs_inode_item_destroy(ip);
132 ip->i_itemp = NULL;
133 }
134
135 /* asserts to verify all state is correct here */
136 ASSERT(atomic_read(&ip->i_iocount) == 0);
137 ASSERT(atomic_read(&ip->i_pincount) == 0);
138 ASSERT(!spin_is_locked(&ip->i_flags_lock));
139 ASSERT(completion_done(&ip->i_flush));
140
141 kmem_zone_free(xfs_inode_zone, ip);
142}
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144/*
David Chinner6441e542008-10-30 17:21:19 +1100145 * Check the validity of the inode we just found it the cache
146 */
147static int
148xfs_iget_cache_hit(
David Chinner6441e542008-10-30 17:21:19 +1100149 struct xfs_perag *pag,
150 struct xfs_inode *ip,
151 int flags,
152 int lock_flags) __releases(pag->pag_ici_lock)
153{
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400154 struct inode *inode = VFS_I(ip);
David Chinner6441e542008-10-30 17:21:19 +1100155 struct xfs_mount *mp = ip->i_mount;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400156 int error;
157
158 spin_lock(&ip->i_flags_lock);
David Chinner6441e542008-10-30 17:21:19 +1100159
160 /*
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400161 * If we are racing with another cache hit that is currently
162 * instantiating this inode or currently recycling it out of
163 * reclaimabe state, wait for the initialisation to complete
164 * before continuing.
165 *
166 * XXX(hch): eventually we should do something equivalent to
167 * wait_on_inode to wait for these flags to be cleared
168 * instead of polling for it.
David Chinner6441e542008-10-30 17:21:19 +1100169 */
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400170 if (ip->i_flags & (XFS_INEW|XFS_IRECLAIM)) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000171 trace_xfs_iget_skip(ip);
David Chinner6441e542008-10-30 17:21:19 +1100172 XFS_STATS_INC(xs_ig_frecycle);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400173 error = EAGAIN;
David Chinner6441e542008-10-30 17:21:19 +1100174 goto out_error;
175 }
176
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400177 /*
178 * If lookup is racing with unlink return an error immediately.
179 */
180 if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
181 error = ENOENT;
182 goto out_error;
183 }
David Chinner6441e542008-10-30 17:21:19 +1100184
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400185 /*
186 * If IRECLAIMABLE is set, we've torn down the VFS inode already.
187 * Need to carefully get it back into useable state.
188 */
189 if (ip->i_flags & XFS_IRECLAIMABLE) {
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000190 trace_xfs_iget_reclaim(ip);
David Chinner6441e542008-10-30 17:21:19 +1100191
David Chinnerbf904242008-10-30 17:36:14 +1100192 /*
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000193 * We need to set XFS_IRECLAIM to prevent xfs_reclaim_inode
194 * from stomping over us while we recycle the inode. We can't
195 * clear the radix tree reclaimable tag yet as it requires
196 * pag_ici_lock to be held exclusive.
David Chinnerbf904242008-10-30 17:36:14 +1100197 */
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000198 ip->i_flags |= XFS_IRECLAIM;
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400199
200 spin_unlock(&ip->i_flags_lock);
201 read_unlock(&pag->pag_ici_lock);
202
203 error = -inode_init_always(mp->m_super, inode);
204 if (error) {
205 /*
206 * Re-initializing the inode failed, and we are in deep
207 * trouble. Try to re-add it to the reclaim list.
208 */
209 read_lock(&pag->pag_ici_lock);
210 spin_lock(&ip->i_flags_lock);
211
212 ip->i_flags &= ~XFS_INEW;
213 ip->i_flags |= XFS_IRECLAIMABLE;
214 __xfs_inode_set_reclaim_tag(pag, ip);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000215 trace_xfs_iget_reclaim(ip);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400216 goto out_error;
217 }
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000218
219 write_lock(&pag->pag_ici_lock);
220 spin_lock(&ip->i_flags_lock);
221 ip->i_flags &= ~(XFS_IRECLAIMABLE | XFS_IRECLAIM);
222 ip->i_flags |= XFS_INEW;
223 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100224 inode->i_state = I_NEW;
Christoph Hellwigf1f724e2010-03-01 11:30:31 +0000225 spin_unlock(&ip->i_flags_lock);
226 write_unlock(&pag->pag_ici_lock);
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400227 } else {
228 /* If the VFS inode is being torn down, pause and try again. */
229 if (!igrab(inode)) {
230 error = EAGAIN;
David Chinnerbf904242008-10-30 17:36:14 +1100231 goto out_error;
232 }
David Chinner6bfb3d02008-10-30 18:32:43 +1100233
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400234 /* We've got a live one. */
235 spin_unlock(&ip->i_flags_lock);
236 read_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100237 }
238
David Chinner6441e542008-10-30 17:21:19 +1100239 if (lock_flags != 0)
240 xfs_ilock(ip, lock_flags);
241
242 xfs_iflags_clear(ip, XFS_ISTALE);
David Chinner6441e542008-10-30 17:21:19 +1100243 XFS_STATS_INC(xs_ig_found);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000244
245 trace_xfs_iget_found(ip);
David Chinner6441e542008-10-30 17:21:19 +1100246 return 0;
247
248out_error:
Christoph Hellwigbc990f52009-08-16 20:36:34 -0400249 spin_unlock(&ip->i_flags_lock);
David Chinner6441e542008-10-30 17:21:19 +1100250 read_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100251 return error;
252}
253
254
255static int
256xfs_iget_cache_miss(
257 struct xfs_mount *mp,
258 struct xfs_perag *pag,
259 xfs_trans_t *tp,
260 xfs_ino_t ino,
261 struct xfs_inode **ipp,
262 xfs_daddr_t bno,
263 int flags,
Christoph Hellwig0c3dc2b2009-11-14 16:17:23 +0000264 int lock_flags)
David Chinner6441e542008-10-30 17:21:19 +1100265{
266 struct xfs_inode *ip;
267 int error;
268 unsigned long first_index, mask;
269 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
270
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100271 ip = xfs_inode_alloc(mp, ino);
272 if (!ip)
273 return ENOMEM;
274
275 error = xfs_iread(mp, tp, ip, bno, flags);
David Chinner6441e542008-10-30 17:21:19 +1100276 if (error)
Christoph Hellwig24f211b2008-11-28 14:23:42 +1100277 goto out_destroy;
David Chinner6441e542008-10-30 17:21:19 +1100278
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000279 xfs_itrace_entry(ip);
David Chinner6441e542008-10-30 17:21:19 +1100280
281 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
282 error = ENOENT;
283 goto out_destroy;
284 }
285
286 /*
287 * Preload the radix tree so we can insert safely under the
David Chinner56e73ec2008-10-30 17:55:27 +1100288 * write spinlock. Note that we cannot sleep inside the preload
289 * region.
David Chinner6441e542008-10-30 17:21:19 +1100290 */
291 if (radix_tree_preload(GFP_KERNEL)) {
292 error = EAGAIN;
Christoph Hellwiged93ec32009-03-03 14:48:35 -0500293 goto out_destroy;
294 }
295
296 /*
297 * Because the inode hasn't been added to the radix-tree yet it can't
298 * be found by another thread, so we can do the non-sleeping lock here.
299 */
300 if (lock_flags) {
301 if (!xfs_ilock_nowait(ip, lock_flags))
302 BUG();
David Chinner6441e542008-10-30 17:21:19 +1100303 }
304
David Chinner6441e542008-10-30 17:21:19 +1100305 mask = ~(((XFS_INODE_CLUSTER_SIZE(mp) >> mp->m_sb.sb_inodelog)) - 1);
306 first_index = agino & mask;
307 write_lock(&pag->pag_ici_lock);
308
309 /* insert the new inode */
310 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
311 if (unlikely(error)) {
312 WARN_ON(error != -EEXIST);
313 XFS_STATS_INC(xs_ig_dup);
314 error = EAGAIN;
David Chinner56e73ec2008-10-30 17:55:27 +1100315 goto out_preload_end;
David Chinner6441e542008-10-30 17:21:19 +1100316 }
317
318 /* These values _must_ be set before releasing the radix tree lock! */
319 ip->i_udquot = ip->i_gdquot = NULL;
320 xfs_iflags_set(ip, XFS_INEW);
321
322 write_unlock(&pag->pag_ici_lock);
323 radix_tree_preload_end();
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000324
325 trace_xfs_iget_alloc(ip);
David Chinner6441e542008-10-30 17:21:19 +1100326 *ipp = ip;
327 return 0;
328
David Chinner56e73ec2008-10-30 17:55:27 +1100329out_preload_end:
David Chinner6441e542008-10-30 17:21:19 +1100330 write_unlock(&pag->pag_ici_lock);
331 radix_tree_preload_end();
David Chinner56e73ec2008-10-30 17:55:27 +1100332 if (lock_flags)
333 xfs_iunlock(ip, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100334out_destroy:
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300335 __destroy_inode(VFS_I(ip));
336 xfs_inode_free(ip);
David Chinner6441e542008-10-30 17:21:19 +1100337 return error;
338}
339
340/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 * Look up an inode by number in the given file system.
David Chinnerda353b02007-08-28 14:00:13 +1000342 * The inode is looked up in the cache held in each AG.
David Chinnerbf904242008-10-30 17:36:14 +1100343 * If the inode is found in the cache, initialise the vfs inode
344 * if necessary.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 *
David Chinnerda353b02007-08-28 14:00:13 +1000346 * If it is not in core, read it in from the file system's device,
David Chinnerbf904242008-10-30 17:36:14 +1100347 * add it to the cache and initialise the vfs inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 *
349 * The inode is locked according to the value of the lock_flags parameter.
350 * This flag parameter indicates how and if the inode's IO lock and inode lock
351 * should be taken.
352 *
353 * mp -- the mount point structure for the current file system. It points
354 * to the inode hash table.
355 * tp -- a pointer to the current transaction if there is one. This is
356 * simply passed through to the xfs_iread() call.
357 * ino -- the number of the inode desired. This is the unique identifier
358 * within the file system for the inode being requested.
359 * lock_flags -- flags indicating how to lock the inode. See the comment
360 * for xfs_ilock() for a list of valid values.
361 * bno -- the block number starting the buffer containing the inode,
362 * if known (as by bulkstat), else 0.
363 */
David Chinnerbf904242008-10-30 17:36:14 +1100364int
365xfs_iget(
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 xfs_mount_t *mp,
367 xfs_trans_t *tp,
368 xfs_ino_t ino,
369 uint flags,
370 uint lock_flags,
371 xfs_inode_t **ipp,
372 xfs_daddr_t bno)
373{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 xfs_inode_t *ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 int error;
David Chinnerda353b02007-08-28 14:00:13 +1000376 xfs_perag_t *pag;
377 xfs_agino_t agino;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
David Chinnerda353b02007-08-28 14:00:13 +1000379 /* the radix tree exists only in inode capable AGs */
380 if (XFS_INO_TO_AGNO(mp, ino) >= mp->m_maxagi)
381 return EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
David Chinnerda353b02007-08-28 14:00:13 +1000383 /* get the perag structure and ensure that it's inode capable */
Dave Chinner5017e972010-01-11 11:47:40 +0000384 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
David Chinnerda353b02007-08-28 14:00:13 +1000385 agino = XFS_INO_TO_AGINO(mp, ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387again:
David Chinner6441e542008-10-30 17:21:19 +1100388 error = 0;
David Chinnerda353b02007-08-28 14:00:13 +1000389 read_lock(&pag->pag_ici_lock);
390 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
David Chinner6441e542008-10-30 17:21:19 +1100392 if (ip) {
David Chinnerbf904242008-10-30 17:36:14 +1100393 error = xfs_iget_cache_hit(pag, ip, flags, lock_flags);
David Chinner6441e542008-10-30 17:21:19 +1100394 if (error)
395 goto out_error_or_again;
396 } else {
David Chinnerda353b02007-08-28 14:00:13 +1000397 read_unlock(&pag->pag_ici_lock);
David Chinner6441e542008-10-30 17:21:19 +1100398 XFS_STATS_INC(xs_ig_missed);
David Chinnerda353b02007-08-28 14:00:13 +1000399
David Chinner6441e542008-10-30 17:21:19 +1100400 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip, bno,
401 flags, lock_flags);
402 if (error)
403 goto out_error_or_again;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 }
Dave Chinner5017e972010-01-11 11:47:40 +0000405 xfs_perag_put(pag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 *ipp = ip;
408
David Chinnerbf904242008-10-30 17:36:14 +1100409 ASSERT(ip->i_df.if_ext_max ==
410 XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000411 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 * If we have a real type for an on-disk inode, we can set ops(&unlock)
413 * now. If it's a new inode being created, xfs_ialloc will handle it.
414 */
David Chinnerbf904242008-10-30 17:36:14 +1100415 if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
Christoph Hellwig41be8be2008-08-13 16:23:13 +1000416 xfs_setup_inode(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 return 0;
David Chinner6441e542008-10-30 17:21:19 +1100418
419out_error_or_again:
420 if (error == EAGAIN) {
421 delay(1);
422 goto again;
423 }
Dave Chinner5017e972010-01-11 11:47:40 +0000424 xfs_perag_put(pag);
David Chinner6441e542008-10-30 17:21:19 +1100425 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426}
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428/*
429 * Decrement reference count of an inode structure and unlock it.
430 *
431 * ip -- the inode being released
432 * lock_flags -- this parameter indicates the inode's locks to be
433 * to be released. See the comment on xfs_iunlock() for a list
434 * of valid values.
435 */
436void
437xfs_iput(xfs_inode_t *ip,
438 uint lock_flags)
439{
Lachlan McIlroycf441ee2008-02-07 16:42:19 +1100440 xfs_itrace_entry(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 xfs_iunlock(ip, lock_flags);
Christoph Hellwig10090be2007-10-11 18:11:03 +1000442 IRELE(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443}
444
445/*
446 * Special iput for brand-new inodes that are still locked
447 */
448void
David Chinner01651642008-08-13 15:45:15 +1000449xfs_iput_new(
450 xfs_inode_t *ip,
451 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
David Chinner01651642008-08-13 15:45:15 +1000453 struct inode *inode = VFS_I(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Lachlan McIlroycf441ee2008-02-07 16:42:19 +1100455 xfs_itrace_entry(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 if ((ip->i_d.di_mode == 0)) {
David Chinner7a18c382006-11-11 18:04:54 +1100458 ASSERT(!xfs_iflags_test(ip, XFS_IRECLAIMABLE));
Christoph Hellwig10090be2007-10-11 18:11:03 +1000459 make_bad_inode(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 }
461 if (inode->i_state & I_NEW)
462 unlock_new_inode(inode);
463 if (lock_flags)
464 xfs_iunlock(ip, lock_flags);
Christoph Hellwig10090be2007-10-11 18:11:03 +1000465 IRELE(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466}
467
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468/*
Christoph Hellwig5cafdeb2008-12-03 12:20:25 +0100469 * This is called free all the memory associated with an inode.
470 * It must free the inode itself and any buffers allocated for
471 * if_extents/if_data and if_broot. It must also free the lock
472 * associated with the inode.
473 *
474 * Note: because we don't initialise everything on reallocation out
475 * of the zone, we must ensure we nullify everything correctly before
476 * freeing the structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 */
478void
Christoph Hellwig5cafdeb2008-12-03 12:20:25 +0100479xfs_ireclaim(
480 struct xfs_inode *ip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
Christoph Hellwig5cafdeb2008-12-03 12:20:25 +0100482 struct xfs_mount *mp = ip->i_mount;
483 struct xfs_perag *pag;
Christoph Hellwigb44b1122009-12-01 18:12:29 +0000484 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ip->i_ino);
Christoph Hellwig5cafdeb2008-12-03 12:20:25 +0100485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 XFS_STATS_INC(xs_ig_reclaims);
487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 /*
Christoph Hellwigb44b1122009-12-01 18:12:29 +0000489 * Remove the inode from the per-AG radix tree.
490 *
491 * Because radix_tree_delete won't complain even if the item was never
492 * added to the tree assert that it's been there before to catch
493 * problems with the inode life time early on.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 */
Dave Chinner5017e972010-01-11 11:47:40 +0000495 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
David Chinnerda353b02007-08-28 14:00:13 +1000496 write_lock(&pag->pag_ici_lock);
Christoph Hellwigb44b1122009-12-01 18:12:29 +0000497 if (!radix_tree_delete(&pag->pag_ici_root, agino))
498 ASSERT(0);
David Chinnerda353b02007-08-28 14:00:13 +1000499 write_unlock(&pag->pag_ici_lock);
Dave Chinner5017e972010-01-11 11:47:40 +0000500 xfs_perag_put(pag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Christoph Hellwig5cafdeb2008-12-03 12:20:25 +0100502 /*
503 * Here we do an (almost) spurious inode lock in order to coordinate
504 * with inode cache radix tree lookups. This is because the lookup
505 * can reference the inodes in the cache without taking references.
506 *
507 * We make that OK here by ensuring that we wait until the inode is
508 * unlocked after the lookup before we go ahead and free it. We get
509 * both the ilock and the iolock because the code may need to drop the
510 * ilock one but will still hold the iolock.
511 */
512 xfs_ilock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
Christoph Hellwig7d095252009-06-08 15:33:32 +0200513 xfs_qm_dqdetach(ip);
Christoph Hellwig5cafdeb2008-12-03 12:20:25 +0100514 xfs_iunlock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
515
Christoph Hellwigb36ec042009-08-07 14:38:34 -0300516 xfs_inode_free(ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517}
518
519/*
520 * This is a wrapper routine around the xfs_ilock() routine
521 * used to centralize some grungy code. It is used in places
522 * that wish to lock the inode solely for reading the extents.
523 * The reason these places can't just call xfs_ilock(SHARED)
524 * is that the inode lock also guards to bringing in of the
525 * extents from disk for a file in b-tree format. If the inode
526 * is in b-tree format, then we need to lock the inode exclusively
527 * until the extents are read in. Locking it exclusively all
528 * the time would limit our parallelism unnecessarily, though.
529 * What we do instead is check to see if the extents have been
530 * read in yet, and only lock the inode exclusively if they
531 * have not.
532 *
533 * The function returns a value which should be given to the
534 * corresponding xfs_iunlock_map_shared(). This value is
535 * the mode in which the lock was actually taken.
536 */
537uint
538xfs_ilock_map_shared(
539 xfs_inode_t *ip)
540{
541 uint lock_mode;
542
543 if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
544 ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
545 lock_mode = XFS_ILOCK_EXCL;
546 } else {
547 lock_mode = XFS_ILOCK_SHARED;
548 }
549
550 xfs_ilock(ip, lock_mode);
551
552 return lock_mode;
553}
554
555/*
556 * This is simply the unlock routine to go with xfs_ilock_map_shared().
557 * All it does is call xfs_iunlock() with the given lock_mode.
558 */
559void
560xfs_iunlock_map_shared(
561 xfs_inode_t *ip,
562 unsigned int lock_mode)
563{
564 xfs_iunlock(ip, lock_mode);
565}
566
567/*
568 * The xfs inode contains 2 locks: a multi-reader lock called the
569 * i_iolock and a multi-reader lock called the i_lock. This routine
570 * allows either or both of the locks to be obtained.
571 *
572 * The 2 locks should always be ordered so that the IO lock is
573 * obtained first in order to prevent deadlock.
574 *
575 * ip -- the inode being locked
576 * lock_flags -- this parameter indicates the inode's locks
577 * to be locked. It can be:
578 * XFS_IOLOCK_SHARED,
579 * XFS_IOLOCK_EXCL,
580 * XFS_ILOCK_SHARED,
581 * XFS_ILOCK_EXCL,
582 * XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
583 * XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
584 * XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
585 * XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
586 */
587void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000588xfs_ilock(
589 xfs_inode_t *ip,
590 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591{
592 /*
593 * You can't set both SHARED and EXCL for the same lock,
594 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
595 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
596 */
597 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
598 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
599 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
600 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000601 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000603 if (lock_flags & XFS_IOLOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000604 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000605 else if (lock_flags & XFS_IOLOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000606 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000607
608 if (lock_flags & XFS_ILOCK_EXCL)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000609 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000610 else if (lock_flags & XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000611 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000612
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000613 trace_xfs_ilock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614}
615
616/*
617 * This is just like xfs_ilock(), except that the caller
618 * is guaranteed not to sleep. It returns 1 if it gets
619 * the requested locks and 0 otherwise. If the IO lock is
620 * obtained but the inode lock cannot be, then the IO lock
621 * is dropped before returning.
622 *
623 * ip -- the inode being locked
624 * lock_flags -- this parameter indicates the inode's locks to be
625 * to be locked. See the comment for xfs_ilock() for a list
626 * of valid values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 */
628int
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000629xfs_ilock_nowait(
630 xfs_inode_t *ip,
631 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 /*
634 * You can't set both SHARED and EXCL for the same lock,
635 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
636 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
637 */
638 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
639 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
640 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
641 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000642 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 if (lock_flags & XFS_IOLOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000645 if (!mrtryupdate(&ip->i_iolock))
646 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 } else if (lock_flags & XFS_IOLOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000648 if (!mrtryaccess(&ip->i_iolock))
649 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 }
651 if (lock_flags & XFS_ILOCK_EXCL) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000652 if (!mrtryupdate(&ip->i_lock))
653 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 } else if (lock_flags & XFS_ILOCK_SHARED) {
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000655 if (!mrtryaccess(&ip->i_lock))
656 goto out_undo_iolock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000658 trace_xfs_ilock_nowait(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 return 1;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000660
661 out_undo_iolock:
662 if (lock_flags & XFS_IOLOCK_EXCL)
663 mrunlock_excl(&ip->i_iolock);
664 else if (lock_flags & XFS_IOLOCK_SHARED)
665 mrunlock_shared(&ip->i_iolock);
666 out:
667 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668}
669
670/*
671 * xfs_iunlock() is used to drop the inode locks acquired with
672 * xfs_ilock() and xfs_ilock_nowait(). The caller must pass
673 * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
674 * that we know which locks to drop.
675 *
676 * ip -- the inode being unlocked
677 * lock_flags -- this parameter indicates the inode's locks to be
678 * to be unlocked. See the comment for xfs_ilock() for a list
679 * of valid values for this parameter.
680 *
681 */
682void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000683xfs_iunlock(
684 xfs_inode_t *ip,
685 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686{
687 /*
688 * You can't set both SHARED and EXCL for the same lock,
689 * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
690 * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
691 */
692 ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
693 (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
694 ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
695 (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000696 ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
697 XFS_LOCK_DEP_MASK)) == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 ASSERT(lock_flags != 0);
699
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000700 if (lock_flags & XFS_IOLOCK_EXCL)
701 mrunlock_excl(&ip->i_iolock);
702 else if (lock_flags & XFS_IOLOCK_SHARED)
703 mrunlock_shared(&ip->i_iolock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000705 if (lock_flags & XFS_ILOCK_EXCL)
706 mrunlock_excl(&ip->i_lock);
707 else if (lock_flags & XFS_ILOCK_SHARED)
708 mrunlock_shared(&ip->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000710 if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
711 !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 /*
713 * Let the AIL know that this item has been unlocked in case
714 * it is in the AIL and anyone is waiting on it. Don't do
715 * this if the caller has asked us not to.
716 */
David Chinner783a2f62008-10-30 17:39:58 +1100717 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000718 (xfs_log_item_t*)(ip->i_itemp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000720 trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721}
722
723/*
724 * give up write locks. the i/o lock cannot be held nested
725 * if it is being demoted.
726 */
727void
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000728xfs_ilock_demote(
729 xfs_inode_t *ip,
730 uint lock_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731{
732 ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
733 ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
734
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000735 if (lock_flags & XFS_ILOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 mrdemote(&ip->i_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000737 if (lock_flags & XFS_IOLOCK_EXCL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 mrdemote(&ip->i_iolock);
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000739
740 trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741}
742
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000743#ifdef DEBUG
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000744int
745xfs_isilocked(
746 xfs_inode_t *ip,
747 uint lock_flags)
748{
Christoph Hellwigf9369722010-06-03 16:22:29 +1000749 if (lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) {
750 if (!(lock_flags & XFS_ILOCK_SHARED))
751 return !!ip->i_lock.mr_writer;
752 return rwsem_is_locked(&ip->i_lock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000753 }
754
Christoph Hellwigf9369722010-06-03 16:22:29 +1000755 if (lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) {
756 if (!(lock_flags & XFS_IOLOCK_SHARED))
757 return !!ip->i_iolock.mr_writer;
758 return rwsem_is_locked(&ip->i_iolock.mr_lock);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000759 }
760
Christoph Hellwigf9369722010-06-03 16:22:29 +1000761 ASSERT(0);
762 return 0;
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000763}
764#endif