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 the functions that access LEB properties and their
25 * categories. LEBs are categorized based on the needs of UBIFS, and the
26 * categories are stored as either heaps or lists to provide a fast way of
27 * finding a LEB in a particular category. For example, UBIFS may need to find
28 * an empty LEB for the journal, or a very dirty LEB for garbage collection.
34 * get_heap_comp_val - get the LEB properties value for heap comparisons.
35 * @lprops: LEB properties
38 static int get_heap_comp_val(struct ubifs_lprops
*lprops
, int cat
)
43 case LPROPS_DIRTY_IDX
:
44 return lprops
->free
+ lprops
->dirty
;
51 * move_up_lpt_heap - move a new heap entry up as far as possible.
52 * @c: UBIFS file-system description object
53 * @heap: LEB category heap
54 * @lprops: LEB properties to move
57 * New entries to a heap are added at the bottom and then moved up until the
58 * parent's value is greater. In the case of LPT's category heaps, the value
59 * is either the amount of free space or the amount of dirty space, depending
62 static void move_up_lpt_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
,
63 struct ubifs_lprops
*lprops
, int cat
)
69 return; /* Already top of the heap */
70 val1
= get_heap_comp_val(lprops
, cat
);
71 /* Compare to parent and, if greater, move up the heap */
73 int ppos
= (hpos
- 1) / 2;
75 val2
= get_heap_comp_val(heap
->arr
[ppos
], cat
);
78 /* Greater than parent so move up */
79 heap
->arr
[ppos
]->hpos
= hpos
;
80 heap
->arr
[hpos
] = heap
->arr
[ppos
];
81 heap
->arr
[ppos
] = lprops
;
88 * adjust_lpt_heap - move a changed heap entry up or down the heap.
89 * @c: UBIFS file-system description object
90 * @heap: LEB category heap
91 * @lprops: LEB properties to move
92 * @hpos: heap position of @lprops
95 * Changed entries in a heap are moved up or down until the parent's value is
96 * greater. In the case of LPT's category heaps, the value is either the amount
97 * of free space or the amount of dirty space, depending on the category.
99 static void adjust_lpt_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
,
100 struct ubifs_lprops
*lprops
, int hpos
, int cat
)
102 int val1
, val2
, val3
, cpos
;
104 val1
= get_heap_comp_val(lprops
, cat
);
105 /* Compare to parent and, if greater than parent, move up the heap */
107 int ppos
= (hpos
- 1) / 2;
109 val2
= get_heap_comp_val(heap
->arr
[ppos
], cat
);
111 /* Greater than parent so move up */
113 heap
->arr
[ppos
]->hpos
= hpos
;
114 heap
->arr
[hpos
] = heap
->arr
[ppos
];
115 heap
->arr
[ppos
] = lprops
;
120 ppos
= (hpos
- 1) / 2;
121 val2
= get_heap_comp_val(heap
->arr
[ppos
], cat
);
124 /* Still greater than parent so keep going */
129 /* Not greater than parent, so compare to children */
131 /* Compare to left child */
133 if (cpos
>= heap
->cnt
)
135 val2
= get_heap_comp_val(heap
->arr
[cpos
], cat
);
137 /* Less than left child, so promote biggest child */
138 if (cpos
+ 1 < heap
->cnt
) {
139 val3
= get_heap_comp_val(heap
->arr
[cpos
+ 1],
142 cpos
+= 1; /* Right child is bigger */
144 heap
->arr
[cpos
]->hpos
= hpos
;
145 heap
->arr
[hpos
] = heap
->arr
[cpos
];
146 heap
->arr
[cpos
] = lprops
;
151 /* Compare to right child */
153 if (cpos
>= heap
->cnt
)
155 val3
= get_heap_comp_val(heap
->arr
[cpos
], cat
);
157 /* Less than right child, so promote right child */
158 heap
->arr
[cpos
]->hpos
= hpos
;
159 heap
->arr
[hpos
] = heap
->arr
[cpos
];
160 heap
->arr
[cpos
] = lprops
;
170 * add_to_lpt_heap - add LEB properties to a LEB category heap.
171 * @c: UBIFS file-system description object
172 * @lprops: LEB properties to add
175 * This function returns %1 if @lprops is added to the heap for LEB category
176 * @cat, otherwise %0 is returned because the heap is full.
178 static int add_to_lpt_heap(struct ubifs_info
*c
, struct ubifs_lprops
*lprops
,
181 struct ubifs_lpt_heap
*heap
= &c
->lpt_heap
[cat
- 1];
183 if (heap
->cnt
>= heap
->max_cnt
) {
184 const int b
= LPT_HEAP_SZ
/ 2 - 1;
185 int cpos
, val1
, val2
;
187 /* Compare to some other LEB on the bottom of heap */
188 /* Pick a position kind of randomly */
189 cpos
= (((size_t)lprops
>> 4) & b
) + b
;
190 ubifs_assert(cpos
>= b
);
191 ubifs_assert(cpos
< LPT_HEAP_SZ
);
192 ubifs_assert(cpos
< heap
->cnt
);
194 val1
= get_heap_comp_val(lprops
, cat
);
195 val2
= get_heap_comp_val(heap
->arr
[cpos
], cat
);
197 struct ubifs_lprops
*lp
;
199 lp
= heap
->arr
[cpos
];
200 lp
->flags
&= ~LPROPS_CAT_MASK
;
201 lp
->flags
|= LPROPS_UNCAT
;
202 list_add(&lp
->list
, &c
->uncat_list
);
204 heap
->arr
[cpos
] = lprops
;
205 move_up_lpt_heap(c
, heap
, lprops
, cat
);
206 dbg_check_heap(c
, heap
, cat
, lprops
->hpos
);
207 return 1; /* Added to heap */
209 dbg_check_heap(c
, heap
, cat
, -1);
210 return 0; /* Not added to heap */
212 lprops
->hpos
= heap
->cnt
++;
213 heap
->arr
[lprops
->hpos
] = lprops
;
214 move_up_lpt_heap(c
, heap
, lprops
, cat
);
215 dbg_check_heap(c
, heap
, cat
, lprops
->hpos
);
216 return 1; /* Added to heap */
221 * remove_from_lpt_heap - remove LEB properties from a LEB category heap.
222 * @c: UBIFS file-system description object
223 * @lprops: LEB properties to remove
226 static void remove_from_lpt_heap(struct ubifs_info
*c
,
227 struct ubifs_lprops
*lprops
, int cat
)
229 struct ubifs_lpt_heap
*heap
;
230 int hpos
= lprops
->hpos
;
232 heap
= &c
->lpt_heap
[cat
- 1];
233 ubifs_assert(hpos
>= 0 && hpos
< heap
->cnt
);
234 ubifs_assert(heap
->arr
[hpos
] == lprops
);
236 if (hpos
< heap
->cnt
) {
237 heap
->arr
[hpos
] = heap
->arr
[heap
->cnt
];
238 heap
->arr
[hpos
]->hpos
= hpos
;
239 adjust_lpt_heap(c
, heap
, heap
->arr
[hpos
], hpos
, cat
);
241 dbg_check_heap(c
, heap
, cat
, -1);
245 * lpt_heap_replace - replace lprops in a category heap.
246 * @c: UBIFS file-system description object
247 * @old_lprops: LEB properties to replace
248 * @new_lprops: LEB properties with which to replace
251 * During commit it is sometimes necessary to copy a pnode (see dirty_cow_pnode)
252 * and the lprops that the pnode contains. When that happens, references in
253 * the category heaps to those lprops must be updated to point to the new
254 * lprops. This function does that.
256 static void lpt_heap_replace(struct ubifs_info
*c
,
257 struct ubifs_lprops
*old_lprops
,
258 struct ubifs_lprops
*new_lprops
, int cat
)
260 struct ubifs_lpt_heap
*heap
;
261 int hpos
= new_lprops
->hpos
;
263 heap
= &c
->lpt_heap
[cat
- 1];
264 heap
->arr
[hpos
] = new_lprops
;
268 * ubifs_add_to_cat - add LEB properties to a category list or heap.
269 * @c: UBIFS file-system description object
270 * @lprops: LEB properties to add
271 * @cat: LEB category to which to add
273 * LEB properties are categorized to enable fast find operations.
275 void ubifs_add_to_cat(struct ubifs_info
*c
, struct ubifs_lprops
*lprops
,
280 case LPROPS_DIRTY_IDX
:
282 if (add_to_lpt_heap(c
, lprops
, cat
))
284 /* No more room on heap so make it un-categorized */
288 list_add(&lprops
->list
, &c
->uncat_list
);
291 list_add(&lprops
->list
, &c
->empty_list
);
293 case LPROPS_FREEABLE
:
294 list_add(&lprops
->list
, &c
->freeable_list
);
295 c
->freeable_cnt
+= 1;
297 case LPROPS_FRDI_IDX
:
298 list_add(&lprops
->list
, &c
->frdi_idx_list
);
304 lprops
->flags
&= ~LPROPS_CAT_MASK
;
305 lprops
->flags
|= cat
;
306 c
->in_a_category_cnt
+= 1;
307 ubifs_assert(c
->in_a_category_cnt
<= c
->main_lebs
);
311 * ubifs_remove_from_cat - remove LEB properties from a category list or heap.
312 * @c: UBIFS file-system description object
313 * @lprops: LEB properties to remove
314 * @cat: LEB category from which to remove
316 * LEB properties are categorized to enable fast find operations.
318 static void ubifs_remove_from_cat(struct ubifs_info
*c
,
319 struct ubifs_lprops
*lprops
, int cat
)
323 case LPROPS_DIRTY_IDX
:
325 remove_from_lpt_heap(c
, lprops
, cat
);
327 case LPROPS_FREEABLE
:
328 c
->freeable_cnt
-= 1;
329 ubifs_assert(c
->freeable_cnt
>= 0);
333 case LPROPS_FRDI_IDX
:
334 ubifs_assert(!list_empty(&lprops
->list
));
335 list_del(&lprops
->list
);
341 c
->in_a_category_cnt
-= 1;
342 ubifs_assert(c
->in_a_category_cnt
>= 0);
346 * ubifs_replace_cat - replace lprops in a category list or heap.
347 * @c: UBIFS file-system description object
348 * @old_lprops: LEB properties to replace
349 * @new_lprops: LEB properties with which to replace
351 * During commit it is sometimes necessary to copy a pnode (see dirty_cow_pnode)
352 * and the lprops that the pnode contains. When that happens, references in
353 * category lists and heaps must be replaced. This function does that.
355 void ubifs_replace_cat(struct ubifs_info
*c
, struct ubifs_lprops
*old_lprops
,
356 struct ubifs_lprops
*new_lprops
)
360 cat
= new_lprops
->flags
& LPROPS_CAT_MASK
;
363 case LPROPS_DIRTY_IDX
:
365 lpt_heap_replace(c
, old_lprops
, new_lprops
, cat
);
369 case LPROPS_FREEABLE
:
370 case LPROPS_FRDI_IDX
:
371 list_replace(&old_lprops
->list
, &new_lprops
->list
);
379 * ubifs_ensure_cat - ensure LEB properties are categorized.
380 * @c: UBIFS file-system description object
381 * @lprops: LEB properties
383 * A LEB may have fallen off of the bottom of a heap, and ended up as
384 * un-categorized even though it has enough space for us now. If that is the
385 * case this function will put the LEB back onto a heap.
387 void ubifs_ensure_cat(struct ubifs_info
*c
, struct ubifs_lprops
*lprops
)
389 int cat
= lprops
->flags
& LPROPS_CAT_MASK
;
391 if (cat
!= LPROPS_UNCAT
)
393 cat
= ubifs_categorize_lprops(c
, lprops
);
394 if (cat
== LPROPS_UNCAT
)
396 ubifs_remove_from_cat(c
, lprops
, LPROPS_UNCAT
);
397 ubifs_add_to_cat(c
, lprops
, cat
);
401 * ubifs_categorize_lprops - categorize LEB properties.
402 * @c: UBIFS file-system description object
403 * @lprops: LEB properties to categorize
405 * LEB properties are categorized to enable fast find operations. This function
406 * returns the LEB category to which the LEB properties belong. Note however
407 * that if the LEB category is stored as a heap and the heap is full, the
408 * LEB properties may have their category changed to %LPROPS_UNCAT.
410 int ubifs_categorize_lprops(const struct ubifs_info
*c
,
411 const struct ubifs_lprops
*lprops
)
413 if (lprops
->flags
& LPROPS_TAKEN
)
416 if (lprops
->free
== c
->leb_size
) {
417 ubifs_assert(!(lprops
->flags
& LPROPS_INDEX
));
421 if (lprops
->free
+ lprops
->dirty
== c
->leb_size
) {
422 if (lprops
->flags
& LPROPS_INDEX
)
423 return LPROPS_FRDI_IDX
;
425 return LPROPS_FREEABLE
;
428 if (lprops
->flags
& LPROPS_INDEX
) {
429 if (lprops
->dirty
+ lprops
->free
>= c
->min_idx_node_sz
)
430 return LPROPS_DIRTY_IDX
;
432 if (lprops
->dirty
>= c
->dead_wm
&&
433 lprops
->dirty
> lprops
->free
)
435 if (lprops
->free
> 0)
443 * change_category - change LEB properties category.
444 * @c: UBIFS file-system description object
445 * @lprops: LEB properties to re-categorize
447 * LEB properties are categorized to enable fast find operations. When the LEB
448 * properties change they must be re-categorized.
450 static void change_category(struct ubifs_info
*c
, struct ubifs_lprops
*lprops
)
452 int old_cat
= lprops
->flags
& LPROPS_CAT_MASK
;
453 int new_cat
= ubifs_categorize_lprops(c
, lprops
);
455 if (old_cat
== new_cat
) {
456 struct ubifs_lpt_heap
*heap
;
458 /* lprops on a heap now must be moved up or down */
459 if (new_cat
< 1 || new_cat
> LPROPS_HEAP_CNT
)
460 return; /* Not on a heap */
461 heap
= &c
->lpt_heap
[new_cat
- 1];
462 adjust_lpt_heap(c
, heap
, lprops
, lprops
->hpos
, new_cat
);
464 ubifs_remove_from_cat(c
, lprops
, old_cat
);
465 ubifs_add_to_cat(c
, lprops
, new_cat
);
470 * ubifs_calc_dark - calculate LEB dark space size.
471 * @c: the UBIFS file-system description object
472 * @spc: amount of free and dirty space in the LEB
474 * This function calculates and returns amount of dark space in an LEB which
475 * has @spc bytes of free and dirty space.
477 * UBIFS is trying to account the space which might not be usable, and this
478 * space is called "dark space". For example, if an LEB has only %512 free
479 * bytes, it is dark space, because it cannot fit a large data node.
481 int ubifs_calc_dark(const struct ubifs_info
*c
, int spc
)
483 ubifs_assert(!(spc
& 7));
485 if (spc
< c
->dark_wm
)
489 * If we have slightly more space then the dark space watermark, we can
490 * anyway safely assume it we'll be able to write a node of the
491 * smallest size there.
493 if (spc
- c
->dark_wm
< MIN_WRITE_SZ
)
494 return spc
- MIN_WRITE_SZ
;
500 * is_lprops_dirty - determine if LEB properties are dirty.
501 * @c: the UBIFS file-system description object
502 * @lprops: LEB properties to test
504 static int is_lprops_dirty(struct ubifs_info
*c
, struct ubifs_lprops
*lprops
)
506 struct ubifs_pnode
*pnode
;
509 pos
= (lprops
->lnum
- c
->main_first
) & (UBIFS_LPT_FANOUT
- 1);
510 pnode
= (struct ubifs_pnode
*)container_of(lprops
- pos
,
513 return !test_bit(COW_CNODE
, &pnode
->flags
) &&
514 test_bit(DIRTY_CNODE
, &pnode
->flags
);
518 * ubifs_change_lp - change LEB properties.
519 * @c: the UBIFS file-system description object
520 * @lp: LEB properties to change
521 * @free: new free space amount
522 * @dirty: new dirty space amount
524 * @idx_gc_cnt: change to the count of @idx_gc list
526 * This function changes LEB properties (@free, @dirty or @flag). However, the
527 * property which has the %LPROPS_NC value is not changed. Returns a pointer to
528 * the updated LEB properties on success and a negative error code on failure.
530 * Note, the LEB properties may have had to be copied (due to COW) and
531 * consequently the pointer returned may not be the same as the pointer
534 const struct ubifs_lprops
*ubifs_change_lp(struct ubifs_info
*c
,
535 const struct ubifs_lprops
*lp
,
536 int free
, int dirty
, int flags
,
540 * This is the only function that is allowed to change lprops, so we
541 * discard the "const" qualifier.
543 struct ubifs_lprops
*lprops
= (struct ubifs_lprops
*)lp
;
545 dbg_lp("LEB %d, free %d, dirty %d, flags %d",
546 lprops
->lnum
, free
, dirty
, flags
);
548 ubifs_assert(mutex_is_locked(&c
->lp_mutex
));
549 ubifs_assert(c
->lst
.empty_lebs
>= 0 &&
550 c
->lst
.empty_lebs
<= c
->main_lebs
);
551 ubifs_assert(c
->freeable_cnt
>= 0);
552 ubifs_assert(c
->freeable_cnt
<= c
->main_lebs
);
553 ubifs_assert(c
->lst
.taken_empty_lebs
>= 0);
554 ubifs_assert(c
->lst
.taken_empty_lebs
<= c
->lst
.empty_lebs
);
555 ubifs_assert(!(c
->lst
.total_free
& 7) && !(c
->lst
.total_dirty
& 7));
556 ubifs_assert(!(c
->lst
.total_dead
& 7) && !(c
->lst
.total_dark
& 7));
557 ubifs_assert(!(c
->lst
.total_used
& 7));
558 ubifs_assert(free
== LPROPS_NC
|| free
>= 0);
559 ubifs_assert(dirty
== LPROPS_NC
|| dirty
>= 0);
561 if (!is_lprops_dirty(c
, lprops
)) {
562 lprops
= ubifs_lpt_lookup_dirty(c
, lprops
->lnum
);
566 ubifs_assert(lprops
== ubifs_lpt_lookup_dirty(c
, lprops
->lnum
));
568 ubifs_assert(!(lprops
->free
& 7) && !(lprops
->dirty
& 7));
570 spin_lock(&c
->space_lock
);
571 if ((lprops
->flags
& LPROPS_TAKEN
) && lprops
->free
== c
->leb_size
)
572 c
->lst
.taken_empty_lebs
-= 1;
574 if (!(lprops
->flags
& LPROPS_INDEX
)) {
577 old_spc
= lprops
->free
+ lprops
->dirty
;
578 if (old_spc
< c
->dead_wm
)
579 c
->lst
.total_dead
-= old_spc
;
581 c
->lst
.total_dark
-= ubifs_calc_dark(c
, old_spc
);
583 c
->lst
.total_used
-= c
->leb_size
- old_spc
;
586 if (free
!= LPROPS_NC
) {
587 free
= ALIGN(free
, 8);
588 c
->lst
.total_free
+= free
- lprops
->free
;
590 /* Increase or decrease empty LEBs counter if needed */
591 if (free
== c
->leb_size
) {
592 if (lprops
->free
!= c
->leb_size
)
593 c
->lst
.empty_lebs
+= 1;
594 } else if (lprops
->free
== c
->leb_size
)
595 c
->lst
.empty_lebs
-= 1;
599 if (dirty
!= LPROPS_NC
) {
600 dirty
= ALIGN(dirty
, 8);
601 c
->lst
.total_dirty
+= dirty
- lprops
->dirty
;
602 lprops
->dirty
= dirty
;
605 if (flags
!= LPROPS_NC
) {
606 /* Take care about indexing LEBs counter if needed */
607 if ((lprops
->flags
& LPROPS_INDEX
)) {
608 if (!(flags
& LPROPS_INDEX
))
609 c
->lst
.idx_lebs
-= 1;
610 } else if (flags
& LPROPS_INDEX
)
611 c
->lst
.idx_lebs
+= 1;
612 lprops
->flags
= flags
;
615 if (!(lprops
->flags
& LPROPS_INDEX
)) {
618 new_spc
= lprops
->free
+ lprops
->dirty
;
619 if (new_spc
< c
->dead_wm
)
620 c
->lst
.total_dead
+= new_spc
;
622 c
->lst
.total_dark
+= ubifs_calc_dark(c
, new_spc
);
624 c
->lst
.total_used
+= c
->leb_size
- new_spc
;
627 if ((lprops
->flags
& LPROPS_TAKEN
) && lprops
->free
== c
->leb_size
)
628 c
->lst
.taken_empty_lebs
+= 1;
630 change_category(c
, lprops
);
631 c
->idx_gc_cnt
+= idx_gc_cnt
;
632 spin_unlock(&c
->space_lock
);
637 * ubifs_get_lp_stats - get lprops statistics.
638 * @c: UBIFS file-system description object
639 * @st: return statistics
641 void ubifs_get_lp_stats(struct ubifs_info
*c
, struct ubifs_lp_stats
*lst
)
643 spin_lock(&c
->space_lock
);
644 memcpy(lst
, &c
->lst
, sizeof(struct ubifs_lp_stats
));
645 spin_unlock(&c
->space_lock
);
649 * ubifs_change_one_lp - change LEB properties.
650 * @c: the UBIFS file-system description object
651 * @lnum: LEB to change properties for
652 * @free: amount of free space
653 * @dirty: amount of dirty space
654 * @flags_set: flags to set
655 * @flags_clean: flags to clean
656 * @idx_gc_cnt: change to the count of idx_gc list
658 * This function changes properties of LEB @lnum. It is a helper wrapper over
659 * 'ubifs_change_lp()' which hides lprops get/release. The arguments are the
660 * same as in case of 'ubifs_change_lp()'. Returns zero in case of success and
661 * a negative error code in case of failure.
663 int ubifs_change_one_lp(struct ubifs_info
*c
, int lnum
, int free
, int dirty
,
664 int flags_set
, int flags_clean
, int idx_gc_cnt
)
667 const struct ubifs_lprops
*lp
;
671 lp
= ubifs_lpt_lookup_dirty(c
, lnum
);
677 flags
= (lp
->flags
| flags_set
) & ~flags_clean
;
678 lp
= ubifs_change_lp(c
, lp
, free
, dirty
, flags
, idx_gc_cnt
);
683 ubifs_release_lprops(c
);
685 ubifs_err("cannot change properties of LEB %d, error %d",
691 * ubifs_update_one_lp - update LEB properties.
692 * @c: the UBIFS file-system description object
693 * @lnum: LEB to change properties for
694 * @free: amount of free space
695 * @dirty: amount of dirty space to add
696 * @flags_set: flags to set
697 * @flags_clean: flags to clean
699 * This function is the same as 'ubifs_change_one_lp()' but @dirty is added to
700 * current dirty space, not substitutes it.
702 int ubifs_update_one_lp(struct ubifs_info
*c
, int lnum
, int free
, int dirty
,
703 int flags_set
, int flags_clean
)
706 const struct ubifs_lprops
*lp
;
710 lp
= ubifs_lpt_lookup_dirty(c
, lnum
);
716 flags
= (lp
->flags
| flags_set
) & ~flags_clean
;
717 lp
= ubifs_change_lp(c
, lp
, free
, lp
->dirty
+ dirty
, flags
, 0);
722 ubifs_release_lprops(c
);
724 ubifs_err("cannot update properties of LEB %d, error %d",
730 * ubifs_read_one_lp - read LEB properties.
731 * @c: the UBIFS file-system description object
732 * @lnum: LEB to read properties for
733 * @lp: where to store read properties
735 * This helper function reads properties of a LEB @lnum and stores them in @lp.
736 * Returns zero in case of success and a negative error code in case of
739 int ubifs_read_one_lp(struct ubifs_info
*c
, int lnum
, struct ubifs_lprops
*lp
)
742 const struct ubifs_lprops
*lpp
;
746 lpp
= ubifs_lpt_lookup(c
, lnum
);
749 ubifs_err("cannot read properties of LEB %d, error %d",
754 memcpy(lp
, lpp
, sizeof(struct ubifs_lprops
));
757 ubifs_release_lprops(c
);
762 * ubifs_fast_find_free - try to find a LEB with free space quickly.
763 * @c: the UBIFS file-system description object
765 * This function returns LEB properties for a LEB with free space or %NULL if
766 * the function is unable to find a LEB quickly.
768 const struct ubifs_lprops
*ubifs_fast_find_free(struct ubifs_info
*c
)
770 struct ubifs_lprops
*lprops
;
771 struct ubifs_lpt_heap
*heap
;
773 ubifs_assert(mutex_is_locked(&c
->lp_mutex
));
775 heap
= &c
->lpt_heap
[LPROPS_FREE
- 1];
779 lprops
= heap
->arr
[0];
780 ubifs_assert(!(lprops
->flags
& LPROPS_TAKEN
));
781 ubifs_assert(!(lprops
->flags
& LPROPS_INDEX
));
786 * ubifs_fast_find_empty - try to find an empty LEB quickly.
787 * @c: the UBIFS file-system description object
789 * This function returns LEB properties for an empty LEB or %NULL if the
790 * function is unable to find an empty LEB quickly.
792 const struct ubifs_lprops
*ubifs_fast_find_empty(struct ubifs_info
*c
)
794 struct ubifs_lprops
*lprops
;
796 ubifs_assert(mutex_is_locked(&c
->lp_mutex
));
798 if (list_empty(&c
->empty_list
))
801 lprops
= list_entry(c
->empty_list
.next
, struct ubifs_lprops
, list
);
802 ubifs_assert(!(lprops
->flags
& LPROPS_TAKEN
));
803 ubifs_assert(!(lprops
->flags
& LPROPS_INDEX
));
804 ubifs_assert(lprops
->free
== c
->leb_size
);
809 * ubifs_fast_find_freeable - try to find a freeable LEB quickly.
810 * @c: the UBIFS file-system description object
812 * This function returns LEB properties for a freeable LEB or %NULL if the
813 * function is unable to find a freeable LEB quickly.
815 const struct ubifs_lprops
*ubifs_fast_find_freeable(struct ubifs_info
*c
)
817 struct ubifs_lprops
*lprops
;
819 ubifs_assert(mutex_is_locked(&c
->lp_mutex
));
821 if (list_empty(&c
->freeable_list
))
824 lprops
= list_entry(c
->freeable_list
.next
, struct ubifs_lprops
, list
);
825 ubifs_assert(!(lprops
->flags
& LPROPS_TAKEN
));
826 ubifs_assert(!(lprops
->flags
& LPROPS_INDEX
));
827 ubifs_assert(lprops
->free
+ lprops
->dirty
== c
->leb_size
);
828 ubifs_assert(c
->freeable_cnt
> 0);
833 * ubifs_fast_find_frdi_idx - try to find a freeable index LEB quickly.
834 * @c: the UBIFS file-system description object
836 * This function returns LEB properties for a freeable index LEB or %NULL if the
837 * function is unable to find a freeable index LEB quickly.
839 const struct ubifs_lprops
*ubifs_fast_find_frdi_idx(struct ubifs_info
*c
)
841 struct ubifs_lprops
*lprops
;
843 ubifs_assert(mutex_is_locked(&c
->lp_mutex
));
845 if (list_empty(&c
->frdi_idx_list
))
848 lprops
= list_entry(c
->frdi_idx_list
.next
, struct ubifs_lprops
, list
);
849 ubifs_assert(!(lprops
->flags
& LPROPS_TAKEN
));
850 ubifs_assert((lprops
->flags
& LPROPS_INDEX
));
851 ubifs_assert(lprops
->free
+ lprops
->dirty
== c
->leb_size
);
856 * Everything below is related to debugging.
860 * dbg_check_cats - check category heaps and lists.
861 * @c: UBIFS file-system description object
863 * This function returns %0 on success and a negative error code on failure.
865 int dbg_check_cats(struct ubifs_info
*c
)
867 struct ubifs_lprops
*lprops
;
868 struct list_head
*pos
;
871 if (!dbg_is_chk_gen(c
) && !dbg_is_chk_lprops(c
))
874 list_for_each_entry(lprops
, &c
->empty_list
, list
) {
875 if (lprops
->free
!= c
->leb_size
) {
876 ubifs_err("non-empty LEB %d on empty list (free %d dirty %d flags %d)",
877 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
881 if (lprops
->flags
& LPROPS_TAKEN
) {
882 ubifs_err("taken LEB %d on empty list (free %d dirty %d flags %d)",
883 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
890 list_for_each_entry(lprops
, &c
->freeable_list
, list
) {
891 if (lprops
->free
+ lprops
->dirty
!= c
->leb_size
) {
892 ubifs_err("non-freeable LEB %d on freeable list (free %d dirty %d flags %d)",
893 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
897 if (lprops
->flags
& LPROPS_TAKEN
) {
898 ubifs_err("taken LEB %d on freeable list (free %d dirty %d flags %d)",
899 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
905 if (i
!= c
->freeable_cnt
) {
906 ubifs_err("freeable list count %d expected %d", i
,
912 list_for_each(pos
, &c
->idx_gc
)
914 if (i
!= c
->idx_gc_cnt
) {
915 ubifs_err("idx_gc list count %d expected %d", i
,
920 list_for_each_entry(lprops
, &c
->frdi_idx_list
, list
) {
921 if (lprops
->free
+ lprops
->dirty
!= c
->leb_size
) {
922 ubifs_err("non-freeable LEB %d on frdi_idx list (free %d dirty %d flags %d)",
923 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
927 if (lprops
->flags
& LPROPS_TAKEN
) {
928 ubifs_err("taken LEB %d on frdi_idx list (free %d dirty %d flags %d)",
929 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
933 if (!(lprops
->flags
& LPROPS_INDEX
)) {
934 ubifs_err("non-index LEB %d on frdi_idx list (free %d dirty %d flags %d)",
935 lprops
->lnum
, lprops
->free
, lprops
->dirty
,
941 for (cat
= 1; cat
<= LPROPS_HEAP_CNT
; cat
++) {
942 struct ubifs_lpt_heap
*heap
= &c
->lpt_heap
[cat
- 1];
944 for (i
= 0; i
< heap
->cnt
; i
++) {
945 lprops
= heap
->arr
[i
];
947 ubifs_err("null ptr in LPT heap cat %d", cat
);
950 if (lprops
->hpos
!= i
) {
951 ubifs_err("bad ptr in LPT heap cat %d", cat
);
954 if (lprops
->flags
& LPROPS_TAKEN
) {
955 ubifs_err("taken LEB in LPT heap cat %d", cat
);
964 void dbg_check_heap(struct ubifs_info
*c
, struct ubifs_lpt_heap
*heap
, int cat
,
967 int i
= 0, j
, err
= 0;
969 if (!dbg_is_chk_gen(c
) && !dbg_is_chk_lprops(c
))
972 for (i
= 0; i
< heap
->cnt
; i
++) {
973 struct ubifs_lprops
*lprops
= heap
->arr
[i
];
974 struct ubifs_lprops
*lp
;
977 if ((lprops
->flags
& LPROPS_CAT_MASK
) != cat
) {
981 if (lprops
->hpos
!= i
) {
985 lp
= ubifs_lpt_lookup(c
, lprops
->lnum
);
991 ubifs_err("lprops %zx lp %zx lprops->lnum %d lp->lnum %d",
992 (size_t)lprops
, (size_t)lp
, lprops
->lnum
,
997 for (j
= 0; j
< i
; j
++) {
1003 if (lp
->lnum
== lprops
->lnum
) {
1011 ubifs_err("failed cat %d hpos %d err %d", cat
, i
, err
);
1013 ubifs_dump_heap(c
, heap
, cat
);
1018 * scan_check_cb - scan callback.
1019 * @c: the UBIFS file-system description object
1020 * @lp: LEB properties to scan
1021 * @in_tree: whether the LEB properties are in main memory
1022 * @lst: lprops statistics to update
1024 * This function returns a code that indicates whether the scan should continue
1025 * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
1026 * in main memory (%LPT_SCAN_ADD), or whether the scan should stop
1029 static int scan_check_cb(struct ubifs_info
*c
,
1030 const struct ubifs_lprops
*lp
, int in_tree
,
1031 struct ubifs_lp_stats
*lst
)
1033 struct ubifs_scan_leb
*sleb
;
1034 struct ubifs_scan_node
*snod
;
1035 int cat
, lnum
= lp
->lnum
, is_idx
= 0, used
= 0, free
, dirty
, ret
;
1038 cat
= lp
->flags
& LPROPS_CAT_MASK
;
1039 if (cat
!= LPROPS_UNCAT
) {
1040 cat
= ubifs_categorize_lprops(c
, lp
);
1041 if (cat
!= (lp
->flags
& LPROPS_CAT_MASK
)) {
1042 ubifs_err("bad LEB category %d expected %d",
1043 (lp
->flags
& LPROPS_CAT_MASK
), cat
);
1048 /* Check lp is on its category list (if it has one) */
1050 struct list_head
*list
= NULL
;
1054 list
= &c
->empty_list
;
1056 case LPROPS_FREEABLE
:
1057 list
= &c
->freeable_list
;
1059 case LPROPS_FRDI_IDX
:
1060 list
= &c
->frdi_idx_list
;
1063 list
= &c
->uncat_list
;
1067 struct ubifs_lprops
*lprops
;
1070 list_for_each_entry(lprops
, list
, list
) {
1077 ubifs_err("bad LPT list (category %d)", cat
);
1083 /* Check lp is on its category heap (if it has one) */
1084 if (in_tree
&& cat
> 0 && cat
<= LPROPS_HEAP_CNT
) {
1085 struct ubifs_lpt_heap
*heap
= &c
->lpt_heap
[cat
- 1];
1087 if ((lp
->hpos
!= -1 && heap
->arr
[lp
->hpos
]->lnum
!= lnum
) ||
1088 lp
!= heap
->arr
[lp
->hpos
]) {
1089 ubifs_err("bad LPT heap (category %d)", cat
);
1094 buf
= __vmalloc(c
->leb_size
, GFP_NOFS
, PAGE_KERNEL
);
1099 * After an unclean unmount, empty and freeable LEBs
1100 * may contain garbage - do not scan them.
1102 if (lp
->free
== c
->leb_size
) {
1103 lst
->empty_lebs
+= 1;
1104 lst
->total_free
+= c
->leb_size
;
1105 lst
->total_dark
+= ubifs_calc_dark(c
, c
->leb_size
);
1106 return LPT_SCAN_CONTINUE
;
1108 if (lp
->free
+ lp
->dirty
== c
->leb_size
&&
1109 !(lp
->flags
& LPROPS_INDEX
)) {
1110 lst
->total_free
+= lp
->free
;
1111 lst
->total_dirty
+= lp
->dirty
;
1112 lst
->total_dark
+= ubifs_calc_dark(c
, c
->leb_size
);
1113 return LPT_SCAN_CONTINUE
;
1116 sleb
= ubifs_scan(c
, lnum
, 0, buf
, 0);
1118 ret
= PTR_ERR(sleb
);
1119 if (ret
== -EUCLEAN
) {
1120 ubifs_dump_lprops(c
);
1121 ubifs_dump_budg(c
, &c
->bi
);
1127 list_for_each_entry(snod
, &sleb
->nodes
, list
) {
1128 int found
, level
= 0;
1133 is_idx
= (snod
->type
== UBIFS_IDX_NODE
) ? 1 : 0;
1135 if (is_idx
&& snod
->type
!= UBIFS_IDX_NODE
) {
1136 ubifs_err("indexing node in data LEB %d:%d",
1141 if (snod
->type
== UBIFS_IDX_NODE
) {
1142 struct ubifs_idx_node
*idx
= snod
->node
;
1144 key_read(c
, ubifs_idx_key(c
, idx
), &snod
->key
);
1145 level
= le16_to_cpu(idx
->level
);
1148 found
= ubifs_tnc_has_node(c
, &snod
->key
, level
, lnum
,
1149 snod
->offs
, is_idx
);
1153 used
+= ALIGN(snod
->len
, 8);
1157 free
= c
->leb_size
- sleb
->endpt
;
1158 dirty
= sleb
->endpt
- used
;
1160 if (free
> c
->leb_size
|| free
< 0 || dirty
> c
->leb_size
||
1162 ubifs_err("bad calculated accounting for LEB %d: free %d, dirty %d",
1167 if (lp
->free
+ lp
->dirty
== c
->leb_size
&&
1168 free
+ dirty
== c
->leb_size
)
1169 if ((is_idx
&& !(lp
->flags
& LPROPS_INDEX
)) ||
1170 (!is_idx
&& free
== c
->leb_size
) ||
1171 lp
->free
== c
->leb_size
) {
1173 * Empty or freeable LEBs could contain index
1174 * nodes from an uncompleted commit due to an
1175 * unclean unmount. Or they could be empty for
1176 * the same reason. Or it may simply not have been
1184 if (is_idx
&& lp
->free
+ lp
->dirty
== free
+ dirty
&&
1185 lnum
!= c
->ihead_lnum
) {
1187 * After an unclean unmount, an index LEB could have a different
1188 * amount of free space than the value recorded by lprops. That
1189 * is because the in-the-gaps method may use free space or
1190 * create free space (as a side-effect of using ubi_leb_change
1191 * and not writing the whole LEB). The incorrect free space
1192 * value is not a problem because the index is only ever
1193 * allocated empty LEBs, so there will never be an attempt to
1194 * write to the free space at the end of an index LEB - except
1195 * by the in-the-gaps method for which it is not a problem.
1201 if (lp
->free
!= free
|| lp
->dirty
!= dirty
)
1204 if (is_idx
&& !(lp
->flags
& LPROPS_INDEX
)) {
1205 if (free
== c
->leb_size
)
1206 /* Free but not unmapped LEB, it's fine */
1209 ubifs_err("indexing node without indexing flag");
1214 if (!is_idx
&& (lp
->flags
& LPROPS_INDEX
)) {
1215 ubifs_err("data node with indexing flag");
1219 if (free
== c
->leb_size
)
1220 lst
->empty_lebs
+= 1;
1225 if (!(lp
->flags
& LPROPS_INDEX
))
1226 lst
->total_used
+= c
->leb_size
- free
- dirty
;
1227 lst
->total_free
+= free
;
1228 lst
->total_dirty
+= dirty
;
1230 if (!(lp
->flags
& LPROPS_INDEX
)) {
1231 int spc
= free
+ dirty
;
1233 if (spc
< c
->dead_wm
)
1234 lst
->total_dead
+= spc
;
1236 lst
->total_dark
+= ubifs_calc_dark(c
, spc
);
1239 ubifs_scan_destroy(sleb
);
1241 return LPT_SCAN_CONTINUE
;
1244 ubifs_err("bad accounting of LEB %d: free %d, dirty %d flags %#x, should be free %d, dirty %d",
1245 lnum
, lp
->free
, lp
->dirty
, lp
->flags
, free
, dirty
);
1246 ubifs_dump_leb(c
, lnum
);
1248 ubifs_scan_destroy(sleb
);
1256 * dbg_check_lprops - check all LEB properties.
1257 * @c: UBIFS file-system description object
1259 * This function checks all LEB properties and makes sure they are all correct.
1260 * It returns zero if everything is fine, %-EINVAL if there is an inconsistency
1261 * and other negative error codes in case of other errors. This function is
1262 * called while the file system is locked (because of commit start), so no
1263 * additional locking is required. Note that locking the LPT mutex would cause
1264 * a circular lock dependency with the TNC mutex.
1266 int dbg_check_lprops(struct ubifs_info
*c
)
1269 struct ubifs_lp_stats lst
;
1271 if (!dbg_is_chk_lprops(c
))
1275 * As we are going to scan the media, the write buffers have to be
1278 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
1279 err
= ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
1284 memset(&lst
, 0, sizeof(struct ubifs_lp_stats
));
1285 err
= ubifs_lpt_scan_nolock(c
, c
->main_first
, c
->leb_cnt
- 1,
1286 (ubifs_lpt_scan_callback
)scan_check_cb
,
1288 if (err
&& err
!= -ENOSPC
)
1291 if (lst
.empty_lebs
!= c
->lst
.empty_lebs
||
1292 lst
.idx_lebs
!= c
->lst
.idx_lebs
||
1293 lst
.total_free
!= c
->lst
.total_free
||
1294 lst
.total_dirty
!= c
->lst
.total_dirty
||
1295 lst
.total_used
!= c
->lst
.total_used
) {
1296 ubifs_err("bad overall accounting");
1297 ubifs_err("calculated: empty_lebs %d, idx_lebs %d, total_free %lld, total_dirty %lld, total_used %lld",
1298 lst
.empty_lebs
, lst
.idx_lebs
, lst
.total_free
,
1299 lst
.total_dirty
, lst
.total_used
);
1300 ubifs_err("read from lprops: empty_lebs %d, idx_lebs %d, total_free %lld, total_dirty %lld, total_used %lld",
1301 c
->lst
.empty_lebs
, c
->lst
.idx_lebs
, c
->lst
.total_free
,
1302 c
->lst
.total_dirty
, c
->lst
.total_used
);
1307 if (lst
.total_dead
!= c
->lst
.total_dead
||
1308 lst
.total_dark
!= c
->lst
.total_dark
) {
1309 ubifs_err("bad dead/dark space accounting");
1310 ubifs_err("calculated: total_dead %lld, total_dark %lld",
1311 lst
.total_dead
, lst
.total_dark
);
1312 ubifs_err("read from lprops: total_dead %lld, total_dark %lld",
1313 c
->lst
.total_dead
, c
->lst
.total_dark
);
1318 err
= dbg_check_cats(c
);