ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / fs / jfs / jfs_metapage.c
1 /*
2  *   Copyright (C) International Business Machines Corp., 2000-2003
3  *   Portions Copyright (C) Christoph Hellwig, 2001-2002
4  *
5  *   This program is free software;  you can redistribute it and/or modify
6  *   it under the terms of the GNU General Public License as published by
7  *   the Free Software Foundation; either version 2 of the License, or 
8  *   (at your option) any later version.
9  * 
10  *   This program is distributed in the hope that it will be useful,
11  *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
13  *   the GNU General Public License for more details.
14  *
15  *   You should have received a copy of the GNU General Public License
16  *   along with this program;  if not, write to the Free Software 
17  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19
20 #include <linux/fs.h>
21 #include <linux/init.h>
22 #include <linux/buffer_head.h>
23 #include <linux/mempool.h>
24 #include "jfs_incore.h"
25 #include "jfs_superblock.h"
26 #include "jfs_filsys.h"
27 #include "jfs_metapage.h"
28 #include "jfs_txnmgr.h"
29 #include "jfs_debug.h"
30
31 static spinlock_t meta_lock = SPIN_LOCK_UNLOCKED;
32
33 #ifdef CONFIG_JFS_STATISTICS
34 struct {
35         uint    pagealloc;      /* # of page allocations */
36         uint    pagefree;       /* # of page frees */
37         uint    lockwait;       /* # of sleeping lock_metapage() calls */
38 } mpStat;
39 #endif
40
41
42 #define HASH_BITS 10            /* This makes hash_table 1 4K page */
43 #define HASH_SIZE (1 << HASH_BITS)
44 static struct metapage **hash_table = NULL;
45 static unsigned long hash_order;
46
47
48 static inline int metapage_locked(struct metapage *mp)
49 {
50         return test_bit(META_locked, &mp->flag);
51 }
52
53 static inline int trylock_metapage(struct metapage *mp)
54 {
55         return test_and_set_bit(META_locked, &mp->flag);
56 }
57
58 static inline void unlock_metapage(struct metapage *mp)
59 {
60         clear_bit(META_locked, &mp->flag);
61         wake_up(&mp->wait);
62 }
63
64 static void __lock_metapage(struct metapage *mp)
65 {
66         DECLARE_WAITQUEUE(wait, current);
67
68         INCREMENT(mpStat.lockwait);
69
70         add_wait_queue_exclusive(&mp->wait, &wait);
71         do {
72                 set_current_state(TASK_UNINTERRUPTIBLE);
73                 if (metapage_locked(mp)) {
74                         spin_unlock(&meta_lock);
75                         schedule();
76                         spin_lock(&meta_lock);
77                 }
78         } while (trylock_metapage(mp));
79         __set_current_state(TASK_RUNNING);
80         remove_wait_queue(&mp->wait, &wait);
81 }
82
83 /* needs meta_lock */
84 static inline void lock_metapage(struct metapage *mp)
85 {
86         if (trylock_metapage(mp))
87                 __lock_metapage(mp);
88 }
89
90 #define METAPOOL_MIN_PAGES 32
91 static kmem_cache_t *metapage_cache;
92 static mempool_t *metapage_mempool;
93
94 static void init_once(void *foo, kmem_cache_t *cachep, unsigned long flags)
95 {
96         struct metapage *mp = (struct metapage *)foo;
97
98         if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
99             SLAB_CTOR_CONSTRUCTOR) {
100                 mp->lid = 0;
101                 mp->lsn = 0;
102                 mp->flag = 0;
103                 mp->data = NULL;
104                 mp->clsn = 0;
105                 mp->log = NULL;
106                 set_bit(META_free, &mp->flag);
107                 init_waitqueue_head(&mp->wait);
108         }
109 }
110
111 static inline struct metapage *alloc_metapage(int no_wait)
112 {
113         return mempool_alloc(metapage_mempool, no_wait ? GFP_ATOMIC : GFP_NOFS);
114 }
115
116 static inline void free_metapage(struct metapage *mp)
117 {
118         mp->flag = 0;
119         set_bit(META_free, &mp->flag);
120
121         mempool_free(mp, metapage_mempool);
122 }
123
124 int __init metapage_init(void)
125 {
126         /*
127          * Allocate the metapage structures
128          */
129         metapage_cache = kmem_cache_create("jfs_mp", sizeof(struct metapage),
130                                            0, 0, init_once, NULL);
131         if (metapage_cache == NULL)
132                 return -ENOMEM;
133
134         metapage_mempool = mempool_create(METAPOOL_MIN_PAGES, mempool_alloc_slab,
135                                           mempool_free_slab, metapage_cache);
136
137         if (metapage_mempool == NULL) {
138                 kmem_cache_destroy(metapage_cache);
139                 return -ENOMEM;
140         }
141         /*
142          * Now the hash list
143          */
144         for (hash_order = 0;
145              ((PAGE_SIZE << hash_order) / sizeof(void *)) < HASH_SIZE;
146              hash_order++);
147         hash_table =
148             (struct metapage **) __get_free_pages(GFP_KERNEL, hash_order);
149         assert(hash_table);
150         memset(hash_table, 0, PAGE_SIZE << hash_order);
151
152         return 0;
153 }
154
155 void metapage_exit(void)
156 {
157         mempool_destroy(metapage_mempool);
158         kmem_cache_destroy(metapage_cache);
159 }
160
161 /*
162  * Basically same hash as in pagemap.h, but using our hash table
163  */
164 static struct metapage **meta_hash(struct address_space *mapping,
165                                    unsigned long index)
166 {
167 #define i (((unsigned long)mapping)/ \
168            (sizeof(struct inode) & ~(sizeof(struct inode) -1 )))
169 #define s(x) ((x) + ((x) >> HASH_BITS))
170         return hash_table + (s(i + index) & (HASH_SIZE - 1));
171 #undef i
172 #undef s
173 }
174
175 static struct metapage *search_hash(struct metapage ** hash_ptr,
176                                     struct address_space *mapping,
177                                unsigned long index)
178 {
179         struct metapage *ptr;
180
181         for (ptr = *hash_ptr; ptr; ptr = ptr->hash_next) {
182                 if ((ptr->mapping == mapping) && (ptr->index == index))
183                         return ptr;
184         }
185
186         return NULL;
187 }
188
189 static void add_to_hash(struct metapage * mp, struct metapage ** hash_ptr)
190 {
191         if (*hash_ptr)
192                 (*hash_ptr)->hash_prev = mp;
193
194         mp->hash_prev = NULL;
195         mp->hash_next = *hash_ptr;
196         *hash_ptr = mp;
197 }
198
199 static void remove_from_hash(struct metapage * mp, struct metapage ** hash_ptr)
200 {
201         if (mp->hash_prev)
202                 mp->hash_prev->hash_next = mp->hash_next;
203         else {
204                 assert(*hash_ptr == mp);
205                 *hash_ptr = mp->hash_next;
206         }
207
208         if (mp->hash_next)
209                 mp->hash_next->hash_prev = mp->hash_prev;
210 }
211
212 struct metapage *__get_metapage(struct inode *inode, unsigned long lblock,
213                                 unsigned int size, int absolute,
214                                 unsigned long new)
215 {
216         struct metapage **hash_ptr;
217         int l2BlocksPerPage;
218         int l2bsize;
219         struct address_space *mapping;
220         struct metapage *mp;
221         unsigned long page_index;
222         unsigned long page_offset;
223
224         jfs_info("__get_metapage: inode = 0x%p, lblock = 0x%lx", inode, lblock);
225
226         if (absolute)
227                 mapping = inode->i_sb->s_bdev->bd_inode->i_mapping;
228         else
229                 mapping = inode->i_mapping;
230
231         spin_lock(&meta_lock);
232         hash_ptr = meta_hash(mapping, lblock);
233         mp = search_hash(hash_ptr, mapping, lblock);
234         if (mp) {
235               page_found:
236                 if (test_bit(META_discard, &mp->flag)) {
237                         if (!new) {
238                                 spin_unlock(&meta_lock);
239                                 jfs_error(inode->i_sb,
240                                           "__get_metapage: using a "
241                                           "discarded metapage");
242                                 return NULL;
243                         }
244                         clear_bit(META_discard, &mp->flag);
245                 }
246                 mp->count++;
247                 jfs_info("__get_metapage: found 0x%p, in hash", mp);
248                 if (mp->logical_size != size) {
249                         spin_unlock(&meta_lock);
250                         jfs_error(inode->i_sb,
251                                   "__get_metapage: mp->logical_size != size");
252                         return NULL;
253                 }
254                 lock_metapage(mp);
255                 spin_unlock(&meta_lock);
256         } else {
257                 l2bsize = inode->i_blkbits;
258                 l2BlocksPerPage = PAGE_CACHE_SHIFT - l2bsize;
259                 page_index = lblock >> l2BlocksPerPage;
260                 page_offset = (lblock - (page_index << l2BlocksPerPage)) <<
261                     l2bsize;
262                 if ((page_offset + size) > PAGE_CACHE_SIZE) {
263                         spin_unlock(&meta_lock);
264                         jfs_err("MetaData crosses page boundary!!");
265                         return NULL;
266                 }
267                 
268                 /*
269                  * Locks held on aggregate inode pages are usually
270                  * not held long, and they are taken in critical code
271                  * paths (committing dirty inodes, txCommit thread) 
272                  * 
273                  * Attempt to get metapage without blocking, tapping into
274                  * reserves if necessary.
275                  */
276                 mp = NULL;
277                 if (JFS_IP(inode)->fileset == AGGREGATE_I) {
278                         mp =  mempool_alloc(metapage_mempool, GFP_ATOMIC);
279                         if (!mp) {
280                                 /*
281                                  * mempool is supposed to protect us from
282                                  * failing here.  We will try a blocking
283                                  * call, but a deadlock is possible here
284                                  */
285                                 printk(KERN_WARNING
286                                        "__get_metapage: atomic call to mempool_alloc failed.\n");
287                                 printk(KERN_WARNING
288                                        "Will attempt blocking call\n");
289                         }
290                 }
291                 if (!mp) {
292                         struct metapage *mp2;
293
294                         spin_unlock(&meta_lock);
295                         mp =  mempool_alloc(metapage_mempool, GFP_NOFS);
296                         spin_lock(&meta_lock);
297
298                         /* we dropped the meta_lock, we need to search the
299                          * hash again.
300                          */
301                         mp2 = search_hash(hash_ptr, mapping, lblock);
302                         if (mp2) {
303                                 free_metapage(mp);
304                                 mp = mp2;
305                                 goto page_found;
306                         }
307                 }
308                 mp->flag = 0;
309                 lock_metapage(mp);
310                 if (absolute)
311                         set_bit(META_absolute, &mp->flag);
312                 mp->xflag = COMMIT_PAGE;
313                 mp->count = 1;
314                 atomic_set(&mp->nohomeok,0);
315                 mp->mapping = mapping;
316                 mp->index = lblock;
317                 mp->page = 0;
318                 mp->logical_size = size;
319                 add_to_hash(mp, hash_ptr);
320                 spin_unlock(&meta_lock);
321
322                 if (new) {
323                         jfs_info("__get_metapage: Calling grab_cache_page");
324                         mp->page = grab_cache_page(mapping, page_index);
325                         if (!mp->page) {
326                                 jfs_err("grab_cache_page failed!");
327                                 goto freeit;
328                         } else {
329                                 INCREMENT(mpStat.pagealloc);
330                                 unlock_page(mp->page);
331                         }
332                 } else {
333                         jfs_info("__get_metapage: Calling read_cache_page");
334                         mp->page = read_cache_page(mapping, lblock,
335                                     (filler_t *)mapping->a_ops->readpage, NULL);
336                         if (IS_ERR(mp->page)) {
337                                 jfs_err("read_cache_page failed!");
338                                 goto freeit;
339                         } else
340                                 INCREMENT(mpStat.pagealloc);
341                 }
342                 mp->data = kmap(mp->page) + page_offset;
343         }
344
345         if (new)
346                 memset(mp->data, 0, PSIZE);
347
348         jfs_info("__get_metapage: returning = 0x%p", mp);
349         return mp;
350
351 freeit:
352         spin_lock(&meta_lock);
353         remove_from_hash(mp, hash_ptr);
354         free_metapage(mp);
355         spin_unlock(&meta_lock);
356         return NULL;
357 }
358
359 void hold_metapage(struct metapage * mp, int force)
360 {
361         spin_lock(&meta_lock);
362
363         mp->count++;
364
365         if (force) {
366                 ASSERT (!(test_bit(META_forced, &mp->flag)));
367                 if (trylock_metapage(mp))
368                         set_bit(META_forced, &mp->flag);
369         } else
370                 lock_metapage(mp);
371
372         spin_unlock(&meta_lock);
373 }
374
375 static void __write_metapage(struct metapage * mp)
376 {
377         int l2bsize = mp->mapping->host->i_blkbits;
378         int l2BlocksPerPage = PAGE_CACHE_SHIFT - l2bsize;
379         unsigned long page_index;
380         unsigned long page_offset;
381         int rc;
382
383         jfs_info("__write_metapage: mp = 0x%p", mp);
384
385         if (test_bit(META_discard, &mp->flag)) {
386                 /*
387                  * This metadata is no longer valid
388                  */
389                 clear_bit(META_dirty, &mp->flag);
390                 return;
391         }
392
393         page_index = mp->page->index;
394         page_offset =
395             (mp->index - (page_index << l2BlocksPerPage)) << l2bsize;
396
397         lock_page(mp->page);
398         rc = mp->mapping->a_ops->prepare_write(NULL, mp->page, page_offset,
399                                                page_offset +
400                                                mp->logical_size);
401         if (rc) {
402                 jfs_err("prepare_write return %d!", rc);
403                 ClearPageUptodate(mp->page);
404                 unlock_page(mp->page);
405                 clear_bit(META_dirty, &mp->flag);
406                 return;
407         }
408         rc = mp->mapping->a_ops->commit_write(NULL, mp->page, page_offset,
409                                               page_offset +
410                                               mp->logical_size);
411         if (rc) {
412                 jfs_err("commit_write returned %d", rc);
413         }
414
415         unlock_page(mp->page);
416         clear_bit(META_dirty, &mp->flag);
417
418         jfs_info("__write_metapage done");
419 }
420
421 static inline void sync_metapage(struct metapage *mp)
422 {
423         struct page *page = mp->page;
424
425         page_cache_get(page);
426         lock_page(page);
427
428         /* we're done with this page - no need to check for errors */
429         if (page_has_buffers(page))
430                 write_one_page(page, 1);
431         else
432                 unlock_page(page);
433         page_cache_release(page);
434 }
435
436 void release_metapage(struct metapage * mp)
437 {
438         struct jfs_log *log;
439
440         jfs_info("release_metapage: mp = 0x%p, flag = 0x%lx", mp, mp->flag);
441
442         spin_lock(&meta_lock);
443         if (test_bit(META_forced, &mp->flag)) {
444                 clear_bit(META_forced, &mp->flag);
445                 mp->count--;
446                 spin_unlock(&meta_lock);
447                 return;
448         }
449
450         assert(mp->count);
451         if (--mp->count || atomic_read(&mp->nohomeok)) {
452                 unlock_metapage(mp);
453                 spin_unlock(&meta_lock);
454         } else {
455                 remove_from_hash(mp, meta_hash(mp->mapping, mp->index));
456                 spin_unlock(&meta_lock);
457
458                 if (mp->page) {
459                         kunmap(mp->page);
460                         mp->data = 0;
461                         if (test_bit(META_dirty, &mp->flag))
462                                 __write_metapage(mp);
463                         if (test_bit(META_sync, &mp->flag)) {
464                                 sync_metapage(mp);
465                                 clear_bit(META_sync, &mp->flag);
466                         }
467
468                         if (test_bit(META_discard, &mp->flag)) {
469                                 lock_page(mp->page);
470                                 block_invalidatepage(mp->page, 0);
471                                 unlock_page(mp->page);
472                         }
473
474                         page_cache_release(mp->page);
475                         INCREMENT(mpStat.pagefree);
476                 }
477
478                 if (mp->lsn) {
479                         /*
480                          * Remove metapage from logsynclist.
481                          */
482                         log = mp->log;
483                         LOGSYNC_LOCK(log);
484                         mp->log = 0;
485                         mp->lsn = 0;
486                         mp->clsn = 0;
487                         log->count--;
488                         list_del(&mp->synclist);
489                         LOGSYNC_UNLOCK(log);
490                 }
491
492                 free_metapage(mp);
493         }
494 }
495
496 void __invalidate_metapages(struct inode *ip, s64 addr, int len)
497 {
498         struct metapage **hash_ptr;
499         unsigned long lblock;
500         int l2BlocksPerPage = PAGE_CACHE_SHIFT - ip->i_blkbits;
501         /* All callers are interested in block device's mapping */
502         struct address_space *mapping = ip->i_sb->s_bdev->bd_inode->i_mapping;
503         struct metapage *mp;
504         struct page *page;
505
506         /*
507          * First, mark metapages to discard.  They will eventually be
508          * released, but should not be written.
509          */
510         for (lblock = addr; lblock < addr + len;
511              lblock += 1 << l2BlocksPerPage) {
512                 hash_ptr = meta_hash(mapping, lblock);
513                 spin_lock(&meta_lock);
514                 mp = search_hash(hash_ptr, mapping, lblock);
515                 if (mp) {
516                         set_bit(META_discard, &mp->flag);
517                         spin_unlock(&meta_lock);
518                 } else {
519                         spin_unlock(&meta_lock);
520                         page = find_lock_page(mapping, lblock>>l2BlocksPerPage);
521                         if (page) {
522                                 block_invalidatepage(page, 0);
523                                 unlock_page(page);
524                         }
525                 }
526         }
527 }
528
529 #ifdef CONFIG_JFS_STATISTICS
530 int jfs_mpstat_read(char *buffer, char **start, off_t offset, int length,
531                     int *eof, void *data)
532 {
533         int len = 0;
534         off_t begin;
535
536         len += sprintf(buffer,
537                        "JFS Metapage statistics\n"
538                        "=======================\n"
539                        "page allocations = %d\n"
540                        "page frees = %d\n"
541                        "lock waits = %d\n",
542                        mpStat.pagealloc,
543                        mpStat.pagefree,
544                        mpStat.lockwait);
545
546         begin = offset;
547         *start = buffer + begin;
548         len -= begin;
549
550         if (len > length)
551                 len = length;
552         else
553                 *eof = 1;
554
555         if (len < 0)
556                 len = 0;
557
558         return len;
559 }
560 #endif