patch-2.6.6-vs1.9.0
[linux-2.6.git] / fs / inode.c
1 /*
2  * linux/fs/inode.c
3  *
4  * (C) 1997 Linus Torvalds
5  */
6
7 #include <linux/config.h>
8 #include <linux/fs.h>
9 #include <linux/mm.h>
10 #include <linux/dcache.h>
11 #include <linux/init.h>
12 #include <linux/quotaops.h>
13 #include <linux/slab.h>
14 #include <linux/writeback.h>
15 #include <linux/module.h>
16 #include <linux/backing-dev.h>
17 #include <linux/wait.h>
18 #include <linux/hash.h>
19 #include <linux/swap.h>
20 #include <linux/security.h>
21 #include <linux/pagemap.h>
22 #include <linux/cdev.h>
23
24 /*
25  * This is needed for the following functions:
26  *  - inode_has_buffers
27  *  - invalidate_inode_buffers
28  *  - fsync_bdev
29  *  - invalidate_bdev
30  *
31  * FIXME: remove all knowledge of the buffer layer from this file
32  */
33 #include <linux/buffer_head.h>
34
35 /*
36  * New inode.c implementation.
37  *
38  * This implementation has the basic premise of trying
39  * to be extremely low-overhead and SMP-safe, yet be
40  * simple enough to be "obviously correct".
41  *
42  * Famous last words.
43  */
44
45 /* inode dynamic allocation 1999, Andrea Arcangeli <andrea@suse.de> */
46
47 /* #define INODE_PARANOIA 1 */
48 /* #define INODE_DEBUG 1 */
49
50 /*
51  * Inode lookup is no longer as critical as it used to be:
52  * most of the lookups are going to be through the dcache.
53  */
54 #define I_HASHBITS      i_hash_shift
55 #define I_HASHMASK      i_hash_mask
56
57 static unsigned int i_hash_mask;
58 static unsigned int i_hash_shift;
59
60 /*
61  * Each inode can be on two separate lists. One is
62  * the hash list of the inode, used for lookups. The
63  * other linked list is the "type" list:
64  *  "in_use" - valid inode, i_count > 0, i_nlink > 0
65  *  "dirty"  - as "in_use" but also dirty
66  *  "unused" - valid inode, i_count = 0
67  *
68  * A "dirty" list is maintained for each super block,
69  * allowing for low-overhead inode sync() operations.
70  */
71
72 LIST_HEAD(inode_in_use);
73 LIST_HEAD(inode_unused);
74 static struct hlist_head *inode_hashtable;
75
76 /*
77  * A simple spinlock to protect the list manipulations.
78  *
79  * NOTE! You also have to own the lock if you change
80  * the i_state of an inode while it is in use..
81  */
82 spinlock_t inode_lock = SPIN_LOCK_UNLOCKED;
83
84 /*
85  * iprune_sem provides exclusion between the kswapd or try_to_free_pages
86  * icache shrinking path, and the umount path.  Without this exclusion,
87  * by the time prune_icache calls iput for the inode whose pages it has
88  * been invalidating, or by the time it calls clear_inode & destroy_inode
89  * from its final dispose_list, the struct super_block they refer to
90  * (for inode->i_sb->s_op) may already have been freed and reused.
91  */
92 static DECLARE_MUTEX(iprune_sem);
93
94 /*
95  * Statistics gathering..
96  */
97 struct inodes_stat_t inodes_stat;
98
99 static kmem_cache_t * inode_cachep;
100
101 static struct inode *alloc_inode(struct super_block *sb)
102 {
103         static struct address_space_operations empty_aops;
104         static struct inode_operations empty_iops;
105         static struct file_operations empty_fops;
106         struct inode *inode;
107
108         if (sb->s_op->alloc_inode)
109                 inode = sb->s_op->alloc_inode(sb);
110         else
111                 inode = (struct inode *) kmem_cache_alloc(inode_cachep, SLAB_KERNEL);
112
113         if (inode) {
114                 struct address_space * const mapping = &inode->i_data;
115
116                 inode->i_sb = sb;
117                 if (sb->s_flags & MS_TAGXID)
118                         inode->i_xid = current->xid;
119                 else
120                         inode->i_xid = 0;       /* maybe xid -1 would be better? */
121                 // inode->i_dqh = dqhget(sb->s_dqh);
122                 inode->i_blkbits = sb->s_blocksize_bits;
123                 inode->i_flags = 0;
124                 atomic_set(&inode->i_count, 1);
125                 inode->i_sock = 0;
126                 inode->i_op = &empty_iops;
127                 inode->i_fop = &empty_fops;
128                 inode->i_nlink = 1;
129                 atomic_set(&inode->i_writecount, 0);
130                 inode->i_size = 0;
131                 inode->i_blocks = 0;
132                 inode->i_bytes = 0;
133                 inode->i_generation = 0;
134 #ifdef CONFIG_QUOTA
135                 memset(&inode->i_dquot, 0, sizeof(inode->i_dquot));
136 #endif
137                 inode->i_pipe = NULL;
138                 inode->i_bdev = NULL;
139                 inode->i_cdev = NULL;
140                 inode->i_rdev = 0;
141                 // inode->i_xid = 0;    /* maybe not too wise ... */
142                 inode->i_security = NULL;
143                 inode->dirtied_when = 0;
144                 if (security_inode_alloc(inode)) {
145                         if (inode->i_sb->s_op->destroy_inode)
146                                 inode->i_sb->s_op->destroy_inode(inode);
147                         else
148                                 kmem_cache_free(inode_cachep, (inode));
149                         return NULL;
150                 }
151
152                 mapping->a_ops = &empty_aops;
153                 mapping->host = inode;
154                 mapping->flags = 0;
155                 mapping_set_gfp_mask(mapping, GFP_HIGHUSER);
156                 mapping->assoc_mapping = NULL;
157                 mapping->backing_dev_info = &default_backing_dev_info;
158                 if (sb->s_bdev)
159                         mapping->backing_dev_info = sb->s_bdev->bd_inode->i_mapping->backing_dev_info;
160                 memset(&inode->u, 0, sizeof(inode->u));
161                 inode->i_mapping = mapping;
162         }
163         return inode;
164 }
165
166 void destroy_inode(struct inode *inode) 
167 {
168         if (inode_has_buffers(inode))
169                 BUG();
170         security_inode_free(inode);
171         if (inode->i_sb->s_op->destroy_inode)
172                 inode->i_sb->s_op->destroy_inode(inode);
173         else
174                 kmem_cache_free(inode_cachep, (inode));
175 }
176
177
178 /*
179  * These are initializations that only need to be done
180  * once, because the fields are idempotent across use
181  * of the inode, so let the slab aware of that.
182  */
183 void inode_init_once(struct inode *inode)
184 {
185         memset(inode, 0, sizeof(*inode));
186         INIT_HLIST_NODE(&inode->i_hash);
187         INIT_LIST_HEAD(&inode->i_dentry);
188         INIT_LIST_HEAD(&inode->i_devices);
189         sema_init(&inode->i_sem, 1);
190         init_rwsem(&inode->i_alloc_sem);
191         INIT_RADIX_TREE(&inode->i_data.page_tree, GFP_ATOMIC);
192         spin_lock_init(&inode->i_data.tree_lock);
193         init_MUTEX(&inode->i_data.i_shared_sem);
194         atomic_set(&inode->i_data.truncate_count, 0);
195         INIT_LIST_HEAD(&inode->i_data.private_list);
196         spin_lock_init(&inode->i_data.private_lock);
197         INIT_LIST_HEAD(&inode->i_data.i_mmap);
198         INIT_LIST_HEAD(&inode->i_data.i_mmap_shared);
199         spin_lock_init(&inode->i_lock);
200         i_size_ordered_init(inode);
201 }
202
203 EXPORT_SYMBOL(inode_init_once);
204
205 static void init_once(void * foo, kmem_cache_t * cachep, unsigned long flags)
206 {
207         struct inode * inode = (struct inode *) foo;
208
209         if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
210             SLAB_CTOR_CONSTRUCTOR)
211                 inode_init_once(inode);
212 }
213
214 /*
215  * inode_lock must be held
216  */
217 void __iget(struct inode * inode)
218 {
219         if (atomic_read(&inode->i_count)) {
220                 atomic_inc(&inode->i_count);
221                 return;
222         }
223         atomic_inc(&inode->i_count);
224         if (!(inode->i_state & (I_DIRTY|I_LOCK)))
225                 list_move(&inode->i_list, &inode_in_use);
226         inodes_stat.nr_unused--;
227 }
228
229 /**
230  * clear_inode - clear an inode
231  * @inode: inode to clear
232  *
233  * This is called by the filesystem to tell us
234  * that the inode is no longer useful. We just
235  * terminate it with extreme prejudice.
236  */
237 void clear_inode(struct inode *inode)
238 {
239         invalidate_inode_buffers(inode);
240        
241         if (inode->i_data.nrpages)
242                 BUG();
243         if (!(inode->i_state & I_FREEING))
244                 BUG();
245         if (inode->i_state & I_CLEAR)
246                 BUG();
247         wait_on_inode(inode);
248         DQUOT_DROP(inode);
249         if (inode->i_sb && inode->i_sb->s_op->clear_inode)
250                 inode->i_sb->s_op->clear_inode(inode);
251         if (inode->i_bdev)
252                 bd_forget(inode);
253         if (inode->i_cdev)
254                 cd_forget(inode);
255         inode->i_state = I_CLEAR;
256 }
257
258 EXPORT_SYMBOL(clear_inode);
259
260 /*
261  * dispose_list - dispose of the contents of a local list
262  * @head: the head of the list to free
263  *
264  * Dispose-list gets a local list with local inodes in it, so it doesn't
265  * need to worry about list corruption and SMP locks.
266  */
267 static void dispose_list(struct list_head *head)
268 {
269         int nr_disposed = 0;
270
271         while (!list_empty(head)) {
272                 struct inode *inode;
273
274                 inode = list_entry(head->next, struct inode, i_list);
275                 list_del(&inode->i_list);
276
277                 if (inode->i_data.nrpages)
278                         truncate_inode_pages(&inode->i_data, 0);
279                 clear_inode(inode);
280                 destroy_inode(inode);
281                 nr_disposed++;
282         }
283         spin_lock(&inode_lock);
284         inodes_stat.nr_inodes -= nr_disposed;
285         spin_unlock(&inode_lock);
286 }
287
288 /*
289  * Invalidate all inodes for a device.
290  */
291 static int invalidate_list(struct list_head *head, struct super_block * sb, struct list_head * dispose)
292 {
293         struct list_head *next;
294         int busy = 0, count = 0;
295
296         next = head->next;
297         for (;;) {
298                 struct list_head * tmp = next;
299                 struct inode * inode;
300
301                 next = next->next;
302                 if (tmp == head)
303                         break;
304                 inode = list_entry(tmp, struct inode, i_list);
305                 if (inode->i_sb != sb)
306                         continue;
307                 invalidate_inode_buffers(inode);
308                 if (!atomic_read(&inode->i_count)) {
309                         hlist_del_init(&inode->i_hash);
310                         list_move(&inode->i_list, dispose);
311                         inode->i_state |= I_FREEING;
312                         count++;
313                         continue;
314                 }
315                 busy = 1;
316         }
317         /* only unused inodes may be cached with i_count zero */
318         inodes_stat.nr_unused -= count;
319         return busy;
320 }
321
322 /*
323  * This is a two-stage process. First we collect all
324  * offending inodes onto the throw-away list, and in
325  * the second stage we actually dispose of them. This
326  * is because we don't want to sleep while messing
327  * with the global lists..
328  */
329  
330 /**
331  *      invalidate_inodes       - discard the inodes on a device
332  *      @sb: superblock
333  *
334  *      Discard all of the inodes for a given superblock. If the discard
335  *      fails because there are busy inodes then a non zero value is returned.
336  *      If the discard is successful all the inodes have been discarded.
337  */
338 int invalidate_inodes(struct super_block * sb)
339 {
340         int busy;
341         LIST_HEAD(throw_away);
342
343         down(&iprune_sem);
344         spin_lock(&inode_lock);
345         busy = invalidate_list(&inode_in_use, sb, &throw_away);
346         busy |= invalidate_list(&inode_unused, sb, &throw_away);
347         busy |= invalidate_list(&sb->s_dirty, sb, &throw_away);
348         busy |= invalidate_list(&sb->s_io, sb, &throw_away);
349         spin_unlock(&inode_lock);
350
351         dispose_list(&throw_away);
352         up(&iprune_sem);
353
354         return busy;
355 }
356
357 EXPORT_SYMBOL(invalidate_inodes);
358  
359 int __invalidate_device(struct block_device *bdev, int do_sync)
360 {
361         struct super_block *sb;
362         int res;
363
364         if (do_sync)
365                 fsync_bdev(bdev);
366
367         res = 0;
368         sb = get_super(bdev);
369         if (sb) {
370                 /*
371                  * no need to lock the super, get_super holds the
372                  * read semaphore so the filesystem cannot go away
373                  * under us (->put_super runs with the write lock
374                  * hold).
375                  */
376                 shrink_dcache_sb(sb);
377                 res = invalidate_inodes(sb);
378                 drop_super(sb);
379         }
380         invalidate_bdev(bdev, 0);
381         return res;
382 }
383
384 EXPORT_SYMBOL(__invalidate_device);
385
386 static int can_unuse(struct inode *inode)
387 {
388         if (inode->i_state)
389                 return 0;
390         if (inode_has_buffers(inode))
391                 return 0;
392         if (atomic_read(&inode->i_count))
393                 return 0;
394         if (inode->i_data.nrpages)
395                 return 0;
396         return 1;
397 }
398
399 /*
400  * Scan `goal' inodes on the unused list for freeable ones. They are moved to
401  * a temporary list and then are freed outside inode_lock by dispose_list().
402  *
403  * Any inodes which are pinned purely because of attached pagecache have their
404  * pagecache removed.  We expect the final iput() on that inode to add it to
405  * the front of the inode_unused list.  So look for it there and if the
406  * inode is still freeable, proceed.  The right inode is found 99.9% of the
407  * time in testing on a 4-way.
408  *
409  * If the inode has metadata buffers attached to mapping->private_list then
410  * try to remove them.
411  */
412 static void prune_icache(int nr_to_scan)
413 {
414         LIST_HEAD(freeable);
415         int nr_pruned = 0;
416         int nr_scanned;
417         unsigned long reap = 0;
418
419         down(&iprune_sem);
420         spin_lock(&inode_lock);
421         for (nr_scanned = 0; nr_scanned < nr_to_scan; nr_scanned++) {
422                 struct inode *inode;
423
424                 if (list_empty(&inode_unused))
425                         break;
426
427                 inode = list_entry(inode_unused.prev, struct inode, i_list);
428
429                 if (inode->i_state || atomic_read(&inode->i_count)) {
430                         list_move(&inode->i_list, &inode_unused);
431                         continue;
432                 }
433                 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
434                         __iget(inode);
435                         spin_unlock(&inode_lock);
436                         if (remove_inode_buffers(inode))
437                                 reap += invalidate_inode_pages(&inode->i_data);
438                         iput(inode);
439                         spin_lock(&inode_lock);
440
441                         if (inode != list_entry(inode_unused.next,
442                                                 struct inode, i_list))
443                                 continue;       /* wrong inode or list_empty */
444                         if (!can_unuse(inode))
445                                 continue;
446                 }
447                 hlist_del_init(&inode->i_hash);
448                 list_move(&inode->i_list, &freeable);
449                 inode->i_state |= I_FREEING;
450                 nr_pruned++;
451         }
452         inodes_stat.nr_unused -= nr_pruned;
453         spin_unlock(&inode_lock);
454
455         dispose_list(&freeable);
456         up(&iprune_sem);
457
458         if (current_is_kswapd())
459                 mod_page_state(kswapd_inodesteal, reap);
460         else
461                 mod_page_state(pginodesteal, reap);
462 }
463
464 /*
465  * shrink_icache_memory() will attempt to reclaim some unused inodes.  Here,
466  * "unused" means that no dentries are referring to the inodes: the files are
467  * not open and the dcache references to those inodes have already been
468  * reclaimed.
469  *
470  * This function is passed the number of inodes to scan, and it returns the
471  * total number of remaining possibly-reclaimable inodes.
472  */
473 static int shrink_icache_memory(int nr, unsigned int gfp_mask)
474 {
475         if (nr) {
476                 /*
477                  * Nasty deadlock avoidance.  We may hold various FS locks,
478                  * and we don't want to recurse into the FS that called us
479                  * in clear_inode() and friends..
480                  */
481                 if (gfp_mask & __GFP_FS)
482                         prune_icache(nr);
483         }
484         return inodes_stat.nr_unused;
485 }
486
487 static void __wait_on_freeing_inode(struct inode *inode);
488 /*
489  * Called with the inode lock held.
490  * NOTE: we are not increasing the inode-refcount, you must call __iget()
491  * by hand after calling find_inode now! This simplifies iunique and won't
492  * add any additional branch in the common code.
493  */
494 static struct inode * find_inode(struct super_block * sb, struct hlist_head *head, int (*test)(struct inode *, void *), void *data)
495 {
496         struct hlist_node *node;
497         struct inode * inode = NULL;
498
499 repeat:
500         hlist_for_each (node, head) { 
501                 inode = hlist_entry(node, struct inode, i_hash);
502                 if (inode->i_sb != sb)
503                         continue;
504                 if (!test(inode, data))
505                         continue;
506                 if (inode->i_state & (I_FREEING|I_CLEAR)) {
507                         __wait_on_freeing_inode(inode);
508                         goto repeat;
509                 }
510                 break;
511         }
512         return node ? inode : NULL;
513 }
514
515 /*
516  * find_inode_fast is the fast path version of find_inode, see the comment at
517  * iget_locked for details.
518  */
519 static struct inode * find_inode_fast(struct super_block * sb, struct hlist_head *head, unsigned long ino)
520 {
521         struct hlist_node *node;
522         struct inode * inode = NULL;
523
524 repeat:
525         hlist_for_each (node, head) {
526                 inode = hlist_entry(node, struct inode, i_hash);
527                 if (inode->i_ino != ino)
528                         continue;
529                 if (inode->i_sb != sb)
530                         continue;
531                 if (inode->i_state & (I_FREEING|I_CLEAR)) {
532                         __wait_on_freeing_inode(inode);
533                         goto repeat;
534                 }
535                 break;
536         }
537         return node ? inode : NULL;
538 }
539
540 /**
541  *      new_inode       - obtain an inode
542  *      @sb: superblock
543  *
544  *      Allocates a new inode for given superblock.
545  */
546 struct inode *new_inode(struct super_block *sb)
547 {
548         static unsigned long last_ino;
549         struct inode * inode;
550
551         spin_lock_prefetch(&inode_lock);
552         
553         inode = alloc_inode(sb);
554         if (inode) {
555                 spin_lock(&inode_lock);
556                 inodes_stat.nr_inodes++;
557                 list_add(&inode->i_list, &inode_in_use);
558                 inode->i_ino = ++last_ino;
559                 inode->i_state = 0;
560                 spin_unlock(&inode_lock);
561         }
562         return inode;
563 }
564
565 EXPORT_SYMBOL(new_inode);
566
567 void unlock_new_inode(struct inode *inode)
568 {
569         /*
570          * This is special!  We do not need the spinlock
571          * when clearing I_LOCK, because we're guaranteed
572          * that nobody else tries to do anything about the
573          * state of the inode when it is locked, as we
574          * just created it (so there can be no old holders
575          * that haven't tested I_LOCK).
576          */
577         inode->i_state &= ~(I_LOCK|I_NEW);
578         wake_up_inode(inode);
579 }
580
581 EXPORT_SYMBOL(unlock_new_inode);
582
583 /*
584  * This is called without the inode lock held.. Be careful.
585  *
586  * We no longer cache the sb_flags in i_flags - see fs.h
587  *      -- rmk@arm.uk.linux.org
588  */
589 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)
590 {
591         struct inode * inode;
592
593         inode = alloc_inode(sb);
594         if (inode) {
595                 struct inode * old;
596
597                 spin_lock(&inode_lock);
598                 /* We released the lock, so.. */
599                 old = find_inode(sb, head, test, data);
600                 if (!old) {
601                         if (set(inode, data))
602                                 goto set_failed;
603
604                         inodes_stat.nr_inodes++;
605                         list_add(&inode->i_list, &inode_in_use);
606                         hlist_add_head(&inode->i_hash, head);
607                         inode->i_state = I_LOCK|I_NEW;
608                         spin_unlock(&inode_lock);
609
610                         /* Return the locked inode with I_NEW set, the
611                          * caller is responsible for filling in the contents
612                          */
613                         return inode;
614                 }
615
616                 /*
617                  * Uhhuh, somebody else created the same inode under
618                  * us. Use the old inode instead of the one we just
619                  * allocated.
620                  */
621                 __iget(old);
622                 spin_unlock(&inode_lock);
623                 destroy_inode(inode);
624                 inode = old;
625                 wait_on_inode(inode);
626         }
627         return inode;
628
629 set_failed:
630         spin_unlock(&inode_lock);
631         destroy_inode(inode);
632         return NULL;
633 }
634
635 /*
636  * get_new_inode_fast is the fast path version of get_new_inode, see the
637  * comment at iget_locked for details.
638  */
639 static struct inode * get_new_inode_fast(struct super_block *sb, struct hlist_head *head, unsigned long ino)
640 {
641         struct inode * inode;
642
643         inode = alloc_inode(sb);
644         if (inode) {
645                 struct inode * old;
646
647                 spin_lock(&inode_lock);
648                 /* We released the lock, so.. */
649                 old = find_inode_fast(sb, head, ino);
650                 if (!old) {
651                         inode->i_ino = ino;
652                         inodes_stat.nr_inodes++;
653                         list_add(&inode->i_list, &inode_in_use);
654                         hlist_add_head(&inode->i_hash, head);
655                         inode->i_state = I_LOCK|I_NEW;
656                         spin_unlock(&inode_lock);
657
658                         /* Return the locked inode with I_NEW set, the
659                          * caller is responsible for filling in the contents
660                          */
661                         return inode;
662                 }
663
664                 /*
665                  * Uhhuh, somebody else created the same inode under
666                  * us. Use the old inode instead of the one we just
667                  * allocated.
668                  */
669                 __iget(old);
670                 spin_unlock(&inode_lock);
671                 destroy_inode(inode);
672                 inode = old;
673                 wait_on_inode(inode);
674         }
675         return inode;
676 }
677
678 static inline unsigned long hash(struct super_block *sb, unsigned long hashval)
679 {
680         unsigned long tmp = hashval + ((unsigned long) sb / L1_CACHE_BYTES);
681         tmp = tmp + (tmp >> I_HASHBITS);
682         return tmp & I_HASHMASK;
683 }
684
685 /* Yeah, I know about quadratic hash. Maybe, later. */
686
687 /**
688  *      iunique - get a unique inode number
689  *      @sb: superblock
690  *      @max_reserved: highest reserved inode number
691  *
692  *      Obtain an inode number that is unique on the system for a given
693  *      superblock. This is used by file systems that have no natural
694  *      permanent inode numbering system. An inode number is returned that
695  *      is higher than the reserved limit but unique.
696  *
697  *      BUGS:
698  *      With a large number of inodes live on the file system this function
699  *      currently becomes quite slow.
700  */
701 ino_t iunique(struct super_block *sb, ino_t max_reserved)
702 {
703         static ino_t counter;
704         struct inode *inode;
705         struct hlist_head * head;
706         ino_t res;
707         spin_lock(&inode_lock);
708 retry:
709         if (counter > max_reserved) {
710                 head = inode_hashtable + hash(sb,counter);
711                 res = counter++;
712                 inode = find_inode_fast(sb, head, res);
713                 if (!inode) {
714                         spin_unlock(&inode_lock);
715                         return res;
716                 }
717         } else {
718                 counter = max_reserved + 1;
719         }
720         goto retry;
721         
722 }
723
724 EXPORT_SYMBOL(iunique);
725
726 struct inode *igrab(struct inode *inode)
727 {
728         spin_lock(&inode_lock);
729         if (!(inode->i_state & I_FREEING))
730                 __iget(inode);
731         else
732                 /*
733                  * Handle the case where s_op->clear_inode is not been
734                  * called yet, and somebody is calling igrab
735                  * while the inode is getting freed.
736                  */
737                 inode = NULL;
738         spin_unlock(&inode_lock);
739         return inode;
740 }
741
742 EXPORT_SYMBOL(igrab);
743
744 /**
745  * ifind - internal function, you want ilookup5() or iget5().
746  * @sb:         super block of file system to search
747  * @head:       the head of the list to search
748  * @test:       callback used for comparisons between inodes
749  * @data:       opaque data pointer to pass to @test
750  *
751  * ifind() searches for the inode specified by @data in the inode
752  * cache. This is a generalized version of ifind_fast() for file systems where
753  * the inode number is not sufficient for unique identification of an inode.
754  *
755  * If the inode is in the cache, the inode is returned with an incremented
756  * reference count.
757  *
758  * Otherwise NULL is returned.
759  *
760  * Note, @test is called with the inode_lock held, so can't sleep.
761  */
762 static inline struct inode *ifind(struct super_block *sb,
763                 struct hlist_head *head, int (*test)(struct inode *, void *),
764                 void *data)
765 {
766         struct inode *inode;
767
768         spin_lock(&inode_lock);
769         inode = find_inode(sb, head, test, data);
770         if (inode) {
771                 __iget(inode);
772                 spin_unlock(&inode_lock);
773                 wait_on_inode(inode);
774                 return inode;
775         }
776         spin_unlock(&inode_lock);
777         return NULL;
778 }
779
780 /**
781  * ifind_fast - internal function, you want ilookup() or iget().
782  * @sb:         super block of file system to search
783  * @head:       head of the list to search
784  * @ino:        inode number to search for
785  *
786  * ifind_fast() searches for the inode @ino in the inode cache. This is for
787  * file systems where the inode number is sufficient for unique identification
788  * of an inode.
789  *
790  * If the inode is in the cache, the inode is returned with an incremented
791  * reference count.
792  *
793  * Otherwise NULL is returned.
794  */
795 static inline struct inode *ifind_fast(struct super_block *sb,
796                 struct hlist_head *head, unsigned long ino)
797 {
798         struct inode *inode;
799
800         spin_lock(&inode_lock);
801         inode = find_inode_fast(sb, head, ino);
802         if (inode) {
803                 __iget(inode);
804                 spin_unlock(&inode_lock);
805                 wait_on_inode(inode);
806                 return inode;
807         }
808         spin_unlock(&inode_lock);
809         return NULL;
810 }
811
812 /**
813  * ilookup5 - search for an inode in the inode cache
814  * @sb:         super block of file system to search
815  * @hashval:    hash value (usually inode number) to search for
816  * @test:       callback used for comparisons between inodes
817  * @data:       opaque data pointer to pass to @test
818  *
819  * ilookup5() uses ifind() to search for the inode specified by @hashval and
820  * @data in the inode cache. This is a generalized version of ilookup() for
821  * file systems where the inode number is not sufficient for unique
822  * identification of an inode.
823  *
824  * If the inode is in the cache, the inode is returned with an incremented
825  * reference count.
826  *
827  * Otherwise NULL is returned.
828  *
829  * Note, @test is called with the inode_lock held, so can't sleep.
830  */
831 struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
832                 int (*test)(struct inode *, void *), void *data)
833 {
834         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
835
836         return ifind(sb, head, test, data);
837 }
838
839 EXPORT_SYMBOL(ilookup5);
840
841 /**
842  * ilookup - search for an inode in the inode cache
843  * @sb:         super block of file system to search
844  * @ino:        inode number to search for
845  *
846  * ilookup() uses ifind_fast() to search for the inode @ino in the inode cache.
847  * This is for file systems where the inode number is sufficient for unique
848  * identification of an inode.
849  *
850  * If the inode is in the cache, the inode is returned with an incremented
851  * reference count.
852  *
853  * Otherwise NULL is returned.
854  */
855 struct inode *ilookup(struct super_block *sb, unsigned long ino)
856 {
857         struct hlist_head *head = inode_hashtable + hash(sb, ino);
858
859         return ifind_fast(sb, head, ino);
860 }
861
862 EXPORT_SYMBOL(ilookup);
863
864 /**
865  * iget5_locked - obtain an inode from a mounted file system
866  * @sb:         super block of file system
867  * @hashval:    hash value (usually inode number) to get
868  * @test:       callback used for comparisons between inodes
869  * @set:        callback used to initialize a new struct inode
870  * @data:       opaque data pointer to pass to @test and @set
871  *
872  * This is iget() without the read_inode() portion of get_new_inode().
873  *
874  * iget5_locked() uses ifind() to search for the inode specified by @hashval
875  * and @data in the inode cache and if present it is returned with an increased
876  * reference count. This is a generalized version of iget_locked() for file
877  * systems where the inode number is not sufficient for unique identification
878  * of an inode.
879  *
880  * If the inode is not in cache, get_new_inode() is called to allocate a new
881  * inode and this is returned locked, hashed, and with the I_NEW flag set. The
882  * file system gets to fill it in before unlocking it via unlock_new_inode().
883  *
884  * Note both @test and @set are called with the inode_lock held, so can't sleep.
885  */
886 struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
887                 int (*test)(struct inode *, void *),
888                 int (*set)(struct inode *, void *), void *data)
889 {
890         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
891         struct inode *inode;
892
893         inode = ifind(sb, head, test, data);
894         if (inode)
895                 return inode;
896         /*
897          * get_new_inode() will do the right thing, re-trying the search
898          * in case it had to block at any point.
899          */
900         return get_new_inode(sb, head, test, set, data);
901 }
902
903 EXPORT_SYMBOL(iget5_locked);
904
905 /**
906  * iget_locked - obtain an inode from a mounted file system
907  * @sb:         super block of file system
908  * @ino:        inode number to get
909  *
910  * This is iget() without the read_inode() portion of get_new_inode_fast().
911  *
912  * iget_locked() uses ifind_fast() to search for the inode specified by @ino in
913  * the inode cache and if present it is returned with an increased reference
914  * count. This is for file systems where the inode number is sufficient for
915  * unique identification of an inode.
916  *
917  * If the inode is not in cache, get_new_inode_fast() is called to allocate a
918  * new inode and this is returned locked, hashed, and with the I_NEW flag set.
919  * The file system gets to fill it in before unlocking it via
920  * unlock_new_inode().
921  */
922 struct inode *iget_locked(struct super_block *sb, unsigned long ino)
923 {
924         struct hlist_head *head = inode_hashtable + hash(sb, ino);
925         struct inode *inode;
926
927         inode = ifind_fast(sb, head, ino);
928         if (inode)
929                 return inode;
930         /*
931          * get_new_inode_fast() will do the right thing, re-trying the search
932          * in case it had to block at any point.
933          */
934         return get_new_inode_fast(sb, head, ino);
935 }
936
937 EXPORT_SYMBOL(iget_locked);
938
939 /**
940  *      __insert_inode_hash - hash an inode
941  *      @inode: unhashed inode
942  *      @hashval: unsigned long value used to locate this object in the
943  *              inode_hashtable.
944  *
945  *      Add an inode to the inode hash for this superblock.
946  */
947 void __insert_inode_hash(struct inode *inode, unsigned long hashval)
948 {
949         struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
950         spin_lock(&inode_lock);
951         hlist_add_head(&inode->i_hash, head);
952         spin_unlock(&inode_lock);
953 }
954
955 EXPORT_SYMBOL(__insert_inode_hash);
956
957 /**
958  *      remove_inode_hash - remove an inode from the hash
959  *      @inode: inode to unhash
960  *
961  *      Remove an inode from the superblock.
962  */
963 void remove_inode_hash(struct inode *inode)
964 {
965         spin_lock(&inode_lock);
966         hlist_del_init(&inode->i_hash);
967         spin_unlock(&inode_lock);
968 }
969
970 EXPORT_SYMBOL(remove_inode_hash);
971
972 /*
973  * Tell the filesystem that this inode is no longer of any interest and should
974  * be completely destroyed.
975  *
976  * We leave the inode in the inode hash table until *after* the filesystem's
977  * ->delete_inode completes.  This ensures that an iget (such as nfsd might
978  * instigate) will always find up-to-date information either in the hash or on
979  * disk.
980  *
981  * I_FREEING is set so that no-one will take a new reference to the inode while
982  * it is being deleted.
983  */
984 void generic_delete_inode(struct inode *inode)
985 {
986         struct super_operations *op = inode->i_sb->s_op;
987
988         list_del_init(&inode->i_list);
989         inode->i_state|=I_FREEING;
990         inodes_stat.nr_inodes--;
991         spin_unlock(&inode_lock);
992
993         if (inode->i_data.nrpages)
994                 truncate_inode_pages(&inode->i_data, 0);
995
996         security_inode_delete(inode);
997
998         if (op->delete_inode) {
999                 void (*delete)(struct inode *) = op->delete_inode;
1000                 if (!is_bad_inode(inode))
1001                         DQUOT_INIT(inode);
1002                 /* s_op->delete_inode internally recalls clear_inode() */
1003                 delete(inode);
1004         } else
1005                 clear_inode(inode);
1006         spin_lock(&inode_lock);
1007         hlist_del_init(&inode->i_hash);
1008         spin_unlock(&inode_lock);
1009         wake_up_inode(inode);
1010         if (inode->i_state != I_CLEAR)
1011                 BUG();
1012         destroy_inode(inode);
1013 }
1014
1015 EXPORT_SYMBOL(generic_delete_inode);
1016
1017 static void generic_forget_inode(struct inode *inode)
1018 {
1019         struct super_block *sb = inode->i_sb;
1020
1021         if (!hlist_unhashed(&inode->i_hash)) {
1022                 if (!(inode->i_state & (I_DIRTY|I_LOCK)))
1023                         list_move(&inode->i_list, &inode_unused);
1024                 inodes_stat.nr_unused++;
1025                 spin_unlock(&inode_lock);
1026                 if (!sb || (sb->s_flags & MS_ACTIVE))
1027                         return;
1028                 write_inode_now(inode, 1);
1029                 spin_lock(&inode_lock);
1030                 inodes_stat.nr_unused--;
1031                 hlist_del_init(&inode->i_hash);
1032         }
1033         list_del_init(&inode->i_list);
1034         inode->i_state|=I_FREEING;
1035         inodes_stat.nr_inodes--;
1036         spin_unlock(&inode_lock);
1037         if (inode->i_data.nrpages)
1038                 truncate_inode_pages(&inode->i_data, 0);
1039         clear_inode(inode);
1040         destroy_inode(inode);
1041 }
1042
1043 /*
1044  * Normal UNIX filesystem behaviour: delete the
1045  * inode when the usage count drops to zero, and
1046  * i_nlink is zero.
1047  */
1048 static void generic_drop_inode(struct inode *inode)
1049 {
1050         if (!inode->i_nlink)
1051                 generic_delete_inode(inode);
1052         else
1053                 generic_forget_inode(inode);
1054 }
1055
1056 /*
1057  * Called when we're dropping the last reference
1058  * to an inode. 
1059  *
1060  * Call the FS "drop()" function, defaulting to
1061  * the legacy UNIX filesystem behaviour..
1062  *
1063  * NOTE! NOTE! NOTE! We're called with the inode lock
1064  * held, and the drop function is supposed to release
1065  * the lock!
1066  */
1067 static inline void iput_final(struct inode *inode)
1068 {
1069         struct super_operations *op = inode->i_sb->s_op;
1070         void (*drop)(struct inode *) = generic_drop_inode;
1071
1072         if (op && op->drop_inode)
1073                 drop = op->drop_inode;
1074         drop(inode);
1075 }
1076
1077 /**
1078  *      iput    - put an inode 
1079  *      @inode: inode to put
1080  *
1081  *      Puts an inode, dropping its usage count. If the inode use count hits
1082  *      zero the inode is also then freed and may be destroyed.
1083  */
1084 void iput(struct inode *inode)
1085 {
1086         if (inode) {
1087                 struct super_operations *op = inode->i_sb->s_op;
1088
1089                 if (inode->i_state == I_CLEAR)
1090                         BUG();
1091
1092                 if (op && op->put_inode)
1093                         op->put_inode(inode);
1094
1095                 if (atomic_dec_and_lock(&inode->i_count, &inode_lock))
1096                         iput_final(inode);
1097         }
1098 }
1099
1100 EXPORT_SYMBOL(iput);
1101
1102 /**
1103  *      bmap    - find a block number in a file
1104  *      @inode: inode of file
1105  *      @block: block to find
1106  *
1107  *      Returns the block number on the device holding the inode that
1108  *      is the disk block number for the block of the file requested.
1109  *      That is, asked for block 4 of inode 1 the function will return the
1110  *      disk block relative to the disk start that holds that block of the 
1111  *      file.
1112  */
1113 sector_t bmap(struct inode * inode, sector_t block)
1114 {
1115         sector_t res = 0;
1116         if (inode->i_mapping->a_ops->bmap)
1117                 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1118         return res;
1119 }
1120
1121 EXPORT_SYMBOL(bmap);
1122
1123 /*
1124  * Return true if the filesystem which backs this inode considers the two
1125  * passed timespecs to be sufficiently different to warrant flushing the
1126  * altered time out to disk.
1127  */
1128 static int inode_times_differ(struct inode *inode,
1129                         struct timespec *old, struct timespec *new)
1130 {
1131         if (IS_ONE_SECOND(inode))
1132                 return old->tv_sec != new->tv_sec;
1133         return !timespec_equal(old, new);
1134 }
1135
1136 /**
1137  *      update_atime    -       update the access time
1138  *      @inode: inode accessed
1139  *
1140  *      Update the accessed time on an inode and mark it for writeback.
1141  *      This function automatically handles read only file systems and media,
1142  *      as well as the "noatime" flag and inode specific "noatime" markers.
1143  */
1144 void update_atime(struct inode *inode)
1145 {
1146         struct timespec now;
1147
1148         if (IS_NOATIME(inode))
1149                 return;
1150         if (IS_NODIRATIME(inode) && S_ISDIR(inode->i_mode))
1151                 return;
1152         if (IS_RDONLY(inode))
1153                 return;
1154
1155         now = current_kernel_time();
1156         if (inode_times_differ(inode, &inode->i_atime, &now)) {
1157                 inode->i_atime = now;
1158                 mark_inode_dirty_sync(inode);
1159         } else {
1160                 if (!timespec_equal(&inode->i_atime, &now))
1161                         inode->i_atime = now;
1162         }
1163 }
1164
1165 EXPORT_SYMBOL(update_atime);
1166
1167 /**
1168  *      inode_update_time       -       update mtime and ctime time
1169  *      @inode: inode accessed
1170  *      @ctime_too: update ctime too
1171  *
1172  *      Update the mtime time on an inode and mark it for writeback.
1173  *      When ctime_too is specified update the ctime too.
1174  */
1175
1176 void inode_update_time(struct inode *inode, int ctime_too)
1177 {
1178         struct timespec now;
1179         int sync_it = 0;
1180
1181         if (IS_NOCMTIME(inode))
1182                 return;
1183         if (IS_RDONLY(inode))
1184                 return;
1185
1186         now = current_kernel_time();
1187
1188         if (inode_times_differ(inode, &inode->i_mtime, &now))
1189                 sync_it = 1;
1190         inode->i_mtime = now;
1191
1192         if (ctime_too) {
1193                 if (inode_times_differ(inode, &inode->i_ctime, &now))
1194                         sync_it = 1;
1195                 inode->i_ctime = now;
1196         }
1197         if (sync_it)
1198                 mark_inode_dirty_sync(inode);
1199 }
1200
1201 EXPORT_SYMBOL(inode_update_time);
1202
1203 int inode_needs_sync(struct inode *inode)
1204 {
1205         if (IS_SYNC(inode))
1206                 return 1;
1207         if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1208                 return 1;
1209         return 0;
1210 }
1211
1212 EXPORT_SYMBOL(inode_needs_sync);
1213
1214 /*
1215  *      Quota functions that want to walk the inode lists..
1216  */
1217 #ifdef CONFIG_QUOTA
1218
1219 /* Function back in dquot.c */
1220 int remove_inode_dquot_ref(struct inode *, int, struct list_head *);
1221
1222 void remove_dquot_ref(struct super_block *sb, int type, struct list_head *tofree_head)
1223 {
1224         struct inode *inode;
1225         struct list_head *act_head;
1226
1227         if (!sb->dq_op)
1228                 return; /* nothing to do */
1229         spin_lock(&inode_lock); /* This lock is for inodes code */
1230         /* We don't have to lock against quota code - test IS_QUOTAINIT is just for speedup... */
1231  
1232         list_for_each(act_head, &inode_in_use) {
1233                 inode = list_entry(act_head, struct inode, i_list);
1234                 if (inode->i_sb == sb && IS_QUOTAINIT(inode))
1235                         remove_inode_dquot_ref(inode, type, tofree_head);
1236         }
1237         list_for_each(act_head, &inode_unused) {
1238                 inode = list_entry(act_head, struct inode, i_list);
1239                 if (inode->i_sb == sb && IS_QUOTAINIT(inode))
1240                         remove_inode_dquot_ref(inode, type, tofree_head);
1241         }
1242         list_for_each(act_head, &sb->s_dirty) {
1243                 inode = list_entry(act_head, struct inode, i_list);
1244                 if (IS_QUOTAINIT(inode))
1245                         remove_inode_dquot_ref(inode, type, tofree_head);
1246         }
1247         list_for_each(act_head, &sb->s_io) {
1248                 inode = list_entry(act_head, struct inode, i_list);
1249                 if (IS_QUOTAINIT(inode))
1250                         remove_inode_dquot_ref(inode, type, tofree_head);
1251         }
1252         spin_unlock(&inode_lock);
1253 }
1254
1255 #endif
1256
1257 /*
1258  * Hashed waitqueues for wait_on_inode().  The table is pretty small - the
1259  * kernel doesn't lock many inodes at the same time.
1260  */
1261 #define I_WAIT_TABLE_ORDER      3
1262 static struct i_wait_queue_head {
1263         wait_queue_head_t wqh;
1264 } ____cacheline_aligned_in_smp i_wait_queue_heads[1<<I_WAIT_TABLE_ORDER];
1265
1266 /*
1267  * Return the address of the waitqueue_head to be used for this inode
1268  */
1269 static wait_queue_head_t *i_waitq_head(struct inode *inode)
1270 {
1271         return &i_wait_queue_heads[hash_ptr(inode, I_WAIT_TABLE_ORDER)].wqh;
1272 }
1273
1274 void __wait_on_inode(struct inode *inode)
1275 {
1276         DECLARE_WAITQUEUE(wait, current);
1277         wait_queue_head_t *wq = i_waitq_head(inode);
1278
1279         add_wait_queue(wq, &wait);
1280 repeat:
1281         set_current_state(TASK_UNINTERRUPTIBLE);
1282         if (inode->i_state & I_LOCK) {
1283                 schedule();
1284                 goto repeat;
1285         }
1286         remove_wait_queue(wq, &wait);
1287         __set_current_state(TASK_RUNNING);
1288 }
1289
1290 /*
1291  * If we try to find an inode in the inode hash while it is being deleted, we
1292  * have to wait until the filesystem completes its deletion before reporting
1293  * that it isn't found.  This is because iget will immediately call
1294  * ->read_inode, and we want to be sure that evidence of the deletion is found
1295  * by ->read_inode.
1296  *
1297  * This call might return early if an inode which shares the waitq is woken up.
1298  * This is most easily handled by the caller which will loop around again
1299  * looking for the inode.
1300  *
1301  * This is called with inode_lock held.
1302  */
1303 static void __wait_on_freeing_inode(struct inode *inode)
1304 {
1305         DECLARE_WAITQUEUE(wait, current);
1306         wait_queue_head_t *wq = i_waitq_head(inode);
1307
1308         add_wait_queue(wq, &wait);
1309         set_current_state(TASK_UNINTERRUPTIBLE);
1310         spin_unlock(&inode_lock);
1311         schedule();
1312         remove_wait_queue(wq, &wait);
1313         spin_lock(&inode_lock);
1314 }
1315
1316 void wake_up_inode(struct inode *inode)
1317 {
1318         wait_queue_head_t *wq = i_waitq_head(inode);
1319
1320         /*
1321          * Prevent speculative execution through spin_unlock(&inode_lock);
1322          */
1323         smp_mb();
1324         if (waitqueue_active(wq))
1325                 wake_up_all(wq);
1326 }
1327
1328 static __initdata unsigned long ihash_entries;
1329 static int __init set_ihash_entries(char *str)
1330 {
1331         if (!str)
1332                 return 0;
1333         ihash_entries = simple_strtoul(str, &str, 0);
1334         return 1;
1335 }
1336 __setup("ihash_entries=", set_ihash_entries);
1337
1338 /*
1339  * Initialize the waitqueues and inode hash table.
1340  */
1341 void __init inode_init(unsigned long mempages)
1342 {
1343         struct hlist_head *head;
1344         unsigned long order;
1345         unsigned int nr_hash;
1346         int i;
1347
1348         for (i = 0; i < ARRAY_SIZE(i_wait_queue_heads); i++)
1349                 init_waitqueue_head(&i_wait_queue_heads[i].wqh);
1350
1351         if (!ihash_entries)
1352                 ihash_entries = PAGE_SHIFT < 14 ?
1353                                 mempages >> (14 - PAGE_SHIFT) :
1354                                 mempages << (PAGE_SHIFT - 14);
1355
1356         ihash_entries *= sizeof(struct hlist_head);
1357         for (order = 0; ((1UL << order) << PAGE_SHIFT) < ihash_entries; order++)
1358                 ;
1359
1360         do {
1361                 unsigned long tmp;
1362
1363                 nr_hash = (1UL << order) * PAGE_SIZE /
1364                         sizeof(struct hlist_head);
1365                 i_hash_mask = (nr_hash - 1);
1366
1367                 tmp = nr_hash;
1368                 i_hash_shift = 0;
1369                 while ((tmp >>= 1UL) != 0UL)
1370                         i_hash_shift++;
1371
1372                 inode_hashtable = (struct hlist_head *)
1373                         __get_free_pages(GFP_ATOMIC, order);
1374         } while (inode_hashtable == NULL && --order >= 0);
1375
1376         printk("Inode-cache hash table entries: %d (order: %ld, %ld bytes)\n",
1377                         nr_hash, order, (PAGE_SIZE << order));
1378
1379         if (!inode_hashtable)
1380                 panic("Failed to allocate inode hash table\n");
1381
1382         head = inode_hashtable;
1383         i = nr_hash;
1384         do {
1385                 INIT_HLIST_HEAD(head);
1386                 head++;
1387                 i--;
1388         } while (i);
1389
1390         /* inode slab cache */
1391         inode_cachep = kmem_cache_create("inode_cache", sizeof(struct inode),
1392                                          0, SLAB_HWCACHE_ALIGN, init_once,
1393                                          NULL);
1394         if (!inode_cachep)
1395                 panic("cannot create inode slab cache");
1396
1397         set_shrinker(DEFAULT_SEEKS, shrink_icache_memory);
1398 }
1399
1400 void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1401 {
1402         inode->i_mode = mode;
1403         if (S_ISCHR(mode)) {
1404                 inode->i_fop = &def_chr_fops;
1405                 inode->i_rdev = rdev;
1406         } else if (S_ISBLK(mode)) {
1407                 inode->i_fop = &def_blk_fops;
1408                 inode->i_rdev = rdev;
1409         } else if (S_ISFIFO(mode))
1410                 inode->i_fop = &def_fifo_fops;
1411         else if (S_ISSOCK(mode))
1412                 inode->i_fop = &bad_sock_fops;
1413         else
1414                 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o)\n",
1415                        mode);
1416 }
1417
1418 EXPORT_SYMBOL(init_special_inode);