fs/xfs/xfs_sync.c

   1 /*
   2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #include "xfs.h"
  19 #include "xfs_fs.h"
  20 #include "xfs_types.h"
  21 #include "xfs_bit.h"
  22 #include "xfs_log.h"
  23 #include "xfs_inum.h"
  24 #include "xfs_trans.h"
  25 #include "xfs_trans_priv.h"
  26 #include "xfs_sb.h"
  27 #include "xfs_ag.h"
  28 #include "xfs_mount.h"
  29 #include "xfs_bmap_btree.h"
  30 #include "xfs_inode.h"
  31 #include "xfs_dinode.h"
  32 #include "xfs_error.h"
  33 #include "xfs_filestream.h"
  34 #include "xfs_vnodeops.h"
  35 #include "xfs_inode_item.h"
  36 #include "xfs_quota.h"
  37 #include "xfs_trace.h"
  38 #include "xfs_fsops.h"
  39
  40 #include <linux/kthread.h>
  41 #include <linux/freezer.h>
  42
  43 struct workqueue_struct *xfs_syncd_wq;  /* sync workqueue */
  44
  45 /*
  46  * The inode lookup is done in batches to keep the amount of lock traffic and
  47  * radix tree lookups to a minimum. The batch size is a trade off between
  48  * lookup reduction and stack usage. This is in the reclaim path, so we can't
  49  * be too greedy.
  50  */
  51 #define XFS_LOOKUP_BATCH        32
  52
  53 STATIC int
  54 xfs_inode_ag_walk_grab(
  55         struct xfs_inode        *ip)
  56 {
  57         struct inode            *inode = VFS_I(ip);
  58
  59         ASSERT(rcu_read_lock_held());
  60
  61         /*
  62          * check for stale RCU freed inode
  63          *
  64          * If the inode has been reallocated, it doesn't matter if it's not in
  65          * the AG we are walking - we are walking for writeback, so if it
  66          * passes all the "valid inode" checks and is dirty, then we'll write
  67          * it back anyway.  If it has been reallocated and still being
  68          * initialised, the XFS_INEW check below will catch it.
  69          */
  70         spin_lock(&ip->i_flags_lock);
  71         if (!ip->i_ino)
  72                 goto out_unlock_noent;
  73
  74         /* avoid new or reclaimable inodes. Leave for reclaim code to flush */
  75         if (__xfs_iflags_test(ip, XFS_INEW | XFS_IRECLAIMABLE | XFS_IRECLAIM))
  76                 goto out_unlock_noent;
  77         spin_unlock(&ip->i_flags_lock);
  78
  79         /* nothing to sync during shutdown */
  80         if (XFS_FORCED_SHUTDOWN(ip->i_mount))
  81                 return EFSCORRUPTED;
  82
  83         /* If we can't grab the inode, it must on it's way to reclaim. */
  84         if (!igrab(inode))
  85                 return ENOENT;
  86
  87         if (is_bad_inode(inode)) {
  88                 IRELE(ip);
  89                 return ENOENT;
  90         }
  91
  92         /* inode is valid */
  93         return 0;
  94
  95 out_unlock_noent:
  96         spin_unlock(&ip->i_flags_lock);
  97         return ENOENT;
  98 }
  99
 100 STATIC int
 101 xfs_inode_ag_walk(
 102         struct xfs_mount        *mp,
 103         struct xfs_perag        *pag,
 104         int                     (*execute)(struct xfs_inode *ip,
 105                                            struct xfs_perag *pag, int flags),
 106         int                     flags)
 107 {
 108         uint32_t                first_index;
 109         int                     last_error = 0;
 110         int                     skipped;
 111         int                     done;
 112         int                     nr_found;
 113
 114 restart:
 115         done = 0;
 116         skipped = 0;
 117         first_index = 0;
 118         nr_found = 0;
 119         do {
 120                 struct xfs_inode *batch[XFS_LOOKUP_BATCH];
 121                 int             error = 0;
 122                 int             i;
 123
 124                 rcu_read_lock();
 125                 nr_found = radix_tree_gang_lookup(&pag->pag_ici_root,
 126                                         (void **)batch, first_index,
 127                                         XFS_LOOKUP_BATCH);
 128                 if (!nr_found) {
 129                         rcu_read_unlock();
 130                         break;
 131                 }
 132
 133                 /*
 134                  * Grab the inodes before we drop the lock. if we found
 135                  * nothing, nr == 0 and the loop will be skipped.
 136                  */
 137                 for (i = 0; i < nr_found; i++) {
 138                         struct xfs_inode *ip = batch[i];
 139
 140                         if (done || xfs_inode_ag_walk_grab(ip))
 141                                 batch[i] = NULL;
 142
 143                         /*
 144                          * Update the index for the next lookup. Catch
 145                          * overflows into the next AG range which can occur if
 146                          * we have inodes in the last block of the AG and we
 147                          * are currently pointing to the last inode.
 148                          *
 149                          * Because we may see inodes that are from the wrong AG
 150                          * due to RCU freeing and reallocation, only update the
 151                          * index if it lies in this AG. It was a race that lead
 152                          * us to see this inode, so another lookup from the
 153                          * same index will not find it again.
 154                          */
 155                         if (XFS_INO_TO_AGNO(mp, ip->i_ino) != pag->pag_agno)
 156                                 continue;
 157                         first_index = XFS_INO_TO_AGINO(mp, ip->i_ino + 1);
 158                         if (first_index < XFS_INO_TO_AGINO(mp, ip->i_ino))
 159                                 done = 1;
 160                 }
 161
 162                 /* unlock now we've grabbed the inodes. */
 163                 rcu_read_unlock();
 164
 165                 for (i = 0; i < nr_found; i++) {
 166                         if (!batch[i])
 167                                 continue;
 168                         error = execute(batch[i], pag, flags);
 169                         IRELE(batch[i]);
 170                         if (error == EAGAIN) {
 171                                 skipped++;
 172                                 continue;
 173                         }
 174                         if (error && last_error != EFSCORRUPTED)
 175                                 last_error = error;
 176                 }
 177
 178                 /* bail out if the filesystem is corrupted.  */
 179                 if (error == EFSCORRUPTED)
 180                         break;
 181
 182                 cond_resched();
 183
 184         } while (nr_found && !done);
 185
 186         if (skipped) {
 187                 delay(1);
 188                 goto restart;
 189         }
 190         return last_error;
 191 }
 192
 193 int
 194 xfs_inode_ag_iterator(
 195         struct xfs_mount        *mp,
 196         int                     (*execute)(struct xfs_inode *ip,
 197                                            struct xfs_perag *pag, int flags),
 198         int                     flags)
 199 {
 200         struct xfs_perag        *pag;
 201         int                     error = 0;
 202         int                     last_error = 0;
 203         xfs_agnumber_t          ag;
 204
 205         ag = 0;
 206         while ((pag = xfs_perag_get(mp, ag))) {
 207                 ag = pag->pag_agno + 1;
 208                 error = xfs_inode_ag_walk(mp, pag, execute, flags);
 209                 xfs_perag_put(pag);
 210                 if (error) {
 211                         last_error = error;
 212                         if (error == EFSCORRUPTED)
 213                                 break;
 214                 }
 215         }
 216         return XFS_ERROR(last_error);
 217 }
 218
 219 STATIC int
 220 xfs_sync_inode_data(
 221         struct xfs_inode        *ip,
 222         struct xfs_perag        *pag,
 223         int                     flags)
 224 {
 225         struct inode            *inode = VFS_I(ip);
 226         struct address_space *mapping = inode->i_mapping;
 227         int                     error = 0;
 228
 229         if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
 230                 return 0;
 231
 232         if (!xfs_ilock_nowait(ip, XFS_IOLOCK_SHARED)) {
 233                 if (flags & SYNC_TRYLOCK)
 234                         return 0;
 235                 xfs_ilock(ip, XFS_IOLOCK_SHARED);
 236         }
 237
 238         error = xfs_flush_pages(ip, 0, -1, (flags & SYNC_WAIT) ?
 239                                 0 : XBF_ASYNC, FI_NONE);
 240         xfs_iunlock(ip, XFS_IOLOCK_SHARED);
 241         return error;
 242 }
 243
 244 STATIC int
 245 xfs_sync_inode_attr(
 246         struct xfs_inode        *ip,
 247         struct xfs_perag        *pag,
 248         int                     flags)
 249 {
 250         int                     error = 0;
 251
 252         xfs_ilock(ip, XFS_ILOCK_SHARED);
 253         if (xfs_inode_clean(ip))
 254                 goto out_unlock;
 255         if (!xfs_iflock_nowait(ip)) {
 256                 if (!(flags & SYNC_WAIT))
 257                         goto out_unlock;
 258                 xfs_iflock(ip);
 259         }
 260
 261         if (xfs_inode_clean(ip)) {
 262                 xfs_ifunlock(ip);
 263                 goto out_unlock;
 264         }
 265
 266         error = xfs_iflush(ip, flags);
 267
 268         /*
 269          * We don't want to try again on non-blocking flushes that can't run
 270          * again immediately. If an inode really must be written, then that's
 271          * what the SYNC_WAIT flag is for.
 272          */
 273         if (error == EAGAIN) {
 274                 ASSERT(!(flags & SYNC_WAIT));
 275                 error = 0;
 276         }
 277
 278  out_unlock:
 279         xfs_iunlock(ip, XFS_ILOCK_SHARED);
 280         return error;
 281 }
 282
 283 /*
 284  * Write out pagecache data for the whole filesystem.
 285  */
 286 STATIC int
 287 xfs_sync_data(
 288         struct xfs_mount        *mp,
 289         int                     flags)
 290 {
 291         int                     error;
 292
 293         ASSERT((flags & ~(SYNC_TRYLOCK|SYNC_WAIT)) == 0);
 294
 295         error = xfs_inode_ag_iterator(mp, xfs_sync_inode_data, flags);
 296         if (error)
 297                 return XFS_ERROR(error);
 298
 299         xfs_log_force(mp, (flags & SYNC_WAIT) ? XFS_LOG_SYNC : 0);
 300         return 0;
 301 }
 302
 303 /*
 304  * Write out inode metadata (attributes) for the whole filesystem.
 305  */
 306 STATIC int
 307 xfs_sync_attr(
 308         struct xfs_mount        *mp,
 309         int                     flags)
 310 {
 311         ASSERT((flags & ~SYNC_WAIT) == 0);
 312
 313         return xfs_inode_ag_iterator(mp, xfs_sync_inode_attr, flags);
 314 }
 315
 316 STATIC int
 317 xfs_sync_fsdata(
 318         struct xfs_mount        *mp)
 319 {
 320         struct xfs_buf          *bp;
 321         int                     error;
 322
 323         /*
 324          * If the buffer is pinned then push on the log so we won't get stuck
 325          * waiting in the write for someone, maybe ourselves, to flush the log.
 326          *
 327          * Even though we just pushed the log above, we did not have the
 328          * superblock buffer locked at that point so it can become pinned in
 329          * between there and here.
 330          */
 331         bp = xfs_getsb(mp, 0);
 332         if (xfs_buf_ispinned(bp))
 333                 xfs_log_force(mp, 0);
 334         error = xfs_bwrite(bp);
 335         xfs_buf_relse(bp);
 336         return error;
 337 }
 338
 339 /*
 340  * When remounting a filesystem read-only or freezing the filesystem, we have
 341  * two phases to execute. This first phase is syncing the data before we
 342  * quiesce the filesystem, and the second is flushing all the inodes out after
 343  * we've waited for all the transactions created by the first phase to
 344  * complete. The second phase ensures that the inodes are written to their
 345  * location on disk rather than just existing in transactions in the log. This
 346  * means after a quiesce there is no log replay required to write the inodes to
 347  * disk (this is the main difference between a sync and a quiesce).
 348  */
 349 /*
 350  * First stage of freeze - no writers will make progress now we are here,
 351  * so we flush delwri and delalloc buffers here, then wait for all I/O to
 352  * complete.  Data is frozen at that point. Metadata is not frozen,
 353  * transactions can still occur here so don't bother flushing the buftarg
 354  * because it'll just get dirty again.
 355  */
 356 int
 357 xfs_quiesce_data(
 358         struct xfs_mount        *mp)
 359 {
 360         int                     error, error2 = 0;
 361
 362         /* force out the log */
 363         xfs_log_force(mp, XFS_LOG_SYNC);
 364
 365         /* write superblock and hoover up shutdown errors */
 366         error = xfs_sync_fsdata(mp);
 367
 368         /* make sure all delwri buffers are written out */
 369         xfs_flush_buftarg(mp->m_ddev_targp, 1);
 370
 371         /* mark the log as covered if needed */
 372         if (xfs_log_need_covered(mp))
 373                 error2 = xfs_fs_log_dummy(mp);
 374
 375         /* flush data-only devices */
 376         if (mp->m_rtdev_targp)
 377                 xfs_flush_buftarg(mp->m_rtdev_targp, 1);
 378
 379         return error ? error : error2;
 380 }
 381
 382 STATIC void
 383 xfs_quiesce_fs(
 384         struct xfs_mount        *mp)
 385 {
 386         int     count = 0, pincount;
 387
 388         xfs_reclaim_inodes(mp, 0);
 389         xfs_flush_buftarg(mp->m_ddev_targp, 0);
 390
 391         /*
 392          * This loop must run at least twice.  The first instance of the loop
 393          * will flush most meta data but that will generate more meta data
 394          * (typically directory updates).  Which then must be flushed and
 395          * logged before we can write the unmount record. We also so sync
 396          * reclaim of inodes to catch any that the above delwri flush skipped.
 397          */
 398         do {
 399                 xfs_reclaim_inodes(mp, SYNC_WAIT);
 400                 xfs_sync_attr(mp, SYNC_WAIT);
 401                 pincount = xfs_flush_buftarg(mp->m_ddev_targp, 1);
 402                 if (!pincount) {
 403                         delay(50);
 404                         count++;
 405                 }
 406         } while (count < 2);
 407 }
 408
 409 /*
 410  * Second stage of a quiesce. The data is already synced, now we have to take
 411  * care of the metadata. New transactions are already blocked, so we need to
 412  * wait for any remaining transactions to drain out before proceeding.
 413  */
 414 void
 415 xfs_quiesce_attr(
 416         struct xfs_mount        *mp)
 417 {
 418         int     error = 0;
 419
 420         /* wait for all modifications to complete */
 421         while (atomic_read(&mp->m_active_trans) > 0)
 422                 delay(100);
 423
 424         /* flush inodes and push all remaining buffers out to disk */
 425         xfs_quiesce_fs(mp);
 426
 427         /*
 428          * Just warn here till VFS can correctly support
 429          * read-only remount without racing.
 430          */
 431         WARN_ON(atomic_read(&mp->m_active_trans) != 0);
 432
 433         /* Push the superblock and write an unmount record */
 434         error = xfs_log_sbcount(mp);
 435         if (error)
 436                 xfs_warn(mp, "xfs_attr_quiesce: failed to log sb changes. "
 437                                 "Frozen image may not be consistent.");
 438         xfs_log_unmount_write(mp);
 439         xfs_unmountfs_writesb(mp);
 440 }
 441
 442 static void
 443 xfs_syncd_queue_sync(
 444         struct xfs_mount        *mp)
 445 {
 446         queue_delayed_work(xfs_syncd_wq, &mp->m_sync_work,
 447                                 msecs_to_jiffies(xfs_syncd_centisecs * 10));
 448 }
 449
 450 /*
 451  * Every sync period we need to unpin all items, reclaim inodes and sync
 452  * disk quotas.  We might need to cover the log to indicate that the
 453  * filesystem is idle and not frozen.
 454  */
 455 STATIC void
 456 xfs_sync_worker(
 457         struct work_struct *work)
 458 {
 459         struct xfs_mount *mp = container_of(to_delayed_work(work),
 460                                         struct xfs_mount, m_sync_work);
 461         int             error;
 462
 463         /*
 464          * We shouldn't write/force the log if we are in the mount/unmount
 465          * process or on a read only filesystem. The workqueue still needs to be
 466          * active in both cases, however, because it is used for inode reclaim
 467          * during these times. hence use the MS_ACTIVE flag to avoid doing
 468          * anything in these periods.
 469          */
 470         if (!(mp->m_super->s_flags & MS_ACTIVE) &&
 471             !(mp->m_flags & XFS_MOUNT_RDONLY)) {
 472                 /* dgc: errors ignored here */
 473                 if (mp->m_super->s_frozen == SB_UNFROZEN &&
 474                     xfs_log_need_covered(mp))
 475                         error = xfs_fs_log_dummy(mp);
 476                 else
 477                         xfs_log_force(mp, 0);
 478
 479                 /* start pushing all the metadata that is currently dirty */
 480                 xfs_ail_push_all(mp->m_ail);
 481         }
 482
 483         /* queue us up again */
 484         xfs_syncd_queue_sync(mp);
 485 }
 486
 487 /*
 488  * Queue a new inode reclaim pass if there are reclaimable inodes and there
 489  * isn't a reclaim pass already in progress. By default it runs every 5s based
 490  * on the xfs syncd work default of 30s. Perhaps this should have it's own
 491  * tunable, but that can be done if this method proves to be ineffective or too
 492  * aggressive.
 493  */
 494 static void
 495 xfs_syncd_queue_reclaim(
 496         struct xfs_mount        *mp)
 497 {
 498
 499         rcu_read_lock();
 500         if (radix_tree_tagged(&mp->m_perag_tree, XFS_ICI_RECLAIM_TAG)) {
 501                 queue_delayed_work(xfs_syncd_wq, &mp->m_reclaim_work,
 502                         msecs_to_jiffies(xfs_syncd_centisecs / 6 * 10));
 503         }
 504         rcu_read_unlock();
 505 }
 506
 507 /*
 508  * This is a fast pass over the inode cache to try to get reclaim moving on as
 509  * many inodes as possible in a short period of time. It kicks itself every few
 510  * seconds, as well as being kicked by the inode cache shrinker when memory
 511  * goes low. It scans as quickly as possible avoiding locked inodes or those
 512  * already being flushed, and once done schedules a future pass.
 513  */
 514 STATIC void
 515 xfs_reclaim_worker(
 516         struct work_struct *work)
 517 {
 518         struct xfs_mount *mp = container_of(to_delayed_work(work),
 519                                         struct xfs_mount, m_reclaim_work);
 520
 521         xfs_reclaim_inodes(mp, SYNC_TRYLOCK);
 522         xfs_syncd_queue_reclaim(mp);
 523 }
 524
 525 /*
 526  * Flush delayed allocate data, attempting to free up reserved space
 527  * from existing allocations.  At this point a new allocation attempt
 528  * has failed with ENOSPC and we are in the process of scratching our
 529  * heads, looking about for more room.
 530  *
 531  * Queue a new data flush if there isn't one already in progress and
 532  * wait for completion of the flush. This means that we only ever have one
 533  * inode flush in progress no matter how many ENOSPC events are occurring and
 534  * so will prevent the system from bogging down due to every concurrent
 535  * ENOSPC event scanning all the active inodes in the system for writeback.
 536  */
 537 void
 538 xfs_flush_inodes(
 539         struct xfs_inode        *ip)
 540 {
 541         struct xfs_mount        *mp = ip->i_mount;
 542
 543         queue_work(xfs_syncd_wq, &mp->m_flush_work);
 544         flush_work_sync(&mp->m_flush_work);
 545 }
 546
 547 STATIC void
 548 xfs_flush_worker(
 549         struct work_struct *work)
 550 {
 551         struct xfs_mount *mp = container_of(work,
 552                                         struct xfs_mount, m_flush_work);
 553
 554         xfs_sync_data(mp, SYNC_TRYLOCK);
 555         xfs_sync_data(mp, SYNC_TRYLOCK | SYNC_WAIT);
 556 }
 557
 558 int
 559 xfs_syncd_init(
 560         struct xfs_mount        *mp)
 561 {
 562         INIT_WORK(&mp->m_flush_work, xfs_flush_worker);
 563         INIT_DELAYED_WORK(&mp->m_sync_work, xfs_sync_worker);
 564         INIT_DELAYED_WORK(&mp->m_reclaim_work, xfs_reclaim_worker);
 565
 566         xfs_syncd_queue_sync(mp);
 567
 568         return 0;
 569 }
 570
 571 void
 572 xfs_syncd_stop(
 573         struct xfs_mount        *mp)
 574 {
 575         cancel_delayed_work_sync(&mp->m_sync_work);
 576         cancel_delayed_work_sync(&mp->m_reclaim_work);
 577         cancel_work_sync(&mp->m_flush_work);
 578 }
 579
 580 void
 581 __xfs_inode_set_reclaim_tag(
 582         struct xfs_perag        *pag,
 583         struct xfs_inode        *ip)
 584 {
 585         radix_tree_tag_set(&pag->pag_ici_root,
 586                            XFS_INO_TO_AGINO(ip->i_mount, ip->i_ino),
 587                            XFS_ICI_RECLAIM_TAG);
 588
 589         if (!pag->pag_ici_reclaimable) {
 590                 /* propagate the reclaim tag up into the perag radix tree */
 591                 spin_lock(&ip->i_mount->m_perag_lock);
 592                 radix_tree_tag_set(&ip->i_mount->m_perag_tree,
 593                                 XFS_INO_TO_AGNO(ip->i_mount, ip->i_ino),
 594                                 XFS_ICI_RECLAIM_TAG);
 595                 spin_unlock(&ip->i_mount->m_perag_lock);
 596
 597                 /* schedule periodic background inode reclaim */
 598                 xfs_syncd_queue_reclaim(ip->i_mount);
 599
 600                 trace_xfs_perag_set_reclaim(ip->i_mount, pag->pag_agno,
 601                                                         -1, _RET_IP_);
 602         }
 603         pag->pag_ici_reclaimable++;
 604 }
 605
 606 /*
 607  * We set the inode flag atomically with the radix tree tag.
 608  * Once we get tag lookups on the radix tree, this inode flag
 609  * can go away.
 610  */
 611 void
 612 xfs_inode_set_reclaim_tag(
 613         xfs_inode_t     *ip)
 614 {
 615         struct xfs_mount *mp = ip->i_mount;
 616         struct xfs_perag *pag;
 617
 618         pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
 619         spin_lock(&pag->pag_ici_lock);
 620         spin_lock(&ip->i_flags_lock);
 621         __xfs_inode_set_reclaim_tag(pag, ip);
 622         __xfs_iflags_set(ip, XFS_IRECLAIMABLE);
 623         spin_unlock(&ip->i_flags_lock);
 624         spin_unlock(&pag->pag_ici_lock);
 625         xfs_perag_put(pag);
 626 }
 627
 628 STATIC void
 629 __xfs_inode_clear_reclaim(
 630         xfs_perag_t     *pag,
 631         xfs_inode_t     *ip)
 632 {
 633         pag->pag_ici_reclaimable--;
 634         if (!pag->pag_ici_reclaimable) {
 635                 /* clear the reclaim tag from the perag radix tree */
 636                 spin_lock(&ip->i_mount->m_perag_lock);
 637                 radix_tree_tag_clear(&ip->i_mount->m_perag_tree,
 638                                 XFS_INO_TO_AGNO(ip->i_mount, ip->i_ino),
 639                                 XFS_ICI_RECLAIM_TAG);
 640                 spin_unlock(&ip->i_mount->m_perag_lock);
 641                 trace_xfs_perag_clear_reclaim(ip->i_mount, pag->pag_agno,
 642                                                         -1, _RET_IP_);
 643         }
 644 }
 645
 646 void
 647 __xfs_inode_clear_reclaim_tag(
 648         xfs_mount_t     *mp,
 649         xfs_perag_t     *pag,
 650         xfs_inode_t     *ip)
 651 {
 652         radix_tree_tag_clear(&pag->pag_ici_root,
 653                         XFS_INO_TO_AGINO(mp, ip->i_ino), XFS_ICI_RECLAIM_TAG);
 654         __xfs_inode_clear_reclaim(pag, ip);
 655 }
 656
 657 /*
 658  * Grab the inode for reclaim exclusively.
 659  * Return 0 if we grabbed it, non-zero otherwise.
 660  */
 661 STATIC int
 662 xfs_reclaim_inode_grab(
 663         struct xfs_inode        *ip,
 664         int                     flags)
 665 {
 666         ASSERT(rcu_read_lock_held());
 667
 668         /* quick check for stale RCU freed inode */
 669         if (!ip->i_ino)
 670                 return 1;
 671
 672         /*
 673          * If we are asked for non-blocking operation, do unlocked checks to
 674          * see if the inode already is being flushed or in reclaim to avoid
 675          * lock traffic.
 676          */
 677         if ((flags & SYNC_TRYLOCK) &&
 678             __xfs_iflags_test(ip, XFS_IFLOCK | XFS_IRECLAIM))
 679                 return 1;
 680
 681         /*
 682          * The radix tree lock here protects a thread in xfs_iget from racing
 683          * with us starting reclaim on the inode.  Once we have the
 684          * XFS_IRECLAIM flag set it will not touch us.
 685          *
 686          * Due to RCU lookup, we may find inodes that have been freed and only
 687          * have XFS_IRECLAIM set.  Indeed, we may see reallocated inodes that
 688          * aren't candidates for reclaim at all, so we must check the
 689          * XFS_IRECLAIMABLE is set first before proceeding to reclaim.
 690          */
 691         spin_lock(&ip->i_flags_lock);
 692         if (!__xfs_iflags_test(ip, XFS_IRECLAIMABLE) ||
 693             __xfs_iflags_test(ip, XFS_IRECLAIM)) {
 694                 /* not a reclaim candidate. */
 695                 spin_unlock(&ip->i_flags_lock);
 696                 return 1;
 697         }
 698         __xfs_iflags_set(ip, XFS_IRECLAIM);
 699         spin_unlock(&ip->i_flags_lock);
 700         return 0;
 701 }
 702
 703 /*
 704  * Inodes in different states need to be treated differently, and the return
 705  * value of xfs_iflush is not sufficient to get this right. The following table
 706  * lists the inode states and the reclaim actions necessary for non-blocking
 707  * reclaim:
 708  *
 709  *
 710  *      inode state          iflush ret         required action
 711  *      ---------------      ----------         ---------------
 712  *      bad                     -               reclaim
 713  *      shutdown                EIO             unpin and reclaim
 714  *      clean, unpinned         0               reclaim
 715  *      stale, unpinned         0               reclaim
 716  *      clean, pinned(*)        0               requeue
 717  *      stale, pinned           EAGAIN          requeue
 718  *      dirty, delwri ok        0               requeue
 719  *      dirty, delwri blocked   EAGAIN          requeue
 720  *      dirty, sync flush       0               reclaim
 721  *
 722  * (*) dgc: I don't think the clean, pinned state is possible but it gets
 723  * handled anyway given the order of checks implemented.
 724  *
 725  * As can be seen from the table, the return value of xfs_iflush() is not
 726  * sufficient to correctly decide the reclaim action here. The checks in
 727  * xfs_iflush() might look like duplicates, but they are not.
 728  *
 729  * Also, because we get the flush lock first, we know that any inode that has
 730  * been flushed delwri has had the flush completed by the time we check that
 731  * the inode is clean. The clean inode check needs to be done before flushing
 732  * the inode delwri otherwise we would loop forever requeuing clean inodes as
 733  * we cannot tell apart a successful delwri flush and a clean inode from the
 734  * return value of xfs_iflush().
 735  *
 736  * Note that because the inode is flushed delayed write by background
 737  * writeback, the flush lock may already be held here and waiting on it can
 738  * result in very long latencies. Hence for sync reclaims, where we wait on the
 739  * flush lock, the caller should push out delayed write inodes first before
 740  * trying to reclaim them to minimise the amount of time spent waiting. For
 741  * background relaim, we just requeue the inode for the next pass.
 742  *
 743  * Hence the order of actions after gaining the locks should be:
 744  *      bad             => reclaim
 745  *      shutdown        => unpin and reclaim
 746  *      pinned, delwri  => requeue
 747  *      pinned, sync    => unpin
 748  *      stale           => reclaim
 749  *      clean           => reclaim
 750  *      dirty, delwri   => flush and requeue
 751  *      dirty, sync     => flush, wait and reclaim
 752  */
 753 STATIC int
 754 xfs_reclaim_inode(
 755         struct xfs_inode        *ip,
 756         struct xfs_perag        *pag,
 757         int                     sync_mode)
 758 {
 759         int     error;
 760
 761 restart:
 762         error = 0;
 763         xfs_ilock(ip, XFS_ILOCK_EXCL);
 764         if (!xfs_iflock_nowait(ip)) {
 765                 if (!(sync_mode & SYNC_WAIT))
 766                         goto out;
 767
 768                 /*
 769                  * If we only have a single dirty inode in a cluster there is
 770                  * a fair chance that the AIL push may have pushed it into
 771                  * the buffer, but xfsbufd won't touch it until 30 seconds
 772                  * from now, and thus we will lock up here.
 773                  *
 774                  * Promote the inode buffer to the front of the delwri list
 775                  * and wake up xfsbufd now.
 776                  */
 777                 xfs_promote_inode(ip);
 778                 xfs_iflock(ip);
 779         }
 780
 781         if (is_bad_inode(VFS_I(ip)))
 782                 goto reclaim;
 783         if (XFS_FORCED_SHUTDOWN(ip->i_mount)) {
 784                 xfs_iunpin_wait(ip);
 785                 goto reclaim;
 786         }
 787         if (xfs_ipincount(ip)) {
 788                 if (!(sync_mode & SYNC_WAIT)) {
 789                         xfs_ifunlock(ip);
 790                         goto out;
 791                 }
 792                 xfs_iunpin_wait(ip);
 793         }
 794         if (xfs_iflags_test(ip, XFS_ISTALE))
 795                 goto reclaim;
 796         if (xfs_inode_clean(ip))
 797                 goto reclaim;
 798
 799         /*
 800          * Now we have an inode that needs flushing.
 801          *
 802          * We do a nonblocking flush here even if we are doing a SYNC_WAIT
 803          * reclaim as we can deadlock with inode cluster removal.
 804          * xfs_ifree_cluster() can lock the inode buffer before it locks the
 805          * ip->i_lock, and we are doing the exact opposite here. As a result,
 806          * doing a blocking xfs_itobp() to get the cluster buffer will result
 807          * in an ABBA deadlock with xfs_ifree_cluster().
 808          *
 809          * As xfs_ifree_cluser() must gather all inodes that are active in the
 810          * cache to mark them stale, if we hit this case we don't actually want
 811          * to do IO here - we want the inode marked stale so we can simply
 812          * reclaim it. Hence if we get an EAGAIN error on a SYNC_WAIT flush,
 813          * just unlock the inode, back off and try again. Hopefully the next
 814          * pass through will see the stale flag set on the inode.
 815          */
 816         error = xfs_iflush(ip, SYNC_TRYLOCK | sync_mode);
 817         if (sync_mode & SYNC_WAIT) {
 818                 if (error == EAGAIN) {
 819                         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 820                         /* backoff longer than in xfs_ifree_cluster */
 821                         delay(2);
 822                         goto restart;
 823                 }
 824                 xfs_iflock(ip);
 825                 goto reclaim;
 826         }
 827
 828         /*
 829          * When we have to flush an inode but don't have SYNC_WAIT set, we
 830          * flush the inode out using a delwri buffer and wait for the next
 831          * call into reclaim to find it in a clean state instead of waiting for
 832          * it now. We also don't return errors here - if the error is transient
 833          * then the next reclaim pass will flush the inode, and if the error
 834          * is permanent then the next sync reclaim will reclaim the inode and
 835          * pass on the error.
 836          */
 837         if (error && error != EAGAIN && !XFS_FORCED_SHUTDOWN(ip->i_mount)) {
 838                 xfs_warn(ip->i_mount,
 839                         "inode 0x%llx background reclaim flush failed with %d",
 840                         (long long)ip->i_ino, error);
 841         }
 842 out:
 843         xfs_iflags_clear(ip, XFS_IRECLAIM);
 844         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 845         /*
 846          * We could return EAGAIN here to make reclaim rescan the inode tree in
 847          * a short while. However, this just burns CPU time scanning the tree
 848          * waiting for IO to complete and xfssyncd never goes back to the idle
 849          * state. Instead, return 0 to let the next scheduled background reclaim
 850          * attempt to reclaim the inode again.
 851          */
 852         return 0;
 853
 854 reclaim:
 855         xfs_ifunlock(ip);
 856         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 857
 858         XFS_STATS_INC(xs_ig_reclaims);
 859         /*
 860          * Remove the inode from the per-AG radix tree.
 861          *
 862          * Because radix_tree_delete won't complain even if the item was never
 863          * added to the tree assert that it's been there before to catch
 864          * problems with the inode life time early on.
 865          */
 866         spin_lock(&pag->pag_ici_lock);
 867         if (!radix_tree_delete(&pag->pag_ici_root,
 868                                 XFS_INO_TO_AGINO(ip->i_mount, ip->i_ino)))
 869                 ASSERT(0);
 870         __xfs_inode_clear_reclaim(pag, ip);
 871         spin_unlock(&pag->pag_ici_lock);
 872
 873         /*
 874          * Here we do an (almost) spurious inode lock in order to coordinate
 875          * with inode cache radix tree lookups.  This is because the lookup
 876          * can reference the inodes in the cache without taking references.
 877          *
 878          * We make that OK here by ensuring that we wait until the inode is
 879          * unlocked after the lookup before we go ahead and free it.
 880          */
 881         xfs_ilock(ip, XFS_ILOCK_EXCL);
 882         xfs_qm_dqdetach(ip);
 883         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 884
 885         xfs_inode_free(ip);
 886
 887         return error;
 888 }
 889
 890 /*
 891  * Walk the AGs and reclaim the inodes in them. Even if the filesystem is
 892  * corrupted, we still want to try to reclaim all the inodes. If we don't,
 893  * then a shut down during filesystem unmount reclaim walk leak all the
 894  * unreclaimed inodes.
 895  */
 896 int
 897 xfs_reclaim_inodes_ag(
 898         struct xfs_mount        *mp,
 899         int                     flags,
 900         int                     *nr_to_scan)
 901 {
 902         struct xfs_perag        *pag;
 903         int                     error = 0;
 904         int                     last_error = 0;
 905         xfs_agnumber_t          ag;
 906         int                     trylock = flags & SYNC_TRYLOCK;
 907         int                     skipped;
 908
 909 restart:
 910         ag = 0;
 911         skipped = 0;
 912         while ((pag = xfs_perag_get_tag(mp, ag, XFS_ICI_RECLAIM_TAG))) {
 913                 unsigned long   first_index = 0;
 914                 int             done = 0;
 915                 int             nr_found = 0;
 916
 917                 ag = pag->pag_agno + 1;
 918
 919                 if (trylock) {
 920                         if (!mutex_trylock(&pag->pag_ici_reclaim_lock)) {
 921                                 skipped++;
 922                                 xfs_perag_put(pag);
 923                                 continue;
 924                         }
 925                         first_index = pag->pag_ici_reclaim_cursor;
 926                 } else
 927                         mutex_lock(&pag->pag_ici_reclaim_lock);
 928
 929                 do {
 930                         struct xfs_inode *batch[XFS_LOOKUP_BATCH];
 931                         int     i;
 932
 933                         rcu_read_lock();
 934                         nr_found = radix_tree_gang_lookup_tag(
 935                                         &pag->pag_ici_root,
 936                                         (void **)batch, first_index,
 937                                         XFS_LOOKUP_BATCH,
 938                                         XFS_ICI_RECLAIM_TAG);
 939                         if (!nr_found) {
 940                                 done = 1;
 941                                 rcu_read_unlock();
 942                                 break;
 943                         }
 944
 945                         /*
 946                          * Grab the inodes before we drop the lock. if we found
 947                          * nothing, nr == 0 and the loop will be skipped.
 948                          */
 949                         for (i = 0; i < nr_found; i++) {
 950                                 struct xfs_inode *ip = batch[i];
 951
 952                                 if (done || xfs_reclaim_inode_grab(ip, flags))
 953                                         batch[i] = NULL;
 954
 955                                 /*
 956                                  * Update the index for the next lookup. Catch
 957                                  * overflows into the next AG range which can
 958                                  * occur if we have inodes in the last block of
 959                                  * the AG and we are currently pointing to the
 960                                  * last inode.
 961                                  *
 962                                  * Because we may see inodes that are from the
 963                                  * wrong AG due to RCU freeing and
 964                                  * reallocation, only update the index if it
 965                                  * lies in this AG. It was a race that lead us
 966                                  * to see this inode, so another lookup from
 967                                  * the same index will not find it again.
 968                                  */
 969                                 if (XFS_INO_TO_AGNO(mp, ip->i_ino) !=
 970                                                                 pag->pag_agno)
 971                                         continue;
 972                                 first_index = XFS_INO_TO_AGINO(mp, ip->i_ino + 1);
 973                                 if (first_index < XFS_INO_TO_AGINO(mp, ip->i_ino))
 974                                         done = 1;
 975                         }
 976
 977                         /* unlock now we've grabbed the inodes. */
 978                         rcu_read_unlock();
 979
 980                         for (i = 0; i < nr_found; i++) {
 981                                 if (!batch[i])
 982                                         continue;
 983                                 error = xfs_reclaim_inode(batch[i], pag, flags);
 984                                 if (error && last_error != EFSCORRUPTED)
 985                                         last_error = error;
 986                         }
 987
 988                         *nr_to_scan -= XFS_LOOKUP_BATCH;
 989
 990                         cond_resched();
 991
 992                 } while (nr_found && !done && *nr_to_scan > 0);
 993
 994                 if (trylock && !done)
 995                         pag->pag_ici_reclaim_cursor = first_index;
 996                 else
 997                         pag->pag_ici_reclaim_cursor = 0;
 998                 mutex_unlock(&pag->pag_ici_reclaim_lock);
 999                 xfs_perag_put(pag);
1000         }
1001
1002         /*
1003          * if we skipped any AG, and we still have scan count remaining, do
1004          * another pass this time using blocking reclaim semantics (i.e
1005          * waiting on the reclaim locks and ignoring the reclaim cursors). This
1006          * ensure that when we get more reclaimers than AGs we block rather
1007          * than spin trying to execute reclaim.
1008          */
1009         if (skipped && (flags & SYNC_WAIT) && *nr_to_scan > 0) {
1010                 trylock = 0;
1011                 goto restart;
1012         }
1013         return XFS_ERROR(last_error);
1014 }
1015
1016 int
1017 xfs_reclaim_inodes(
1018         xfs_mount_t     *mp,
1019         int             mode)
1020 {
1021         int             nr_to_scan = INT_MAX;
1022
1023         return xfs_reclaim_inodes_ag(mp, mode, &nr_to_scan);
1024 }
1025
1026 /*
1027  * Scan a certain number of inodes for reclaim.
1028  *
1029  * When called we make sure that there is a background (fast) inode reclaim in
1030  * progress, while we will throttle the speed of reclaim via doing synchronous
1031  * reclaim of inodes. That means if we come across dirty inodes, we wait for
1032  * them to be cleaned, which we hope will not be very long due to the
1033  * background walker having already kicked the IO off on those dirty inodes.
1034  */
1035 void
1036 xfs_reclaim_inodes_nr(
1037         struct xfs_mount        *mp,
1038         int                     nr_to_scan)
1039 {
1040         /* kick background reclaimer and push the AIL */
1041         xfs_syncd_queue_reclaim(mp);
1042         xfs_ail_push_all(mp->m_ail);
1043
1044         xfs_reclaim_inodes_ag(mp, SYNC_TRYLOCK | SYNC_WAIT, &nr_to_scan);
1045 }
1046
1047 /*
1048  * Return the number of reclaimable inodes in the filesystem for
1049  * the shrinker to determine how much to reclaim.
1050  */
1051 int
1052 xfs_reclaim_inodes_count(
1053         struct xfs_mount        *mp)
1054 {
1055         struct xfs_perag        *pag;
1056         xfs_agnumber_t          ag = 0;
1057         int                     reclaimable = 0;
1058
1059         while ((pag = xfs_perag_get_tag(mp, ag, XFS_ICI_RECLAIM_TAG))) {
1060                 ag = pag->pag_agno + 1;
1061                 reclaimable += pag->pag_ici_reclaimable;
1062                 xfs_perag_put(pag);
1063         }
1064         return reclaimable;
1065 }
1066