fs/ubifs/gc.c

   1 /*
   2  * This file is part of UBIFS.
   3  *
   4  * Copyright (C) 2006-2008 Nokia Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published by
   8  * the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program; if not, write to the Free Software Foundation, Inc., 51
  17  * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  *
  19  * Authors: Adrian Hunter
  20  *          Artem Bityutskiy (Битюцкий Артём)
  21  */
  22
  23 /*
  24  * This file implements garbage collection. The procedure for garbage collection
  25  * is different depending on whether a LEB as an index LEB (contains index
  26  * nodes) or not. For non-index LEBs, garbage collection finds a LEB which
  27  * contains a lot of dirty space (obsolete nodes), and copies the non-obsolete
  28  * nodes to the journal, at which point the garbage-collected LEB is free to be
  29  * reused. For index LEBs, garbage collection marks the non-obsolete index nodes
  30  * dirty in the TNC, and after the next commit, the garbage-collected LEB is
  31  * to be reused. Garbage collection will cause the number of dirty index nodes
  32  * to grow, however sufficient space is reserved for the index to ensure the
  33  * commit will never run out of space.
  34  *
  35  * Notes about dead watermark. At current UBIFS implementation we assume that
  36  * LEBs which have less than @c->dead_wm bytes of free + dirty space are full
  37  * and not worth garbage-collecting. The dead watermark is one min. I/O unit
  38  * size, or min. UBIFS node size, depending on what is greater. Indeed, UBIFS
  39  * Garbage Collector has to synchronize the GC head's write buffer before
  40  * returning, so this is about wasting one min. I/O unit. However, UBIFS GC can
  41  * actually reclaim even very small pieces of dirty space by garbage collecting
  42  * enough dirty LEBs, but we do not bother doing this at this implementation.
  43  *
  44  * Notes about dark watermark. The results of GC work depends on how big are
  45  * the UBIFS nodes GC deals with. Large nodes make GC waste more space. Indeed,
  46  * if GC move data from LEB A to LEB B and nodes in LEB A are large, GC would
  47  * have to waste large pieces of free space at the end of LEB B, because nodes
  48  * from LEB A would not fit. And the worst situation is when all nodes are of
  49  * maximum size. So dark watermark is the amount of free + dirty space in LEB
  50  * which are guaranteed to be reclaimable. If LEB has less space, the GC might
  51  * be unable to reclaim it. So, LEBs with free + dirty greater than dark
  52  * watermark are "good" LEBs from GC's point of few. The other LEBs are not so
  53  * good, and GC takes extra care when moving them.
  54  */
  55
  56 #include <linux/slab.h>
  57 #include <linux/pagemap.h>
  58 #include <linux/list_sort.h>
  59 #include "ubifs.h"
  60
  61 /*
  62  * GC may need to move more than one LEB to make progress. The below constants
  63  * define "soft" and "hard" limits on the number of LEBs the garbage collector
  64  * may move.
  65  */
  66 #define SOFT_LEBS_LIMIT 4
  67 #define HARD_LEBS_LIMIT 32
  68
  69 /**
  70  * switch_gc_head - switch the garbage collection journal head.
  71  * @c: UBIFS file-system description object
  72  * @buf: buffer to write
  73  * @len: length of the buffer to write
  74  * @lnum: LEB number written is returned here
  75  * @offs: offset written is returned here
  76  *
  77  * This function switch the GC head to the next LEB which is reserved in
  78  * @c->gc_lnum. Returns %0 in case of success, %-EAGAIN if commit is required,
  79  * and other negative error code in case of failures.
  80  */
  81 static int switch_gc_head(struct ubifs_info *c)
  82 {
  83         int err, gc_lnum = c->gc_lnum;
  84         struct ubifs_wbuf *wbuf = &c->jheads[GCHD].wbuf;
  85
  86         ubifs_assert(gc_lnum != -1);
  87         dbg_gc("switch GC head from LEB %d:%d to LEB %d (waste %d bytes)",
  88                wbuf->lnum, wbuf->offs + wbuf->used, gc_lnum,
  89                c->leb_size - wbuf->offs - wbuf->used);
  90
  91         err = ubifs_wbuf_sync_nolock(wbuf);
  92         if (err)
  93                 return err;
  94
  95         /*
  96          * The GC write-buffer was synchronized, we may safely unmap
  97          * 'c->gc_lnum'.
  98          */
  99         err = ubifs_leb_unmap(c, gc_lnum);
 100         if (err)
 101                 return err;
 102
 103         err = ubifs_add_bud_to_log(c, GCHD, gc_lnum, 0);
 104         if (err)
 105                 return err;
 106
 107         c->gc_lnum = -1;
 108         err = ubifs_wbuf_seek_nolock(wbuf, gc_lnum, 0, UBI_LONGTERM);
 109         return err;
 110 }
 111
 112 /**
 113  * data_nodes_cmp - compare 2 data nodes.
 114  * @priv: UBIFS file-system description object
 115  * @a: first data node
 116  * @a: second data node
 117  *
 118  * This function compares data nodes @a and @b. Returns %1 if @a has greater
 119  * inode or block number, and %-1 otherwise.
 120  */
 121 int data_nodes_cmp(void *priv, struct list_head *a, struct list_head *b)
 122 {
 123         ino_t inuma, inumb;
 124         struct ubifs_info *c = priv;
 125         struct ubifs_scan_node *sa, *sb;
 126
 127         cond_resched();
 128         if (a == b)
 129                 return 0;
 130
 131         sa = list_entry(a, struct ubifs_scan_node, list);
 132         sb = list_entry(b, struct ubifs_scan_node, list);
 133
 134         ubifs_assert(key_type(c, &sa->key) == UBIFS_DATA_KEY);
 135         ubifs_assert(key_type(c, &sb->key) == UBIFS_DATA_KEY);
 136         ubifs_assert(sa->type == UBIFS_DATA_NODE);
 137         ubifs_assert(sb->type == UBIFS_DATA_NODE);
 138
 139         inuma = key_inum(c, &sa->key);
 140         inumb = key_inum(c, &sb->key);
 141
 142         if (inuma == inumb) {
 143                 unsigned int blka = key_block(c, &sa->key);
 144                 unsigned int blkb = key_block(c, &sb->key);
 145
 146                 if (blka <= blkb)
 147                         return -1;
 148         } else if (inuma <= inumb)
 149                 return -1;
 150
 151         return 1;
 152 }
 153
 154 /*
 155  * nondata_nodes_cmp - compare 2 non-data nodes.
 156  * @priv: UBIFS file-system description object
 157  * @a: first node
 158  * @a: second node
 159  *
 160  * This function compares nodes @a and @b. It makes sure that inode nodes go
 161  * first and sorted by length in descending order. Directory entry nodes go
 162  * after inode nodes and are sorted in ascending hash valuer order.
 163  */
 164 int nondata_nodes_cmp(void *priv, struct list_head *a, struct list_head *b)
 165 {
 166         ino_t inuma, inumb;
 167         struct ubifs_info *c = priv;
 168         struct ubifs_scan_node *sa, *sb;
 169
 170         cond_resched();
 171         if (a == b)
 172                 return 0;
 173
 174         sa = list_entry(a, struct ubifs_scan_node, list);
 175         sb = list_entry(b, struct ubifs_scan_node, list);
 176
 177         ubifs_assert(key_type(c, &sa->key) != UBIFS_DATA_KEY &&
 178                      key_type(c, &sb->key) != UBIFS_DATA_KEY);
 179         ubifs_assert(sa->type != UBIFS_DATA_NODE &&
 180                      sb->type != UBIFS_DATA_NODE);
 181
 182         /* Inodes go before directory entries */
 183         if (sa->type == UBIFS_INO_NODE) {
 184                 if (sb->type == UBIFS_INO_NODE)
 185                         return sb->len - sa->len;
 186                 return -1;
 187         }
 188         if (sb->type == UBIFS_INO_NODE)
 189                 return 1;
 190
 191         ubifs_assert(key_type(c, &sa->key) == UBIFS_DENT_KEY ||
 192                      key_type(c, &sa->key) == UBIFS_XENT_KEY);
 193         ubifs_assert(key_type(c, &sb->key) == UBIFS_DENT_KEY ||
 194                      key_type(c, &sb->key) == UBIFS_XENT_KEY);
 195         ubifs_assert(sa->type == UBIFS_DENT_NODE ||
 196                      sa->type == UBIFS_XENT_NODE);
 197         ubifs_assert(sb->type == UBIFS_DENT_NODE ||
 198                      sb->type == UBIFS_XENT_NODE);
 199
 200         inuma = key_inum(c, &sa->key);
 201         inumb = key_inum(c, &sb->key);
 202
 203         if (inuma == inumb) {
 204                 uint32_t hasha = key_hash(c, &sa->key);
 205                 uint32_t hashb = key_hash(c, &sb->key);
 206
 207                 if (hasha <= hashb)
 208                         return -1;
 209         } else if (inuma <= inumb)
 210                 return -1;
 211
 212         return 1;
 213 }
 214
 215 /**
 216  * sort_nodes - sort nodes for GC.
 217  * @c: UBIFS file-system description object
 218  * @sleb: describes nodes to sort and contains the result on exit
 219  * @nondata: contains non-data nodes on exit
 220  * @min: minimum node size is returned here
 221  *
 222  * This function sorts the list of inodes to garbage collect. First of all, it
 223  * kills obsolete nodes and separates data and non-data nodes to the
 224  * @sleb->nodes and @nondata lists correspondingly.
 225  *
 226  * Data nodes are then sorted in block number order - this is important for
 227  * bulk-read; data nodes with lower inode number go before data nodes with
 228  * higher inode number, and data nodes with lower block number go before data
 229  * nodes with higher block number;
 230  *
 231  * Non-data nodes are sorted as follows.
 232  *   o First go inode nodes - they are sorted in descending length order.
 233  *   o Then go directory entry nodes - they are sorted in hash order, which
 234  *     should supposedly optimize 'readdir()'. Direntry nodes with lower parent
 235  *     inode number go before direntry nodes with higher parent inode number,
 236  *     and direntry nodes with lower name hash values go before direntry nodes
 237  *     with higher name hash values.
 238  *
 239  * This function returns zero in case of success and a negative error code in
 240  * case of failure.
 241  */
 242 static int sort_nodes(struct ubifs_info *c, struct ubifs_scan_leb *sleb,
 243                       struct list_head *nondata, int *min)
 244 {
 245         struct ubifs_scan_node *snod, *tmp;
 246
 247         *min = INT_MAX;
 248
 249         /* Separate data nodes and non-data nodes */
 250         list_for_each_entry_safe(snod, tmp, &sleb->nodes, list) {
 251                 int err;
 252
 253                 ubifs_assert(snod->type == UBIFS_INO_NODE  ||
 254                              snod->type == UBIFS_DATA_NODE ||
 255                              snod->type == UBIFS_DENT_NODE ||
 256                              snod->type == UBIFS_XENT_NODE ||
 257                              snod->type == UBIFS_TRUN_NODE);
 258
 259                 if (snod->type != UBIFS_INO_NODE  &&
 260                     snod->type != UBIFS_DATA_NODE &&
 261                     snod->type != UBIFS_DENT_NODE &&
 262                     snod->type != UBIFS_XENT_NODE) {
 263                         /* Probably truncation node, zap it */
 264                         list_del(&snod->list);
 265                         kfree(snod);
 266                         continue;
 267                 }
 268
 269                 ubifs_assert(key_type(c, &snod->key) == UBIFS_DATA_KEY ||
 270                              key_type(c, &snod->key) == UBIFS_INO_KEY  ||
 271                              key_type(c, &snod->key) == UBIFS_DENT_KEY ||
 272                              key_type(c, &snod->key) == UBIFS_XENT_KEY);
 273
 274                 err = ubifs_tnc_has_node(c, &snod->key, 0, sleb->lnum,
 275                                          snod->offs, 0);
 276                 if (err < 0)
 277                         return err;
 278
 279                 if (!err) {
 280                         /* The node is obsolete, remove it from the list */
 281                         list_del(&snod->list);
 282                         kfree(snod);
 283                         continue;
 284                 }
 285
 286                 if (snod->len < *min)
 287                         *min = snod->len;
 288
 289                 if (key_type(c, &snod->key) != UBIFS_DATA_KEY)
 290                         list_move_tail(&snod->list, nondata);
 291         }
 292
 293         /* Sort data and non-data nodes */
 294         list_sort(c, &sleb->nodes, &data_nodes_cmp);
 295         list_sort(c, nondata, &nondata_nodes_cmp);
 296         return 0;
 297 }
 298
 299 /**
 300  * move_node - move a node.
 301  * @c: UBIFS file-system description object
 302  * @sleb: describes the LEB to move nodes from
 303  * @snod: the mode to move
 304  * @wbuf: write-buffer to move node to
 305  *
 306  * This function moves node @snod to @wbuf, changes TNC correspondingly, and
 307  * destroys @snod. Returns zero in case of success and a negative error code in
 308  * case of failure.
 309  */
 310 static int move_node(struct ubifs_info *c, struct ubifs_scan_leb *sleb,
 311                      struct ubifs_scan_node *snod, struct ubifs_wbuf *wbuf)
 312 {
 313         int err, new_lnum = wbuf->lnum, new_offs = wbuf->offs + wbuf->used;
 314
 315         cond_resched();
 316         err = ubifs_wbuf_write_nolock(wbuf, snod->node, snod->len);
 317         if (err)
 318                 return err;
 319
 320         err = ubifs_tnc_replace(c, &snod->key, sleb->lnum,
 321                                 snod->offs, new_lnum, new_offs,
 322                                 snod->len);
 323         list_del(&snod->list);
 324         kfree(snod);
 325         return err;
 326 }
 327
 328 /**
 329  * move_nodes - move nodes.
 330  * @c: UBIFS file-system description object
 331  * @sleb: describes the LEB to move nodes from
 332  *
 333  * This function moves valid nodes from data LEB described by @sleb to the GC
 334  * journal head. This function returns zero in case of success, %-EAGAIN if
 335  * commit is required, and other negative error codes in case of other
 336  * failures.
 337  */
 338 static int move_nodes(struct ubifs_info *c, struct ubifs_scan_leb *sleb)
 339 {
 340         int err, min;
 341         LIST_HEAD(nondata);
 342         struct ubifs_wbuf *wbuf = &c->jheads[GCHD].wbuf;
 343
 344         if (wbuf->lnum == -1) {
 345                 /*
 346                  * The GC journal head is not set, because it is the first GC
 347                  * invocation since mount.
 348                  */
 349                 err = switch_gc_head(c);
 350                 if (err)
 351                         return err;
 352         }
 353
 354         err = sort_nodes(c, sleb, &nondata, &min);
 355         if (err)
 356                 goto out;
 357
 358         /* Write nodes to their new location. Use the first-fit strategy */
 359         while (1) {
 360                 int avail;
 361                 struct ubifs_scan_node *snod, *tmp;
 362
 363                 /* Move data nodes */
 364                 list_for_each_entry_safe(snod, tmp, &sleb->nodes, list) {
 365                         avail = c->leb_size - wbuf->offs - wbuf->used;
 366                         if  (snod->len > avail)
 367                                 /*
 368                                  * Do not skip data nodes in order to optimize
 369                                  * bulk-read.
 370                                  */
 371                                 break;
 372
 373                         err = move_node(c, sleb, snod, wbuf);
 374                         if (err)
 375                                 goto out;
 376                 }
 377
 378                 /* Move non-data nodes */
 379                 list_for_each_entry_safe(snod, tmp, &nondata, list) {
 380                         avail = c->leb_size - wbuf->offs - wbuf->used;
 381                         if (avail < min)
 382                                 break;
 383
 384                         if  (snod->len > avail) {
 385                                 /*
 386                                  * Keep going only if this is an inode with
 387                                  * some data. Otherwise stop and switch the GC
 388                                  * head. IOW, we assume that data-less inode
 389                                  * nodes and direntry nodes are roughly of the
 390                                  * same size.
 391                                  */
 392                                 if (key_type(c, &snod->key) == UBIFS_DENT_KEY ||
 393                                     snod->len == UBIFS_INO_NODE_SZ)
 394                                         break;
 395                                 continue;
 396                         }
 397
 398                         err = move_node(c, sleb, snod, wbuf);
 399                         if (err)
 400                                 goto out;
 401                 }
 402
 403                 if (list_empty(&sleb->nodes) && list_empty(&nondata))
 404                         break;
 405
 406                 /*
 407                  * Waste the rest of the space in the LEB and switch to the
 408                  * next LEB.
 409                  */
 410                 err = switch_gc_head(c);
 411                 if (err)
 412                         goto out;
 413         }
 414
 415         return 0;
 416
 417 out:
 418         list_splice_tail(&nondata, &sleb->nodes);
 419         return err;
 420 }
 421
 422 /**
 423  * gc_sync_wbufs - sync write-buffers for GC.
 424  * @c: UBIFS file-system description object
 425  *
 426  * We must guarantee that obsoleting nodes are on flash. Unfortunately they may
 427  * be in a write-buffer instead. That is, a node could be written to a
 428  * write-buffer, obsoleting another node in a LEB that is GC'd. If that LEB is
 429  * erased before the write-buffer is sync'd and then there is an unclean
 430  * unmount, then an existing node is lost. To avoid this, we sync all
 431  * write-buffers.
 432  *
 433  * This function returns %0 on success or a negative error code on failure.
 434  */
 435 static int gc_sync_wbufs(struct ubifs_info *c)
 436 {
 437         int err, i;
 438
 439         for (i = 0; i < c->jhead_cnt; i++) {
 440                 if (i == GCHD)
 441                         continue;
 442                 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
 443                 if (err)
 444                         return err;
 445         }
 446         return 0;
 447 }
 448
 449 /**
 450  * ubifs_garbage_collect_leb - garbage-collect a logical eraseblock.
 451  * @c: UBIFS file-system description object
 452  * @lp: describes the LEB to garbage collect
 453  *
 454  * This function garbage-collects an LEB and returns one of the @LEB_FREED,
 455  * @LEB_RETAINED, etc positive codes in case of success, %-EAGAIN if commit is
 456  * required, and other negative error codes in case of failures.
 457  */
 458 int ubifs_garbage_collect_leb(struct ubifs_info *c, struct ubifs_lprops *lp)
 459 {
 460         struct ubifs_scan_leb *sleb;
 461         struct ubifs_scan_node *snod;
 462         struct ubifs_wbuf *wbuf = &c->jheads[GCHD].wbuf;
 463         int err = 0, lnum = lp->lnum;
 464
 465         ubifs_assert(c->gc_lnum != -1 || wbuf->offs + wbuf->used == 0 ||
 466                      c->need_recovery);
 467         ubifs_assert(c->gc_lnum != lnum);
 468         ubifs_assert(wbuf->lnum != lnum);
 469
 470         /*
 471          * We scan the entire LEB even though we only really need to scan up to
 472          * (c->leb_size - lp->free).
 473          */
 474         sleb = ubifs_scan(c, lnum, 0, c->sbuf, 0);
 475         if (IS_ERR(sleb))
 476                 return PTR_ERR(sleb);
 477
 478         ubifs_assert(!list_empty(&sleb->nodes));
 479         snod = list_entry(sleb->nodes.next, struct ubifs_scan_node, list);
 480
 481         if (snod->type == UBIFS_IDX_NODE) {
 482                 struct ubifs_gced_idx_leb *idx_gc;
 483
 484                 dbg_gc("indexing LEB %d (free %d, dirty %d)",
 485                        lnum, lp->free, lp->dirty);
 486                 list_for_each_entry(snod, &sleb->nodes, list) {
 487                         struct ubifs_idx_node *idx = snod->node;
 488                         int level = le16_to_cpu(idx->level);
 489
 490                         ubifs_assert(snod->type == UBIFS_IDX_NODE);
 491                         key_read(c, ubifs_idx_key(c, idx), &snod->key);
 492                         err = ubifs_dirty_idx_node(c, &snod->key, level, lnum,
 493                                                    snod->offs);
 494                         if (err)
 495                                 goto out;
 496                 }
 497
 498                 idx_gc = kmalloc(sizeof(struct ubifs_gced_idx_leb), GFP_NOFS);
 499                 if (!idx_gc) {
 500                         err = -ENOMEM;
 501                         goto out;
 502                 }
 503
 504                 idx_gc->lnum = lnum;
 505                 idx_gc->unmap = 0;
 506                 list_add(&idx_gc->list, &c->idx_gc);
 507
 508                 /*
 509                  * Don't release the LEB until after the next commit, because
 510                  * it may contain data which is needed for recovery. So
 511                  * although we freed this LEB, it will become usable only after
 512                  * the commit.
 513                  */
 514                 err = ubifs_change_one_lp(c, lnum, c->leb_size, 0, 0,
 515                                           LPROPS_INDEX, 1);
 516                 if (err)
 517                         goto out;
 518                 err = LEB_FREED_IDX;
 519         } else {
 520                 dbg_gc("data LEB %d (free %d, dirty %d)",
 521                        lnum, lp->free, lp->dirty);
 522
 523                 err = move_nodes(c, sleb);
 524                 if (err)
 525                         goto out_inc_seq;
 526
 527                 err = gc_sync_wbufs(c);
 528                 if (err)
 529                         goto out_inc_seq;
 530
 531                 err = ubifs_change_one_lp(c, lnum, c->leb_size, 0, 0, 0, 0);
 532                 if (err)
 533                         goto out_inc_seq;
 534
 535                 /* Allow for races with TNC */
 536                 c->gced_lnum = lnum;
 537                 smp_wmb();
 538                 c->gc_seq += 1;
 539                 smp_wmb();
 540
 541                 if (c->gc_lnum == -1) {
 542                         c->gc_lnum = lnum;
 543                         err = LEB_RETAINED;
 544                 } else {
 545                         err = ubifs_wbuf_sync_nolock(wbuf);
 546                         if (err)
 547                                 goto out;
 548
 549                         err = ubifs_leb_unmap(c, lnum);
 550                         if (err)
 551                                 goto out;
 552
 553                         err = LEB_FREED;
 554                 }
 555         }
 556
 557 out:
 558         ubifs_scan_destroy(sleb);
 559         return err;
 560
 561 out_inc_seq:
 562         /* We may have moved at least some nodes so allow for races with TNC */
 563         c->gced_lnum = lnum;
 564         smp_wmb();
 565         c->gc_seq += 1;
 566         smp_wmb();
 567         goto out;
 568 }
 569
 570 /**
 571  * ubifs_garbage_collect - UBIFS garbage collector.
 572  * @c: UBIFS file-system description object
 573  * @anyway: do GC even if there are free LEBs
 574  *
 575  * This function does out-of-place garbage collection. The return codes are:
 576  *   o positive LEB number if the LEB has been freed and may be used;
 577  *   o %-EAGAIN if the caller has to run commit;
 578  *   o %-ENOSPC if GC failed to make any progress;
 579  *   o other negative error codes in case of other errors.
 580  *
 581  * Garbage collector writes data to the journal when GC'ing data LEBs, and just
 582  * marking indexing nodes dirty when GC'ing indexing LEBs. Thus, at some point
 583  * commit may be required. But commit cannot be run from inside GC, because the
 584  * caller might be holding the commit lock, so %-EAGAIN is returned instead;
 585  * And this error code means that the caller has to run commit, and re-run GC
 586  * if there is still no free space.
 587  *
 588  * There are many reasons why this function may return %-EAGAIN:
 589  * o the log is full and there is no space to write an LEB reference for
 590  *   @c->gc_lnum;
 591  * o the journal is too large and exceeds size limitations;
 592  * o GC moved indexing LEBs, but they can be used only after the commit;
 593  * o the shrinker fails to find clean znodes to free and requests the commit;
 594  * o etc.
 595  *
 596  * Note, if the file-system is close to be full, this function may return
 597  * %-EAGAIN infinitely, so the caller has to limit amount of re-invocations of
 598  * the function. E.g., this happens if the limits on the journal size are too
 599  * tough and GC writes too much to the journal before an LEB is freed. This
 600  * might also mean that the journal is too large, and the TNC becomes to big,
 601  * so that the shrinker is constantly called, finds not clean znodes to free,
 602  * and requests commit. Well, this may also happen if the journal is all right,
 603  * but another kernel process consumes too much memory. Anyway, infinite
 604  * %-EAGAIN may happen, but in some extreme/misconfiguration cases.
 605  */
 606 int ubifs_garbage_collect(struct ubifs_info *c, int anyway)
 607 {
 608         int i, err, ret, min_space = c->dead_wm;
 609         struct ubifs_lprops lp;
 610         struct ubifs_wbuf *wbuf = &c->jheads[GCHD].wbuf;
 611
 612         ubifs_assert_cmt_locked(c);
 613
 614         if (ubifs_gc_should_commit(c))
 615                 return -EAGAIN;
 616
 617         mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
 618
 619         if (c->ro_media) {
 620                 ret = -EROFS;
 621                 goto out_unlock;
 622         }
 623
 624         /* We expect the write-buffer to be empty on entry */
 625         ubifs_assert(!wbuf->used);
 626
 627         for (i = 0; ; i++) {
 628                 int space_before = c->leb_size - wbuf->offs - wbuf->used;
 629                 int space_after;
 630
 631                 cond_resched();
 632
 633                 /* Give the commit an opportunity to run */
 634                 if (ubifs_gc_should_commit(c)) {
 635                         ret = -EAGAIN;
 636                         break;
 637                 }
 638
 639                 if (i > SOFT_LEBS_LIMIT && !list_empty(&c->idx_gc)) {
 640                         /*
 641                          * We've done enough iterations. Indexing LEBs were
 642                          * moved and will be available after the commit.
 643                          */
 644                         dbg_gc("soft limit, some index LEBs GC'ed, -EAGAIN");
 645                         ubifs_commit_required(c);
 646                         ret = -EAGAIN;
 647                         break;
 648                 }
 649
 650                 if (i > HARD_LEBS_LIMIT) {
 651                         /*
 652                          * We've moved too many LEBs and have not made
 653                          * progress, give up.
 654                          */
 655                         dbg_gc("hard limit, -ENOSPC");
 656                         ret = -ENOSPC;
 657                         break;
 658                 }
 659
 660                 /*
 661                  * Empty and freeable LEBs can turn up while we waited for
 662                  * the wbuf lock, or while we have been running GC. In that
 663                  * case, we should just return one of those instead of
 664                  * continuing to GC dirty LEBs. Hence we request
 665                  * 'ubifs_find_dirty_leb()' to return an empty LEB if it can.
 666                  */
 667                 ret = ubifs_find_dirty_leb(c, &lp, min_space, anyway ? 0 : 1);
 668                 if (ret) {
 669                         if (ret == -ENOSPC)
 670                                 dbg_gc("no more dirty LEBs");
 671                         break;
 672                 }
 673
 674                 dbg_gc("found LEB %d: free %d, dirty %d, sum %d "
 675                        "(min. space %d)", lp.lnum, lp.free, lp.dirty,
 676                        lp.free + lp.dirty, min_space);
 677
 678                 if (lp.free + lp.dirty == c->leb_size) {
 679                         /* An empty LEB was returned */
 680                         dbg_gc("LEB %d is free, return it", lp.lnum);
 681                         /*
 682                          * ubifs_find_dirty_leb() doesn't return freeable index
 683                          * LEBs.
 684                          */
 685                         ubifs_assert(!(lp.flags & LPROPS_INDEX));
 686                         if (lp.free != c->leb_size) {
 687                                 /*
 688                                  * Write buffers must be sync'd before
 689                                  * unmapping freeable LEBs, because one of them
 690                                  * may contain data which obsoletes something
 691                                  * in 'lp.pnum'.
 692                                  */
 693                                 ret = gc_sync_wbufs(c);
 694                                 if (ret)
 695                                         goto out;
 696                                 ret = ubifs_change_one_lp(c, lp.lnum,
 697                                                           c->leb_size, 0, 0, 0,
 698                                                           0);
 699                                 if (ret)
 700                                         goto out;
 701                         }
 702                         ret = ubifs_leb_unmap(c, lp.lnum);
 703                         if (ret)
 704                                 goto out;
 705                         ret = lp.lnum;
 706                         break;
 707                 }
 708
 709                 space_before = c->leb_size - wbuf->offs - wbuf->used;
 710                 if (wbuf->lnum == -1)
 711                         space_before = 0;
 712
 713                 ret = ubifs_garbage_collect_leb(c, &lp);
 714                 if (ret < 0) {
 715                         if (ret == -EAGAIN) {
 716                                 /*
 717                                  * This is not error, so we have to return the
 718                                  * LEB to lprops. But if 'ubifs_return_leb()'
 719                                  * fails, its failure code is propagated to the
 720                                  * caller instead of the original '-EAGAIN'.
 721                                  */
 722                                 err = ubifs_return_leb(c, lp.lnum);
 723                                 if (err)
 724                                         ret = err;
 725                                 break;
 726                         }
 727                         goto out;
 728                 }
 729
 730                 if (ret == LEB_FREED) {
 731                         /* An LEB has been freed and is ready for use */
 732                         dbg_gc("LEB %d freed, return", lp.lnum);
 733                         ret = lp.lnum;
 734                         break;
 735                 }
 736
 737                 if (ret == LEB_FREED_IDX) {
 738                         /*
 739                          * This was an indexing LEB and it cannot be
 740                          * immediately used. And instead of requesting the
 741                          * commit straight away, we try to garbage collect some
 742                          * more.
 743                          */
 744                         dbg_gc("indexing LEB %d freed, continue", lp.lnum);
 745                         continue;
 746                 }
 747
 748                 ubifs_assert(ret == LEB_RETAINED);
 749                 space_after = c->leb_size - wbuf->offs - wbuf->used;
 750                 dbg_gc("LEB %d retained, freed %d bytes", lp.lnum,
 751                        space_after - space_before);
 752
 753                 if (space_after > space_before) {
 754                         /* GC makes progress, keep working */
 755                         min_space >>= 1;
 756                         if (min_space < c->dead_wm)
 757                                 min_space = c->dead_wm;
 758                         continue;
 759                 }
 760
 761                 dbg_gc("did not make progress");
 762
 763                 /*
 764                  * GC moved an LEB bud have not done any progress. This means
 765                  * that the previous GC head LEB contained too few free space
 766                  * and the LEB which was GC'ed contained only large nodes which
 767                  * did not fit that space.
 768                  *
 769                  * We can do 2 things:
 770                  * 1. pick another LEB in a hope it'll contain a small node
 771                  *    which will fit the space we have at the end of current GC
 772                  *    head LEB, but there is no guarantee, so we try this out
 773                  *    unless we have already been working for too long;
 774                  * 2. request an LEB with more dirty space, which will force
 775                  *    'ubifs_find_dirty_leb()' to start scanning the lprops
 776                  *    table, instead of just picking one from the heap
 777                  *    (previously it already picked the dirtiest LEB).
 778                  */
 779                 if (i < SOFT_LEBS_LIMIT) {
 780                         dbg_gc("try again");
 781                         continue;
 782                 }
 783
 784                 min_space <<= 1;
 785                 if (min_space > c->dark_wm)
 786                         min_space = c->dark_wm;
 787                 dbg_gc("set min. space to %d", min_space);
 788         }
 789
 790         if (ret == -ENOSPC && !list_empty(&c->idx_gc)) {
 791                 dbg_gc("no space, some index LEBs GC'ed, -EAGAIN");
 792                 ubifs_commit_required(c);
 793                 ret = -EAGAIN;
 794         }
 795
 796         err = ubifs_wbuf_sync_nolock(wbuf);
 797         if (!err)
 798                 err = ubifs_leb_unmap(c, c->gc_lnum);
 799         if (err) {
 800                 ret = err;
 801                 goto out;
 802         }
 803 out_unlock:
 804         mutex_unlock(&wbuf->io_mutex);
 805         return ret;
 806
 807 out:
 808         ubifs_assert(ret < 0);
 809         ubifs_assert(ret != -ENOSPC && ret != -EAGAIN);
 810         ubifs_wbuf_sync_nolock(wbuf);
 811         ubifs_ro_mode(c, ret);
 812         mutex_unlock(&wbuf->io_mutex);
 813         ubifs_return_leb(c, lp.lnum);
 814         return ret;
 815 }
 816
 817 /**
 818  * ubifs_gc_start_commit - garbage collection at start of commit.
 819  * @c: UBIFS file-system description object
 820  *
 821  * If a LEB has only dirty and free space, then we may safely unmap it and make
 822  * it free.  Note, we cannot do this with indexing LEBs because dirty space may
 823  * correspond index nodes that are required for recovery.  In that case, the
 824  * LEB cannot be unmapped until after the next commit.
 825  *
 826  * This function returns %0 upon success and a negative error code upon failure.
 827  */
 828 int ubifs_gc_start_commit(struct ubifs_info *c)
 829 {
 830         struct ubifs_gced_idx_leb *idx_gc;
 831         const struct ubifs_lprops *lp;
 832         int err = 0, flags;
 833
 834         ubifs_get_lprops(c);
 835
 836         /*
 837          * Unmap (non-index) freeable LEBs. Note that recovery requires that all
 838          * wbufs are sync'd before this, which is done in 'do_commit()'.
 839          */
 840         while (1) {
 841                 lp = ubifs_fast_find_freeable(c);
 842                 if (IS_ERR(lp)) {
 843                         err = PTR_ERR(lp);
 844                         goto out;
 845                 }
 846                 if (!lp)
 847                         break;
 848                 ubifs_assert(!(lp->flags & LPROPS_TAKEN));
 849                 ubifs_assert(!(lp->flags & LPROPS_INDEX));
 850                 err = ubifs_leb_unmap(c, lp->lnum);
 851                 if (err)
 852                         goto out;
 853                 lp = ubifs_change_lp(c, lp, c->leb_size, 0, lp->flags, 0);
 854                 if (IS_ERR(lp)) {
 855                         err = PTR_ERR(lp);
 856                         goto out;
 857                 }
 858                 ubifs_assert(!(lp->flags & LPROPS_TAKEN));
 859                 ubifs_assert(!(lp->flags & LPROPS_INDEX));
 860         }
 861
 862         /* Mark GC'd index LEBs OK to unmap after this commit finishes */
 863         list_for_each_entry(idx_gc, &c->idx_gc, list)
 864                 idx_gc->unmap = 1;
 865
 866         /* Record index freeable LEBs for unmapping after commit */
 867         while (1) {
 868                 lp = ubifs_fast_find_frdi_idx(c);
 869                 if (IS_ERR(lp)) {
 870                         err = PTR_ERR(lp);
 871                         goto out;
 872                 }
 873                 if (!lp)
 874                         break;
 875                 idx_gc = kmalloc(sizeof(struct ubifs_gced_idx_leb), GFP_NOFS);
 876                 if (!idx_gc) {
 877                         err = -ENOMEM;
 878                         goto out;
 879                 }
 880                 ubifs_assert(!(lp->flags & LPROPS_TAKEN));
 881                 ubifs_assert(lp->flags & LPROPS_INDEX);
 882                 /* Don't release the LEB until after the next commit */
 883                 flags = (lp->flags | LPROPS_TAKEN) ^ LPROPS_INDEX;
 884                 lp = ubifs_change_lp(c, lp, c->leb_size, 0, flags, 1);
 885                 if (IS_ERR(lp)) {
 886                         err = PTR_ERR(lp);
 887                         kfree(idx_gc);
 888                         goto out;
 889                 }
 890                 ubifs_assert(lp->flags & LPROPS_TAKEN);
 891                 ubifs_assert(!(lp->flags & LPROPS_INDEX));
 892                 idx_gc->lnum = lp->lnum;
 893                 idx_gc->unmap = 1;
 894                 list_add(&idx_gc->list, &c->idx_gc);
 895         }
 896 out:
 897         ubifs_release_lprops(c);
 898         return err;
 899 }
 900
 901 /**
 902  * ubifs_gc_end_commit - garbage collection at end of commit.
 903  * @c: UBIFS file-system description object
 904  *
 905  * This function completes out-of-place garbage collection of index LEBs.
 906  */
 907 int ubifs_gc_end_commit(struct ubifs_info *c)
 908 {
 909         struct ubifs_gced_idx_leb *idx_gc, *tmp;
 910         struct ubifs_wbuf *wbuf;
 911         int err = 0;
 912
 913         wbuf = &c->jheads[GCHD].wbuf;
 914         mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
 915         list_for_each_entry_safe(idx_gc, tmp, &c->idx_gc, list)
 916                 if (idx_gc->unmap) {
 917                         dbg_gc("LEB %d", idx_gc->lnum);
 918                         err = ubifs_leb_unmap(c, idx_gc->lnum);
 919                         if (err)
 920                                 goto out;
 921                         err = ubifs_change_one_lp(c, idx_gc->lnum, LPROPS_NC,
 922                                           LPROPS_NC, 0, LPROPS_TAKEN, -1);
 923                         if (err)
 924                                 goto out;
 925                         list_del(&idx_gc->list);
 926                         kfree(idx_gc);
 927                 }
 928 out:
 929         mutex_unlock(&wbuf->io_mutex);
 930         return err;
 931 }
 932
 933 /**
 934  * ubifs_destroy_idx_gc - destroy idx_gc list.
 935  * @c: UBIFS file-system description object
 936  *
 937  * This function destroys the @c->idx_gc list. It is called when unmounting
 938  * so locks are not needed. Returns zero in case of success and a negative
 939  * error code in case of failure.
 940  */
 941 void ubifs_destroy_idx_gc(struct ubifs_info *c)
 942 {
 943         while (!list_empty(&c->idx_gc)) {
 944                 struct ubifs_gced_idx_leb *idx_gc;
 945
 946                 idx_gc = list_entry(c->idx_gc.next, struct ubifs_gced_idx_leb,
 947                                     list);
 948                 c->idx_gc_cnt -= 1;
 949                 list_del(&idx_gc->list);
 950                 kfree(idx_gc);
 951         }
 952 }
 953
 954 /**
 955  * ubifs_get_idx_gc_leb - get a LEB from GC'd index LEB list.
 956  * @c: UBIFS file-system description object
 957  *
 958  * Called during start commit so locks are not needed.
 959  */
 960 int ubifs_get_idx_gc_leb(struct ubifs_info *c)
 961 {
 962         struct ubifs_gced_idx_leb *idx_gc;
 963         int lnum;
 964
 965         if (list_empty(&c->idx_gc))
 966                 return -ENOSPC;
 967         idx_gc = list_entry(c->idx_gc.next, struct ubifs_gced_idx_leb, list);
 968         lnum = idx_gc->lnum;
 969         /* c->idx_gc_cnt is updated by the caller when lprops are updated */
 970         list_del(&idx_gc->list);
 971         kfree(idx_gc);
 972         return lnum;
 973 }