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 DEFINE_SPINLOCK(meta_lock);
  32
  33 #ifdef CONFIG_JFS_STATISTICS
  34 static 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 gfp_mask)
 112 {
 113         return mempool_alloc(metapage_mempool, gfp_mask);
 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                 /*
 230                  * If an nfs client tries to read an inode that is larger
 231                  * than any existing inodes, we may try to read past the
 232                  * end of the inode map
 233                  */
 234                 if ((lblock << inode->i_blkbits) >= inode->i_size)
 235                         return NULL;
 236                 mapping = inode->i_mapping;
 237         }
 238
 239         hash_ptr = meta_hash(mapping, lblock);
 240 again:
 241         spin_lock(&meta_lock);
 242         mp = search_hash(hash_ptr, mapping, lblock);
 243         if (mp) {
 244               page_found:
 245                 mp->count++;
 246                 lock_metapage(mp);
 247                 spin_unlock(&meta_lock);
 248                 if (test_bit(META_stale, &mp->flag)) {
 249                         release_metapage(mp);
 250                         yield();        /* Let other waiters release it, too */
 251                         goto again;
 252                 }
 253                 if (test_bit(META_discard, &mp->flag)) {
 254                         if (!new) {
 255                                 jfs_error(inode->i_sb,
 256                                           "__get_metapage: using a "
 257                                           "discarded metapage");
 258                                 release_metapage(mp);
 259                                 return NULL;
 260                         }
 261                         clear_bit(META_discard, &mp->flag);
 262                 }
 263                 jfs_info("__get_metapage: found 0x%p, in hash", mp);
 264                 if (mp->logical_size != size) {
 265                         jfs_error(inode->i_sb,
 266                                   "__get_metapage: mp->logical_size != size");
 267                         release_metapage(mp);
 268                         return NULL;
 269                 }
 270         } else {
 271                 l2bsize = inode->i_blkbits;
 272                 l2BlocksPerPage = PAGE_CACHE_SHIFT - l2bsize;
 273                 page_index = lblock >> l2BlocksPerPage;
 274                 page_offset = (lblock - (page_index << l2BlocksPerPage)) <<
 275                     l2bsize;
 276                 if ((page_offset + size) > PAGE_CACHE_SIZE) {
 277                         spin_unlock(&meta_lock);
 278                         jfs_err("MetaData crosses page boundary!!");
 279                         return NULL;
 280                 }
 281
 282                 /*
 283                  * Locks held on aggregate inode pages are usually
 284                  * not held long, and they are taken in critical code
 285                  * paths (committing dirty inodes, txCommit thread)
 286                  *
 287                  * Attempt to get metapage without blocking, tapping into
 288                  * reserves if necessary.
 289                  */
 290                 mp = NULL;
 291                 if (JFS_IP(inode)->fileset == AGGREGATE_I) {
 292                         mp = alloc_metapage(GFP_ATOMIC);
 293                         if (!mp) {
 294                                 /*
 295                                  * mempool is supposed to protect us from
 296                                  * failing here.  We will try a blocking
 297                                  * call, but a deadlock is possible here
 298                                  */
 299                                 printk(KERN_WARNING
 300                                        "__get_metapage: atomic call to mempool_alloc failed.\n");
 301                                 printk(KERN_WARNING
 302                                        "Will attempt blocking call\n");
 303                         }
 304                 }
 305                 if (!mp) {
 306                         struct metapage *mp2;
 307
 308                         spin_unlock(&meta_lock);
 309                         mp = alloc_metapage(GFP_NOFS);
 310                         spin_lock(&meta_lock);
 311
 312                         /* we dropped the meta_lock, we need to search the
 313                          * hash again.
 314                          */
 315                         mp2 = search_hash(hash_ptr, mapping, lblock);
 316                         if (mp2) {
 317                                 free_metapage(mp);
 318                                 mp = mp2;
 319                                 goto page_found;
 320                         }
 321                 }
 322                 mp->flag = 0;
 323                 lock_metapage(mp);
 324                 if (absolute)
 325                         set_bit(META_absolute, &mp->flag);
 326                 mp->xflag = COMMIT_PAGE;
 327                 mp->count = 1;
 328                 atomic_set(&mp->nohomeok,0);
 329                 mp->mapping = mapping;
 330                 mp->index = lblock;
 331                 mp->page = NULL;
 332                 mp->logical_size = size;
 333                 add_to_hash(mp, hash_ptr);
 334                 spin_unlock(&meta_lock);
 335
 336                 if (new) {
 337                         jfs_info("__get_metapage: Calling grab_cache_page");
 338                         mp->page = grab_cache_page(mapping, page_index);
 339                         if (!mp->page) {
 340                                 jfs_err("grab_cache_page failed!");
 341                                 goto freeit;
 342                         } else {
 343                                 INCREMENT(mpStat.pagealloc);
 344                                 unlock_page(mp->page);
 345                         }
 346                 } else {
 347                         jfs_info("__get_metapage: Calling read_cache_page");
 348                         mp->page = read_cache_page(mapping, lblock,
 349                                     (filler_t *)mapping->a_ops->readpage, NULL);
 350                         if (IS_ERR(mp->page)) {
 351                                 jfs_err("read_cache_page failed!");
 352                                 goto freeit;
 353                         } else
 354                                 INCREMENT(mpStat.pagealloc);
 355                 }
 356                 mp->data = kmap(mp->page) + page_offset;
 357         }
 358
 359         if (new)
 360                 memset(mp->data, 0, PSIZE);
 361
 362         jfs_info("__get_metapage: returning = 0x%p", mp);
 363         return mp;
 364
 365 freeit:
 366         spin_lock(&meta_lock);
 367         remove_from_hash(mp, hash_ptr);
 368         free_metapage(mp);
 369         spin_unlock(&meta_lock);
 370         return NULL;
 371 }
 372
 373 void hold_metapage(struct metapage * mp, int force)
 374 {
 375         spin_lock(&meta_lock);
 376
 377         mp->count++;
 378
 379         if (force) {
 380                 ASSERT (!(test_bit(META_forced, &mp->flag)));
 381                 if (trylock_metapage(mp))
 382                         set_bit(META_forced, &mp->flag);
 383         } else
 384                 lock_metapage(mp);
 385
 386         spin_unlock(&meta_lock);
 387 }
 388
 389 static void __write_metapage(struct metapage * mp)
 390 {
 391         int l2bsize = mp->mapping->host->i_blkbits;
 392         int l2BlocksPerPage = PAGE_CACHE_SHIFT - l2bsize;
 393         unsigned long page_index;
 394         unsigned long page_offset;
 395         int rc;
 396
 397         jfs_info("__write_metapage: mp = 0x%p", mp);
 398
 399         page_index = mp->page->index;
 400         page_offset =
 401             (mp->index - (page_index << l2BlocksPerPage)) << l2bsize;
 402
 403         lock_page(mp->page);
 404         rc = mp->mapping->a_ops->prepare_write(NULL, mp->page, page_offset,
 405                                                page_offset +
 406                                                mp->logical_size);
 407         if (rc) {
 408                 jfs_err("prepare_write return %d!", rc);
 409                 ClearPageUptodate(mp->page);
 410                 unlock_page(mp->page);
 411                 clear_bit(META_dirty, &mp->flag);
 412                 return;
 413         }
 414         rc = mp->mapping->a_ops->commit_write(NULL, mp->page, page_offset,
 415                                               page_offset +
 416                                               mp->logical_size);
 417         if (rc) {
 418                 jfs_err("commit_write returned %d", rc);
 419         }
 420
 421         unlock_page(mp->page);
 422         clear_bit(META_dirty, &mp->flag);
 423
 424         jfs_info("__write_metapage done");
 425 }
 426
 427 static inline void sync_metapage(struct metapage *mp)
 428 {
 429         struct page *page = mp->page;
 430
 431         page_cache_get(page);
 432         lock_page(page);
 433
 434         /* we're done with this page - no need to check for errors */
 435         if (page_has_buffers(page))
 436                 write_one_page(page, 1);
 437         else
 438                 unlock_page(page);
 439         page_cache_release(page);
 440 }
 441
 442 void release_metapage(struct metapage * mp)
 443 {
 444         struct jfs_log *log;
 445
 446         jfs_info("release_metapage: mp = 0x%p, flag = 0x%lx", mp, mp->flag);
 447
 448         spin_lock(&meta_lock);
 449         if (test_bit(META_forced, &mp->flag)) {
 450                 clear_bit(META_forced, &mp->flag);
 451                 mp->count--;
 452                 spin_unlock(&meta_lock);
 453                 return;
 454         }
 455
 456         assert(mp->count);
 457         if (--mp->count || atomic_read(&mp->nohomeok)) {
 458                 unlock_metapage(mp);
 459                 spin_unlock(&meta_lock);
 460                 return;
 461         }
 462
 463         if (mp->page) {
 464                 /* Releasing spinlock, we have to check mp->count later */
 465                 set_bit(META_stale, &mp->flag);
 466                 spin_unlock(&meta_lock);
 467                 kunmap(mp->page);
 468                 mp->data = NULL;
 469                 if (test_bit(META_dirty, &mp->flag))
 470                         __write_metapage(mp);
 471                 if (test_bit(META_sync, &mp->flag)) {
 472                         sync_metapage(mp);
 473                         clear_bit(META_sync, &mp->flag);
 474                 }
 475
 476                 if (test_bit(META_discard, &mp->flag)) {
 477                         lock_page(mp->page);
 478                         block_invalidatepage(mp->page, 0);
 479                         unlock_page(mp->page);
 480                 }
 481
 482                 page_cache_release(mp->page);
 483                 mp->page = NULL;
 484                 INCREMENT(mpStat.pagefree);
 485                 spin_lock(&meta_lock);
 486         }
 487
 488         if (mp->lsn) {
 489                 /*
 490                  * Remove metapage from logsynclist.
 491                  */
 492                 log = mp->log;
 493                 LOGSYNC_LOCK(log);
 494                 mp->log = NULL;
 495                 mp->lsn = 0;
 496                 mp->clsn = 0;
 497                 log->count--;
 498                 list_del(&mp->synclist);
 499                 LOGSYNC_UNLOCK(log);
 500         }
 501         if (mp->count) {
 502                 /* Someone else is trying to get this metpage */
 503                 unlock_metapage(mp);
 504                 spin_unlock(&meta_lock);
 505                 return;
 506         }
 507         remove_from_hash(mp, meta_hash(mp->mapping, mp->index));
 508         spin_unlock(&meta_lock);
 509
 510         free_metapage(mp);
 511 }
 512
 513 void __invalidate_metapages(struct inode *ip, s64 addr, int len)
 514 {
 515         struct metapage **hash_ptr;
 516         unsigned long lblock;
 517         int l2BlocksPerPage = PAGE_CACHE_SHIFT - ip->i_blkbits;
 518         /* All callers are interested in block device's mapping */
 519         struct address_space *mapping = ip->i_sb->s_bdev->bd_inode->i_mapping;
 520         struct metapage *mp;
 521         struct page *page;
 522
 523         /*
 524          * First, mark metapages to discard.  They will eventually be
 525          * released, but should not be written.
 526          */
 527         for (lblock = addr; lblock < addr + len;
 528              lblock += 1 << l2BlocksPerPage) {
 529                 hash_ptr = meta_hash(mapping, lblock);
 530 again:
 531                 spin_lock(&meta_lock);
 532                 mp = search_hash(hash_ptr, mapping, lblock);
 533                 if (mp) {
 534                         if (test_bit(META_stale, &mp->flag)) {
 535                                 /* Racing with release_metapage */
 536                                 mp->count++;
 537                                 lock_metapage(mp);
 538                                 spin_unlock(&meta_lock);
 539                                 /* racing release_metapage should be done now */
 540                                 release_metapage(mp);
 541                                 goto again;
 542                         }
 543
 544                         clear_bit(META_dirty, &mp->flag);
 545                         set_bit(META_discard, &mp->flag);
 546                         spin_unlock(&meta_lock);
 547                 } else {
 548                         spin_unlock(&meta_lock);
 549                         page = find_lock_page(mapping, lblock>>l2BlocksPerPage);
 550                         if (page) {
 551                                 block_invalidatepage(page, 0);
 552                                 unlock_page(page);
 553                                 page_cache_release(page);
 554                         }
 555                 }
 556         }
 557 }
 558
 559 #ifdef CONFIG_JFS_STATISTICS
 560 int jfs_mpstat_read(char *buffer, char **start, off_t offset, int length,
 561                     int *eof, void *data)
 562 {
 563         int len = 0;
 564         off_t begin;
 565
 566         len += sprintf(buffer,
 567                        "JFS Metapage statistics\n"
 568                        "=======================\n"
 569                        "page allocations = %d\n"
 570                        "page frees = %d\n"
 571                        "lock waits = %d\n",
 572                        mpStat.pagealloc,
 573                        mpStat.pagefree,
 574                        mpStat.lockwait);
 575
 576         begin = offset;
 577         *start = buffer + begin;
 578         len -= begin;
 579
 580         if (len > length)
 581                 len = length;
 582         else
 583                 *eof = 1;
 584
 585         if (len < 0)
 586                 len = 0;
 587
 588         return len;
 589 }
 590 #endif