UBIFS: harmonize znode flag helpers
[linux-3.10.git] / fs / ubifs / tnc_commit.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 /* This file implements TNC functions for committing */
24
25 #include "ubifs.h"
26
27 /**
28  * make_idx_node - make an index node for fill-the-gaps method of TNC commit.
29  * @c: UBIFS file-system description object
30  * @idx: buffer in which to place new index node
31  * @znode: znode from which to make new index node
32  * @lnum: LEB number where new index node will be written
33  * @offs: offset where new index node will be written
34  * @len: length of new index node
35  */
36 static int make_idx_node(struct ubifs_info *c, struct ubifs_idx_node *idx,
37                          struct ubifs_znode *znode, int lnum, int offs, int len)
38 {
39         struct ubifs_znode *zp;
40         int i, err;
41
42         /* Make index node */
43         idx->ch.node_type = UBIFS_IDX_NODE;
44         idx->child_cnt = cpu_to_le16(znode->child_cnt);
45         idx->level = cpu_to_le16(znode->level);
46         for (i = 0; i < znode->child_cnt; i++) {
47                 struct ubifs_branch *br = ubifs_idx_branch(c, idx, i);
48                 struct ubifs_zbranch *zbr = &znode->zbranch[i];
49
50                 key_write_idx(c, &zbr->key, &br->key);
51                 br->lnum = cpu_to_le32(zbr->lnum);
52                 br->offs = cpu_to_le32(zbr->offs);
53                 br->len = cpu_to_le32(zbr->len);
54                 if (!zbr->lnum || !zbr->len) {
55                         ubifs_err("bad ref in znode");
56                         dbg_dump_znode(c, znode);
57                         if (zbr->znode)
58                                 dbg_dump_znode(c, zbr->znode);
59                 }
60         }
61         ubifs_prepare_node(c, idx, len, 0);
62
63 #ifdef CONFIG_UBIFS_FS_DEBUG
64         znode->lnum = lnum;
65         znode->offs = offs;
66         znode->len = len;
67 #endif
68
69         err = insert_old_idx_znode(c, znode);
70
71         /* Update the parent */
72         zp = znode->parent;
73         if (zp) {
74                 struct ubifs_zbranch *zbr;
75
76                 zbr = &zp->zbranch[znode->iip];
77                 zbr->lnum = lnum;
78                 zbr->offs = offs;
79                 zbr->len = len;
80         } else {
81                 c->zroot.lnum = lnum;
82                 c->zroot.offs = offs;
83                 c->zroot.len = len;
84         }
85         c->calc_idx_sz += ALIGN(len, 8);
86
87         atomic_long_dec(&c->dirty_zn_cnt);
88
89         ubifs_assert(ubifs_zn_dirty(znode));
90         ubifs_assert(ubifs_zn_cow(znode));
91
92         __clear_bit(DIRTY_ZNODE, &znode->flags);
93         __clear_bit(COW_ZNODE, &znode->flags);
94
95         return err;
96 }
97
98 /**
99  * fill_gap - make index nodes in gaps in dirty index LEBs.
100  * @c: UBIFS file-system description object
101  * @lnum: LEB number that gap appears in
102  * @gap_start: offset of start of gap
103  * @gap_end: offset of end of gap
104  * @dirt: adds dirty space to this
105  *
106  * This function returns the number of index nodes written into the gap.
107  */
108 static int fill_gap(struct ubifs_info *c, int lnum, int gap_start, int gap_end,
109                     int *dirt)
110 {
111         int len, gap_remains, gap_pos, written, pad_len;
112
113         ubifs_assert((gap_start & 7) == 0);
114         ubifs_assert((gap_end & 7) == 0);
115         ubifs_assert(gap_end >= gap_start);
116
117         gap_remains = gap_end - gap_start;
118         if (!gap_remains)
119                 return 0;
120         gap_pos = gap_start;
121         written = 0;
122         while (c->enext) {
123                 len = ubifs_idx_node_sz(c, c->enext->child_cnt);
124                 if (len < gap_remains) {
125                         struct ubifs_znode *znode = c->enext;
126                         const int alen = ALIGN(len, 8);
127                         int err;
128
129                         ubifs_assert(alen <= gap_remains);
130                         err = make_idx_node(c, c->ileb_buf + gap_pos, znode,
131                                             lnum, gap_pos, len);
132                         if (err)
133                                 return err;
134                         gap_remains -= alen;
135                         gap_pos += alen;
136                         c->enext = znode->cnext;
137                         if (c->enext == c->cnext)
138                                 c->enext = NULL;
139                         written += 1;
140                 } else
141                         break;
142         }
143         if (gap_end == c->leb_size) {
144                 c->ileb_len = ALIGN(gap_pos, c->min_io_size);
145                 /* Pad to end of min_io_size */
146                 pad_len = c->ileb_len - gap_pos;
147         } else
148                 /* Pad to end of gap */
149                 pad_len = gap_remains;
150         dbg_gc("LEB %d:%d to %d len %d nodes written %d wasted bytes %d",
151                lnum, gap_start, gap_end, gap_end - gap_start, written, pad_len);
152         ubifs_pad(c, c->ileb_buf + gap_pos, pad_len);
153         *dirt += pad_len;
154         return written;
155 }
156
157 /**
158  * find_old_idx - find an index node obsoleted since the last commit start.
159  * @c: UBIFS file-system description object
160  * @lnum: LEB number of obsoleted index node
161  * @offs: offset of obsoleted index node
162  *
163  * Returns %1 if found and %0 otherwise.
164  */
165 static int find_old_idx(struct ubifs_info *c, int lnum, int offs)
166 {
167         struct ubifs_old_idx *o;
168         struct rb_node *p;
169
170         p = c->old_idx.rb_node;
171         while (p) {
172                 o = rb_entry(p, struct ubifs_old_idx, rb);
173                 if (lnum < o->lnum)
174                         p = p->rb_left;
175                 else if (lnum > o->lnum)
176                         p = p->rb_right;
177                 else if (offs < o->offs)
178                         p = p->rb_left;
179                 else if (offs > o->offs)
180                         p = p->rb_right;
181                 else
182                         return 1;
183         }
184         return 0;
185 }
186
187 /**
188  * is_idx_node_in_use - determine if an index node can be overwritten.
189  * @c: UBIFS file-system description object
190  * @key: key of index node
191  * @level: index node level
192  * @lnum: LEB number of index node
193  * @offs: offset of index node
194  *
195  * If @key / @lnum / @offs identify an index node that was not part of the old
196  * index, then this function returns %0 (obsolete).  Else if the index node was
197  * part of the old index but is now dirty %1 is returned, else if it is clean %2
198  * is returned. A negative error code is returned on failure.
199  */
200 static int is_idx_node_in_use(struct ubifs_info *c, union ubifs_key *key,
201                               int level, int lnum, int offs)
202 {
203         int ret;
204
205         ret = is_idx_node_in_tnc(c, key, level, lnum, offs);
206         if (ret < 0)
207                 return ret; /* Error code */
208         if (ret == 0)
209                 if (find_old_idx(c, lnum, offs))
210                         return 1;
211         return ret;
212 }
213
214 /**
215  * layout_leb_in_gaps - layout index nodes using in-the-gaps method.
216  * @c: UBIFS file-system description object
217  * @p: return LEB number here
218  *
219  * This function lays out new index nodes for dirty znodes using in-the-gaps
220  * method of TNC commit.
221  * This function merely puts the next znode into the next gap, making no attempt
222  * to try to maximise the number of znodes that fit.
223  * This function returns the number of index nodes written into the gaps, or a
224  * negative error code on failure.
225  */
226 static int layout_leb_in_gaps(struct ubifs_info *c, int *p)
227 {
228         struct ubifs_scan_leb *sleb;
229         struct ubifs_scan_node *snod;
230         int lnum, dirt = 0, gap_start, gap_end, err, written, tot_written;
231
232         tot_written = 0;
233         /* Get an index LEB with lots of obsolete index nodes */
234         lnum = ubifs_find_dirty_idx_leb(c);
235         if (lnum < 0)
236                 /*
237                  * There also may be dirt in the index head that could be
238                  * filled, however we do not check there at present.
239                  */
240                 return lnum; /* Error code */
241         *p = lnum;
242         dbg_gc("LEB %d", lnum);
243         /*
244          * Scan the index LEB.  We use the generic scan for this even though
245          * it is more comprehensive and less efficient than is needed for this
246          * purpose.
247          */
248         sleb = ubifs_scan(c, lnum, 0, c->ileb_buf, 0);
249         c->ileb_len = 0;
250         if (IS_ERR(sleb))
251                 return PTR_ERR(sleb);
252         gap_start = 0;
253         list_for_each_entry(snod, &sleb->nodes, list) {
254                 struct ubifs_idx_node *idx;
255                 int in_use, level;
256
257                 ubifs_assert(snod->type == UBIFS_IDX_NODE);
258                 idx = snod->node;
259                 key_read(c, ubifs_idx_key(c, idx), &snod->key);
260                 level = le16_to_cpu(idx->level);
261                 /* Determine if the index node is in use (not obsolete) */
262                 in_use = is_idx_node_in_use(c, &snod->key, level, lnum,
263                                             snod->offs);
264                 if (in_use < 0) {
265                         ubifs_scan_destroy(sleb);
266                         return in_use; /* Error code */
267                 }
268                 if (in_use) {
269                         if (in_use == 1)
270                                 dirt += ALIGN(snod->len, 8);
271                         /*
272                          * The obsolete index nodes form gaps that can be
273                          * overwritten.  This gap has ended because we have
274                          * found an index node that is still in use
275                          * i.e. not obsolete
276                          */
277                         gap_end = snod->offs;
278                         /* Try to fill gap */
279                         written = fill_gap(c, lnum, gap_start, gap_end, &dirt);
280                         if (written < 0) {
281                                 ubifs_scan_destroy(sleb);
282                                 return written; /* Error code */
283                         }
284                         tot_written += written;
285                         gap_start = ALIGN(snod->offs + snod->len, 8);
286                 }
287         }
288         ubifs_scan_destroy(sleb);
289         c->ileb_len = c->leb_size;
290         gap_end = c->leb_size;
291         /* Try to fill gap */
292         written = fill_gap(c, lnum, gap_start, gap_end, &dirt);
293         if (written < 0)
294                 return written; /* Error code */
295         tot_written += written;
296         if (tot_written == 0) {
297                 struct ubifs_lprops lp;
298
299                 dbg_gc("LEB %d wrote %d index nodes", lnum, tot_written);
300                 err = ubifs_read_one_lp(c, lnum, &lp);
301                 if (err)
302                         return err;
303                 if (lp.free == c->leb_size) {
304                         /*
305                          * We must have snatched this LEB from the idx_gc list
306                          * so we need to correct the free and dirty space.
307                          */
308                         err = ubifs_change_one_lp(c, lnum,
309                                                   c->leb_size - c->ileb_len,
310                                                   dirt, 0, 0, 0);
311                         if (err)
312                                 return err;
313                 }
314                 return 0;
315         }
316         err = ubifs_change_one_lp(c, lnum, c->leb_size - c->ileb_len, dirt,
317                                   0, 0, 0);
318         if (err)
319                 return err;
320         err = ubifs_leb_change(c, lnum, c->ileb_buf, c->ileb_len,
321                                UBI_SHORTTERM);
322         if (err)
323                 return err;
324         dbg_gc("LEB %d wrote %d index nodes", lnum, tot_written);
325         return tot_written;
326 }
327
328 /**
329  * get_leb_cnt - calculate the number of empty LEBs needed to commit.
330  * @c: UBIFS file-system description object
331  * @cnt: number of znodes to commit
332  *
333  * This function returns the number of empty LEBs needed to commit @cnt znodes
334  * to the current index head.  The number is not exact and may be more than
335  * needed.
336  */
337 static int get_leb_cnt(struct ubifs_info *c, int cnt)
338 {
339         int d;
340
341         /* Assume maximum index node size (i.e. overestimate space needed) */
342         cnt -= (c->leb_size - c->ihead_offs) / c->max_idx_node_sz;
343         if (cnt < 0)
344                 cnt = 0;
345         d = c->leb_size / c->max_idx_node_sz;
346         return DIV_ROUND_UP(cnt, d);
347 }
348
349 /**
350  * layout_in_gaps - in-the-gaps method of committing TNC.
351  * @c: UBIFS file-system description object
352  * @cnt: number of dirty znodes to commit.
353  *
354  * This function lays out new index nodes for dirty znodes using in-the-gaps
355  * method of TNC commit.
356  *
357  * This function returns %0 on success and a negative error code on failure.
358  */
359 static int layout_in_gaps(struct ubifs_info *c, int cnt)
360 {
361         int err, leb_needed_cnt, written, *p;
362
363         dbg_gc("%d znodes to write", cnt);
364
365         c->gap_lebs = kmalloc(sizeof(int) * (c->lst.idx_lebs + 1), GFP_NOFS);
366         if (!c->gap_lebs)
367                 return -ENOMEM;
368
369         p = c->gap_lebs;
370         do {
371                 ubifs_assert(p < c->gap_lebs + sizeof(int) * c->lst.idx_lebs);
372                 written = layout_leb_in_gaps(c, p);
373                 if (written < 0) {
374                         err = written;
375                         if (err != -ENOSPC) {
376                                 kfree(c->gap_lebs);
377                                 c->gap_lebs = NULL;
378                                 return err;
379                         }
380                         if (dbg_force_in_the_gaps_enabled()) {
381                                 /*
382                                  * Do not print scary warnings if the debugging
383                                  * option which forces in-the-gaps is enabled.
384                                  */
385                                 ubifs_warn("out of space");
386                                 dbg_dump_budg(c, &c->bi);
387                                 dbg_dump_lprops(c);
388                         }
389                         /* Try to commit anyway */
390                         err = 0;
391                         break;
392                 }
393                 p++;
394                 cnt -= written;
395                 leb_needed_cnt = get_leb_cnt(c, cnt);
396                 dbg_gc("%d znodes remaining, need %d LEBs, have %d", cnt,
397                        leb_needed_cnt, c->ileb_cnt);
398         } while (leb_needed_cnt > c->ileb_cnt);
399
400         *p = -1;
401         return 0;
402 }
403
404 /**
405  * layout_in_empty_space - layout index nodes in empty space.
406  * @c: UBIFS file-system description object
407  *
408  * This function lays out new index nodes for dirty znodes using empty LEBs.
409  *
410  * This function returns %0 on success and a negative error code on failure.
411  */
412 static int layout_in_empty_space(struct ubifs_info *c)
413 {
414         struct ubifs_znode *znode, *cnext, *zp;
415         int lnum, offs, len, next_len, buf_len, buf_offs, used, avail;
416         int wlen, blen, err;
417
418         cnext = c->enext;
419         if (!cnext)
420                 return 0;
421
422         lnum = c->ihead_lnum;
423         buf_offs = c->ihead_offs;
424
425         buf_len = ubifs_idx_node_sz(c, c->fanout);
426         buf_len = ALIGN(buf_len, c->min_io_size);
427         used = 0;
428         avail = buf_len;
429
430         /* Ensure there is enough room for first write */
431         next_len = ubifs_idx_node_sz(c, cnext->child_cnt);
432         if (buf_offs + next_len > c->leb_size)
433                 lnum = -1;
434
435         while (1) {
436                 znode = cnext;
437
438                 len = ubifs_idx_node_sz(c, znode->child_cnt);
439
440                 /* Determine the index node position */
441                 if (lnum == -1) {
442                         if (c->ileb_nxt >= c->ileb_cnt) {
443                                 ubifs_err("out of space");
444                                 return -ENOSPC;
445                         }
446                         lnum = c->ilebs[c->ileb_nxt++];
447                         buf_offs = 0;
448                         used = 0;
449                         avail = buf_len;
450                 }
451
452                 offs = buf_offs + used;
453
454 #ifdef CONFIG_UBIFS_FS_DEBUG
455                 znode->lnum = lnum;
456                 znode->offs = offs;
457                 znode->len = len;
458 #endif
459
460                 /* Update the parent */
461                 zp = znode->parent;
462                 if (zp) {
463                         struct ubifs_zbranch *zbr;
464                         int i;
465
466                         i = znode->iip;
467                         zbr = &zp->zbranch[i];
468                         zbr->lnum = lnum;
469                         zbr->offs = offs;
470                         zbr->len = len;
471                 } else {
472                         c->zroot.lnum = lnum;
473                         c->zroot.offs = offs;
474                         c->zroot.len = len;
475                 }
476                 c->calc_idx_sz += ALIGN(len, 8);
477
478                 /*
479                  * Once lprops is updated, we can decrease the dirty znode count
480                  * but it is easier to just do it here.
481                  */
482                 atomic_long_dec(&c->dirty_zn_cnt);
483
484                 /*
485                  * Calculate the next index node length to see if there is
486                  * enough room for it
487                  */
488                 cnext = znode->cnext;
489                 if (cnext == c->cnext)
490                         next_len = 0;
491                 else
492                         next_len = ubifs_idx_node_sz(c, cnext->child_cnt);
493
494                 /* Update buffer positions */
495                 wlen = used + len;
496                 used += ALIGN(len, 8);
497                 avail -= ALIGN(len, 8);
498
499                 if (next_len != 0 &&
500                     buf_offs + used + next_len <= c->leb_size &&
501                     avail > 0)
502                         continue;
503
504                 if (avail <= 0 && next_len &&
505                     buf_offs + used + next_len <= c->leb_size)
506                         blen = buf_len;
507                 else
508                         blen = ALIGN(wlen, c->min_io_size);
509
510                 /* The buffer is full or there are no more znodes to do */
511                 buf_offs += blen;
512                 if (next_len) {
513                         if (buf_offs + next_len > c->leb_size) {
514                                 err = ubifs_update_one_lp(c, lnum,
515                                         c->leb_size - buf_offs, blen - used,
516                                         0, 0);
517                                 if (err)
518                                         return err;
519                                 lnum = -1;
520                         }
521                         used -= blen;
522                         if (used < 0)
523                                 used = 0;
524                         avail = buf_len - used;
525                         continue;
526                 }
527                 err = ubifs_update_one_lp(c, lnum, c->leb_size - buf_offs,
528                                           blen - used, 0, 0);
529                 if (err)
530                         return err;
531                 break;
532         }
533
534 #ifdef CONFIG_UBIFS_FS_DEBUG
535         c->dbg->new_ihead_lnum = lnum;
536         c->dbg->new_ihead_offs = buf_offs;
537 #endif
538
539         return 0;
540 }
541
542 /**
543  * layout_commit - determine positions of index nodes to commit.
544  * @c: UBIFS file-system description object
545  * @no_space: indicates that insufficient empty LEBs were allocated
546  * @cnt: number of znodes to commit
547  *
548  * Calculate and update the positions of index nodes to commit.  If there were
549  * an insufficient number of empty LEBs allocated, then index nodes are placed
550  * into the gaps created by obsolete index nodes in non-empty index LEBs.  For
551  * this purpose, an obsolete index node is one that was not in the index as at
552  * the end of the last commit.  To write "in-the-gaps" requires that those index
553  * LEBs are updated atomically in-place.
554  */
555 static int layout_commit(struct ubifs_info *c, int no_space, int cnt)
556 {
557         int err;
558
559         if (no_space) {
560                 err = layout_in_gaps(c, cnt);
561                 if (err)
562                         return err;
563         }
564         err = layout_in_empty_space(c);
565         return err;
566 }
567
568 /**
569  * find_first_dirty - find first dirty znode.
570  * @znode: znode to begin searching from
571  */
572 static struct ubifs_znode *find_first_dirty(struct ubifs_znode *znode)
573 {
574         int i, cont;
575
576         if (!znode)
577                 return NULL;
578
579         while (1) {
580                 if (znode->level == 0) {
581                         if (ubifs_zn_dirty(znode))
582                                 return znode;
583                         return NULL;
584                 }
585                 cont = 0;
586                 for (i = 0; i < znode->child_cnt; i++) {
587                         struct ubifs_zbranch *zbr = &znode->zbranch[i];
588
589                         if (zbr->znode && ubifs_zn_dirty(zbr->znode)) {
590                                 znode = zbr->znode;
591                                 cont = 1;
592                                 break;
593                         }
594                 }
595                 if (!cont) {
596                         if (ubifs_zn_dirty(znode))
597                                 return znode;
598                         return NULL;
599                 }
600         }
601 }
602
603 /**
604  * find_next_dirty - find next dirty znode.
605  * @znode: znode to begin searching from
606  */
607 static struct ubifs_znode *find_next_dirty(struct ubifs_znode *znode)
608 {
609         int n = znode->iip + 1;
610
611         znode = znode->parent;
612         if (!znode)
613                 return NULL;
614         for (; n < znode->child_cnt; n++) {
615                 struct ubifs_zbranch *zbr = &znode->zbranch[n];
616
617                 if (zbr->znode && ubifs_zn_dirty(zbr->znode))
618                         return find_first_dirty(zbr->znode);
619         }
620         return znode;
621 }
622
623 /**
624  * get_znodes_to_commit - create list of dirty znodes to commit.
625  * @c: UBIFS file-system description object
626  *
627  * This function returns the number of znodes to commit.
628  */
629 static int get_znodes_to_commit(struct ubifs_info *c)
630 {
631         struct ubifs_znode *znode, *cnext;
632         int cnt = 0;
633
634         c->cnext = find_first_dirty(c->zroot.znode);
635         znode = c->enext = c->cnext;
636         if (!znode) {
637                 dbg_cmt("no znodes to commit");
638                 return 0;
639         }
640         cnt += 1;
641         while (1) {
642                 ubifs_assert(!ubifs_zn_cow(znode));
643                 __set_bit(COW_ZNODE, &znode->flags);
644                 znode->alt = 0;
645                 cnext = find_next_dirty(znode);
646                 if (!cnext) {
647                         znode->cnext = c->cnext;
648                         break;
649                 }
650                 znode->cnext = cnext;
651                 znode = cnext;
652                 cnt += 1;
653         }
654         dbg_cmt("committing %d znodes", cnt);
655         ubifs_assert(cnt == atomic_long_read(&c->dirty_zn_cnt));
656         return cnt;
657 }
658
659 /**
660  * alloc_idx_lebs - allocate empty LEBs to be used to commit.
661  * @c: UBIFS file-system description object
662  * @cnt: number of znodes to commit
663  *
664  * This function returns %-ENOSPC if it cannot allocate a sufficient number of
665  * empty LEBs.  %0 is returned on success, otherwise a negative error code
666  * is returned.
667  */
668 static int alloc_idx_lebs(struct ubifs_info *c, int cnt)
669 {
670         int i, leb_cnt, lnum;
671
672         c->ileb_cnt = 0;
673         c->ileb_nxt = 0;
674         leb_cnt = get_leb_cnt(c, cnt);
675         dbg_cmt("need about %d empty LEBS for TNC commit", leb_cnt);
676         if (!leb_cnt)
677                 return 0;
678         c->ilebs = kmalloc(leb_cnt * sizeof(int), GFP_NOFS);
679         if (!c->ilebs)
680                 return -ENOMEM;
681         for (i = 0; i < leb_cnt; i++) {
682                 lnum = ubifs_find_free_leb_for_idx(c);
683                 if (lnum < 0)
684                         return lnum;
685                 c->ilebs[c->ileb_cnt++] = lnum;
686                 dbg_cmt("LEB %d", lnum);
687         }
688         if (dbg_force_in_the_gaps())
689                 return -ENOSPC;
690         return 0;
691 }
692
693 /**
694  * free_unused_idx_lebs - free unused LEBs that were allocated for the commit.
695  * @c: UBIFS file-system description object
696  *
697  * It is possible that we allocate more empty LEBs for the commit than we need.
698  * This functions frees the surplus.
699  *
700  * This function returns %0 on success and a negative error code on failure.
701  */
702 static int free_unused_idx_lebs(struct ubifs_info *c)
703 {
704         int i, err = 0, lnum, er;
705
706         for (i = c->ileb_nxt; i < c->ileb_cnt; i++) {
707                 lnum = c->ilebs[i];
708                 dbg_cmt("LEB %d", lnum);
709                 er = ubifs_change_one_lp(c, lnum, LPROPS_NC, LPROPS_NC, 0,
710                                          LPROPS_INDEX | LPROPS_TAKEN, 0);
711                 if (!err)
712                         err = er;
713         }
714         return err;
715 }
716
717 /**
718  * free_idx_lebs - free unused LEBs after commit end.
719  * @c: UBIFS file-system description object
720  *
721  * This function returns %0 on success and a negative error code on failure.
722  */
723 static int free_idx_lebs(struct ubifs_info *c)
724 {
725         int err;
726
727         err = free_unused_idx_lebs(c);
728         kfree(c->ilebs);
729         c->ilebs = NULL;
730         return err;
731 }
732
733 /**
734  * ubifs_tnc_start_commit - start TNC commit.
735  * @c: UBIFS file-system description object
736  * @zroot: new index root position is returned here
737  *
738  * This function prepares the list of indexing nodes to commit and lays out
739  * their positions on flash. If there is not enough free space it uses the
740  * in-gap commit method. Returns zero in case of success and a negative error
741  * code in case of failure.
742  */
743 int ubifs_tnc_start_commit(struct ubifs_info *c, struct ubifs_zbranch *zroot)
744 {
745         int err = 0, cnt;
746
747         mutex_lock(&c->tnc_mutex);
748         err = dbg_check_tnc(c, 1);
749         if (err)
750                 goto out;
751         cnt = get_znodes_to_commit(c);
752         if (cnt != 0) {
753                 int no_space = 0;
754
755                 err = alloc_idx_lebs(c, cnt);
756                 if (err == -ENOSPC)
757                         no_space = 1;
758                 else if (err)
759                         goto out_free;
760                 err = layout_commit(c, no_space, cnt);
761                 if (err)
762                         goto out_free;
763                 ubifs_assert(atomic_long_read(&c->dirty_zn_cnt) == 0);
764                 err = free_unused_idx_lebs(c);
765                 if (err)
766                         goto out;
767         }
768         destroy_old_idx(c);
769         memcpy(zroot, &c->zroot, sizeof(struct ubifs_zbranch));
770
771         err = ubifs_save_dirty_idx_lnums(c);
772         if (err)
773                 goto out;
774
775         spin_lock(&c->space_lock);
776         /*
777          * Although we have not finished committing yet, update size of the
778          * committed index ('c->bi.old_idx_sz') and zero out the index growth
779          * budget. It is OK to do this now, because we've reserved all the
780          * space which is needed to commit the index, and it is save for the
781          * budgeting subsystem to assume the index is already committed,
782          * even though it is not.
783          */
784         ubifs_assert(c->bi.min_idx_lebs == ubifs_calc_min_idx_lebs(c));
785         c->bi.old_idx_sz = c->calc_idx_sz;
786         c->bi.uncommitted_idx = 0;
787         c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
788         spin_unlock(&c->space_lock);
789         mutex_unlock(&c->tnc_mutex);
790
791         dbg_cmt("number of index LEBs %d", c->lst.idx_lebs);
792         dbg_cmt("size of index %llu", c->calc_idx_sz);
793         return err;
794
795 out_free:
796         free_idx_lebs(c);
797 out:
798         mutex_unlock(&c->tnc_mutex);
799         return err;
800 }
801
802 /**
803  * write_index - write index nodes.
804  * @c: UBIFS file-system description object
805  *
806  * This function writes the index nodes whose positions were laid out in the
807  * layout_in_empty_space function.
808  */
809 static int write_index(struct ubifs_info *c)
810 {
811         struct ubifs_idx_node *idx;
812         struct ubifs_znode *znode, *cnext;
813         int i, lnum, offs, len, next_len, buf_len, buf_offs, used;
814         int avail, wlen, err, lnum_pos = 0, blen, nxt_offs;
815
816         cnext = c->enext;
817         if (!cnext)
818                 return 0;
819
820         /*
821          * Always write index nodes to the index head so that index nodes and
822          * other types of nodes are never mixed in the same erase block.
823          */
824         lnum = c->ihead_lnum;
825         buf_offs = c->ihead_offs;
826
827         /* Allocate commit buffer */
828         buf_len = ALIGN(c->max_idx_node_sz, c->min_io_size);
829         used = 0;
830         avail = buf_len;
831
832         /* Ensure there is enough room for first write */
833         next_len = ubifs_idx_node_sz(c, cnext->child_cnt);
834         if (buf_offs + next_len > c->leb_size) {
835                 err = ubifs_update_one_lp(c, lnum, LPROPS_NC, 0, 0,
836                                           LPROPS_TAKEN);
837                 if (err)
838                         return err;
839                 lnum = -1;
840         }
841
842         while (1) {
843                 cond_resched();
844
845                 znode = cnext;
846                 idx = c->cbuf + used;
847
848                 /* Make index node */
849                 idx->ch.node_type = UBIFS_IDX_NODE;
850                 idx->child_cnt = cpu_to_le16(znode->child_cnt);
851                 idx->level = cpu_to_le16(znode->level);
852                 for (i = 0; i < znode->child_cnt; i++) {
853                         struct ubifs_branch *br = ubifs_idx_branch(c, idx, i);
854                         struct ubifs_zbranch *zbr = &znode->zbranch[i];
855
856                         key_write_idx(c, &zbr->key, &br->key);
857                         br->lnum = cpu_to_le32(zbr->lnum);
858                         br->offs = cpu_to_le32(zbr->offs);
859                         br->len = cpu_to_le32(zbr->len);
860                         if (!zbr->lnum || !zbr->len) {
861                                 ubifs_err("bad ref in znode");
862                                 dbg_dump_znode(c, znode);
863                                 if (zbr->znode)
864                                         dbg_dump_znode(c, zbr->znode);
865                         }
866                 }
867                 len = ubifs_idx_node_sz(c, znode->child_cnt);
868                 ubifs_prepare_node(c, idx, len, 0);
869
870                 /* Determine the index node position */
871                 if (lnum == -1) {
872                         lnum = c->ilebs[lnum_pos++];
873                         buf_offs = 0;
874                         used = 0;
875                         avail = buf_len;
876                 }
877                 offs = buf_offs + used;
878
879 #ifdef CONFIG_UBIFS_FS_DEBUG
880                 if (lnum != znode->lnum || offs != znode->offs ||
881                     len != znode->len) {
882                         ubifs_err("inconsistent znode posn");
883                         return -EINVAL;
884                 }
885 #endif
886
887                 /* Grab some stuff from znode while we still can */
888                 cnext = znode->cnext;
889
890                 ubifs_assert(ubifs_zn_dirty(znode));
891                 ubifs_assert(ubifs_zn_cow(znode));
892
893                 /*
894                  * It is important that other threads should see %DIRTY_ZNODE
895                  * flag cleared before %COW_ZNODE. Specifically, it matters in
896                  * the 'dirty_cow_znode()' function. This is the reason for the
897                  * first barrier. Also, we want the bit changes to be seen to
898                  * other threads ASAP, to avoid unnecesarry copying, which is
899                  * the reason for the second barrier.
900                  */
901                 clear_bit(DIRTY_ZNODE, &znode->flags);
902                 smp_mb__before_clear_bit();
903                 clear_bit(COW_ZNODE, &znode->flags);
904                 smp_mb__after_clear_bit();
905
906                 /* Do not access znode from this point on */
907
908                 /* Update buffer positions */
909                 wlen = used + len;
910                 used += ALIGN(len, 8);
911                 avail -= ALIGN(len, 8);
912
913                 /*
914                  * Calculate the next index node length to see if there is
915                  * enough room for it
916                  */
917                 if (cnext == c->cnext)
918                         next_len = 0;
919                 else
920                         next_len = ubifs_idx_node_sz(c, cnext->child_cnt);
921
922                 nxt_offs = buf_offs + used + next_len;
923                 if (next_len && nxt_offs <= c->leb_size) {
924                         if (avail > 0)
925                                 continue;
926                         else
927                                 blen = buf_len;
928                 } else {
929                         wlen = ALIGN(wlen, 8);
930                         blen = ALIGN(wlen, c->min_io_size);
931                         ubifs_pad(c, c->cbuf + wlen, blen - wlen);
932                 }
933
934                 /* The buffer is full or there are no more znodes to do */
935                 err = ubifs_leb_write(c, lnum, c->cbuf, buf_offs, blen,
936                                       UBI_SHORTTERM);
937                 if (err)
938                         return err;
939                 buf_offs += blen;
940                 if (next_len) {
941                         if (nxt_offs > c->leb_size) {
942                                 err = ubifs_update_one_lp(c, lnum, LPROPS_NC, 0,
943                                                           0, LPROPS_TAKEN);
944                                 if (err)
945                                         return err;
946                                 lnum = -1;
947                         }
948                         used -= blen;
949                         if (used < 0)
950                                 used = 0;
951                         avail = buf_len - used;
952                         memmove(c->cbuf, c->cbuf + blen, used);
953                         continue;
954                 }
955                 break;
956         }
957
958 #ifdef CONFIG_UBIFS_FS_DEBUG
959         if (lnum != c->dbg->new_ihead_lnum ||
960             buf_offs != c->dbg->new_ihead_offs) {
961                 ubifs_err("inconsistent ihead");
962                 return -EINVAL;
963         }
964 #endif
965
966         c->ihead_lnum = lnum;
967         c->ihead_offs = buf_offs;
968
969         return 0;
970 }
971
972 /**
973  * free_obsolete_znodes - free obsolete znodes.
974  * @c: UBIFS file-system description object
975  *
976  * At the end of commit end, obsolete znodes are freed.
977  */
978 static void free_obsolete_znodes(struct ubifs_info *c)
979 {
980         struct ubifs_znode *znode, *cnext;
981
982         cnext = c->cnext;
983         do {
984                 znode = cnext;
985                 cnext = znode->cnext;
986                 if (ubifs_zn_obsolete(znode))
987                         kfree(znode);
988                 else {
989                         znode->cnext = NULL;
990                         atomic_long_inc(&c->clean_zn_cnt);
991                         atomic_long_inc(&ubifs_clean_zn_cnt);
992                 }
993         } while (cnext != c->cnext);
994 }
995
996 /**
997  * return_gap_lebs - return LEBs used by the in-gap commit method.
998  * @c: UBIFS file-system description object
999  *
1000  * This function clears the "taken" flag for the LEBs which were used by the
1001  * "commit in-the-gaps" method.
1002  */
1003 static int return_gap_lebs(struct ubifs_info *c)
1004 {
1005         int *p, err;
1006
1007         if (!c->gap_lebs)
1008                 return 0;
1009
1010         dbg_cmt("");
1011         for (p = c->gap_lebs; *p != -1; p++) {
1012                 err = ubifs_change_one_lp(c, *p, LPROPS_NC, LPROPS_NC, 0,
1013                                           LPROPS_TAKEN, 0);
1014                 if (err)
1015                         return err;
1016         }
1017
1018         kfree(c->gap_lebs);
1019         c->gap_lebs = NULL;
1020         return 0;
1021 }
1022
1023 /**
1024  * ubifs_tnc_end_commit - update the TNC for commit end.
1025  * @c: UBIFS file-system description object
1026  *
1027  * Write the dirty znodes.
1028  */
1029 int ubifs_tnc_end_commit(struct ubifs_info *c)
1030 {
1031         int err;
1032
1033         if (!c->cnext)
1034                 return 0;
1035
1036         err = return_gap_lebs(c);
1037         if (err)
1038                 return err;
1039
1040         err = write_index(c);
1041         if (err)
1042                 return err;
1043
1044         mutex_lock(&c->tnc_mutex);
1045
1046         dbg_cmt("TNC height is %d", c->zroot.znode->level + 1);
1047
1048         free_obsolete_znodes(c);
1049
1050         c->cnext = NULL;
1051         kfree(c->ilebs);
1052         c->ilebs = NULL;
1053
1054         mutex_unlock(&c->tnc_mutex);
1055
1056         return 0;
1057 }