fs/ubifs/orphan.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  * Author: Adrian Hunter
  20  */
  21
  22 #include "ubifs.h"
  23
  24 /*
  25  * An orphan is an inode number whose inode node has been committed to the index
  26  * with a link count of zero. That happens when an open file is deleted
  27  * (unlinked) and then a commit is run. In the normal course of events the inode
  28  * would be deleted when the file is closed. However in the case of an unclean
  29  * unmount, orphans need to be accounted for. After an unclean unmount, the
  30  * orphans' inodes must be deleted which means either scanning the entire index
  31  * looking for them, or keeping a list on flash somewhere. This unit implements
  32  * the latter approach.
  33  *
  34  * The orphan area is a fixed number of LEBs situated between the LPT area and
  35  * the main area. The number of orphan area LEBs is specified when the file
  36  * system is created. The minimum number is 1. The size of the orphan area
  37  * should be so that it can hold the maximum number of orphans that are expected
  38  * to ever exist at one time.
  39  *
  40  * The number of orphans that can fit in a LEB is:
  41  *
  42  *         (c->leb_size - UBIFS_ORPH_NODE_SZ) / sizeof(__le64)
  43  *
  44  * For example: a 15872 byte LEB can fit 1980 orphans so 1 LEB may be enough.
  45  *
  46  * Orphans are accumulated in a rb-tree. When an inode's link count drops to
  47  * zero, the inode number is added to the rb-tree. It is removed from the tree
  48  * when the inode is deleted.  Any new orphans that are in the orphan tree when
  49  * the commit is run, are written to the orphan area in 1 or more orphan nodes.
  50  * If the orphan area is full, it is consolidated to make space.  There is
  51  * always enough space because validation prevents the user from creating more
  52  * than the maximum number of orphans allowed.
  53  */
  54
  55 static int dbg_check_orphans(struct ubifs_info *c);
  56
  57 /**
  58  * ubifs_add_orphan - add an orphan.
  59  * @c: UBIFS file-system description object
  60  * @inum: orphan inode number
  61  *
  62  * Add an orphan. This function is called when an inodes link count drops to
  63  * zero.
  64  */
  65 int ubifs_add_orphan(struct ubifs_info *c, ino_t inum)
  66 {
  67         struct ubifs_orphan *orphan, *o;
  68         struct rb_node **p, *parent = NULL;
  69
  70         orphan = kzalloc(sizeof(struct ubifs_orphan), GFP_NOFS);
  71         if (!orphan)
  72                 return -ENOMEM;
  73         orphan->inum = inum;
  74         orphan->new = 1;
  75
  76         spin_lock(&c->orphan_lock);
  77         if (c->tot_orphans >= c->max_orphans) {
  78                 spin_unlock(&c->orphan_lock);
  79                 kfree(orphan);
  80                 return -ENFILE;
  81         }
  82         p = &c->orph_tree.rb_node;
  83         while (*p) {
  84                 parent = *p;
  85                 o = rb_entry(parent, struct ubifs_orphan, rb);
  86                 if (inum < o->inum)
  87                         p = &(*p)->rb_left;
  88                 else if (inum > o->inum)
  89                         p = &(*p)->rb_right;
  90                 else {
  91                         ubifs_err("orphaned twice");
  92                         spin_unlock(&c->orphan_lock);
  93                         kfree(orphan);
  94                         return 0;
  95                 }
  96         }
  97         c->tot_orphans += 1;
  98         c->new_orphans += 1;
  99         rb_link_node(&orphan->rb, parent, p);
 100         rb_insert_color(&orphan->rb, &c->orph_tree);
 101         list_add_tail(&orphan->list, &c->orph_list);
 102         list_add_tail(&orphan->new_list, &c->orph_new);
 103         spin_unlock(&c->orphan_lock);
 104         dbg_gen("ino %lu", (unsigned long)inum);
 105         return 0;
 106 }
 107
 108 /**
 109  * ubifs_delete_orphan - delete an orphan.
 110  * @c: UBIFS file-system description object
 111  * @inum: orphan inode number
 112  *
 113  * Delete an orphan. This function is called when an inode is deleted.
 114  */
 115 void ubifs_delete_orphan(struct ubifs_info *c, ino_t inum)
 116 {
 117         struct ubifs_orphan *o;
 118         struct rb_node *p;
 119
 120         spin_lock(&c->orphan_lock);
 121         p = c->orph_tree.rb_node;
 122         while (p) {
 123                 o = rb_entry(p, struct ubifs_orphan, rb);
 124                 if (inum < o->inum)
 125                         p = p->rb_left;
 126                 else if (inum > o->inum)
 127                         p = p->rb_right;
 128                 else {
 129                         if (o->del) {
 130                                 spin_unlock(&c->orphan_lock);
 131                                 dbg_gen("deleted twice ino %lu",
 132                                         (unsigned long)inum);
 133                                 return;
 134                         }
 135                         if (o->cnext) {
 136                                 o->del = 1;
 137                                 o->dnext = c->orph_dnext;
 138                                 c->orph_dnext = o;
 139                                 spin_unlock(&c->orphan_lock);
 140                                 dbg_gen("delete later ino %lu",
 141                                         (unsigned long)inum);
 142                                 return;
 143                         }
 144                         rb_erase(p, &c->orph_tree);
 145                         list_del(&o->list);
 146                         c->tot_orphans -= 1;
 147                         if (o->new) {
 148                                 list_del(&o->new_list);
 149                                 c->new_orphans -= 1;
 150                         }
 151                         spin_unlock(&c->orphan_lock);
 152                         kfree(o);
 153                         dbg_gen("inum %lu", (unsigned long)inum);
 154                         return;
 155                 }
 156         }
 157         spin_unlock(&c->orphan_lock);
 158         ubifs_err("missing orphan ino %lu", (unsigned long)inum);
 159         dump_stack();
 160 }
 161
 162 /**
 163  * ubifs_orphan_start_commit - start commit of orphans.
 164  * @c: UBIFS file-system description object
 165  *
 166  * Start commit of orphans.
 167  */
 168 int ubifs_orphan_start_commit(struct ubifs_info *c)
 169 {
 170         struct ubifs_orphan *orphan, **last;
 171
 172         spin_lock(&c->orphan_lock);
 173         last = &c->orph_cnext;
 174         list_for_each_entry(orphan, &c->orph_new, new_list) {
 175                 ubifs_assert(orphan->new);
 176                 orphan->new = 0;
 177                 *last = orphan;
 178                 last = &orphan->cnext;
 179         }
 180         *last = orphan->cnext;
 181         c->cmt_orphans = c->new_orphans;
 182         c->new_orphans = 0;
 183         dbg_cmt("%d orphans to commit", c->cmt_orphans);
 184         INIT_LIST_HEAD(&c->orph_new);
 185         if (c->tot_orphans == 0)
 186                 c->no_orphs = 1;
 187         else
 188                 c->no_orphs = 0;
 189         spin_unlock(&c->orphan_lock);
 190         return 0;
 191 }
 192
 193 /**
 194  * avail_orphs - calculate available space.
 195  * @c: UBIFS file-system description object
 196  *
 197  * This function returns the number of orphans that can be written in the
 198  * available space.
 199  */
 200 static int avail_orphs(struct ubifs_info *c)
 201 {
 202         int avail_lebs, avail, gap;
 203
 204         avail_lebs = c->orph_lebs - (c->ohead_lnum - c->orph_first) - 1;
 205         avail = avail_lebs *
 206                ((c->leb_size - UBIFS_ORPH_NODE_SZ) / sizeof(__le64));
 207         gap = c->leb_size - c->ohead_offs;
 208         if (gap >= UBIFS_ORPH_NODE_SZ + sizeof(__le64))
 209                 avail += (gap - UBIFS_ORPH_NODE_SZ) / sizeof(__le64);
 210         return avail;
 211 }
 212
 213 /**
 214  * tot_avail_orphs - calculate total space.
 215  * @c: UBIFS file-system description object
 216  *
 217  * This function returns the number of orphans that can be written in half
 218  * the total space. That leaves half the space for adding new orphans.
 219  */
 220 static int tot_avail_orphs(struct ubifs_info *c)
 221 {
 222         int avail_lebs, avail;
 223
 224         avail_lebs = c->orph_lebs;
 225         avail = avail_lebs *
 226                ((c->leb_size - UBIFS_ORPH_NODE_SZ) / sizeof(__le64));
 227         return avail / 2;
 228 }
 229
 230 /**
 231  * do_write_orph_node - write a node to the orphan head.
 232  * @c: UBIFS file-system description object
 233  * @len: length of node
 234  * @atomic: write atomically
 235  *
 236  * This function writes a node to the orphan head from the orphan buffer. If
 237  * %atomic is not zero, then the write is done atomically. On success, %0 is
 238  * returned, otherwise a negative error code is returned.
 239  */
 240 static int do_write_orph_node(struct ubifs_info *c, int len, int atomic)
 241 {
 242         int err = 0;
 243
 244         if (atomic) {
 245                 ubifs_assert(c->ohead_offs == 0);
 246                 ubifs_prepare_node(c, c->orph_buf, len, 1);
 247                 len = ALIGN(len, c->min_io_size);
 248                 err = ubifs_leb_change(c, c->ohead_lnum, c->orph_buf, len);
 249         } else {
 250                 if (c->ohead_offs == 0) {
 251                         /* Ensure LEB has been unmapped */
 252                         err = ubifs_leb_unmap(c, c->ohead_lnum);
 253                         if (err)
 254                                 return err;
 255                 }
 256                 err = ubifs_write_node(c, c->orph_buf, len, c->ohead_lnum,
 257                                        c->ohead_offs);
 258         }
 259         return err;
 260 }
 261
 262 /**
 263  * write_orph_node - write an orphan node.
 264  * @c: UBIFS file-system description object
 265  * @atomic: write atomically
 266  *
 267  * This function builds an orphan node from the cnext list and writes it to the
 268  * orphan head. On success, %0 is returned, otherwise a negative error code
 269  * is returned.
 270  */
 271 static int write_orph_node(struct ubifs_info *c, int atomic)
 272 {
 273         struct ubifs_orphan *orphan, *cnext;
 274         struct ubifs_orph_node *orph;
 275         int gap, err, len, cnt, i;
 276
 277         ubifs_assert(c->cmt_orphans > 0);
 278         gap = c->leb_size - c->ohead_offs;
 279         if (gap < UBIFS_ORPH_NODE_SZ + sizeof(__le64)) {
 280                 c->ohead_lnum += 1;
 281                 c->ohead_offs = 0;
 282                 gap = c->leb_size;
 283                 if (c->ohead_lnum > c->orph_last) {
 284                         /*
 285                          * We limit the number of orphans so that this should
 286                          * never happen.
 287                          */
 288                         ubifs_err("out of space in orphan area");
 289                         return -EINVAL;
 290                 }
 291         }
 292         cnt = (gap - UBIFS_ORPH_NODE_SZ) / sizeof(__le64);
 293         if (cnt > c->cmt_orphans)
 294                 cnt = c->cmt_orphans;
 295         len = UBIFS_ORPH_NODE_SZ + cnt * sizeof(__le64);
 296         ubifs_assert(c->orph_buf);
 297         orph = c->orph_buf;
 298         orph->ch.node_type = UBIFS_ORPH_NODE;
 299         spin_lock(&c->orphan_lock);
 300         cnext = c->orph_cnext;
 301         for (i = 0; i < cnt; i++) {
 302                 orphan = cnext;
 303                 orph->inos[i] = cpu_to_le64(orphan->inum);
 304                 cnext = orphan->cnext;
 305                 orphan->cnext = NULL;
 306         }
 307         c->orph_cnext = cnext;
 308         c->cmt_orphans -= cnt;
 309         spin_unlock(&c->orphan_lock);
 310         if (c->cmt_orphans)
 311                 orph->cmt_no = cpu_to_le64(c->cmt_no);
 312         else
 313                 /* Mark the last node of the commit */
 314                 orph->cmt_no = cpu_to_le64((c->cmt_no) | (1ULL << 63));
 315         ubifs_assert(c->ohead_offs + len <= c->leb_size);
 316         ubifs_assert(c->ohead_lnum >= c->orph_first);
 317         ubifs_assert(c->ohead_lnum <= c->orph_last);
 318         err = do_write_orph_node(c, len, atomic);
 319         c->ohead_offs += ALIGN(len, c->min_io_size);
 320         c->ohead_offs = ALIGN(c->ohead_offs, 8);
 321         return err;
 322 }
 323
 324 /**
 325  * write_orph_nodes - write orphan nodes until there are no more to commit.
 326  * @c: UBIFS file-system description object
 327  * @atomic: write atomically
 328  *
 329  * This function writes orphan nodes for all the orphans to commit. On success,
 330  * %0 is returned, otherwise a negative error code is returned.
 331  */
 332 static int write_orph_nodes(struct ubifs_info *c, int atomic)
 333 {
 334         int err;
 335
 336         while (c->cmt_orphans > 0) {
 337                 err = write_orph_node(c, atomic);
 338                 if (err)
 339                         return err;
 340         }
 341         if (atomic) {
 342                 int lnum;
 343
 344                 /* Unmap any unused LEBs after consolidation */
 345                 lnum = c->ohead_lnum + 1;
 346                 for (lnum = c->ohead_lnum + 1; lnum <= c->orph_last; lnum++) {
 347                         err = ubifs_leb_unmap(c, lnum);
 348                         if (err)
 349                                 return err;
 350                 }
 351         }
 352         return 0;
 353 }
 354
 355 /**
 356  * consolidate - consolidate the orphan area.
 357  * @c: UBIFS file-system description object
 358  *
 359  * This function enables consolidation by putting all the orphans into the list
 360  * to commit. The list is in the order that the orphans were added, and the
 361  * LEBs are written atomically in order, so at no time can orphans be lost by
 362  * an unclean unmount.
 363  *
 364  * This function returns %0 on success and a negative error code on failure.
 365  */
 366 static int consolidate(struct ubifs_info *c)
 367 {
 368         int tot_avail = tot_avail_orphs(c), err = 0;
 369
 370         spin_lock(&c->orphan_lock);
 371         dbg_cmt("there is space for %d orphans and there are %d",
 372                 tot_avail, c->tot_orphans);
 373         if (c->tot_orphans - c->new_orphans <= tot_avail) {
 374                 struct ubifs_orphan *orphan, **last;
 375                 int cnt = 0;
 376
 377                 /* Change the cnext list to include all non-new orphans */
 378                 last = &c->orph_cnext;
 379                 list_for_each_entry(orphan, &c->orph_list, list) {
 380                         if (orphan->new)
 381                                 continue;
 382                         *last = orphan;
 383                         last = &orphan->cnext;
 384                         cnt += 1;
 385                 }
 386                 *last = orphan->cnext;
 387                 ubifs_assert(cnt == c->tot_orphans - c->new_orphans);
 388                 c->cmt_orphans = cnt;
 389                 c->ohead_lnum = c->orph_first;
 390                 c->ohead_offs = 0;
 391         } else {
 392                 /*
 393                  * We limit the number of orphans so that this should
 394                  * never happen.
 395                  */
 396                 ubifs_err("out of space in orphan area");
 397                 err = -EINVAL;
 398         }
 399         spin_unlock(&c->orphan_lock);
 400         return err;
 401 }
 402
 403 /**
 404  * commit_orphans - commit orphans.
 405  * @c: UBIFS file-system description object
 406  *
 407  * This function commits orphans to flash. On success, %0 is returned,
 408  * otherwise a negative error code is returned.
 409  */
 410 static int commit_orphans(struct ubifs_info *c)
 411 {
 412         int avail, atomic = 0, err;
 413
 414         ubifs_assert(c->cmt_orphans > 0);
 415         avail = avail_orphs(c);
 416         if (avail < c->cmt_orphans) {
 417                 /* Not enough space to write new orphans, so consolidate */
 418                 err = consolidate(c);
 419                 if (err)
 420                         return err;
 421                 atomic = 1;
 422         }
 423         err = write_orph_nodes(c, atomic);
 424         return err;
 425 }
 426
 427 /**
 428  * erase_deleted - erase the orphans marked for deletion.
 429  * @c: UBIFS file-system description object
 430  *
 431  * During commit, the orphans being committed cannot be deleted, so they are
 432  * marked for deletion and deleted by this function. Also, the recovery
 433  * adds killed orphans to the deletion list, and therefore they are deleted
 434  * here too.
 435  */
 436 static void erase_deleted(struct ubifs_info *c)
 437 {
 438         struct ubifs_orphan *orphan, *dnext;
 439
 440         spin_lock(&c->orphan_lock);
 441         dnext = c->orph_dnext;
 442         while (dnext) {
 443                 orphan = dnext;
 444                 dnext = orphan->dnext;
 445                 ubifs_assert(!orphan->new);
 446                 ubifs_assert(orphan->del);
 447                 rb_erase(&orphan->rb, &c->orph_tree);
 448                 list_del(&orphan->list);
 449                 c->tot_orphans -= 1;
 450                 dbg_gen("deleting orphan ino %lu", (unsigned long)orphan->inum);
 451                 kfree(orphan);
 452         }
 453         c->orph_dnext = NULL;
 454         spin_unlock(&c->orphan_lock);
 455 }
 456
 457 /**
 458  * ubifs_orphan_end_commit - end commit of orphans.
 459  * @c: UBIFS file-system description object
 460  *
 461  * End commit of orphans.
 462  */
 463 int ubifs_orphan_end_commit(struct ubifs_info *c)
 464 {
 465         int err;
 466
 467         if (c->cmt_orphans != 0) {
 468                 err = commit_orphans(c);
 469                 if (err)
 470                         return err;
 471         }
 472         erase_deleted(c);
 473         err = dbg_check_orphans(c);
 474         return err;
 475 }
 476
 477 /**
 478  * ubifs_clear_orphans - erase all LEBs used for orphans.
 479  * @c: UBIFS file-system description object
 480  *
 481  * If recovery is not required, then the orphans from the previous session
 482  * are not needed. This function locates the LEBs used to record
 483  * orphans, and un-maps them.
 484  */
 485 int ubifs_clear_orphans(struct ubifs_info *c)
 486 {
 487         int lnum, err;
 488
 489         for (lnum = c->orph_first; lnum <= c->orph_last; lnum++) {
 490                 err = ubifs_leb_unmap(c, lnum);
 491                 if (err)
 492                         return err;
 493         }
 494         c->ohead_lnum = c->orph_first;
 495         c->ohead_offs = 0;
 496         return 0;
 497 }
 498
 499 /**
 500  * insert_dead_orphan - insert an orphan.
 501  * @c: UBIFS file-system description object
 502  * @inum: orphan inode number
 503  *
 504  * This function is a helper to the 'do_kill_orphans()' function. The orphan
 505  * must be kept until the next commit, so it is added to the rb-tree and the
 506  * deletion list.
 507  */
 508 static int insert_dead_orphan(struct ubifs_info *c, ino_t inum)
 509 {
 510         struct ubifs_orphan *orphan, *o;
 511         struct rb_node **p, *parent = NULL;
 512
 513         orphan = kzalloc(sizeof(struct ubifs_orphan), GFP_KERNEL);
 514         if (!orphan)
 515                 return -ENOMEM;
 516         orphan->inum = inum;
 517
 518         p = &c->orph_tree.rb_node;
 519         while (*p) {
 520                 parent = *p;
 521                 o = rb_entry(parent, struct ubifs_orphan, rb);
 522                 if (inum < o->inum)
 523                         p = &(*p)->rb_left;
 524                 else if (inum > o->inum)
 525                         p = &(*p)->rb_right;
 526                 else {
 527                         /* Already added - no problem */
 528                         kfree(orphan);
 529                         return 0;
 530                 }
 531         }
 532         c->tot_orphans += 1;
 533         rb_link_node(&orphan->rb, parent, p);
 534         rb_insert_color(&orphan->rb, &c->orph_tree);
 535         list_add_tail(&orphan->list, &c->orph_list);
 536         orphan->del = 1;
 537         orphan->dnext = c->orph_dnext;
 538         c->orph_dnext = orphan;
 539         dbg_mnt("ino %lu, new %d, tot %d", (unsigned long)inum,
 540                 c->new_orphans, c->tot_orphans);
 541         return 0;
 542 }
 543
 544 /**
 545  * do_kill_orphans - remove orphan inodes from the index.
 546  * @c: UBIFS file-system description object
 547  * @sleb: scanned LEB
 548  * @last_cmt_no: cmt_no of last orphan node read is passed and returned here
 549  * @outofdate: whether the LEB is out of date is returned here
 550  * @last_flagged: whether the end orphan node is encountered
 551  *
 552  * This function is a helper to the 'kill_orphans()' function. It goes through
 553  * every orphan node in a LEB and for every inode number recorded, removes
 554  * all keys for that inode from the TNC.
 555  */
 556 static int do_kill_orphans(struct ubifs_info *c, struct ubifs_scan_leb *sleb,
 557                            unsigned long long *last_cmt_no, int *outofdate,
 558                            int *last_flagged)
 559 {
 560         struct ubifs_scan_node *snod;
 561         struct ubifs_orph_node *orph;
 562         unsigned long long cmt_no;
 563         ino_t inum;
 564         int i, n, err, first = 1;
 565
 566         list_for_each_entry(snod, &sleb->nodes, list) {
 567                 if (snod->type != UBIFS_ORPH_NODE) {
 568                         ubifs_err("invalid node type %d in orphan area at %d:%d",
 569                                   snod->type, sleb->lnum, snod->offs);
 570                         ubifs_dump_node(c, snod->node);
 571                         return -EINVAL;
 572                 }
 573
 574                 orph = snod->node;
 575
 576                 /* Check commit number */
 577                 cmt_no = le64_to_cpu(orph->cmt_no) & LLONG_MAX;
 578                 /*
 579                  * The commit number on the master node may be less, because
 580                  * of a failed commit. If there are several failed commits in a
 581                  * row, the commit number written on orphan nodes will continue
 582                  * to increase (because the commit number is adjusted here) even
 583                  * though the commit number on the master node stays the same
 584                  * because the master node has not been re-written.
 585                  */
 586                 if (cmt_no > c->cmt_no)
 587                         c->cmt_no = cmt_no;
 588                 if (cmt_no < *last_cmt_no && *last_flagged) {
 589                         /*
 590                          * The last orphan node had a higher commit number and
 591                          * was flagged as the last written for that commit
 592                          * number. That makes this orphan node, out of date.
 593                          */
 594                         if (!first) {
 595                                 ubifs_err("out of order commit number %llu in orphan node at %d:%d",
 596                                           cmt_no, sleb->lnum, snod->offs);
 597                                 ubifs_dump_node(c, snod->node);
 598                                 return -EINVAL;
 599                         }
 600                         dbg_rcvry("out of date LEB %d", sleb->lnum);
 601                         *outofdate = 1;
 602                         return 0;
 603                 }
 604
 605                 if (first)
 606                         first = 0;
 607
 608                 n = (le32_to_cpu(orph->ch.len) - UBIFS_ORPH_NODE_SZ) >> 3;
 609                 for (i = 0; i < n; i++) {
 610                         inum = le64_to_cpu(orph->inos[i]);
 611                         dbg_rcvry("deleting orphaned inode %lu",
 612                                   (unsigned long)inum);
 613                         err = ubifs_tnc_remove_ino(c, inum);
 614                         if (err)
 615                                 return err;
 616                         err = insert_dead_orphan(c, inum);
 617                         if (err)
 618                                 return err;
 619                 }
 620
 621                 *last_cmt_no = cmt_no;
 622                 if (le64_to_cpu(orph->cmt_no) & (1ULL << 63)) {
 623                         dbg_rcvry("last orph node for commit %llu at %d:%d",
 624                                   cmt_no, sleb->lnum, snod->offs);
 625                         *last_flagged = 1;
 626                 } else
 627                         *last_flagged = 0;
 628         }
 629
 630         return 0;
 631 }
 632
 633 /**
 634  * kill_orphans - remove all orphan inodes from the index.
 635  * @c: UBIFS file-system description object
 636  *
 637  * If recovery is required, then orphan inodes recorded during the previous
 638  * session (which ended with an unclean unmount) must be deleted from the index.
 639  * This is done by updating the TNC, but since the index is not updated until
 640  * the next commit, the LEBs where the orphan information is recorded are not
 641  * erased until the next commit.
 642  */
 643 static int kill_orphans(struct ubifs_info *c)
 644 {
 645         unsigned long long last_cmt_no = 0;
 646         int lnum, err = 0, outofdate = 0, last_flagged = 0;
 647
 648         c->ohead_lnum = c->orph_first;
 649         c->ohead_offs = 0;
 650         /* Check no-orphans flag and skip this if no orphans */
 651         if (c->no_orphs) {
 652                 dbg_rcvry("no orphans");
 653                 return 0;
 654         }
 655         /*
 656          * Orph nodes always start at c->orph_first and are written to each
 657          * successive LEB in turn. Generally unused LEBs will have been unmapped
 658          * but may contain out of date orphan nodes if the unmap didn't go
 659          * through. In addition, the last orphan node written for each commit is
 660          * marked (top bit of orph->cmt_no is set to 1). It is possible that
 661          * there are orphan nodes from the next commit (i.e. the commit did not
 662          * complete successfully). In that case, no orphans will have been lost
 663          * due to the way that orphans are written, and any orphans added will
 664          * be valid orphans anyway and so can be deleted.
 665          */
 666         for (lnum = c->orph_first; lnum <= c->orph_last; lnum++) {
 667                 struct ubifs_scan_leb *sleb;
 668
 669                 dbg_rcvry("LEB %d", lnum);
 670                 sleb = ubifs_scan(c, lnum, 0, c->sbuf, 1);
 671                 if (IS_ERR(sleb)) {
 672                         if (PTR_ERR(sleb) == -EUCLEAN)
 673                                 sleb = ubifs_recover_leb(c, lnum, 0,
 674                                                          c->sbuf, -1);
 675                         if (IS_ERR(sleb)) {
 676                                 err = PTR_ERR(sleb);
 677                                 break;
 678                         }
 679                 }
 680                 err = do_kill_orphans(c, sleb, &last_cmt_no, &outofdate,
 681                                       &last_flagged);
 682                 if (err || outofdate) {
 683                         ubifs_scan_destroy(sleb);
 684                         break;
 685                 }
 686                 if (sleb->endpt) {
 687                         c->ohead_lnum = lnum;
 688                         c->ohead_offs = sleb->endpt;
 689                 }
 690                 ubifs_scan_destroy(sleb);
 691         }
 692         return err;
 693 }
 694
 695 /**
 696  * ubifs_mount_orphans - delete orphan inodes and erase LEBs that recorded them.
 697  * @c: UBIFS file-system description object
 698  * @unclean: indicates recovery from unclean unmount
 699  * @read_only: indicates read only mount
 700  *
 701  * This function is called when mounting to erase orphans from the previous
 702  * session. If UBIFS was not unmounted cleanly, then the inodes recorded as
 703  * orphans are deleted.
 704  */
 705 int ubifs_mount_orphans(struct ubifs_info *c, int unclean, int read_only)
 706 {
 707         int err = 0;
 708
 709         c->max_orphans = tot_avail_orphs(c);
 710
 711         if (!read_only) {
 712                 c->orph_buf = vmalloc(c->leb_size);
 713                 if (!c->orph_buf)
 714                         return -ENOMEM;
 715         }
 716
 717         if (unclean)
 718                 err = kill_orphans(c);
 719         else if (!read_only)
 720                 err = ubifs_clear_orphans(c);
 721
 722         return err;
 723 }
 724
 725 /*
 726  * Everything below is related to debugging.
 727  */
 728
 729 struct check_orphan {
 730         struct rb_node rb;
 731         ino_t inum;
 732 };
 733
 734 struct check_info {
 735         unsigned long last_ino;
 736         unsigned long tot_inos;
 737         unsigned long missing;
 738         unsigned long long leaf_cnt;
 739         struct ubifs_ino_node *node;
 740         struct rb_root root;
 741 };
 742
 743 static int dbg_find_orphan(struct ubifs_info *c, ino_t inum)
 744 {
 745         struct ubifs_orphan *o;
 746         struct rb_node *p;
 747
 748         spin_lock(&c->orphan_lock);
 749         p = c->orph_tree.rb_node;
 750         while (p) {
 751                 o = rb_entry(p, struct ubifs_orphan, rb);
 752                 if (inum < o->inum)
 753                         p = p->rb_left;
 754                 else if (inum > o->inum)
 755                         p = p->rb_right;
 756                 else {
 757                         spin_unlock(&c->orphan_lock);
 758                         return 1;
 759                 }
 760         }
 761         spin_unlock(&c->orphan_lock);
 762         return 0;
 763 }
 764
 765 static int dbg_ins_check_orphan(struct rb_root *root, ino_t inum)
 766 {
 767         struct check_orphan *orphan, *o;
 768         struct rb_node **p, *parent = NULL;
 769
 770         orphan = kzalloc(sizeof(struct check_orphan), GFP_NOFS);
 771         if (!orphan)
 772                 return -ENOMEM;
 773         orphan->inum = inum;
 774
 775         p = &root->rb_node;
 776         while (*p) {
 777                 parent = *p;
 778                 o = rb_entry(parent, struct check_orphan, rb);
 779                 if (inum < o->inum)
 780                         p = &(*p)->rb_left;
 781                 else if (inum > o->inum)
 782                         p = &(*p)->rb_right;
 783                 else {
 784                         kfree(orphan);
 785                         return 0;
 786                 }
 787         }
 788         rb_link_node(&orphan->rb, parent, p);
 789         rb_insert_color(&orphan->rb, root);
 790         return 0;
 791 }
 792
 793 static int dbg_find_check_orphan(struct rb_root *root, ino_t inum)
 794 {
 795         struct check_orphan *o;
 796         struct rb_node *p;
 797
 798         p = root->rb_node;
 799         while (p) {
 800                 o = rb_entry(p, struct check_orphan, rb);
 801                 if (inum < o->inum)
 802                         p = p->rb_left;
 803                 else if (inum > o->inum)
 804                         p = p->rb_right;
 805                 else
 806                         return 1;
 807         }
 808         return 0;
 809 }
 810
 811 static void dbg_free_check_tree(struct rb_root *root)
 812 {
 813         struct rb_node *this = root->rb_node;
 814         struct check_orphan *o;
 815
 816         while (this) {
 817                 if (this->rb_left) {
 818                         this = this->rb_left;
 819                         continue;
 820                 } else if (this->rb_right) {
 821                         this = this->rb_right;
 822                         continue;
 823                 }
 824                 o = rb_entry(this, struct check_orphan, rb);
 825                 this = rb_parent(this);
 826                 if (this) {
 827                         if (this->rb_left == &o->rb)
 828                                 this->rb_left = NULL;
 829                         else
 830                                 this->rb_right = NULL;
 831                 }
 832                 kfree(o);
 833         }
 834 }
 835
 836 static int dbg_orphan_check(struct ubifs_info *c, struct ubifs_zbranch *zbr,
 837                             void *priv)
 838 {
 839         struct check_info *ci = priv;
 840         ino_t inum;
 841         int err;
 842
 843         inum = key_inum(c, &zbr->key);
 844         if (inum != ci->last_ino) {
 845                 /* Lowest node type is the inode node, so it comes first */
 846                 if (key_type(c, &zbr->key) != UBIFS_INO_KEY)
 847                         ubifs_err("found orphan node ino %lu, type %d",
 848                                   (unsigned long)inum, key_type(c, &zbr->key));
 849                 ci->last_ino = inum;
 850                 ci->tot_inos += 1;
 851                 err = ubifs_tnc_read_node(c, zbr, ci->node);
 852                 if (err) {
 853                         ubifs_err("node read failed, error %d", err);
 854                         return err;
 855                 }
 856                 if (ci->node->nlink == 0)
 857                         /* Must be recorded as an orphan */
 858                         if (!dbg_find_check_orphan(&ci->root, inum) &&
 859                             !dbg_find_orphan(c, inum)) {
 860                                 ubifs_err("missing orphan, ino %lu",
 861                                           (unsigned long)inum);
 862                                 ci->missing += 1;
 863                         }
 864         }
 865         ci->leaf_cnt += 1;
 866         return 0;
 867 }
 868
 869 static int dbg_read_orphans(struct check_info *ci, struct ubifs_scan_leb *sleb)
 870 {
 871         struct ubifs_scan_node *snod;
 872         struct ubifs_orph_node *orph;
 873         ino_t inum;
 874         int i, n, err;
 875
 876         list_for_each_entry(snod, &sleb->nodes, list) {
 877                 cond_resched();
 878                 if (snod->type != UBIFS_ORPH_NODE)
 879                         continue;
 880                 orph = snod->node;
 881                 n = (le32_to_cpu(orph->ch.len) - UBIFS_ORPH_NODE_SZ) >> 3;
 882                 for (i = 0; i < n; i++) {
 883                         inum = le64_to_cpu(orph->inos[i]);
 884                         err = dbg_ins_check_orphan(&ci->root, inum);
 885                         if (err)
 886                                 return err;
 887                 }
 888         }
 889         return 0;
 890 }
 891
 892 static int dbg_scan_orphans(struct ubifs_info *c, struct check_info *ci)
 893 {
 894         int lnum, err = 0;
 895         void *buf;
 896
 897         /* Check no-orphans flag and skip this if no orphans */
 898         if (c->no_orphs)
 899                 return 0;
 900
 901         buf = __vmalloc(c->leb_size, GFP_NOFS, PAGE_KERNEL);
 902         if (!buf) {
 903                 ubifs_err("cannot allocate memory to check orphans");
 904                 return 0;
 905         }
 906
 907         for (lnum = c->orph_first; lnum <= c->orph_last; lnum++) {
 908                 struct ubifs_scan_leb *sleb;
 909
 910                 sleb = ubifs_scan(c, lnum, 0, buf, 0);
 911                 if (IS_ERR(sleb)) {
 912                         err = PTR_ERR(sleb);
 913                         break;
 914                 }
 915
 916                 err = dbg_read_orphans(ci, sleb);
 917                 ubifs_scan_destroy(sleb);
 918                 if (err)
 919                         break;
 920         }
 921
 922         vfree(buf);
 923         return err;
 924 }
 925
 926 static int dbg_check_orphans(struct ubifs_info *c)
 927 {
 928         struct check_info ci;
 929         int err;
 930
 931         if (!dbg_is_chk_orph(c))
 932                 return 0;
 933
 934         ci.last_ino = 0;
 935         ci.tot_inos = 0;
 936         ci.missing  = 0;
 937         ci.leaf_cnt = 0;
 938         ci.root = RB_ROOT;
 939         ci.node = kmalloc(UBIFS_MAX_INO_NODE_SZ, GFP_NOFS);
 940         if (!ci.node) {
 941                 ubifs_err("out of memory");
 942                 return -ENOMEM;
 943         }
 944
 945         err = dbg_scan_orphans(c, &ci);
 946         if (err)
 947                 goto out;
 948
 949         err = dbg_walk_index(c, &dbg_orphan_check, NULL, &ci);
 950         if (err) {
 951                 ubifs_err("cannot scan TNC, error %d", err);
 952                 goto out;
 953         }
 954
 955         if (ci.missing) {
 956                 ubifs_err("%lu missing orphan(s)", ci.missing);
 957                 err = -EINVAL;
 958                 goto out;
 959         }
 960
 961         dbg_cmt("last inode number is %lu", ci.last_ino);
 962         dbg_cmt("total number of inodes is %lu", ci.tot_inos);
 963         dbg_cmt("total number of leaf nodes is %llu", ci.leaf_cnt);
 964
 965 out:
 966         dbg_free_check_tree(&ci.root);
 967         kfree(ci.node);
 968         return err;
 969 }