2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
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.
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
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
19 * Authors: Adrian Hunter
20 * Artem Bityutskiy (Битюцкий Артём)
24 * This file implements commit-related functionality of the LEB properties
28 #include <linux/crc16.h>
29 #include <linux/slab.h>
33 * first_dirty_cnode - find first dirty cnode.
34 * @c: UBIFS file-system description object
35 * @nnode: nnode at which to start
37 * This function returns the first dirty cnode or %NULL if there is not one.
39 static struct ubifs_cnode
*first_dirty_cnode(struct ubifs_nnode
*nnode
)
45 for (i
= 0; i
< UBIFS_LPT_FANOUT
; i
++) {
46 struct ubifs_cnode
*cnode
;
48 cnode
= nnode
->nbranch
[i
].cnode
;
50 test_bit(DIRTY_CNODE
, &cnode
->flags
)) {
51 if (cnode
->level
== 0)
53 nnode
= (struct ubifs_nnode
*)cnode
;
59 return (struct ubifs_cnode
*)nnode
;
64 * next_dirty_cnode - find next dirty cnode.
65 * @cnode: cnode from which to begin searching
67 * This function returns the next dirty cnode or %NULL if there is not one.
69 static struct ubifs_cnode
*next_dirty_cnode(struct ubifs_cnode
*cnode
)
71 struct ubifs_nnode
*nnode
;
75 nnode
= cnode
->parent
;
78 for (i
= cnode
->iip
+ 1; i
< UBIFS_LPT_FANOUT
; i
++) {
79 cnode
= nnode
->nbranch
[i
].cnode
;
80 if (cnode
&& test_bit(DIRTY_CNODE
, &cnode
->flags
)) {
81 if (cnode
->level
== 0)
82 return cnode
; /* cnode is a pnode */
83 /* cnode is a nnode */
84 return first_dirty_cnode((struct ubifs_nnode
*)cnode
);
87 return (struct ubifs_cnode
*)nnode
;
91 * get_cnodes_to_commit - create list of dirty cnodes to commit.
92 * @c: UBIFS file-system description object
94 * This function returns the number of cnodes to commit.
96 static int get_cnodes_to_commit(struct ubifs_info
*c
)
98 struct ubifs_cnode
*cnode
, *cnext
;
104 if (!test_bit(DIRTY_CNODE
, &c
->nroot
->flags
))
107 c
->lpt_cnext
= first_dirty_cnode(c
->nroot
);
108 cnode
= c
->lpt_cnext
;
113 ubifs_assert(!test_bit(COW_ZNODE
, &cnode
->flags
));
114 __set_bit(COW_ZNODE
, &cnode
->flags
);
115 cnext
= next_dirty_cnode(cnode
);
117 cnode
->cnext
= c
->lpt_cnext
;
120 cnode
->cnext
= cnext
;
124 dbg_cmt("committing %d cnodes", cnt
);
125 dbg_lp("committing %d cnodes", cnt
);
126 ubifs_assert(cnt
== c
->dirty_nn_cnt
+ c
->dirty_pn_cnt
);
131 * upd_ltab - update LPT LEB properties.
132 * @c: UBIFS file-system description object
134 * @free: amount of free space
135 * @dirty: amount of dirty space to add
137 static void upd_ltab(struct ubifs_info
*c
, int lnum
, int free
, int dirty
)
139 dbg_lp("LEB %d free %d dirty %d to %d +%d",
140 lnum
, c
->ltab
[lnum
- c
->lpt_first
].free
,
141 c
->ltab
[lnum
- c
->lpt_first
].dirty
, free
, dirty
);
142 ubifs_assert(lnum
>= c
->lpt_first
&& lnum
<= c
->lpt_last
);
143 c
->ltab
[lnum
- c
->lpt_first
].free
= free
;
144 c
->ltab
[lnum
- c
->lpt_first
].dirty
+= dirty
;
148 * alloc_lpt_leb - allocate an LPT LEB that is empty.
149 * @c: UBIFS file-system description object
150 * @lnum: LEB number is passed and returned here
152 * This function finds the next empty LEB in the ltab starting from @lnum. If a
153 * an empty LEB is found it is returned in @lnum and the function returns %0.
154 * Otherwise the function returns -ENOSPC. Note however, that LPT is designed
155 * never to run out of space.
157 static int alloc_lpt_leb(struct ubifs_info
*c
, int *lnum
)
161 n
= *lnum
- c
->lpt_first
+ 1;
162 for (i
= n
; i
< c
->lpt_lebs
; i
++) {
163 if (c
->ltab
[i
].tgc
|| c
->ltab
[i
].cmt
)
165 if (c
->ltab
[i
].free
== c
->leb_size
) {
167 *lnum
= i
+ c
->lpt_first
;
172 for (i
= 0; i
< n
; i
++) {
173 if (c
->ltab
[i
].tgc
|| c
->ltab
[i
].cmt
)
175 if (c
->ltab
[i
].free
== c
->leb_size
) {
177 *lnum
= i
+ c
->lpt_first
;
185 * layout_cnodes - layout cnodes for commit.
186 * @c: UBIFS file-system description object
188 * This function returns %0 on success and a negative error code on failure.
190 static int layout_cnodes(struct ubifs_info
*c
)
192 int lnum
, offs
, len
, alen
, done_lsave
, done_ltab
, err
;
193 struct ubifs_cnode
*cnode
;
195 err
= dbg_chk_lpt_sz(c
, 0, 0);
198 cnode
= c
->lpt_cnext
;
201 lnum
= c
->nhead_lnum
;
202 offs
= c
->nhead_offs
;
203 /* Try to place lsave and ltab nicely */
204 done_lsave
= !c
->big_lpt
;
206 if (!done_lsave
&& offs
+ c
->lsave_sz
<= c
->leb_size
) {
208 c
->lsave_lnum
= lnum
;
209 c
->lsave_offs
= offs
;
211 dbg_chk_lpt_sz(c
, 1, c
->lsave_sz
);
214 if (offs
+ c
->ltab_sz
<= c
->leb_size
) {
219 dbg_chk_lpt_sz(c
, 1, c
->ltab_sz
);
225 c
->dirty_nn_cnt
-= 1;
228 c
->dirty_pn_cnt
-= 1;
230 while (offs
+ len
> c
->leb_size
) {
231 alen
= ALIGN(offs
, c
->min_io_size
);
232 upd_ltab(c
, lnum
, c
->leb_size
- alen
, alen
- offs
);
233 dbg_chk_lpt_sz(c
, 2, c
->leb_size
- offs
);
234 err
= alloc_lpt_leb(c
, &lnum
);
238 ubifs_assert(lnum
>= c
->lpt_first
&&
239 lnum
<= c
->lpt_last
);
240 /* Try to place lsave and ltab nicely */
243 c
->lsave_lnum
= lnum
;
244 c
->lsave_offs
= offs
;
246 dbg_chk_lpt_sz(c
, 1, c
->lsave_sz
);
254 dbg_chk_lpt_sz(c
, 1, c
->ltab_sz
);
260 cnode
->parent
->nbranch
[cnode
->iip
].lnum
= lnum
;
261 cnode
->parent
->nbranch
[cnode
->iip
].offs
= offs
;
267 dbg_chk_lpt_sz(c
, 1, len
);
268 cnode
= cnode
->cnext
;
269 } while (cnode
&& cnode
!= c
->lpt_cnext
);
271 /* Make sure to place LPT's save table */
273 if (offs
+ c
->lsave_sz
> c
->leb_size
) {
274 alen
= ALIGN(offs
, c
->min_io_size
);
275 upd_ltab(c
, lnum
, c
->leb_size
- alen
, alen
- offs
);
276 dbg_chk_lpt_sz(c
, 2, c
->leb_size
- offs
);
277 err
= alloc_lpt_leb(c
, &lnum
);
281 ubifs_assert(lnum
>= c
->lpt_first
&&
282 lnum
<= c
->lpt_last
);
285 c
->lsave_lnum
= lnum
;
286 c
->lsave_offs
= offs
;
288 dbg_chk_lpt_sz(c
, 1, c
->lsave_sz
);
291 /* Make sure to place LPT's own lprops table */
293 if (offs
+ c
->ltab_sz
> c
->leb_size
) {
294 alen
= ALIGN(offs
, c
->min_io_size
);
295 upd_ltab(c
, lnum
, c
->leb_size
- alen
, alen
- offs
);
296 dbg_chk_lpt_sz(c
, 2, c
->leb_size
- offs
);
297 err
= alloc_lpt_leb(c
, &lnum
);
301 ubifs_assert(lnum
>= c
->lpt_first
&&
302 lnum
<= c
->lpt_last
);
308 dbg_chk_lpt_sz(c
, 1, c
->ltab_sz
);
311 alen
= ALIGN(offs
, c
->min_io_size
);
312 upd_ltab(c
, lnum
, c
->leb_size
- alen
, alen
- offs
);
313 dbg_chk_lpt_sz(c
, 4, alen
- offs
);
314 err
= dbg_chk_lpt_sz(c
, 3, alen
);
320 ubifs_err("LPT out of space");
321 dbg_err("LPT out of space at LEB %d:%d needing %d, done_ltab %d, "
322 "done_lsave %d", lnum
, offs
, len
, done_ltab
, done_lsave
);
323 dbg_dump_lpt_info(c
);
324 dbg_dump_lpt_lebs(c
);
330 * realloc_lpt_leb - allocate an LPT LEB that is empty.
331 * @c: UBIFS file-system description object
332 * @lnum: LEB number is passed and returned here
334 * This function duplicates exactly the results of the function alloc_lpt_leb.
335 * It is used during end commit to reallocate the same LEB numbers that were
336 * allocated by alloc_lpt_leb during start commit.
338 * This function finds the next LEB that was allocated by the alloc_lpt_leb
339 * function starting from @lnum. If a LEB is found it is returned in @lnum and
340 * the function returns %0. Otherwise the function returns -ENOSPC.
341 * Note however, that LPT is designed never to run out of space.
343 static int realloc_lpt_leb(struct ubifs_info
*c
, int *lnum
)
347 n
= *lnum
- c
->lpt_first
+ 1;
348 for (i
= n
; i
< c
->lpt_lebs
; i
++)
349 if (c
->ltab
[i
].cmt
) {
351 *lnum
= i
+ c
->lpt_first
;
355 for (i
= 0; i
< n
; i
++)
356 if (c
->ltab
[i
].cmt
) {
358 *lnum
= i
+ c
->lpt_first
;
365 * write_cnodes - write cnodes for commit.
366 * @c: UBIFS file-system description object
368 * This function returns %0 on success and a negative error code on failure.
370 static int write_cnodes(struct ubifs_info
*c
)
372 int lnum
, offs
, len
, from
, err
, wlen
, alen
, done_ltab
, done_lsave
;
373 struct ubifs_cnode
*cnode
;
374 void *buf
= c
->lpt_buf
;
376 cnode
= c
->lpt_cnext
;
379 lnum
= c
->nhead_lnum
;
380 offs
= c
->nhead_offs
;
382 /* Ensure empty LEB is unmapped */
384 err
= ubifs_leb_unmap(c
, lnum
);
388 /* Try to place lsave and ltab nicely */
389 done_lsave
= !c
->big_lpt
;
391 if (!done_lsave
&& offs
+ c
->lsave_sz
<= c
->leb_size
) {
393 ubifs_pack_lsave(c
, buf
+ offs
, c
->lsave
);
395 dbg_chk_lpt_sz(c
, 1, c
->lsave_sz
);
398 if (offs
+ c
->ltab_sz
<= c
->leb_size
) {
400 ubifs_pack_ltab(c
, buf
+ offs
, c
->ltab_cmt
);
402 dbg_chk_lpt_sz(c
, 1, c
->ltab_sz
);
405 /* Loop for each cnode */
411 while (offs
+ len
> c
->leb_size
) {
414 alen
= ALIGN(wlen
, c
->min_io_size
);
415 memset(buf
+ offs
, 0xff, alen
- wlen
);
416 err
= ubifs_leb_write(c
, lnum
, buf
+ from
, from
,
417 alen
, UBI_SHORTTERM
);
421 dbg_chk_lpt_sz(c
, 2, c
->leb_size
- offs
);
422 err
= realloc_lpt_leb(c
, &lnum
);
426 ubifs_assert(lnum
>= c
->lpt_first
&&
427 lnum
<= c
->lpt_last
);
428 err
= ubifs_leb_unmap(c
, lnum
);
431 /* Try to place lsave and ltab nicely */
434 ubifs_pack_lsave(c
, buf
+ offs
, c
->lsave
);
436 dbg_chk_lpt_sz(c
, 1, c
->lsave_sz
);
441 ubifs_pack_ltab(c
, buf
+ offs
, c
->ltab_cmt
);
443 dbg_chk_lpt_sz(c
, 1, c
->ltab_sz
);
449 ubifs_pack_nnode(c
, buf
+ offs
,
450 (struct ubifs_nnode
*)cnode
);
452 ubifs_pack_pnode(c
, buf
+ offs
,
453 (struct ubifs_pnode
*)cnode
);
455 * The reason for the barriers is the same as in case of TNC.
456 * See comment in 'write_index()'. 'dirty_cow_nnode()' and
457 * 'dirty_cow_pnode()' are the functions for which this is
460 clear_bit(DIRTY_CNODE
, &cnode
->flags
);
461 smp_mb__before_clear_bit();
462 clear_bit(COW_ZNODE
, &cnode
->flags
);
463 smp_mb__after_clear_bit();
465 dbg_chk_lpt_sz(c
, 1, len
);
466 cnode
= cnode
->cnext
;
467 } while (cnode
&& cnode
!= c
->lpt_cnext
);
469 /* Make sure to place LPT's save table */
471 if (offs
+ c
->lsave_sz
> c
->leb_size
) {
473 alen
= ALIGN(wlen
, c
->min_io_size
);
474 memset(buf
+ offs
, 0xff, alen
- wlen
);
475 err
= ubifs_leb_write(c
, lnum
, buf
+ from
, from
, alen
,
479 dbg_chk_lpt_sz(c
, 2, c
->leb_size
- offs
);
480 err
= realloc_lpt_leb(c
, &lnum
);
484 ubifs_assert(lnum
>= c
->lpt_first
&&
485 lnum
<= c
->lpt_last
);
486 err
= ubifs_leb_unmap(c
, lnum
);
491 ubifs_pack_lsave(c
, buf
+ offs
, c
->lsave
);
493 dbg_chk_lpt_sz(c
, 1, c
->lsave_sz
);
496 /* Make sure to place LPT's own lprops table */
498 if (offs
+ c
->ltab_sz
> c
->leb_size
) {
500 alen
= ALIGN(wlen
, c
->min_io_size
);
501 memset(buf
+ offs
, 0xff, alen
- wlen
);
502 err
= ubifs_leb_write(c
, lnum
, buf
+ from
, from
, alen
,
506 dbg_chk_lpt_sz(c
, 2, c
->leb_size
- offs
);
507 err
= realloc_lpt_leb(c
, &lnum
);
511 ubifs_assert(lnum
>= c
->lpt_first
&&
512 lnum
<= c
->lpt_last
);
513 err
= ubifs_leb_unmap(c
, lnum
);
518 ubifs_pack_ltab(c
, buf
+ offs
, c
->ltab_cmt
);
520 dbg_chk_lpt_sz(c
, 1, c
->ltab_sz
);
523 /* Write remaining data in buffer */
525 alen
= ALIGN(wlen
, c
->min_io_size
);
526 memset(buf
+ offs
, 0xff, alen
- wlen
);
527 err
= ubifs_leb_write(c
, lnum
, buf
+ from
, from
, alen
, UBI_SHORTTERM
);
531 dbg_chk_lpt_sz(c
, 4, alen
- wlen
);
532 err
= dbg_chk_lpt_sz(c
, 3, ALIGN(offs
, c
->min_io_size
));
536 c
->nhead_lnum
= lnum
;
537 c
->nhead_offs
= ALIGN(offs
, c
->min_io_size
);
539 dbg_lp("LPT root is at %d:%d", c
->lpt_lnum
, c
->lpt_offs
);
540 dbg_lp("LPT head is at %d:%d", c
->nhead_lnum
, c
->nhead_offs
);
541 dbg_lp("LPT ltab is at %d:%d", c
->ltab_lnum
, c
->ltab_offs
);
543 dbg_lp("LPT lsave is at %d:%d", c
->lsave_lnum
, c
->lsave_offs
);
548 ubifs_err("LPT out of space mismatch");
549 dbg_err("LPT out of space mismatch at LEB %d:%d needing %d, done_ltab "
550 "%d, done_lsave %d", lnum
, offs
, len
, done_ltab
, done_lsave
);
551 dbg_dump_lpt_info(c
);
552 dbg_dump_lpt_lebs(c
);
558 * next_pnode_to_dirty - find next pnode to dirty.
559 * @c: UBIFS file-system description object
562 * This function returns the next pnode to dirty or %NULL if there are no more
563 * pnodes. Note that pnodes that have never been written (lnum == 0) are
566 static struct ubifs_pnode
*next_pnode_to_dirty(struct ubifs_info
*c
,
567 struct ubifs_pnode
*pnode
)
569 struct ubifs_nnode
*nnode
;
572 /* Try to go right */
573 nnode
= pnode
->parent
;
574 for (iip
= pnode
->iip
+ 1; iip
< UBIFS_LPT_FANOUT
; iip
++) {
575 if (nnode
->nbranch
[iip
].lnum
)
576 return ubifs_get_pnode(c
, nnode
, iip
);
579 /* Go up while can't go right */
581 iip
= nnode
->iip
+ 1;
582 nnode
= nnode
->parent
;
585 for (; iip
< UBIFS_LPT_FANOUT
; iip
++) {
586 if (nnode
->nbranch
[iip
].lnum
)
589 } while (iip
>= UBIFS_LPT_FANOUT
);
592 nnode
= ubifs_get_nnode(c
, nnode
, iip
);
594 return (void *)nnode
;
596 /* Go down to level 1 */
597 while (nnode
->level
> 1) {
598 for (iip
= 0; iip
< UBIFS_LPT_FANOUT
; iip
++) {
599 if (nnode
->nbranch
[iip
].lnum
)
602 if (iip
>= UBIFS_LPT_FANOUT
) {
604 * Should not happen, but we need to keep going
609 nnode
= ubifs_get_nnode(c
, nnode
, iip
);
611 return (void *)nnode
;
614 for (iip
= 0; iip
< UBIFS_LPT_FANOUT
; iip
++)
615 if (nnode
->nbranch
[iip
].lnum
)
617 if (iip
>= UBIFS_LPT_FANOUT
)
618 /* Should not happen, but we need to keep going if it does */
620 return ubifs_get_pnode(c
, nnode
, iip
);
624 * pnode_lookup - lookup a pnode in the LPT.
625 * @c: UBIFS file-system description object
626 * @i: pnode number (0 to main_lebs - 1)
628 * This function returns a pointer to the pnode on success or a negative
629 * error code on failure.
631 static struct ubifs_pnode
*pnode_lookup(struct ubifs_info
*c
, int i
)
633 int err
, h
, iip
, shft
;
634 struct ubifs_nnode
*nnode
;
637 err
= ubifs_read_nnode(c
, NULL
, 0);
641 i
<<= UBIFS_LPT_FANOUT_SHIFT
;
643 shft
= c
->lpt_hght
* UBIFS_LPT_FANOUT_SHIFT
;
644 for (h
= 1; h
< c
->lpt_hght
; h
++) {
645 iip
= ((i
>> shft
) & (UBIFS_LPT_FANOUT
- 1));
646 shft
-= UBIFS_LPT_FANOUT_SHIFT
;
647 nnode
= ubifs_get_nnode(c
, nnode
, iip
);
649 return ERR_PTR(PTR_ERR(nnode
));
651 iip
= ((i
>> shft
) & (UBIFS_LPT_FANOUT
- 1));
652 return ubifs_get_pnode(c
, nnode
, iip
);
656 * add_pnode_dirt - add dirty space to LPT LEB properties.
657 * @c: UBIFS file-system description object
658 * @pnode: pnode for which to add dirt
660 static void add_pnode_dirt(struct ubifs_info
*c
, struct ubifs_pnode
*pnode
)
662 ubifs_add_lpt_dirt(c
, pnode
->parent
->nbranch
[pnode
->iip
].lnum
,
667 * do_make_pnode_dirty - mark a pnode dirty.
668 * @c: UBIFS file-system description object
669 * @pnode: pnode to mark dirty
671 static void do_make_pnode_dirty(struct ubifs_info
*c
, struct ubifs_pnode
*pnode
)
673 /* Assumes cnext list is empty i.e. not called during commit */
674 if (!test_and_set_bit(DIRTY_CNODE
, &pnode
->flags
)) {
675 struct ubifs_nnode
*nnode
;
677 c
->dirty_pn_cnt
+= 1;
678 add_pnode_dirt(c
, pnode
);
679 /* Mark parent and ancestors dirty too */
680 nnode
= pnode
->parent
;
682 if (!test_and_set_bit(DIRTY_CNODE
, &nnode
->flags
)) {
683 c
->dirty_nn_cnt
+= 1;
684 ubifs_add_nnode_dirt(c
, nnode
);
685 nnode
= nnode
->parent
;
693 * make_tree_dirty - mark the entire LEB properties tree dirty.
694 * @c: UBIFS file-system description object
696 * This function is used by the "small" LPT model to cause the entire LEB
697 * properties tree to be written. The "small" LPT model does not use LPT
698 * garbage collection because it is more efficient to write the entire tree
699 * (because it is small).
701 * This function returns %0 on success and a negative error code on failure.
703 static int make_tree_dirty(struct ubifs_info
*c
)
705 struct ubifs_pnode
*pnode
;
707 pnode
= pnode_lookup(c
, 0);
709 do_make_pnode_dirty(c
, pnode
);
710 pnode
= next_pnode_to_dirty(c
, pnode
);
712 return PTR_ERR(pnode
);
718 * need_write_all - determine if the LPT area is running out of free space.
719 * @c: UBIFS file-system description object
721 * This function returns %1 if the LPT area is running out of free space and %0
724 static int need_write_all(struct ubifs_info
*c
)
729 for (i
= 0; i
< c
->lpt_lebs
; i
++) {
730 if (i
+ c
->lpt_first
== c
->nhead_lnum
)
731 free
+= c
->leb_size
- c
->nhead_offs
;
732 else if (c
->ltab
[i
].free
== c
->leb_size
)
734 else if (c
->ltab
[i
].free
+ c
->ltab
[i
].dirty
== c
->leb_size
)
737 /* Less than twice the size left */
738 if (free
<= c
->lpt_sz
* 2)
744 * lpt_tgc_start - start trivial garbage collection of LPT LEBs.
745 * @c: UBIFS file-system description object
747 * LPT trivial garbage collection is where a LPT LEB contains only dirty and
748 * free space and so may be reused as soon as the next commit is completed.
749 * This function is called during start commit to mark LPT LEBs for trivial GC.
751 static void lpt_tgc_start(struct ubifs_info
*c
)
755 for (i
= 0; i
< c
->lpt_lebs
; i
++) {
756 if (i
+ c
->lpt_first
== c
->nhead_lnum
)
758 if (c
->ltab
[i
].dirty
> 0 &&
759 c
->ltab
[i
].free
+ c
->ltab
[i
].dirty
== c
->leb_size
) {
761 c
->ltab
[i
].free
= c
->leb_size
;
762 c
->ltab
[i
].dirty
= 0;
763 dbg_lp("LEB %d", i
+ c
->lpt_first
);
769 * lpt_tgc_end - end trivial garbage collection of LPT LEBs.
770 * @c: UBIFS file-system description object
772 * LPT trivial garbage collection is where a LPT LEB contains only dirty and
773 * free space and so may be reused as soon as the next commit is completed.
774 * This function is called after the commit is completed (master node has been
775 * written) and un-maps LPT LEBs that were marked for trivial GC.
777 static int lpt_tgc_end(struct ubifs_info
*c
)
781 for (i
= 0; i
< c
->lpt_lebs
; i
++)
782 if (c
->ltab
[i
].tgc
) {
783 err
= ubifs_leb_unmap(c
, i
+ c
->lpt_first
);
787 dbg_lp("LEB %d", i
+ c
->lpt_first
);
793 * populate_lsave - fill the lsave array with important LEB numbers.
794 * @c: the UBIFS file-system description object
796 * This function is only called for the "big" model. It records a small number
797 * of LEB numbers of important LEBs. Important LEBs are ones that are (from
798 * most important to least important): empty, freeable, freeable index, dirty
799 * index, dirty or free. Upon mount, we read this list of LEB numbers and bring
800 * their pnodes into memory. That will stop us from having to scan the LPT
801 * straight away. For the "small" model we assume that scanning the LPT is no
804 static void populate_lsave(struct ubifs_info
*c
)
806 struct ubifs_lprops
*lprops
;
807 struct ubifs_lpt_heap
*heap
;
810 ubifs_assert(c
->big_lpt
);
811 if (!(c
->lpt_drty_flgs
& LSAVE_DIRTY
)) {
812 c
->lpt_drty_flgs
|= LSAVE_DIRTY
;
813 ubifs_add_lpt_dirt(c
, c
->lsave_lnum
, c
->lsave_sz
);
815 list_for_each_entry(lprops
, &c
->empty_list
, list
) {
816 c
->lsave
[cnt
++] = lprops
->lnum
;
817 if (cnt
>= c
->lsave_cnt
)
820 list_for_each_entry(lprops
, &c
->freeable_list
, list
) {
821 c
->lsave
[cnt
++] = lprops
->lnum
;
822 if (cnt
>= c
->lsave_cnt
)
825 list_for_each_entry(lprops
, &c
->frdi_idx_list
, list
) {
826 c
->lsave
[cnt
++] = lprops
->lnum
;
827 if (cnt
>= c
->lsave_cnt
)
830 heap
= &c
->lpt_heap
[LPROPS_DIRTY_IDX
- 1];
831 for (i
= 0; i
< heap
->cnt
; i
++) {
832 c
->lsave
[cnt
++] = heap
->arr
[i
]->lnum
;
833 if (cnt
>= c
->lsave_cnt
)
836 heap
= &c
->lpt_heap
[LPROPS_DIRTY
- 1];
837 for (i
= 0; i
< heap
->cnt
; i
++) {
838 c
->lsave
[cnt
++] = heap
->arr
[i
]->lnum
;
839 if (cnt
>= c
->lsave_cnt
)
842 heap
= &c
->lpt_heap
[LPROPS_FREE
- 1];
843 for (i
= 0; i
< heap
->cnt
; i
++) {
844 c
->lsave
[cnt
++] = heap
->arr
[i
]->lnum
;
845 if (cnt
>= c
->lsave_cnt
)
848 /* Fill it up completely */
849 while (cnt
< c
->lsave_cnt
)
850 c
->lsave
[cnt
++] = c
->main_first
;
854 * nnode_lookup - lookup a nnode in the LPT.
855 * @c: UBIFS file-system description object
858 * This function returns a pointer to the nnode on success or a negative
859 * error code on failure.
861 static struct ubifs_nnode
*nnode_lookup(struct ubifs_info
*c
, int i
)
864 struct ubifs_nnode
*nnode
;
867 err
= ubifs_read_nnode(c
, NULL
, 0);
873 iip
= i
& (UBIFS_LPT_FANOUT
- 1);
874 i
>>= UBIFS_LPT_FANOUT_SHIFT
;
877 nnode
= ubifs_get_nnode(c
, nnode
, iip
);
885 * make_nnode_dirty - find a nnode and, if found, make it dirty.
886 * @c: UBIFS file-system description object
887 * @node_num: nnode number of nnode to make dirty
888 * @lnum: LEB number where nnode was written
889 * @offs: offset where nnode was written
891 * This function is used by LPT garbage collection. LPT garbage collection is
892 * used only for the "big" LPT model (c->big_lpt == 1). Garbage collection
893 * simply involves marking all the nodes in the LEB being garbage-collected as
894 * dirty. The dirty nodes are written next commit, after which the LEB is free
897 * This function returns %0 on success and a negative error code on failure.
899 static int make_nnode_dirty(struct ubifs_info
*c
, int node_num
, int lnum
,
902 struct ubifs_nnode
*nnode
;
904 nnode
= nnode_lookup(c
, node_num
);
906 return PTR_ERR(nnode
);
908 struct ubifs_nbranch
*branch
;
910 branch
= &nnode
->parent
->nbranch
[nnode
->iip
];
911 if (branch
->lnum
!= lnum
|| branch
->offs
!= offs
)
912 return 0; /* nnode is obsolete */
913 } else if (c
->lpt_lnum
!= lnum
|| c
->lpt_offs
!= offs
)
914 return 0; /* nnode is obsolete */
915 /* Assumes cnext list is empty i.e. not called during commit */
916 if (!test_and_set_bit(DIRTY_CNODE
, &nnode
->flags
)) {
917 c
->dirty_nn_cnt
+= 1;
918 ubifs_add_nnode_dirt(c
, nnode
);
919 /* Mark parent and ancestors dirty too */
920 nnode
= nnode
->parent
;
922 if (!test_and_set_bit(DIRTY_CNODE
, &nnode
->flags
)) {
923 c
->dirty_nn_cnt
+= 1;
924 ubifs_add_nnode_dirt(c
, nnode
);
925 nnode
= nnode
->parent
;
934 * make_pnode_dirty - find a pnode and, if found, make it dirty.
935 * @c: UBIFS file-system description object
936 * @node_num: pnode number of pnode to make dirty
937 * @lnum: LEB number where pnode was written
938 * @offs: offset where pnode was written
940 * This function is used by LPT garbage collection. LPT garbage collection is
941 * used only for the "big" LPT model (c->big_lpt == 1). Garbage collection
942 * simply involves marking all the nodes in the LEB being garbage-collected as
943 * dirty. The dirty nodes are written next commit, after which the LEB is free
946 * This function returns %0 on success and a negative error code on failure.
948 static int make_pnode_dirty(struct ubifs_info
*c
, int node_num
, int lnum
,
951 struct ubifs_pnode
*pnode
;
952 struct ubifs_nbranch
*branch
;
954 pnode
= pnode_lookup(c
, node_num
);
956 return PTR_ERR(pnode
);
957 branch
= &pnode
->parent
->nbranch
[pnode
->iip
];
958 if (branch
->lnum
!= lnum
|| branch
->offs
!= offs
)
960 do_make_pnode_dirty(c
, pnode
);
965 * make_ltab_dirty - make ltab node dirty.
966 * @c: UBIFS file-system description object
967 * @lnum: LEB number where ltab was written
968 * @offs: offset where ltab was written
970 * This function is used by LPT garbage collection. LPT garbage collection is
971 * used only for the "big" LPT model (c->big_lpt == 1). Garbage collection
972 * simply involves marking all the nodes in the LEB being garbage-collected as
973 * dirty. The dirty nodes are written next commit, after which the LEB is free
976 * This function returns %0 on success and a negative error code on failure.
978 static int make_ltab_dirty(struct ubifs_info
*c
, int lnum
, int offs
)
980 if (lnum
!= c
->ltab_lnum
|| offs
!= c
->ltab_offs
)
981 return 0; /* This ltab node is obsolete */
982 if (!(c
->lpt_drty_flgs
& LTAB_DIRTY
)) {
983 c
->lpt_drty_flgs
|= LTAB_DIRTY
;
984 ubifs_add_lpt_dirt(c
, c
->ltab_lnum
, c
->ltab_sz
);
990 * make_lsave_dirty - make lsave node dirty.
991 * @c: UBIFS file-system description object
992 * @lnum: LEB number where lsave was written
993 * @offs: offset where lsave was written
995 * This function is used by LPT garbage collection. LPT garbage collection is
996 * used only for the "big" LPT model (c->big_lpt == 1). Garbage collection
997 * simply involves marking all the nodes in the LEB being garbage-collected as
998 * dirty. The dirty nodes are written next commit, after which the LEB is free
1001 * This function returns %0 on success and a negative error code on failure.
1003 static int make_lsave_dirty(struct ubifs_info
*c
, int lnum
, int offs
)
1005 if (lnum
!= c
->lsave_lnum
|| offs
!= c
->lsave_offs
)
1006 return 0; /* This lsave node is obsolete */
1007 if (!(c
->lpt_drty_flgs
& LSAVE_DIRTY
)) {
1008 c
->lpt_drty_flgs
|= LSAVE_DIRTY
;
1009 ubifs_add_lpt_dirt(c
, c
->lsave_lnum
, c
->lsave_sz
);
1015 * make_node_dirty - make node dirty.
1016 * @c: UBIFS file-system description object
1017 * @node_type: LPT node type
1018 * @node_num: node number
1019 * @lnum: LEB number where node was written
1020 * @offs: offset where node was written
1022 * This function is used by LPT garbage collection. LPT garbage collection is
1023 * used only for the "big" LPT model (c->big_lpt == 1). Garbage collection
1024 * simply involves marking all the nodes in the LEB being garbage-collected as
1025 * dirty. The dirty nodes are written next commit, after which the LEB is free
1028 * This function returns %0 on success and a negative error code on failure.
1030 static int make_node_dirty(struct ubifs_info
*c
, int node_type
, int node_num
,
1033 switch (node_type
) {
1034 case UBIFS_LPT_NNODE
:
1035 return make_nnode_dirty(c
, node_num
, lnum
, offs
);
1036 case UBIFS_LPT_PNODE
:
1037 return make_pnode_dirty(c
, node_num
, lnum
, offs
);
1038 case UBIFS_LPT_LTAB
:
1039 return make_ltab_dirty(c
, lnum
, offs
);
1040 case UBIFS_LPT_LSAVE
:
1041 return make_lsave_dirty(c
, lnum
, offs
);
1047 * get_lpt_node_len - return the length of a node based on its type.
1048 * @c: UBIFS file-system description object
1049 * @node_type: LPT node type
1051 static int get_lpt_node_len(const struct ubifs_info
*c
, int node_type
)
1053 switch (node_type
) {
1054 case UBIFS_LPT_NNODE
:
1056 case UBIFS_LPT_PNODE
:
1058 case UBIFS_LPT_LTAB
:
1060 case UBIFS_LPT_LSAVE
:
1067 * get_pad_len - return the length of padding in a buffer.
1068 * @c: UBIFS file-system description object
1070 * @len: length of buffer
1072 static int get_pad_len(const struct ubifs_info
*c
, uint8_t *buf
, int len
)
1076 if (c
->min_io_size
== 1)
1078 offs
= c
->leb_size
- len
;
1079 pad_len
= ALIGN(offs
, c
->min_io_size
) - offs
;
1084 * get_lpt_node_type - return type (and node number) of a node in a buffer.
1085 * @c: UBIFS file-system description object
1087 * @node_num: node number is returned here
1089 static int get_lpt_node_type(const struct ubifs_info
*c
, uint8_t *buf
,
1092 uint8_t *addr
= buf
+ UBIFS_LPT_CRC_BYTES
;
1093 int pos
= 0, node_type
;
1095 node_type
= ubifs_unpack_bits(&addr
, &pos
, UBIFS_LPT_TYPE_BITS
);
1096 *node_num
= ubifs_unpack_bits(&addr
, &pos
, c
->pcnt_bits
);
1101 * is_a_node - determine if a buffer contains a node.
1102 * @c: UBIFS file-system description object
1104 * @len: length of buffer
1106 * This function returns %1 if the buffer contains a node or %0 if it does not.
1108 static int is_a_node(const struct ubifs_info
*c
, uint8_t *buf
, int len
)
1110 uint8_t *addr
= buf
+ UBIFS_LPT_CRC_BYTES
;
1111 int pos
= 0, node_type
, node_len
;
1112 uint16_t crc
, calc_crc
;
1114 if (len
< UBIFS_LPT_CRC_BYTES
+ (UBIFS_LPT_TYPE_BITS
+ 7) / 8)
1116 node_type
= ubifs_unpack_bits(&addr
, &pos
, UBIFS_LPT_TYPE_BITS
);
1117 if (node_type
== UBIFS_LPT_NOT_A_NODE
)
1119 node_len
= get_lpt_node_len(c
, node_type
);
1120 if (!node_len
|| node_len
> len
)
1124 crc
= ubifs_unpack_bits(&addr
, &pos
, UBIFS_LPT_CRC_BITS
);
1125 calc_crc
= crc16(-1, buf
+ UBIFS_LPT_CRC_BYTES
,
1126 node_len
- UBIFS_LPT_CRC_BYTES
);
1127 if (crc
!= calc_crc
)
1133 * lpt_gc_lnum - garbage collect a LPT LEB.
1134 * @c: UBIFS file-system description object
1135 * @lnum: LEB number to garbage collect
1137 * LPT garbage collection is used only for the "big" LPT model
1138 * (c->big_lpt == 1). Garbage collection simply involves marking all the nodes
1139 * in the LEB being garbage-collected as dirty. The dirty nodes are written
1140 * next commit, after which the LEB is free to be reused.
1142 * This function returns %0 on success and a negative error code on failure.
1144 static int lpt_gc_lnum(struct ubifs_info
*c
, int lnum
)
1146 int err
, len
= c
->leb_size
, node_type
, node_num
, node_len
, offs
;
1147 void *buf
= c
->lpt_buf
;
1149 dbg_lp("LEB %d", lnum
);
1150 err
= ubi_read(c
->ubi
, lnum
, buf
, 0, c
->leb_size
);
1152 ubifs_err("cannot read LEB %d, error %d", lnum
, err
);
1156 if (!is_a_node(c
, buf
, len
)) {
1159 pad_len
= get_pad_len(c
, buf
, len
);
1167 node_type
= get_lpt_node_type(c
, buf
, &node_num
);
1168 node_len
= get_lpt_node_len(c
, node_type
);
1169 offs
= c
->leb_size
- len
;
1170 ubifs_assert(node_len
!= 0);
1171 mutex_lock(&c
->lp_mutex
);
1172 err
= make_node_dirty(c
, node_type
, node_num
, lnum
, offs
);
1173 mutex_unlock(&c
->lp_mutex
);
1183 * lpt_gc - LPT garbage collection.
1184 * @c: UBIFS file-system description object
1186 * Select a LPT LEB for LPT garbage collection and call 'lpt_gc_lnum()'.
1187 * Returns %0 on success and a negative error code on failure.
1189 static int lpt_gc(struct ubifs_info
*c
)
1191 int i
, lnum
= -1, dirty
= 0;
1193 mutex_lock(&c
->lp_mutex
);
1194 for (i
= 0; i
< c
->lpt_lebs
; i
++) {
1195 ubifs_assert(!c
->ltab
[i
].tgc
);
1196 if (i
+ c
->lpt_first
== c
->nhead_lnum
||
1197 c
->ltab
[i
].free
+ c
->ltab
[i
].dirty
== c
->leb_size
)
1199 if (c
->ltab
[i
].dirty
> dirty
) {
1200 dirty
= c
->ltab
[i
].dirty
;
1201 lnum
= i
+ c
->lpt_first
;
1204 mutex_unlock(&c
->lp_mutex
);
1207 return lpt_gc_lnum(c
, lnum
);
1211 * ubifs_lpt_start_commit - UBIFS commit starts.
1212 * @c: the UBIFS file-system description object
1214 * This function has to be called when UBIFS starts the commit operation.
1215 * This function "freezes" all currently dirty LEB properties and does not
1216 * change them anymore. Further changes are saved and tracked separately
1217 * because they are not part of this commit. This function returns zero in case
1218 * of success and a negative error code in case of failure.
1220 int ubifs_lpt_start_commit(struct ubifs_info
*c
)
1226 mutex_lock(&c
->lp_mutex
);
1227 err
= dbg_chk_lpt_free_spc(c
);
1230 err
= dbg_check_ltab(c
);
1234 if (c
->check_lpt_free
) {
1236 * We ensure there is enough free space in
1237 * ubifs_lpt_post_commit() by marking nodes dirty. That
1238 * information is lost when we unmount, so we also need
1239 * to check free space once after mounting also.
1241 c
->check_lpt_free
= 0;
1242 while (need_write_all(c
)) {
1243 mutex_unlock(&c
->lp_mutex
);
1247 mutex_lock(&c
->lp_mutex
);
1253 if (!c
->dirty_pn_cnt
) {
1254 dbg_cmt("no cnodes to commit");
1259 if (!c
->big_lpt
&& need_write_all(c
)) {
1260 /* If needed, write everything */
1261 err
= make_tree_dirty(c
);
1270 cnt
= get_cnodes_to_commit(c
);
1271 ubifs_assert(cnt
!= 0);
1273 err
= layout_cnodes(c
);
1277 /* Copy the LPT's own lprops for end commit to write */
1278 memcpy(c
->ltab_cmt
, c
->ltab
,
1279 sizeof(struct ubifs_lpt_lprops
) * c
->lpt_lebs
);
1280 c
->lpt_drty_flgs
&= ~(LTAB_DIRTY
| LSAVE_DIRTY
);
1283 mutex_unlock(&c
->lp_mutex
);
1288 * free_obsolete_cnodes - free obsolete cnodes for commit end.
1289 * @c: UBIFS file-system description object
1291 static void free_obsolete_cnodes(struct ubifs_info
*c
)
1293 struct ubifs_cnode
*cnode
, *cnext
;
1295 cnext
= c
->lpt_cnext
;
1300 cnext
= cnode
->cnext
;
1301 if (test_bit(OBSOLETE_CNODE
, &cnode
->flags
))
1304 cnode
->cnext
= NULL
;
1305 } while (cnext
!= c
->lpt_cnext
);
1306 c
->lpt_cnext
= NULL
;
1310 * ubifs_lpt_end_commit - finish the commit operation.
1311 * @c: the UBIFS file-system description object
1313 * This function has to be called when the commit operation finishes. It
1314 * flushes the changes which were "frozen" by 'ubifs_lprops_start_commit()' to
1315 * the media. Returns zero in case of success and a negative error code in case
1318 int ubifs_lpt_end_commit(struct ubifs_info
*c
)
1327 err
= write_cnodes(c
);
1331 mutex_lock(&c
->lp_mutex
);
1332 free_obsolete_cnodes(c
);
1333 mutex_unlock(&c
->lp_mutex
);
1339 * ubifs_lpt_post_commit - post commit LPT trivial GC and LPT GC.
1340 * @c: UBIFS file-system description object
1342 * LPT trivial GC is completed after a commit. Also LPT GC is done after a
1343 * commit for the "big" LPT model.
1345 int ubifs_lpt_post_commit(struct ubifs_info
*c
)
1349 mutex_lock(&c
->lp_mutex
);
1350 err
= lpt_tgc_end(c
);
1354 while (need_write_all(c
)) {
1355 mutex_unlock(&c
->lp_mutex
);
1359 mutex_lock(&c
->lp_mutex
);
1362 mutex_unlock(&c
->lp_mutex
);
1367 * first_nnode - find the first nnode in memory.
1368 * @c: UBIFS file-system description object
1369 * @hght: height of tree where nnode found is returned here
1371 * This function returns a pointer to the nnode found or %NULL if no nnode is
1372 * found. This function is a helper to 'ubifs_lpt_free()'.
1374 static struct ubifs_nnode
*first_nnode(struct ubifs_info
*c
, int *hght
)
1376 struct ubifs_nnode
*nnode
;
1383 for (h
= 1; h
< c
->lpt_hght
; h
++) {
1385 for (i
= 0; i
< UBIFS_LPT_FANOUT
; i
++) {
1386 if (nnode
->nbranch
[i
].nnode
) {
1388 nnode
= nnode
->nbranch
[i
].nnode
;
1400 * next_nnode - find the next nnode in memory.
1401 * @c: UBIFS file-system description object
1402 * @nnode: nnode from which to start.
1403 * @hght: height of tree where nnode is, is passed and returned here
1405 * This function returns a pointer to the nnode found or %NULL if no nnode is
1406 * found. This function is a helper to 'ubifs_lpt_free()'.
1408 static struct ubifs_nnode
*next_nnode(struct ubifs_info
*c
,
1409 struct ubifs_nnode
*nnode
, int *hght
)
1411 struct ubifs_nnode
*parent
;
1412 int iip
, h
, i
, found
;
1414 parent
= nnode
->parent
;
1417 if (nnode
->iip
== UBIFS_LPT_FANOUT
- 1) {
1421 for (iip
= nnode
->iip
+ 1; iip
< UBIFS_LPT_FANOUT
; iip
++) {
1422 nnode
= parent
->nbranch
[iip
].nnode
;
1430 for (h
= *hght
+ 1; h
< c
->lpt_hght
; h
++) {
1432 for (i
= 0; i
< UBIFS_LPT_FANOUT
; i
++) {
1433 if (nnode
->nbranch
[i
].nnode
) {
1435 nnode
= nnode
->nbranch
[i
].nnode
;
1447 * ubifs_lpt_free - free resources owned by the LPT.
1448 * @c: UBIFS file-system description object
1449 * @wr_only: free only resources used for writing
1451 void ubifs_lpt_free(struct ubifs_info
*c
, int wr_only
)
1453 struct ubifs_nnode
*nnode
;
1456 /* Free write-only things first */
1458 free_obsolete_cnodes(c
); /* Leftover from a failed commit */
1470 /* Now free the rest */
1472 nnode
= first_nnode(c
, &hght
);
1474 for (i
= 0; i
< UBIFS_LPT_FANOUT
; i
++)
1475 kfree(nnode
->nbranch
[i
].nnode
);
1476 nnode
= next_nnode(c
, nnode
, &hght
);
1478 for (i
= 0; i
< LPROPS_HEAP_CNT
; i
++)
1479 kfree(c
->lpt_heap
[i
].arr
);
1480 kfree(c
->dirty_idx
.arr
);
1483 kfree(c
->lpt_nod_buf
);
1486 #ifdef CONFIG_UBIFS_FS_DEBUG
1489 * dbg_is_all_ff - determine if a buffer contains only 0xFF bytes.
1491 * @len: buffer length
1493 static int dbg_is_all_ff(uint8_t *buf
, int len
)
1497 for (i
= 0; i
< len
; i
++)
1504 * dbg_is_nnode_dirty - determine if a nnode is dirty.
1505 * @c: the UBIFS file-system description object
1506 * @lnum: LEB number where nnode was written
1507 * @offs: offset where nnode was written
1509 static int dbg_is_nnode_dirty(struct ubifs_info
*c
, int lnum
, int offs
)
1511 struct ubifs_nnode
*nnode
;
1514 /* Entire tree is in memory so first_nnode / next_nnode are OK */
1515 nnode
= first_nnode(c
, &hght
);
1516 for (; nnode
; nnode
= next_nnode(c
, nnode
, &hght
)) {
1517 struct ubifs_nbranch
*branch
;
1520 if (nnode
->parent
) {
1521 branch
= &nnode
->parent
->nbranch
[nnode
->iip
];
1522 if (branch
->lnum
!= lnum
|| branch
->offs
!= offs
)
1524 if (test_bit(DIRTY_CNODE
, &nnode
->flags
))
1528 if (c
->lpt_lnum
!= lnum
|| c
->lpt_offs
!= offs
)
1530 if (test_bit(DIRTY_CNODE
, &nnode
->flags
))
1539 * dbg_is_pnode_dirty - determine if a pnode is dirty.
1540 * @c: the UBIFS file-system description object
1541 * @lnum: LEB number where pnode was written
1542 * @offs: offset where pnode was written
1544 static int dbg_is_pnode_dirty(struct ubifs_info
*c
, int lnum
, int offs
)
1548 cnt
= DIV_ROUND_UP(c
->main_lebs
, UBIFS_LPT_FANOUT
);
1549 for (i
= 0; i
< cnt
; i
++) {
1550 struct ubifs_pnode
*pnode
;
1551 struct ubifs_nbranch
*branch
;
1554 pnode
= pnode_lookup(c
, i
);
1556 return PTR_ERR(pnode
);
1557 branch
= &pnode
->parent
->nbranch
[pnode
->iip
];
1558 if (branch
->lnum
!= lnum
|| branch
->offs
!= offs
)
1560 if (test_bit(DIRTY_CNODE
, &pnode
->flags
))
1568 * dbg_is_ltab_dirty - determine if a ltab node is dirty.
1569 * @c: the UBIFS file-system description object
1570 * @lnum: LEB number where ltab node was written
1571 * @offs: offset where ltab node was written
1573 static int dbg_is_ltab_dirty(struct ubifs_info
*c
, int lnum
, int offs
)
1575 if (lnum
!= c
->ltab_lnum
|| offs
!= c
->ltab_offs
)
1577 return (c
->lpt_drty_flgs
& LTAB_DIRTY
) != 0;
1581 * dbg_is_lsave_dirty - determine if a lsave node is dirty.
1582 * @c: the UBIFS file-system description object
1583 * @lnum: LEB number where lsave node was written
1584 * @offs: offset where lsave node was written
1586 static int dbg_is_lsave_dirty(struct ubifs_info
*c
, int lnum
, int offs
)
1588 if (lnum
!= c
->lsave_lnum
|| offs
!= c
->lsave_offs
)
1590 return (c
->lpt_drty_flgs
& LSAVE_DIRTY
) != 0;
1594 * dbg_is_node_dirty - determine if a node is dirty.
1595 * @c: the UBIFS file-system description object
1596 * @node_type: node type
1597 * @lnum: LEB number where node was written
1598 * @offs: offset where node was written
1600 static int dbg_is_node_dirty(struct ubifs_info
*c
, int node_type
, int lnum
,
1603 switch (node_type
) {
1604 case UBIFS_LPT_NNODE
:
1605 return dbg_is_nnode_dirty(c
, lnum
, offs
);
1606 case UBIFS_LPT_PNODE
:
1607 return dbg_is_pnode_dirty(c
, lnum
, offs
);
1608 case UBIFS_LPT_LTAB
:
1609 return dbg_is_ltab_dirty(c
, lnum
, offs
);
1610 case UBIFS_LPT_LSAVE
:
1611 return dbg_is_lsave_dirty(c
, lnum
, offs
);
1617 * dbg_check_ltab_lnum - check the ltab for a LPT LEB number.
1618 * @c: the UBIFS file-system description object
1619 * @lnum: LEB number where node was written
1620 * @offs: offset where node was written
1622 * This function returns %0 on success and a negative error code on failure.
1624 static int dbg_check_ltab_lnum(struct ubifs_info
*c
, int lnum
)
1626 int err
, len
= c
->leb_size
, dirty
= 0, node_type
, node_num
, node_len
;
1628 void *buf
= c
->dbg
->buf
;
1630 if (!(ubifs_chk_flags
& UBIFS_CHK_LPROPS
))
1633 dbg_lp("LEB %d", lnum
);
1634 err
= ubi_read(c
->ubi
, lnum
, buf
, 0, c
->leb_size
);
1636 dbg_msg("ubi_read failed, LEB %d, error %d", lnum
, err
);
1640 if (!is_a_node(c
, buf
, len
)) {
1643 pad_len
= get_pad_len(c
, buf
, len
);
1650 if (!dbg_is_all_ff(buf
, len
)) {
1651 dbg_msg("invalid empty space in LEB %d at %d",
1652 lnum
, c
->leb_size
- len
);
1655 i
= lnum
- c
->lpt_first
;
1656 if (len
!= c
->ltab
[i
].free
) {
1657 dbg_msg("invalid free space in LEB %d "
1658 "(free %d, expected %d)",
1659 lnum
, len
, c
->ltab
[i
].free
);
1662 if (dirty
!= c
->ltab
[i
].dirty
) {
1663 dbg_msg("invalid dirty space in LEB %d "
1664 "(dirty %d, expected %d)",
1665 lnum
, dirty
, c
->ltab
[i
].dirty
);
1670 node_type
= get_lpt_node_type(c
, buf
, &node_num
);
1671 node_len
= get_lpt_node_len(c
, node_type
);
1672 ret
= dbg_is_node_dirty(c
, node_type
, lnum
, c
->leb_size
- len
);
1681 * dbg_check_ltab - check the free and dirty space in the ltab.
1682 * @c: the UBIFS file-system description object
1684 * This function returns %0 on success and a negative error code on failure.
1686 int dbg_check_ltab(struct ubifs_info
*c
)
1688 int lnum
, err
, i
, cnt
;
1690 if (!(ubifs_chk_flags
& UBIFS_CHK_LPROPS
))
1693 /* Bring the entire tree into memory */
1694 cnt
= DIV_ROUND_UP(c
->main_lebs
, UBIFS_LPT_FANOUT
);
1695 for (i
= 0; i
< cnt
; i
++) {
1696 struct ubifs_pnode
*pnode
;
1698 pnode
= pnode_lookup(c
, i
);
1700 return PTR_ERR(pnode
);
1705 err
= dbg_check_lpt_nodes(c
, (struct ubifs_cnode
*)c
->nroot
, 0, 0);
1709 /* Check each LEB */
1710 for (lnum
= c
->lpt_first
; lnum
<= c
->lpt_last
; lnum
++) {
1711 err
= dbg_check_ltab_lnum(c
, lnum
);
1713 dbg_err("failed at LEB %d", lnum
);
1718 dbg_lp("succeeded");
1723 * dbg_chk_lpt_free_spc - check LPT free space is enough to write entire LPT.
1724 * @c: the UBIFS file-system description object
1726 * This function returns %0 on success and a negative error code on failure.
1728 int dbg_chk_lpt_free_spc(struct ubifs_info
*c
)
1733 if (!(ubifs_chk_flags
& UBIFS_CHK_LPROPS
))
1736 for (i
= 0; i
< c
->lpt_lebs
; i
++) {
1737 if (c
->ltab
[i
].tgc
|| c
->ltab
[i
].cmt
)
1739 if (i
+ c
->lpt_first
== c
->nhead_lnum
)
1740 free
+= c
->leb_size
- c
->nhead_offs
;
1741 else if (c
->ltab
[i
].free
== c
->leb_size
)
1742 free
+= c
->leb_size
;
1744 if (free
< c
->lpt_sz
) {
1745 dbg_err("LPT space error: free %lld lpt_sz %lld",
1747 dbg_dump_lpt_info(c
);
1748 dbg_dump_lpt_lebs(c
);
1756 * dbg_chk_lpt_sz - check LPT does not write more than LPT size.
1757 * @c: the UBIFS file-system description object
1758 * @action: what to do
1759 * @len: length written
1761 * This function returns %0 on success and a negative error code on failure.
1762 * The @action argument may be one of:
1763 * o %0 - LPT debugging checking starts, initialize debugging variables;
1764 * o %1 - wrote an LPT node, increase LPT size by @len bytes;
1765 * o %2 - switched to a different LEB and wasted @len bytes;
1766 * o %3 - check that we've written the right number of bytes.
1767 * o %4 - wasted @len bytes;
1769 int dbg_chk_lpt_sz(struct ubifs_info
*c
, int action
, int len
)
1771 struct ubifs_debug_info
*d
= c
->dbg
;
1772 long long chk_lpt_sz
, lpt_sz
;
1775 if (!(ubifs_chk_flags
& UBIFS_CHK_LPROPS
))
1782 d
->chk_lpt_lebs
= 0;
1783 d
->chk_lpt_wastage
= 0;
1784 if (c
->dirty_pn_cnt
> c
->pnode_cnt
) {
1785 dbg_err("dirty pnodes %d exceed max %d",
1786 c
->dirty_pn_cnt
, c
->pnode_cnt
);
1789 if (c
->dirty_nn_cnt
> c
->nnode_cnt
) {
1790 dbg_err("dirty nnodes %d exceed max %d",
1791 c
->dirty_nn_cnt
, c
->nnode_cnt
);
1796 d
->chk_lpt_sz
+= len
;
1799 d
->chk_lpt_sz
+= len
;
1800 d
->chk_lpt_wastage
+= len
;
1801 d
->chk_lpt_lebs
+= 1;
1804 chk_lpt_sz
= c
->leb_size
;
1805 chk_lpt_sz
*= d
->chk_lpt_lebs
;
1806 chk_lpt_sz
+= len
- c
->nhead_offs
;
1807 if (d
->chk_lpt_sz
!= chk_lpt_sz
) {
1808 dbg_err("LPT wrote %lld but space used was %lld",
1809 d
->chk_lpt_sz
, chk_lpt_sz
);
1812 if (d
->chk_lpt_sz
> c
->lpt_sz
) {
1813 dbg_err("LPT wrote %lld but lpt_sz is %lld",
1814 d
->chk_lpt_sz
, c
->lpt_sz
);
1817 if (d
->chk_lpt_sz2
&& d
->chk_lpt_sz
!= d
->chk_lpt_sz2
) {
1818 dbg_err("LPT layout size %lld but wrote %lld",
1819 d
->chk_lpt_sz
, d
->chk_lpt_sz2
);
1822 if (d
->chk_lpt_sz2
&& d
->new_nhead_offs
!= len
) {
1823 dbg_err("LPT new nhead offs: expected %d was %d",
1824 d
->new_nhead_offs
, len
);
1827 lpt_sz
= (long long)c
->pnode_cnt
* c
->pnode_sz
;
1828 lpt_sz
+= (long long)c
->nnode_cnt
* c
->nnode_sz
;
1829 lpt_sz
+= c
->ltab_sz
;
1831 lpt_sz
+= c
->lsave_sz
;
1832 if (d
->chk_lpt_sz
- d
->chk_lpt_wastage
> lpt_sz
) {
1833 dbg_err("LPT chk_lpt_sz %lld + waste %lld exceeds %lld",
1834 d
->chk_lpt_sz
, d
->chk_lpt_wastage
, lpt_sz
);
1838 dbg_dump_lpt_info(c
);
1839 dbg_dump_lpt_lebs(c
);
1842 d
->chk_lpt_sz2
= d
->chk_lpt_sz
;
1844 d
->chk_lpt_wastage
= 0;
1845 d
->chk_lpt_lebs
= 0;
1846 d
->new_nhead_offs
= len
;
1849 d
->chk_lpt_sz
+= len
;
1850 d
->chk_lpt_wastage
+= len
;
1858 * dbg_dump_lpt_leb - dump an LPT LEB.
1859 * @c: UBIFS file-system description object
1860 * @lnum: LEB number to dump
1862 * This function dumps an LEB from LPT area. Nodes in this area are very
1863 * different to nodes in the main area (e.g., they do not have common headers,
1864 * they do not have 8-byte alignments, etc), so we have a separate function to
1865 * dump LPT area LEBs. Note, LPT has to be locked by the caller.
1867 static void dump_lpt_leb(const struct ubifs_info
*c
, int lnum
)
1869 int err
, len
= c
->leb_size
, node_type
, node_num
, node_len
, offs
;
1870 void *buf
= c
->dbg
->buf
;
1872 printk(KERN_DEBUG
"(pid %d) start dumping LEB %d\n",
1873 current
->pid
, lnum
);
1874 err
= ubi_read(c
->ubi
, lnum
, buf
, 0, c
->leb_size
);
1876 ubifs_err("cannot read LEB %d, error %d", lnum
, err
);
1880 offs
= c
->leb_size
- len
;
1881 if (!is_a_node(c
, buf
, len
)) {
1884 pad_len
= get_pad_len(c
, buf
, len
);
1886 printk(KERN_DEBUG
"LEB %d:%d, pad %d bytes\n",
1887 lnum
, offs
, pad_len
);
1893 printk(KERN_DEBUG
"LEB %d:%d, free %d bytes\n",
1898 node_type
= get_lpt_node_type(c
, buf
, &node_num
);
1899 switch (node_type
) {
1900 case UBIFS_LPT_PNODE
:
1902 node_len
= c
->pnode_sz
;
1904 printk(KERN_DEBUG
"LEB %d:%d, pnode num %d\n",
1905 lnum
, offs
, node_num
);
1907 printk(KERN_DEBUG
"LEB %d:%d, pnode\n",
1911 case UBIFS_LPT_NNODE
:
1914 struct ubifs_nnode nnode
;
1916 node_len
= c
->nnode_sz
;
1918 printk(KERN_DEBUG
"LEB %d:%d, nnode num %d, ",
1919 lnum
, offs
, node_num
);
1921 printk(KERN_DEBUG
"LEB %d:%d, nnode, ",
1923 err
= ubifs_unpack_nnode(c
, buf
, &nnode
);
1924 for (i
= 0; i
< UBIFS_LPT_FANOUT
; i
++) {
1925 printk(KERN_CONT
"%d:%d", nnode
.nbranch
[i
].lnum
,
1926 nnode
.nbranch
[i
].offs
);
1927 if (i
!= UBIFS_LPT_FANOUT
- 1)
1928 printk(KERN_CONT
", ");
1930 printk(KERN_CONT
"\n");
1933 case UBIFS_LPT_LTAB
:
1934 node_len
= c
->ltab_sz
;
1935 printk(KERN_DEBUG
"LEB %d:%d, ltab\n",
1938 case UBIFS_LPT_LSAVE
:
1939 node_len
= c
->lsave_sz
;
1940 printk(KERN_DEBUG
"LEB %d:%d, lsave len\n", lnum
, offs
);
1943 ubifs_err("LPT node type %d not recognized", node_type
);
1951 printk(KERN_DEBUG
"(pid %d) finish dumping LEB %d\n",
1952 current
->pid
, lnum
);
1956 * dbg_dump_lpt_lebs - dump LPT lebs.
1957 * @c: UBIFS file-system description object
1959 * This function dumps all LPT LEBs. The caller has to make sure the LPT is
1962 void dbg_dump_lpt_lebs(const struct ubifs_info
*c
)
1966 printk(KERN_DEBUG
"(pid %d) start dumping all LPT LEBs\n",
1968 for (i
= 0; i
< c
->lpt_lebs
; i
++)
1969 dump_lpt_leb(c
, i
+ c
->lpt_first
);
1970 printk(KERN_DEBUG
"(pid %d) finish dumping all LPT LEBs\n",
1974 #endif /* CONFIG_UBIFS_FS_DEBUG */