inode.c 42.5 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * linux/fs/inode.c
 *
 * (C) 1997 Linus Torvalds
 */

#include <linux/fs.h>
#include <linux/mm.h>
#include <linux/dcache.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/writeback.h>
#include <linux/module.h>
#include <linux/backing-dev.h>
#include <linux/wait.h>
Nick Piggin's avatar
Nick Piggin committed
16
#include <linux/rwsem.h>
Linus Torvalds's avatar
Linus Torvalds committed
17 18 19 20 21 22
#include <linux/hash.h>
#include <linux/swap.h>
#include <linux/security.h>
#include <linux/pagemap.h>
#include <linux/cdev.h>
#include <linux/bootmem.h>
Robert Love's avatar
Robert Love committed
23
#include <linux/inotify.h>
24
#include <linux/fsnotify.h>
25
#include <linux/mount.h>
26
#include <linux/async.h>
Al Viro's avatar
Al Viro committed
27
#include <linux/posix_acl.h>
Linus Torvalds's avatar
Linus Torvalds committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

/*
 * This is needed for the following functions:
 *  - inode_has_buffers
 *  - invalidate_inode_buffers
 *  - invalidate_bdev
 *
 * FIXME: remove all knowledge of the buffer layer from this file
 */
#include <linux/buffer_head.h>

/*
 * New inode.c implementation.
 *
 * This implementation has the basic premise of trying
 * to be extremely low-overhead and SMP-safe, yet be
 * simple enough to be "obviously correct".
 *
 * Famous last words.
 */

/* inode dynamic allocation 1999, Andrea Arcangeli <andrea@suse.de> */

/* #define INODE_PARANOIA 1 */
/* #define INODE_DEBUG 1 */

/*
 * Inode lookup is no longer as critical as it used to be:
 * most of the lookups are going to be through the dcache.
 */
#define I_HASHBITS	i_hash_shift
#define I_HASHMASK	i_hash_mask

61 62
static unsigned int i_hash_mask __read_mostly;
static unsigned int i_hash_shift __read_mostly;
Linus Torvalds's avatar
Linus Torvalds committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77

/*
 * Each inode can be on two separate lists. One is
 * the hash list of the inode, used for lookups. The
 * other linked list is the "type" list:
 *  "in_use" - valid inode, i_count > 0, i_nlink > 0
 *  "dirty"  - as "in_use" but also dirty
 *  "unused" - valid inode, i_count = 0
 *
 * A "dirty" list is maintained for each super block,
 * allowing for low-overhead inode sync() operations.
 */

LIST_HEAD(inode_in_use);
LIST_HEAD(inode_unused);
78
static struct hlist_head *inode_hashtable __read_mostly;
Linus Torvalds's avatar
Linus Torvalds committed
79 80 81 82 83 84 85 86 87 88

/*
 * A simple spinlock to protect the list manipulations.
 *
 * NOTE! You also have to own the lock if you change
 * the i_state of an inode while it is in use..
 */
DEFINE_SPINLOCK(inode_lock);

/*
Nick Piggin's avatar
Nick Piggin committed
89
 * iprune_sem provides exclusion between the kswapd or try_to_free_pages
Linus Torvalds's avatar
Linus Torvalds committed
90 91 92 93 94
 * icache shrinking path, and the umount path.  Without this exclusion,
 * by the time prune_icache calls iput for the inode whose pages it has
 * been invalidating, or by the time it calls clear_inode & destroy_inode
 * from its final dispose_list, the struct super_block they refer to
 * (for inode->i_sb->s_op) may already have been freed and reused.
Nick Piggin's avatar
Nick Piggin committed
95 96 97 98
 *
 * We make this an rwsem because the fastpath is icache shrinking. In
 * some cases a filesystem may be doing a significant amount of work in
 * its inode reclaim code, so this should improve parallelism.
Linus Torvalds's avatar
Linus Torvalds committed
99
 */
Nick Piggin's avatar
Nick Piggin committed
100
static DECLARE_RWSEM(iprune_sem);
Linus Torvalds's avatar
Linus Torvalds committed
101 102 103 104 105 106

/*
 * Statistics gathering..
 */
struct inodes_stat_t inodes_stat;

107
static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds's avatar
Linus Torvalds committed
108

Joern Engel's avatar
Joern Engel committed
109 110 111 112 113 114
static void wake_up_inode(struct inode *inode)
{
	/*
	 * Prevent speculative execution through spin_unlock(&inode_lock);
	 */
	smp_mb();
Christoph Hellwig's avatar
Christoph Hellwig committed
115
	wake_up_bit(&inode->i_state, __I_NEW);
Joern Engel's avatar
Joern Engel committed
116 117
}

118 119
/**
 * inode_init_always - perform inode structure intialisation
120 121
 * @sb: superblock inode belongs to
 * @inode: inode to initialise
122 123 124 125
 *
 * These are initializations that need to be done on every inode
 * allocation as the fields are not initialised by slab allocation.
 */
126
int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
127
{
128
	static const struct address_space_operations empty_aops;
129
	static const struct inode_operations empty_iops;
130
	static const struct file_operations empty_fops;
131
	struct address_space *const mapping = &inode->i_data;
132 133 134 135 136 137 138 139

	inode->i_sb = sb;
	inode->i_blkbits = sb->s_blocksize_bits;
	inode->i_flags = 0;
	atomic_set(&inode->i_count, 1);
	inode->i_op = &empty_iops;
	inode->i_fop = &empty_fops;
	inode->i_nlink = 1;
Al Viro's avatar
Al Viro committed
140 141
	inode->i_uid = 0;
	inode->i_gid = 0;
142 143 144 145 146
	atomic_set(&inode->i_writecount, 0);
	inode->i_size = 0;
	inode->i_blocks = 0;
	inode->i_bytes = 0;
	inode->i_generation = 0;
Linus Torvalds's avatar
Linus Torvalds committed
147
#ifdef CONFIG_QUOTA
148
	memset(&inode->i_dquot, 0, sizeof(inode->i_dquot));
Linus Torvalds's avatar
Linus Torvalds committed
149
#endif
150 151 152 153 154
	inode->i_pipe = NULL;
	inode->i_bdev = NULL;
	inode->i_cdev = NULL;
	inode->i_rdev = 0;
	inode->dirtied_when = 0;
Mimi Zohar's avatar
Mimi Zohar committed
155 156

	if (security_inode_alloc(inode))
157
		goto out;
158 159 160 161 162 163 164 165 166 167 168 169
	spin_lock_init(&inode->i_lock);
	lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);

	mutex_init(&inode->i_mutex);
	lockdep_set_class(&inode->i_mutex, &sb->s_type->i_mutex_key);

	init_rwsem(&inode->i_alloc_sem);
	lockdep_set_class(&inode->i_alloc_sem, &sb->s_type->i_alloc_sem_key);

	mapping->a_ops = &empty_aops;
	mapping->host = inode;
	mapping->flags = 0;
170
	mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
171 172 173 174 175 176 177 178 179 180 181 182
	mapping->assoc_mapping = NULL;
	mapping->backing_dev_info = &default_backing_dev_info;
	mapping->writeback_index = 0;

	/*
	 * If the block_device provides a backing_dev_info for client
	 * inodes then use that.  Otherwise the inode share the bdev's
	 * backing_dev_info.
	 */
	if (sb->s_bdev) {
		struct backing_dev_info *bdi;

183
		bdi = sb->s_bdev->bd_inode->i_mapping->backing_dev_info;
184 185 186 187
		mapping->backing_dev_info = bdi;
	}
	inode->i_private = NULL;
	inode->i_mapping = mapping;
Al Viro's avatar
Al Viro committed
188 189 190
#ifdef CONFIG_FS_POSIX_ACL
	inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
#endif
191

192 193 194 195
#ifdef CONFIG_FSNOTIFY
	inode->i_fsnotify_mask = 0;
#endif

196 197 198
	return 0;
out:
	return -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
199
}
200 201 202 203 204 205 206 207 208 209 210
EXPORT_SYMBOL(inode_init_always);

static struct inode *alloc_inode(struct super_block *sb)
{
	struct inode *inode;

	if (sb->s_op->alloc_inode)
		inode = sb->s_op->alloc_inode(sb);
	else
		inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);

211 212 213 214 215 216 217 218 219 220 221 222
	if (!inode)
		return NULL;

	if (unlikely(inode_init_always(sb, inode))) {
		if (inode->i_sb->s_op->destroy_inode)
			inode->i_sb->s_op->destroy_inode(inode);
		else
			kmem_cache_free(inode_cachep, inode);
		return NULL;
	}

	return inode;
223
}
Linus Torvalds's avatar
Linus Torvalds committed
224

Christoph Hellwig's avatar
Christoph Hellwig committed
225
void __destroy_inode(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
226
{
227
	BUG_ON(inode_has_buffers(inode));
Linus Torvalds's avatar
Linus Torvalds committed
228
	security_inode_free(inode);
229
	fsnotify_inode_delete(inode);
Al Viro's avatar
Al Viro committed
230 231 232 233 234 235
#ifdef CONFIG_FS_POSIX_ACL
	if (inode->i_acl && inode->i_acl != ACL_NOT_CACHED)
		posix_acl_release(inode->i_acl);
	if (inode->i_default_acl && inode->i_default_acl != ACL_NOT_CACHED)
		posix_acl_release(inode->i_default_acl);
#endif
Christoph Hellwig's avatar
Christoph Hellwig committed
236 237 238 239 240 241
}
EXPORT_SYMBOL(__destroy_inode);

void destroy_inode(struct inode *inode)
{
	__destroy_inode(inode);
Linus Torvalds's avatar
Linus Torvalds committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
	if (inode->i_sb->s_op->destroy_inode)
		inode->i_sb->s_op->destroy_inode(inode);
	else
		kmem_cache_free(inode_cachep, (inode));
}

/*
 * These are initializations that only need to be done
 * once, because the fields are idempotent across use
 * of the inode, so let the slab aware of that.
 */
void inode_init_once(struct inode *inode)
{
	memset(inode, 0, sizeof(*inode));
	INIT_HLIST_NODE(&inode->i_hash);
	INIT_LIST_HEAD(&inode->i_dentry);
	INIT_LIST_HEAD(&inode->i_devices);
	INIT_RADIX_TREE(&inode->i_data.page_tree, GFP_ATOMIC);
Nick Piggin's avatar
Nick Piggin committed
260
	spin_lock_init(&inode->i_data.tree_lock);
Linus Torvalds's avatar
Linus Torvalds committed
261 262 263 264 265 266
	spin_lock_init(&inode->i_data.i_mmap_lock);
	INIT_LIST_HEAD(&inode->i_data.private_list);
	spin_lock_init(&inode->i_data.private_lock);
	INIT_RAW_PRIO_TREE_ROOT(&inode->i_data.i_mmap);
	INIT_LIST_HEAD(&inode->i_data.i_mmap_nonlinear);
	i_size_ordered_init(inode);
Robert Love's avatar
Robert Love committed
267 268
#ifdef CONFIG_INOTIFY
	INIT_LIST_HEAD(&inode->inotify_watches);
Ingo Molnar's avatar
Ingo Molnar committed
269
	mutex_init(&inode->inotify_mutex);
Robert Love's avatar
Robert Love committed
270
#endif
271 272 273
#ifdef CONFIG_FSNOTIFY
	INIT_HLIST_HEAD(&inode->i_fsnotify_mark_entries);
#endif
Linus Torvalds's avatar
Linus Torvalds committed
274 275 276
}
EXPORT_SYMBOL(inode_init_once);

277
static void init_once(void *foo)
Linus Torvalds's avatar
Linus Torvalds committed
278
{
279
	struct inode *inode = (struct inode *) foo;
Linus Torvalds's avatar
Linus Torvalds committed
280

281
	inode_init_once(inode);
Linus Torvalds's avatar
Linus Torvalds committed
282 283 284 285 286
}

/*
 * inode_lock must be held
 */
287
void __iget(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
288
{
289
	if (atomic_inc_return(&inode->i_count) != 1)
Linus Torvalds's avatar
Linus Torvalds committed
290
		return;
291

Joern Engel's avatar
Joern Engel committed
292
	if (!(inode->i_state & (I_DIRTY|I_SYNC)))
Linus Torvalds's avatar
Linus Torvalds committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
		list_move(&inode->i_list, &inode_in_use);
	inodes_stat.nr_unused--;
}

/**
 * clear_inode - clear an inode
 * @inode: inode to clear
 *
 * This is called by the filesystem to tell us
 * that the inode is no longer useful. We just
 * terminate it with extreme prejudice.
 */
void clear_inode(struct inode *inode)
{
	might_sleep();
	invalidate_inode_buffers(inode);
309

310 311 312
	BUG_ON(inode->i_data.nrpages);
	BUG_ON(!(inode->i_state & I_FREEING));
	BUG_ON(inode->i_state & I_CLEAR);
Joern Engel's avatar
Joern Engel committed
313
	inode_sync_wait(inode);
314
	if (inode->i_sb->s_op->clear_inode)
Linus Torvalds's avatar
Linus Torvalds committed
315
		inode->i_sb->s_op->clear_inode(inode);
316
	if (S_ISBLK(inode->i_mode) && inode->i_bdev)
Linus Torvalds's avatar
Linus Torvalds committed
317
		bd_forget(inode);
318
	if (S_ISCHR(inode->i_mode) && inode->i_cdev)
Linus Torvalds's avatar
Linus Torvalds committed
319
		cd_forget(inode);
320
	inode->i_state = I_FREEING | I_CLEAR;
Linus Torvalds's avatar
Linus Torvalds committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
}
EXPORT_SYMBOL(clear_inode);

/*
 * dispose_list - dispose of the contents of a local list
 * @head: the head of the list to free
 *
 * Dispose-list gets a local list with local inodes in it, so it doesn't
 * need to worry about list corruption and SMP locks.
 */
static void dispose_list(struct list_head *head)
{
	int nr_disposed = 0;

	while (!list_empty(head)) {
		struct inode *inode;

338
		inode = list_first_entry(head, struct inode, i_list);
Linus Torvalds's avatar
Linus Torvalds committed
339 340 341 342 343
		list_del(&inode->i_list);

		if (inode->i_data.nrpages)
			truncate_inode_pages(&inode->i_data, 0);
		clear_inode(inode);
344 345 346 347 348 349 350

		spin_lock(&inode_lock);
		hlist_del_init(&inode->i_hash);
		list_del_init(&inode->i_sb_list);
		spin_unlock(&inode_lock);

		wake_up_inode(inode);
Linus Torvalds's avatar
Linus Torvalds committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
		destroy_inode(inode);
		nr_disposed++;
	}
	spin_lock(&inode_lock);
	inodes_stat.nr_inodes -= nr_disposed;
	spin_unlock(&inode_lock);
}

/*
 * Invalidate all inodes for a device.
 */
static int invalidate_list(struct list_head *head, struct list_head *dispose)
{
	struct list_head *next;
	int busy = 0, count = 0;

	next = head->next;
	for (;;) {
369 370
		struct list_head *tmp = next;
		struct inode *inode;
Linus Torvalds's avatar
Linus Torvalds committed
371 372 373 374

		/*
		 * We can reschedule here without worrying about the list's
		 * consistency because the per-sb list of inodes must not
Nick Piggin's avatar
Nick Piggin committed
375
		 * change during umount anymore, and because iprune_sem keeps
Linus Torvalds's avatar
Linus Torvalds committed
376 377 378 379 380 381 382 383
		 * shrink_icache_memory() away.
		 */
		cond_resched_lock(&inode_lock);

		next = next->next;
		if (tmp == head)
			break;
		inode = list_entry(tmp, struct inode, i_sb_list);
Nick Piggin's avatar
Nick Piggin committed
384 385
		if (inode->i_state & I_NEW)
			continue;
Linus Torvalds's avatar
Linus Torvalds committed
386 387 388
		invalidate_inode_buffers(inode);
		if (!atomic_read(&inode->i_count)) {
			list_move(&inode->i_list, dispose);
389
			WARN_ON(inode->i_state & I_NEW);
Linus Torvalds's avatar
Linus Torvalds committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
			inode->i_state |= I_FREEING;
			count++;
			continue;
		}
		busy = 1;
	}
	/* only unused inodes may be cached with i_count zero */
	inodes_stat.nr_unused -= count;
	return busy;
}

/**
 *	invalidate_inodes	- discard the inodes on a device
 *	@sb: superblock
 *
 *	Discard all of the inodes for a given superblock. If the discard
 *	fails because there are busy inodes then a non zero value is returned.
 *	If the discard is successful all the inodes have been discarded.
 */
409
int invalidate_inodes(struct super_block *sb)
Linus Torvalds's avatar
Linus Torvalds committed
410 411 412 413
{
	int busy;
	LIST_HEAD(throw_away);

Nick Piggin's avatar
Nick Piggin committed
414
	down_write(&iprune_sem);
Linus Torvalds's avatar
Linus Torvalds committed
415
	spin_lock(&inode_lock);
Robert Love's avatar
Robert Love committed
416
	inotify_unmount_inodes(&sb->s_inodes);
417
	fsnotify_unmount_inodes(&sb->s_inodes);
Linus Torvalds's avatar
Linus Torvalds committed
418 419 420 421
	busy = invalidate_list(&sb->s_inodes, &throw_away);
	spin_unlock(&inode_lock);

	dispose_list(&throw_away);
Nick Piggin's avatar
Nick Piggin committed
422
	up_write(&iprune_sem);
Linus Torvalds's avatar
Linus Torvalds committed
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

	return busy;
}
EXPORT_SYMBOL(invalidate_inodes);

static int can_unuse(struct inode *inode)
{
	if (inode->i_state)
		return 0;
	if (inode_has_buffers(inode))
		return 0;
	if (atomic_read(&inode->i_count))
		return 0;
	if (inode->i_data.nrpages)
		return 0;
	return 1;
}

/*
 * Scan `goal' inodes on the unused list for freeable ones. They are moved to
 * a temporary list and then are freed outside inode_lock by dispose_list().
 *
 * Any inodes which are pinned purely because of attached pagecache have their
 * pagecache removed.  We expect the final iput() on that inode to add it to
 * the front of the inode_unused list.  So look for it there and if the
 * inode is still freeable, proceed.  The right inode is found 99.9% of the
 * time in testing on a 4-way.
 *
 * If the inode has metadata buffers attached to mapping->private_list then
 * try to remove them.
 */
static void prune_icache(int nr_to_scan)
{
	LIST_HEAD(freeable);
	int nr_pruned = 0;
	int nr_scanned;
	unsigned long reap = 0;

Nick Piggin's avatar
Nick Piggin committed
461
	down_read(&iprune_sem);
Linus Torvalds's avatar
Linus Torvalds committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
	spin_lock(&inode_lock);
	for (nr_scanned = 0; nr_scanned < nr_to_scan; nr_scanned++) {
		struct inode *inode;

		if (list_empty(&inode_unused))
			break;

		inode = list_entry(inode_unused.prev, struct inode, i_list);

		if (inode->i_state || atomic_read(&inode->i_count)) {
			list_move(&inode->i_list, &inode_unused);
			continue;
		}
		if (inode_has_buffers(inode) || inode->i_data.nrpages) {
			__iget(inode);
			spin_unlock(&inode_lock);
			if (remove_inode_buffers(inode))
479 480
				reap += invalidate_mapping_pages(&inode->i_data,
								0, -1);
Linus Torvalds's avatar
Linus Torvalds committed
481 482 483 484 485 486 487 488 489 490
			iput(inode);
			spin_lock(&inode_lock);

			if (inode != list_entry(inode_unused.next,
						struct inode, i_list))
				continue;	/* wrong inode or list_empty */
			if (!can_unuse(inode))
				continue;
		}
		list_move(&inode->i_list, &freeable);
491
		WARN_ON(inode->i_state & I_NEW);
Linus Torvalds's avatar
Linus Torvalds committed
492 493 494 495
		inode->i_state |= I_FREEING;
		nr_pruned++;
	}
	inodes_stat.nr_unused -= nr_pruned;
496 497 498 499
	if (current_is_kswapd())
		__count_vm_events(KSWAPD_INODESTEAL, reap);
	else
		__count_vm_events(PGINODESTEAL, reap);
Linus Torvalds's avatar
Linus Torvalds committed
500 501 502
	spin_unlock(&inode_lock);

	dispose_list(&freeable);
Nick Piggin's avatar
Nick Piggin committed
503
	up_read(&iprune_sem);
Linus Torvalds's avatar
Linus Torvalds committed
504 505 506 507 508 509 510 511 512 513 514
}

/*
 * shrink_icache_memory() will attempt to reclaim some unused inodes.  Here,
 * "unused" means that no dentries are referring to the inodes: the files are
 * not open and the dcache references to those inodes have already been
 * reclaimed.
 *
 * This function is passed the number of inodes to scan, and it returns the
 * total number of remaining possibly-reclaimable inodes.
 */
515
static int shrink_icache_memory(struct shrinker *shrink, int nr, gfp_t gfp_mask)
Linus Torvalds's avatar
Linus Torvalds committed
516 517 518 519 520 521
{
	if (nr) {
		/*
		 * Nasty deadlock avoidance.  We may hold various FS locks,
		 * and we don't want to recurse into the FS that called us
		 * in clear_inode() and friends..
522
		 */
Linus Torvalds's avatar
Linus Torvalds committed
523 524 525 526 527 528 529
		if (!(gfp_mask & __GFP_FS))
			return -1;
		prune_icache(nr);
	}
	return (inodes_stat.nr_unused / 100) * sysctl_vfs_cache_pressure;
}

530 531 532 533 534
static struct shrinker icache_shrinker = {
	.shrink = shrink_icache_memory,
	.seeks = DEFAULT_SEEKS,
};

Linus Torvalds's avatar
Linus Torvalds committed
535 536 537 538 539 540 541
static void __wait_on_freeing_inode(struct inode *inode);
/*
 * Called with the inode lock held.
 * NOTE: we are not increasing the inode-refcount, you must call __iget()
 * by hand after calling find_inode now! This simplifies iunique and won't
 * add any additional branch in the common code.
 */
542 543 544 545
static struct inode *find_inode(struct super_block *sb,
				struct hlist_head *head,
				int (*test)(struct inode *, void *),
				void *data)
Linus Torvalds's avatar
Linus Torvalds committed
546 547
{
	struct hlist_node *node;
548
	struct inode *inode = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
549 550

repeat:
551
	hlist_for_each_entry(inode, node, head, i_hash) {
Linus Torvalds's avatar
Linus Torvalds committed
552 553 554 555
		if (inode->i_sb != sb)
			continue;
		if (!test(inode, data))
			continue;
556
		if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds's avatar
Linus Torvalds committed
557 558 559 560 561 562 563 564 565 566 567 568
			__wait_on_freeing_inode(inode);
			goto repeat;
		}
		break;
	}
	return node ? inode : NULL;
}

/*
 * find_inode_fast is the fast path version of find_inode, see the comment at
 * iget_locked for details.
 */
569 570
static struct inode *find_inode_fast(struct super_block *sb,
				struct hlist_head *head, unsigned long ino)
Linus Torvalds's avatar
Linus Torvalds committed
571 572
{
	struct hlist_node *node;
573
	struct inode *inode = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
574 575

repeat:
576
	hlist_for_each_entry(inode, node, head, i_hash) {
Linus Torvalds's avatar
Linus Torvalds committed
577 578 579 580
		if (inode->i_ino != ino)
			continue;
		if (inode->i_sb != sb)
			continue;
581
		if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds's avatar
Linus Torvalds committed
582 583 584 585 586 587 588 589
			__wait_on_freeing_inode(inode);
			goto repeat;
		}
		break;
	}
	return node ? inode : NULL;
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
static unsigned long hash(struct super_block *sb, unsigned long hashval)
{
	unsigned long tmp;

	tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
			L1_CACHE_BYTES;
	tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> I_HASHBITS);
	return tmp & I_HASHMASK;
}

static inline void
__inode_add_to_lists(struct super_block *sb, struct hlist_head *head,
			struct inode *inode)
{
	inodes_stat.nr_inodes++;
	list_add(&inode->i_list, &inode_in_use);
	list_add(&inode->i_sb_list, &sb->s_inodes);
	if (head)
		hlist_add_head(&inode->i_hash, head);
}

/**
 * inode_add_to_lists - add a new inode to relevant lists
613 614
 * @sb: superblock inode belongs to
 * @inode: inode to mark in use
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
 *
 * When an inode is allocated it needs to be accounted for, added to the in use
 * list, the owning superblock and the inode hash. This needs to be done under
 * the inode_lock, so export a function to do this rather than the inode lock
 * itself. We calculate the hash list to add to here so it is all internal
 * which requires the caller to have already set up the inode number in the
 * inode to add.
 */
void inode_add_to_lists(struct super_block *sb, struct inode *inode)
{
	struct hlist_head *head = inode_hashtable + hash(sb, inode->i_ino);

	spin_lock(&inode_lock);
	__inode_add_to_lists(sb, head, inode);
	spin_unlock(&inode_lock);
}
EXPORT_SYMBOL_GPL(inode_add_to_lists);

Linus Torvalds's avatar
Linus Torvalds committed
633 634 635 636
/**
 *	new_inode 	- obtain an inode
 *	@sb: superblock
 *
637
 *	Allocates a new inode for given superblock. The default gfp_mask
638
 *	for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
639 640 641 642 643
 *	If HIGHMEM pages are unsuitable or it is known that pages allocated
 *	for the page cache are not reclaimable or migratable,
 *	mapping_set_gfp_mask() must be called with suitable flags on the
 *	newly created inode's mapping
 *
Linus Torvalds's avatar
Linus Torvalds committed
644 645 646
 */
struct inode *new_inode(struct super_block *sb)
{
647 648 649 650 651 652
	/*
	 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
	 * error if st_ino won't fit in target struct field. Use 32bit counter
	 * here to attempt to avoid that.
	 */
	static unsigned int last_ino;
653
	struct inode *inode;
Linus Torvalds's avatar
Linus Torvalds committed
654 655

	spin_lock_prefetch(&inode_lock);
656

Linus Torvalds's avatar
Linus Torvalds committed
657 658 659
	inode = alloc_inode(sb);
	if (inode) {
		spin_lock(&inode_lock);
660
		__inode_add_to_lists(sb, NULL, inode);
Linus Torvalds's avatar
Linus Torvalds committed
661 662 663 664 665 666 667 668 669 670
		inode->i_ino = ++last_ino;
		inode->i_state = 0;
		spin_unlock(&inode_lock);
	}
	return inode;
}
EXPORT_SYMBOL(new_inode);

void unlock_new_inode(struct inode *inode)
{
671
#ifdef CONFIG_DEBUG_LOCK_ALLOC
672 673 674
	if (inode->i_mode & S_IFDIR) {
		struct file_system_type *type = inode->i_sb->s_type;

675 676 677 678 679 680 681 682 683 684 685
		/* Set new key only if filesystem hasn't already changed it */
		if (!lockdep_match_class(&inode->i_mutex,
		    &type->i_mutex_key)) {
			/*
			 * ensure nobody is actually holding i_mutex
			 */
			mutex_destroy(&inode->i_mutex);
			mutex_init(&inode->i_mutex);
			lockdep_set_class(&inode->i_mutex,
					  &type->i_mutex_dir_key);
		}
686
	}
687
#endif
Linus Torvalds's avatar
Linus Torvalds committed
688
	/*
Christoph Hellwig's avatar
Christoph Hellwig committed
689
	 * This is special!  We do not need the spinlock when clearing I_NEW,
690 691
	 * because we're guaranteed that nobody else tries to do anything about
	 * the state of the inode when it is locked, as we just created it (so
Christoph Hellwig's avatar
Christoph Hellwig committed
692
	 * there can be no old holders that haven't tested I_NEW).
693
	 * However we must emit the memory barrier so that other CPUs reliably
Christoph Hellwig's avatar
Christoph Hellwig committed
694
	 * see the clearing of I_NEW after the other inode initialisation has
695
	 * completed.
Linus Torvalds's avatar
Linus Torvalds committed
696
	 */
697
	smp_mb();
Christoph Hellwig's avatar
Christoph Hellwig committed
698 699
	WARN_ON(!(inode->i_state & I_NEW));
	inode->i_state &= ~I_NEW;
Linus Torvalds's avatar
Linus Torvalds committed
700 701 702 703 704 705 706 707 708 709
	wake_up_inode(inode);
}
EXPORT_SYMBOL(unlock_new_inode);

/*
 * This is called without the inode lock held.. Be careful.
 *
 * We no longer cache the sb_flags in i_flags - see fs.h
 *	-- rmk@arm.uk.linux.org
 */
710 711 712 713 714
static struct inode *get_new_inode(struct super_block *sb,
				struct hlist_head *head,
				int (*test)(struct inode *, void *),
				int (*set)(struct inode *, void *),
				void *data)
Linus Torvalds's avatar
Linus Torvalds committed
715
{
716
	struct inode *inode;
Linus Torvalds's avatar
Linus Torvalds committed
717 718 719

	inode = alloc_inode(sb);
	if (inode) {
720
		struct inode *old;
Linus Torvalds's avatar
Linus Torvalds committed
721 722 723 724 725 726 727 728

		spin_lock(&inode_lock);
		/* We released the lock, so.. */
		old = find_inode(sb, head, test, data);
		if (!old) {
			if (set(inode, data))
				goto set_failed;

729
			__inode_add_to_lists(sb, head, inode);
Christoph Hellwig's avatar
Christoph Hellwig committed
730
			inode->i_state = I_NEW;
Linus Torvalds's avatar
Linus Torvalds committed
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
			spin_unlock(&inode_lock);

			/* Return the locked inode with I_NEW set, the
			 * caller is responsible for filling in the contents
			 */
			return inode;
		}

		/*
		 * Uhhuh, somebody else created the same inode under
		 * us. Use the old inode instead of the one we just
		 * allocated.
		 */
		__iget(old);
		spin_unlock(&inode_lock);
		destroy_inode(inode);
		inode = old;
		wait_on_inode(inode);
	}
	return inode;

set_failed:
	spin_unlock(&inode_lock);
	destroy_inode(inode);
	return NULL;
}

/*
 * get_new_inode_fast is the fast path version of get_new_inode, see the
 * comment at iget_locked for details.
 */
762 763
static struct inode *get_new_inode_fast(struct super_block *sb,
				struct hlist_head *head, unsigned long ino)
Linus Torvalds's avatar
Linus Torvalds committed
764
{
765
	struct inode *inode;
Linus Torvalds's avatar
Linus Torvalds committed
766 767 768

	inode = alloc_inode(sb);
	if (inode) {
769
		struct inode *old;
Linus Torvalds's avatar
Linus Torvalds committed
770 771 772 773 774 775

		spin_lock(&inode_lock);
		/* We released the lock, so.. */
		old = find_inode_fast(sb, head, ino);
		if (!old) {
			inode->i_ino = ino;
776
			__inode_add_to_lists(sb, head, inode);
Christoph Hellwig's avatar
Christoph Hellwig committed
777
			inode->i_state = I_NEW;
Linus Torvalds's avatar
Linus Torvalds committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
			spin_unlock(&inode_lock);

			/* Return the locked inode with I_NEW set, the
			 * caller is responsible for filling in the contents
			 */
			return inode;
		}

		/*
		 * Uhhuh, somebody else created the same inode under
		 * us. Use the old inode instead of the one we just
		 * allocated.
		 */
		__iget(old);
		spin_unlock(&inode_lock);
		destroy_inode(inode);
		inode = old;
		wait_on_inode(inode);
	}
	return inode;
}

/**
 *	iunique - get a unique inode number
 *	@sb: superblock
 *	@max_reserved: highest reserved inode number
 *
 *	Obtain an inode number that is unique on the system for a given
 *	superblock. This is used by file systems that have no natural
 *	permanent inode numbering system. An inode number is returned that
 *	is higher than the reserved limit but unique.
 *
 *	BUGS:
 *	With a large number of inodes live on the file system this function
 *	currently becomes quite slow.
 */
ino_t iunique(struct super_block *sb, ino_t max_reserved)
{
816 817 818 819 820 821
	/*
	 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
	 * error if st_ino won't fit in target struct field. Use 32bit counter
	 * here to attempt to avoid that.
	 */
	static unsigned int counter;
Linus Torvalds's avatar
Linus Torvalds committed
822
	struct inode *inode;
823
	struct hlist_head *head;
Linus Torvalds's avatar
Linus Torvalds committed
824
	ino_t res;
825

Linus Torvalds's avatar
Linus Torvalds committed
826
	spin_lock(&inode_lock);
827 828 829
	do {
		if (counter <= max_reserved)
			counter = max_reserved + 1;
Linus Torvalds's avatar
Linus Torvalds committed
830
		res = counter++;
831
		head = inode_hashtable + hash(sb, res);
Linus Torvalds's avatar
Linus Torvalds committed
832
		inode = find_inode_fast(sb, head, res);
833 834
	} while (inode != NULL);
	spin_unlock(&inode_lock);
Linus Torvalds's avatar
Linus Torvalds committed
835

836 837
	return res;
}
Linus Torvalds's avatar
Linus Torvalds committed
838 839 840 841 842
EXPORT_SYMBOL(iunique);

struct inode *igrab(struct inode *inode)
{
	spin_lock(&inode_lock);
843
	if (!(inode->i_state & (I_FREEING|I_WILL_FREE)))
Linus Torvalds's avatar
Linus Torvalds committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
		__iget(inode);
	else
		/*
		 * Handle the case where s_op->clear_inode is not been
		 * called yet, and somebody is calling igrab
		 * while the inode is getting freed.
		 */
		inode = NULL;
	spin_unlock(&inode_lock);
	return inode;
}
EXPORT_SYMBOL(igrab);

/**
 * ifind - internal function, you want ilookup5() or iget5().
 * @sb:		super block of file system to search
 * @head:       the head of the list to search
 * @test:	callback used for comparisons between inodes
 * @data:	opaque data pointer to pass to @test
863
 * @wait:	if true wait for the inode to be unlocked, if false do not
Linus Torvalds's avatar
Linus Torvalds committed
864 865 866 867 868 869 870 871 872 873 874 875
 *
 * ifind() searches for the inode specified by @data in the inode
 * cache. This is a generalized version of ifind_fast() for file systems where
 * the inode number is not sufficient for unique identification of an inode.
 *
 * If the inode is in the cache, the inode is returned with an incremented
 * reference count.
 *
 * Otherwise NULL is returned.
 *
 * Note, @test is called with the inode_lock held, so can't sleep.
 */
876
static struct inode *ifind(struct super_block *sb,
Linus Torvalds's avatar
Linus Torvalds committed
877
		struct hlist_head *head, int (*test)(struct inode *, void *),
878
		void *data, const int wait)
Linus Torvalds's avatar
Linus Torvalds committed
879 880 881 882 883 884 885 886
{
	struct inode *inode;

	spin_lock(&inode_lock);
	inode = find_inode(sb, head, test, data);
	if (inode) {
		__iget(inode);
		spin_unlock(&inode_lock);
887 888
		if (likely(wait))
			wait_on_inode(inode);
Linus Torvalds's avatar
Linus Torvalds committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
		return inode;
	}
	spin_unlock(&inode_lock);
	return NULL;
}

/**
 * ifind_fast - internal function, you want ilookup() or iget().
 * @sb:		super block of file system to search
 * @head:       head of the list to search
 * @ino:	inode number to search for
 *
 * ifind_fast() searches for the inode @ino in the inode cache. This is for
 * file systems where the inode number is sufficient for unique identification
 * of an inode.
 *
 * If the inode is in the cache, the inode is returned with an incremented
 * reference count.
 *
 * Otherwise NULL is returned.
 */
910
static struct inode *ifind_fast(struct super_block *sb,
Linus Torvalds's avatar
Linus Torvalds committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
		struct hlist_head *head, unsigned long ino)
{
	struct inode *inode;

	spin_lock(&inode_lock);
	inode = find_inode_fast(sb, head, ino);
	if (inode) {
		__iget(inode);
		spin_unlock(&inode_lock);
		wait_on_inode(inode);
		return inode;
	}
	spin_unlock(&inode_lock);
	return NULL;
}

/**
928
 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds's avatar
Linus Torvalds committed
929 930 931 932 933 934 935 936 937 938 939
 * @sb:		super block of file system to search
 * @hashval:	hash value (usually inode number) to search for
 * @test:	callback used for comparisons between inodes
 * @data:	opaque data pointer to pass to @test
 *
 * ilookup5() uses ifind() to search for the inode specified by @hashval and
 * @data in the inode cache. This is a generalized version of ilookup() for
 * file systems where the inode number is not sufficient for unique
 * identification of an inode.
 *
 * If the inode is in the cache, the inode is returned with an incremented
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
 * reference count.  Note, the inode lock is not waited upon so you have to be
 * very careful what you do with the returned inode.  You probably should be
 * using ilookup5() instead.
 *
 * Otherwise NULL is returned.
 *
 * Note, @test is called with the inode_lock held, so can't sleep.
 */
struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
		int (*test)(struct inode *, void *), void *data)
{
	struct hlist_head *head = inode_hashtable + hash(sb, hashval);

	return ifind(sb, head, test, data, 0);
}
EXPORT_SYMBOL(ilookup5_nowait);

/**
 * ilookup5 - search for an inode in the inode cache
 * @sb:		super block of file system to search
 * @hashval:	hash value (usually inode number) to search for
 * @test:	callback used for comparisons between inodes
 * @data:	opaque data pointer to pass to @test
 *
 * ilookup5() uses ifind() to search for the inode specified by @hashval and
 * @data in the inode cache. This is a generalized version of ilookup() for
 * file systems where the inode number is not sufficient for unique
 * identification of an inode.
 *
 * If the inode is in the cache, the inode lock is waited upon and the inode is
 * returned with an incremented reference count.
Linus Torvalds's avatar
Linus Torvalds committed
971 972 973 974 975 976 977 978 979 980
 *
 * Otherwise NULL is returned.
 *
 * Note, @test is called with the inode_lock held, so can't sleep.
 */
struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
		int (*test)(struct inode *, void *), void *data)
{
	struct hlist_head *head = inode_hashtable + hash(sb, hashval);

981
	return ifind(sb, head, test, data, 1);
Linus Torvalds's avatar
Linus Torvalds committed
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
}
EXPORT_SYMBOL(ilookup5);

/**
 * ilookup - search for an inode in the inode cache
 * @sb:		super block of file system to search
 * @ino:	inode number to search for
 *
 * ilookup() uses ifind_fast() to search for the inode @ino in the inode cache.
 * This is for file systems where the inode number is sufficient for unique
 * identification of an inode.
 *
 * If the inode is in the cache, the inode is returned with an incremented
 * reference count.
 *
 * Otherwise NULL is returned.
 */
struct inode *ilookup(struct super_block *sb, unsigned long ino)
{
	struct hlist_head *head = inode_hashtable + hash(sb, ino);

	return ifind_fast(sb, head, ino);
}
EXPORT_SYMBOL(ilookup);

/**
 * iget5_locked - obtain an inode from a mounted file system
 * @sb:		super block of file system
 * @hashval:	hash value (usually inode number) to get
 * @test:	callback used for comparisons between inodes
 * @set:	callback used to initialize a new struct inode
 * @data:	opaque data pointer to pass to @test and @set
 *
 * iget5_locked() uses ifind() to search for the inode specified by @hashval
 * and @data in the inode cache and if present it is returned with an increased
 * reference count. This is a generalized version of iget_locked() for file
 * systems where the inode number is not sufficient for unique identification
 * of an inode.
 *
 * If the inode is not in cache, get_new_inode() is called to allocate a new
 * inode and this is returned locked, hashed, and with the I_NEW flag set. The
 * file system gets to fill it in before unlocking it via unlock_new_inode().
 *
 * Note both @test and @set are called with the inode_lock held, so can't sleep.
 */
struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
		int (*test)(struct inode *, void *),
		int (*set)(struct inode *, void *), void *data)
{
	struct hlist_head *head = inode_hashtable + hash(sb, hashval);
	struct inode *inode;

1034
	inode = ifind(sb, head, test, data, 1);
Linus Torvalds's avatar
Linus Torvalds committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
	if (inode)
		return inode;
	/*
	 * get_new_inode() will do the right thing, re-trying the search
	 * in case it had to block at any point.
	 */
	return get_new_inode(sb, head, test, set, data);
}
EXPORT_SYMBOL(iget5_locked);

/**
 * iget_locked - obtain an inode from a mounted file system
 * @sb:		super block of file system
 * @ino:	inode number to get
 *
 * iget_locked() uses ifind_fast() to search for the inode specified by @ino in
 * the inode cache and if present it is returned with an increased reference
 * count. This is for file systems where the inode number is sufficient for
 * unique identification of an inode.
 *
 * If the inode is not in cache, get_new_inode_fast() is called to allocate a
 * new inode and this is returned locked, hashed, and with the I_NEW flag set.
 * The file system gets to fill it in before unlocking it via
 * unlock_new_inode().
 */
struct inode *iget_locked(struct super_block *sb, unsigned long ino)
{
	struct hlist_head *head = inode_hashtable + hash(sb, ino);
	struct inode *inode;

	inode = ifind_fast(sb, head, ino);
	if (inode)
		return inode;
	/*
	 * get_new_inode_fast() will do the right thing, re-trying the search
	 * in case it had to block at any point.
	 */
	return get_new_inode_fast(sb, head, ino);
}
EXPORT_SYMBOL(iget_locked);

1076 1077 1078 1079 1080 1081
int insert_inode_locked(struct inode *inode)
{
	struct super_block *sb = inode->i_sb;
	ino_t ino = inode->i_ino;
	struct hlist_head *head = inode_hashtable + hash(sb, ino);

Christoph Hellwig's avatar
Christoph Hellwig committed
1082
	inode->i_state |= I_NEW;
1083
	while (1) {
1084 1085
		struct hlist_node *node;
		struct inode *old = NULL;
1086
		spin_lock(&inode_lock);
1087 1088 1089 1090 1091
		hlist_for_each_entry(old, node, head, i_hash) {
			if (old->i_ino != ino)
				continue;
			if (old->i_sb != sb)
				continue;
1092
			if (old->i_state & (I_FREEING|I_WILL_FREE))
1093 1094 1095 1096
				continue;
			break;
		}
		if (likely(!node)) {
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
			hlist_add_head(&inode->i_hash, head);
			spin_unlock(&inode_lock);
			return 0;
		}
		__iget(old);
		spin_unlock(&inode_lock);
		wait_on_inode(old);
		if (unlikely(!hlist_unhashed(&old->i_hash))) {
			iput(old);
			return -EBUSY;
		}
		iput(old);
	}
}
EXPORT_SYMBOL(insert_inode_locked);

int insert_inode_locked4(struct inode *inode, unsigned long hashval,
		int (*test)(struct inode *, void *), void *data)
{
	struct super_block *sb = inode->i_sb;
	struct hlist_head *head = inode_hashtable + hash(sb, hashval);

Christoph Hellwig's avatar
Christoph Hellwig committed
1119
	inode->i_state |= I_NEW;
1120 1121

	while (1) {
1122 1123 1124
		struct hlist_node *node;
		struct inode *old = NULL;

1125
		spin_lock(&inode_lock);
1126 1127 1128 1129 1130
		hlist_for_each_entry(old, node, head, i_hash) {
			if (old->i_sb != sb)
				continue;
			if (!test(old, data))
				continue;
1131
			if (old->i_state & (I_FREEING|I_WILL_FREE))
1132 1133 1134 1135
				continue;
			break;
		}
		if (likely(!node)) {
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
			hlist_add_head(&inode->i_hash, head);
			spin_unlock(&inode_lock);
			return 0;
		}
		__iget(old);
		spin_unlock(&inode_lock);
		wait_on_inode(old);
		if (unlikely(!hlist_unhashed(&old->i_hash))) {
			iput(old);
			return -EBUSY;
		}
		iput(old);
	}
}
EXPORT_SYMBOL(insert_inode_locked4);

Linus Torvalds's avatar
Linus Torvalds committed
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
/**
 *	__insert_inode_hash - hash an inode
 *	@inode: unhashed inode
 *	@hashval: unsigned long value used to locate this object in the
 *		inode_hashtable.
 *
 *	Add an inode to the inode hash for this superblock.
 */
void __insert_inode_hash(struct inode *inode, unsigned long hashval)
{
	struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
	spin_lock(&inode_lock);
	hlist_add_head(&inode->i_hash, head);
	spin_unlock(&inode_lock);
}
EXPORT_SYMBOL(__insert_inode_hash);

/**
 *	remove_inode_hash - remove an inode from the hash
 *	@inode: inode to unhash
 *
 *	Remove an inode from the superblock.
 */
void remove_inode_hash(struct inode *inode)
{
	spin_lock(&inode_lock);
	hlist_del_init(&inode->i_hash);
	spin_unlock(&inode_lock);
}
EXPORT_SYMBOL(remove_inode_hash);

/*
 * Tell the filesystem that this inode is no longer of any interest and should
 * be completely destroyed.
 *
 * We leave the inode in the inode hash table until *after* the filesystem's
 * ->delete_inode completes.  This ensures that an iget (such as nfsd might
 * instigate) will always find up-to-date information either in the hash or on
 * disk.
 *
 * I_FREEING is set so that no-one will take a new reference to the inode while
 * it is being deleted.
 */
1195
void generic_delete_inode(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
1196
{
1197
	const struct super_operations *op = inode->i_sb->s_op;
Linus Torvalds's avatar
Linus Torvalds committed
1198

1199 1200
	list_del_init(&inode->i_list);
	list_del_init(&inode->i_sb_list);
1201
	WARN_ON(inode->i_state & I_NEW);
1202 1203 1204 1205
	inode->i_state |= I_FREEING;
	inodes_stat.nr_inodes--;
	spin_unlock(&inode_lock);

Linus Torvalds's avatar
Linus Torvalds committed
1206 1207
	if (op->delete_inode) {
		void (*delete)(struct inode *) = op->delete_inode;
1208 1209 1210 1211
		/* Filesystems implementing their own
		 * s_op->delete_inode are required to call
		 * truncate_inode_pages and clear_inode()
		 * internally */
Linus Torvalds's avatar
Linus Torvalds committed
1212
		delete(inode);
1213 1214
	} else {
		truncate_inode_pages(&inode->i_data, 0);
Linus Torvalds's avatar
Linus Torvalds committed
1215
		clear_inode(inode);
1216
	}
Linus Torvalds's avatar
Linus Torvalds committed
1217 1218 1219 1220
	spin_lock(&inode_lock);
	hlist_del_init(&inode->i_hash);
	spin_unlock(&inode_lock);
	wake_up_inode(inode);
1221
	BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
Linus Torvalds's avatar
Linus Torvalds committed
1222 1223 1224 1225
	destroy_inode(inode);
}
EXPORT_SYMBOL(generic_delete_inode);

1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
/**
 *	generic_detach_inode - remove inode from inode lists
 *	@inode: inode to remove
 *
 *	Remove inode from inode lists, write it if it's dirty. This is just an
 *	internal VFS helper exported for hugetlbfs. Do not use!
 *
 *	Returns 1 if inode should be completely destroyed.
 */
int generic_detach_inode(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
1236 1237 1238 1239
{
	struct super_block *sb = inode->i_sb;

	if (!hlist_unhashed(&inode->i_hash)) {
Joern Engel's avatar
Joern Engel committed
1240
		if (!(inode->i_state & (I_DIRTY|I_SYNC)))
Linus Torvalds's avatar
Linus Torvalds committed
1241 1242
			list_move(&inode->i_list, &inode_unused);
		inodes_stat.nr_unused++;
1243
		if (sb->s_flags & MS_ACTIVE) {
1244
			spin_unlock(&inode_lock);
1245
			return 0;
1246
		}
1247
		WARN_ON(inode->i_state & I_NEW);
1248 1249
		inode->i_state |= I_WILL_FREE;
		spin_unlock(&inode_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1250 1251
		write_inode_now(inode, 1);
		spin_lock(&inode_lock);
1252
		WARN_ON(inode->i_state & I_NEW);
1253
		inode->i_state &= ~I_WILL_FREE;
Linus Torvalds's avatar
Linus Torvalds committed
1254 1255 1256 1257 1258
		inodes_stat.nr_unused--;
		hlist_del_init(&inode->i_hash);
	}
	list_del_init(&inode->i_list);
	list_del_init(&inode->i_sb_list);
1259
	WARN_ON(inode->i_state & I_NEW);
1260
	inode->i_state |= I_FREEING;
Linus Torvalds's avatar
Linus Torvalds committed
1261 1262
	inodes_stat.nr_inodes--;
	spin_unlock(&inode_lock);
1263 1264 1265 1266 1267 1268 1269 1270
	return 1;
}
EXPORT_SYMBOL_GPL(generic_detach_inode);

static void generic_forget_inode(struct inode *inode)
{
	if (!generic_detach_inode(inode))
		return;
Linus Torvalds's avatar
Linus Torvalds committed
1271 1272 1273
	if (inode->i_data.nrpages)
		truncate_inode_pages(&inode->i_data, 0);
	clear_inode(inode);
1274
	wake_up_inode(inode);
Linus Torvalds's avatar
Linus Torvalds committed
1275 1276 1277 1278 1279 1280 1281 1282
	destroy_inode(inode);
}

/*
 * Normal UNIX filesystem behaviour: delete the
 * inode when the usage count drops to zero, and
 * i_nlink is zero.
 */
1283
void generic_drop_inode(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
1284 1285 1286 1287 1288 1289
{
	if (!inode->i_nlink)
		generic_delete_inode(inode);
	else
		generic_forget_inode(inode);
}
1290 1291
EXPORT_SYMBOL_GPL(generic_drop_inode);

Linus Torvalds's avatar
Linus Torvalds committed
1292 1293
/*
 * Called when we're dropping the last reference
1294
 * to an inode.
Linus Torvalds's avatar
Linus Torvalds committed
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
 *
 * Call the FS "drop()" function, defaulting to
 * the legacy UNIX filesystem behaviour..
 *
 * NOTE! NOTE! NOTE! We're called with the inode lock
 * held, and the drop function is supposed to release
 * the lock!
 */
static inline void iput_final(struct inode *inode)
{
1305
	const struct super_operations *op = inode->i_sb->s_op;
Linus Torvalds's avatar
Linus Torvalds committed
1306 1307 1308 1309 1310 1311 1312 1313
	void (*drop)(struct inode *) = generic_drop_inode;

	if (op && op->drop_inode)
		drop = op->drop_inode;
	drop(inode);
}

/**
1314
 *	iput	- put an inode
Linus Torvalds's avatar
Linus Torvalds committed
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
 *	@inode: inode to put
 *
 *	Puts an inode, dropping its usage count. If the inode use count hits
 *	zero, the inode is then freed and may also be destroyed.
 *
 *	Consequently, iput() can sleep.
 */
void iput(struct inode *inode)
{
	if (inode) {
1325
		BUG_ON(inode->i_state & I_CLEAR);
Linus Torvalds's avatar
Linus Torvalds committed
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340

		if (atomic_dec_and_lock(&inode->i_count, &inode_lock))
			iput_final(inode);
	}
}
EXPORT_SYMBOL(iput);

/**
 *	bmap	- find a block number in a file
 *	@inode: inode of file
 *	@block: block to find
 *
 *	Returns the block number on the device holding the inode that
 *	is the disk block number for the block of the file requested.
 *	That is, asked for block 4 of inode 1 the function will return the
1341
 *	disk block relative to the disk start that holds that block of the