Merge tag 'v3.10.74' into update
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / mtd / ubi / wl.c
1 /*
2 * Copyright (c) International Business Machines Corp., 2006
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
12 * the GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: Artem Bityutskiy (Битюцкий Артём), Thomas Gleixner
19 */
20
21 /*
22 * UBI wear-leveling sub-system.
23 *
24 * This sub-system is responsible for wear-leveling. It works in terms of
25 * physical eraseblocks and erase counters and knows nothing about logical
26 * eraseblocks, volumes, etc. From this sub-system's perspective all physical
27 * eraseblocks are of two types - used and free. Used physical eraseblocks are
28 * those that were "get" by the 'ubi_wl_get_peb()' function, and free physical
29 * eraseblocks are those that were put by the 'ubi_wl_put_peb()' function.
30 *
31 * Physical eraseblocks returned by 'ubi_wl_get_peb()' have only erase counter
32 * header. The rest of the physical eraseblock contains only %0xFF bytes.
33 *
34 * When physical eraseblocks are returned to the WL sub-system by means of the
35 * 'ubi_wl_put_peb()' function, they are scheduled for erasure. The erasure is
36 * done asynchronously in context of the per-UBI device background thread,
37 * which is also managed by the WL sub-system.
38 *
39 * The wear-leveling is ensured by means of moving the contents of used
40 * physical eraseblocks with low erase counter to free physical eraseblocks
41 * with high erase counter.
42 *
43 * If the WL sub-system fails to erase a physical eraseblock, it marks it as
44 * bad.
45 *
46 * This sub-system is also responsible for scrubbing. If a bit-flip is detected
47 * in a physical eraseblock, it has to be moved. Technically this is the same
48 * as moving it for wear-leveling reasons.
49 *
50 * As it was said, for the UBI sub-system all physical eraseblocks are either
51 * "free" or "used". Free eraseblock are kept in the @wl->free RB-tree, while
52 * used eraseblocks are kept in @wl->used, @wl->erroneous, or @wl->scrub
53 * RB-trees, as well as (temporarily) in the @wl->pq queue.
54 *
55 * When the WL sub-system returns a physical eraseblock, the physical
56 * eraseblock is protected from being moved for some "time". For this reason,
57 * the physical eraseblock is not directly moved from the @wl->free tree to the
58 * @wl->used tree. There is a protection queue in between where this
59 * physical eraseblock is temporarily stored (@wl->pq).
60 *
61 * All this protection stuff is needed because:
62 * o we don't want to move physical eraseblocks just after we have given them
63 * to the user; instead, we first want to let users fill them up with data;
64 *
65 * o there is a chance that the user will put the physical eraseblock very
66 * soon, so it makes sense not to move it for some time, but wait.
67 *
68 * Physical eraseblocks stay protected only for limited time. But the "time" is
69 * measured in erase cycles in this case. This is implemented with help of the
70 * protection queue. Eraseblocks are put to the tail of this queue when they
71 * are returned by the 'ubi_wl_get_peb()', and eraseblocks are removed from the
72 * head of the queue on each erase operation (for any eraseblock). So the
73 * length of the queue defines how may (global) erase cycles PEBs are protected.
74 *
75 * To put it differently, each physical eraseblock has 2 main states: free and
76 * used. The former state corresponds to the @wl->free tree. The latter state
77 * is split up on several sub-states:
78 * o the WL movement is allowed (@wl->used tree);
79 * o the WL movement is disallowed (@wl->erroneous) because the PEB is
80 * erroneous - e.g., there was a read error;
81 * o the WL movement is temporarily prohibited (@wl->pq queue);
82 * o scrubbing is needed (@wl->scrub tree).
83 *
84 * Depending on the sub-state, wear-leveling entries of the used physical
85 * eraseblocks may be kept in one of those structures.
86 *
87 * Note, in this implementation, we keep a small in-RAM object for each physical
88 * eraseblock. This is surely not a scalable solution. But it appears to be good
89 * enough for moderately large flashes and it is simple. In future, one may
90 * re-work this sub-system and make it more scalable.
91 *
92 * At the moment this sub-system does not utilize the sequence number, which
93 * was introduced relatively recently. But it would be wise to do this because
94 * the sequence number of a logical eraseblock characterizes how old is it. For
95 * example, when we move a PEB with low erase counter, and we need to pick the
96 * target PEB, we pick a PEB with the highest EC if our PEB is "old" and we
97 * pick target PEB with an average EC if our PEB is not very "old". This is a
98 * room for future re-works of the WL sub-system.
99 */
100
101 #include <linux/slab.h>
102 #include <linux/crc32.h>
103 #include <linux/freezer.h>
104 #include <linux/kthread.h>
105 #include "ubi.h"
106
107 /* Number of physical eraseblocks reserved for wear-leveling purposes */
108 #define WL_RESERVED_PEBS 1
109
110 /*
111 * Maximum difference between two erase counters. If this threshold is
112 * exceeded, the WL sub-system starts moving data from used physical
113 * eraseblocks with low erase counter to free physical eraseblocks with high
114 * erase counter.
115 */
116 #define UBI_WL_THRESHOLD CONFIG_MTD_UBI_WL_THRESHOLD
117
118 /*
119 * When a physical eraseblock is moved, the WL sub-system has to pick the target
120 * physical eraseblock to move to. The simplest way would be just to pick the
121 * one with the highest erase counter. But in certain workloads this could lead
122 * to an unlimited wear of one or few physical eraseblock. Indeed, imagine a
123 * situation when the picked physical eraseblock is constantly erased after the
124 * data is written to it. So, we have a constant which limits the highest erase
125 * counter of the free physical eraseblock to pick. Namely, the WL sub-system
126 * does not pick eraseblocks with erase counter greater than the lowest erase
127 * counter plus %WL_FREE_MAX_DIFF.
128 */
129 #define WL_FREE_MAX_DIFF (2*UBI_WL_THRESHOLD)
130
131 /*
132 * Maximum number of consecutive background thread failures which is enough to
133 * switch to read-only mode.
134 */
135 #define WL_MAX_FAILURES 32
136
137 static int self_check_ec(struct ubi_device *ubi, int pnum, int ec);
138 static int self_check_in_wl_tree(const struct ubi_device *ubi,
139 struct ubi_wl_entry *e, struct rb_root *root);
140 static int self_check_in_pq(const struct ubi_device *ubi,
141 struct ubi_wl_entry *e);
142
143 #ifdef CONFIG_MTD_UBI_FASTMAP
144 /**
145 * update_fastmap_work_fn - calls ubi_update_fastmap from a work queue
146 * @wrk: the work description object
147 */
148 static void update_fastmap_work_fn(struct work_struct *wrk)
149 {
150 struct ubi_device *ubi = container_of(wrk, struct ubi_device, fm_work);
151 ubi_update_fastmap(ubi);
152 }
153
154 /**
155 * ubi_ubi_is_fm_block - returns 1 if a PEB is currently used in a fastmap.
156 * @ubi: UBI device description object
157 * @pnum: the to be checked PEB
158 */
159 static int ubi_is_fm_block(struct ubi_device *ubi, int pnum)
160 {
161 int i;
162
163 if (!ubi->fm)
164 return 0;
165
166 for (i = 0; i < ubi->fm->used_blocks; i++)
167 if (ubi->fm->e[i]->pnum == pnum)
168 return 1;
169
170 return 0;
171 }
172 #else
173 static int ubi_is_fm_block(struct ubi_device *ubi, int pnum)
174 {
175 return 0;
176 }
177 #endif
178
179 /**
180 * wl_tree_add - add a wear-leveling entry to a WL RB-tree.
181 * @e: the wear-leveling entry to add
182 * @root: the root of the tree
183 *
184 * Note, we use (erase counter, physical eraseblock number) pairs as keys in
185 * the @ubi->used and @ubi->free RB-trees.
186 */
187 static void wl_tree_add(struct ubi_wl_entry *e, struct rb_root *root)
188 {
189 struct rb_node **p, *parent = NULL;
190
191 p = &root->rb_node;
192 while (*p) {
193 struct ubi_wl_entry *e1;
194
195 parent = *p;
196 e1 = rb_entry(parent, struct ubi_wl_entry, u.rb);
197
198 if (e->ec < e1->ec)
199 p = &(*p)->rb_left;
200 else if (e->ec > e1->ec)
201 p = &(*p)->rb_right;
202 else {
203 ubi_assert(e->pnum != e1->pnum);
204 if (e->pnum < e1->pnum)
205 p = &(*p)->rb_left;
206 else
207 p = &(*p)->rb_right;
208 }
209 }
210
211 rb_link_node(&e->u.rb, parent, p);
212 rb_insert_color(&e->u.rb, root);
213 }
214
215 /**
216 * do_work - do one pending work.
217 * @ubi: UBI device description object
218 *
219 * This function returns zero in case of success and a negative error code in
220 * case of failure.
221 */
222 static int do_work(struct ubi_device *ubi)
223 {
224 int err;
225 struct ubi_work *wrk;
226
227 cond_resched();
228
229 /*
230 * @ubi->work_sem is used to synchronize with the workers. Workers take
231 * it in read mode, so many of them may be doing works at a time. But
232 * the queue flush code has to be sure the whole queue of works is
233 * done, and it takes the mutex in write mode.
234 */
235 down_read(&ubi->work_sem);
236 spin_lock(&ubi->wl_lock);
237 if (list_empty(&ubi->works)) {
238 spin_unlock(&ubi->wl_lock);
239 up_read(&ubi->work_sem);
240 return 0;
241 }
242
243 wrk = list_entry(ubi->works.next, struct ubi_work, list);
244 list_del(&wrk->list);
245 ubi->works_count -= 1;
246 ubi_assert(ubi->works_count >= 0);
247 spin_unlock(&ubi->wl_lock);
248
249 /*
250 * Call the worker function. Do not touch the work structure
251 * after this call as it will have been freed or reused by that
252 * time by the worker function.
253 */
254 err = wrk->func(ubi, wrk, 0);
255 if (err)
256 ubi_err("work failed with error code %d", err);
257 up_read(&ubi->work_sem);
258
259 return err;
260 }
261
262 /**
263 * produce_free_peb - produce a free physical eraseblock.
264 * @ubi: UBI device description object
265 *
266 * This function tries to make a free PEB by means of synchronous execution of
267 * pending works. This may be needed if, for example the background thread is
268 * disabled. Returns zero in case of success and a negative error code in case
269 * of failure.
270 */
271 static int produce_free_peb(struct ubi_device *ubi)
272 {
273 int err;
274
275 while (!ubi->free.rb_node) {
276 if (ubi->works_count == 0) {
277 ubi_err("no free eraseblocks");
278 return 0;
279 }
280 spin_unlock(&ubi->wl_lock);
281
282 dbg_wl("do one work synchronously");
283 err = do_work(ubi);
284
285 spin_lock(&ubi->wl_lock);
286 if (err)
287 return err;
288 }
289
290 return 0;
291 }
292
293 /**
294 * in_wl_tree - check if wear-leveling entry is present in a WL RB-tree.
295 * @e: the wear-leveling entry to check
296 * @root: the root of the tree
297 *
298 * This function returns non-zero if @e is in the @root RB-tree and zero if it
299 * is not.
300 */
301 static int in_wl_tree(struct ubi_wl_entry *e, struct rb_root *root)
302 {
303 struct rb_node *p;
304
305 p = root->rb_node;
306 while (p) {
307 struct ubi_wl_entry *e1;
308
309 e1 = rb_entry(p, struct ubi_wl_entry, u.rb);
310
311 if (e->pnum == e1->pnum) {
312 ubi_assert(e == e1);
313 return 1;
314 }
315
316 if (e->ec < e1->ec)
317 p = p->rb_left;
318 else if (e->ec > e1->ec)
319 p = p->rb_right;
320 else {
321 ubi_assert(e->pnum != e1->pnum);
322 if (e->pnum < e1->pnum)
323 p = p->rb_left;
324 else
325 p = p->rb_right;
326 }
327 }
328
329 return 0;
330 }
331
332 /**
333 * prot_queue_add - add physical eraseblock to the protection queue.
334 * @ubi: UBI device description object
335 * @e: the physical eraseblock to add
336 *
337 * This function adds @e to the tail of the protection queue @ubi->pq, where
338 * @e will stay for %UBI_PROT_QUEUE_LEN erase operations and will be
339 * temporarily protected from the wear-leveling worker. Note, @wl->lock has to
340 * be locked.
341 */
342 static void prot_queue_add(struct ubi_device *ubi, struct ubi_wl_entry *e)
343 {
344 int pq_tail = ubi->pq_head - 1;
345
346 if (pq_tail < 0)
347 pq_tail = UBI_PROT_QUEUE_LEN - 1;
348 ubi_assert(pq_tail >= 0 && pq_tail < UBI_PROT_QUEUE_LEN);
349 list_add_tail(&e->u.list, &ubi->pq[pq_tail]);
350 dbg_wl("added PEB %d EC %d to the protection queue", e->pnum, e->ec);
351 }
352
353 /**
354 * find_wl_entry - find wear-leveling entry closest to certain erase counter.
355 * @ubi: UBI device description object
356 * @root: the RB-tree where to look for
357 * @diff: maximum possible difference from the smallest erase counter
358 *
359 * This function looks for a wear leveling entry with erase counter closest to
360 * min + @diff, where min is the smallest erase counter.
361 */
362 static struct ubi_wl_entry *find_wl_entry(struct ubi_device *ubi,
363 struct rb_root *root, int diff)
364 {
365 struct rb_node *p;
366 struct ubi_wl_entry *e, *prev_e = NULL;
367 int max;
368
369 e = rb_entry(rb_first(root), struct ubi_wl_entry, u.rb);
370 max = e->ec + diff;
371
372 p = root->rb_node;
373 while (p) {
374 struct ubi_wl_entry *e1;
375
376 e1 = rb_entry(p, struct ubi_wl_entry, u.rb);
377 if (e1->ec >= max)
378 p = p->rb_left;
379 else {
380 p = p->rb_right;
381 prev_e = e;
382 e = e1;
383 }
384 }
385
386 /* If no fastmap has been written and this WL entry can be used
387 * as anchor PEB, hold it back and return the second best WL entry
388 * such that fastmap can use the anchor PEB later. */
389 if (prev_e && !ubi->fm_disabled &&
390 !ubi->fm && e->pnum < UBI_FM_MAX_START)
391 return prev_e;
392
393 return e;
394 }
395
396 /**
397 * find_mean_wl_entry - find wear-leveling entry with medium erase counter.
398 * @ubi: UBI device description object
399 * @root: the RB-tree where to look for
400 *
401 * This function looks for a wear leveling entry with medium erase counter,
402 * but not greater or equivalent than the lowest erase counter plus
403 * %WL_FREE_MAX_DIFF/2.
404 */
405 static struct ubi_wl_entry *find_mean_wl_entry(struct ubi_device *ubi,
406 struct rb_root *root)
407 {
408 struct ubi_wl_entry *e, *first, *last;
409
410 first = rb_entry(rb_first(root), struct ubi_wl_entry, u.rb);
411 last = rb_entry(rb_last(root), struct ubi_wl_entry, u.rb);
412
413 if (last->ec - first->ec < ubi->wl_th*2) {
414 e = rb_entry(root->rb_node, struct ubi_wl_entry, u.rb);
415
416 #ifdef CONFIG_MTD_UBI_FASTMAP
417 /* If no fastmap has been written and this WL entry can be used
418 * as anchor PEB, hold it back and return the second best
419 * WL entry such that fastmap can use the anchor PEB later. */
420 if (e && !ubi->fm_disabled && !ubi->fm &&
421 e->pnum < UBI_FM_MAX_START)
422 e = rb_entry(rb_next(root->rb_node),
423 struct ubi_wl_entry, u.rb);
424 #endif
425 } else
426 e = find_wl_entry(ubi, root, ubi->wl_th);
427
428 return e;
429 }
430
431 #ifdef CONFIG_MTD_UBI_FASTMAP
432 /**
433 * find_anchor_wl_entry - find wear-leveling entry to used as anchor PEB.
434 * @root: the RB-tree where to look for
435 */
436 static struct ubi_wl_entry *find_anchor_wl_entry(struct rb_root *root)
437 {
438 struct rb_node *p;
439 struct ubi_wl_entry *e, *victim = NULL;
440 int max_ec = UBI_MAX_ERASECOUNTER;
441
442 ubi_rb_for_each_entry(p, e, root, u.rb) {
443 if (e->pnum < UBI_FM_MAX_START && e->ec < max_ec) {
444 victim = e;
445 max_ec = e->ec;
446 }
447 }
448
449 return victim;
450 }
451
452 static int anchor_pebs_avalible(struct rb_root *root)
453 {
454 struct rb_node *p;
455 struct ubi_wl_entry *e;
456
457 ubi_rb_for_each_entry(p, e, root, u.rb)
458 if (e->pnum < UBI_FM_MAX_START)
459 return 1;
460
461 return 0;
462 }
463
464 /**
465 * ubi_wl_get_fm_peb - find a physical erase block with a given maximal number.
466 * @ubi: UBI device description object
467 * @anchor: This PEB will be used as anchor PEB by fastmap
468 *
469 * The function returns a physical erase block with a given maximal number
470 * and removes it from the wl subsystem.
471 * Must be called with wl_lock held!
472 */
473 struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor)
474 {
475 struct ubi_wl_entry *e = NULL;
476
477 if (!ubi->free.rb_node || (ubi->free_count - ubi->beb_rsvd_pebs < 1))
478 goto out;
479
480 if (anchor)
481 e = find_anchor_wl_entry(&ubi->free);
482 else
483 e = find_mean_wl_entry(ubi, &ubi->free);
484
485 if (!e)
486 goto out;
487
488 self_check_in_wl_tree(ubi, e, &ubi->free);
489
490 /* remove it from the free list,
491 * the wl subsystem does no longer know this erase block */
492 rb_erase(&e->u.rb, &ubi->free);
493 ubi->free_count--;
494 out:
495 return e;
496 }
497 #endif
498
499 /**
500 * __wl_get_peb - get a physical eraseblock.
501 * @ubi: UBI device description object
502 *
503 * This function returns a physical eraseblock in case of success and a
504 * negative error code in case of failure.
505 */
506 static int __wl_get_peb(struct ubi_device *ubi)
507 {
508 int err;
509 struct ubi_wl_entry *e;
510
511 retry:
512 if (!ubi->free.rb_node) {
513 if (ubi->works_count == 0) {
514 ubi_err("no free eraseblocks");
515 ubi_assert(list_empty(&ubi->works));
516 return -ENOSPC;
517 }
518
519 err = produce_free_peb(ubi);
520 if (err < 0)
521 return err;
522 goto retry;
523 }
524
525 e = find_mean_wl_entry(ubi, &ubi->free);
526 if (!e) {
527 ubi_err("no free eraseblocks");
528 return -ENOSPC;
529 }
530
531 self_check_in_wl_tree(ubi, e, &ubi->free);
532
533 /*
534 * Move the physical eraseblock to the protection queue where it will
535 * be protected from being moved for some time.
536 */
537 rb_erase(&e->u.rb, &ubi->free);
538 ubi->free_count--;
539 dbg_wl("PEB %d EC %d", e->pnum, e->ec);
540 #ifndef CONFIG_MTD_UBI_FASTMAP
541 /* We have to enqueue e only if fastmap is disabled,
542 * is fastmap enabled prot_queue_add() will be called by
543 * ubi_wl_get_peb() after removing e from the pool. */
544 prot_queue_add(ubi, e);
545 #endif
546 return e->pnum;
547 }
548
549 #ifdef CONFIG_MTD_UBI_FASTMAP
550 /**
551 * return_unused_pool_pebs - returns unused PEB to the free tree.
552 * @ubi: UBI device description object
553 * @pool: fastmap pool description object
554 */
555 static void return_unused_pool_pebs(struct ubi_device *ubi,
556 struct ubi_fm_pool *pool)
557 {
558 int i;
559 struct ubi_wl_entry *e;
560
561 for (i = pool->used; i < pool->size; i++) {
562 e = ubi->lookuptbl[pool->pebs[i]];
563 wl_tree_add(e, &ubi->free);
564 ubi->free_count++;
565 }
566 }
567
568 /**
569 * refill_wl_pool - refills all the fastmap pool used by the
570 * WL sub-system.
571 * @ubi: UBI device description object
572 */
573 static void refill_wl_pool(struct ubi_device *ubi)
574 {
575 struct ubi_wl_entry *e;
576 struct ubi_fm_pool *pool = &ubi->fm_wl_pool;
577
578 return_unused_pool_pebs(ubi, pool);
579 pool->used = 0;
580
581 for (pool->size = 0; pool->size < pool->max_size; pool->size++) {
582 if (!ubi->free.rb_node ||
583 (ubi->free_count - ubi->beb_rsvd_pebs < 5))
584 break;
585
586 e = find_wl_entry(ubi, &ubi->free, ubi->wl_th*2);
587 self_check_in_wl_tree(ubi, e, &ubi->free);
588 rb_erase(&e->u.rb, &ubi->free);
589 ubi->free_count--;
590
591 pool->pebs[pool->size] = e->pnum;
592 }
593 }
594
595 /**
596 * refill_wl_user_pool - refills all the fastmap pool used by ubi_wl_get_peb.
597 * @ubi: UBI device description object
598 */
599 static void refill_wl_user_pool(struct ubi_device *ubi)
600 {
601 struct ubi_fm_pool *pool = &ubi->fm_pool;
602
603 return_unused_pool_pebs(ubi, pool);
604 pool->used = 0;
605
606 for (pool->size = 0; pool->size < pool->max_size; pool->size++) {
607 pool->pebs[pool->size] = __wl_get_peb(ubi);
608 if (pool->pebs[pool->size] < 0)
609 break;
610 }
611 #ifdef MTK_TMP_DEBUG_LOG
612 if(pool->size == 0) {
613 if (!ubi->free.rb_node) {
614 ubi_err("Free list is empty");
615 } else {
616 ubi_err("Free count %d", ubi->free_count);
617 }
618 ubi_err("work count %d", ubi->works_count);
619 }
620 #endif
621 }
622
623 /**
624 * ubi_refill_pools - refills all fastmap PEB pools.
625 * @ubi: UBI device description object
626 */
627 void ubi_refill_pools(struct ubi_device *ubi)
628 {
629 spin_lock(&ubi->wl_lock);
630 refill_wl_pool(ubi);
631 refill_wl_user_pool(ubi);
632 spin_unlock(&ubi->wl_lock);
633 }
634
635 /* ubi_wl_get_peb - works exaclty like __wl_get_peb but keeps track of
636 * the fastmap pool.
637 */
638 int ubi_wl_get_peb(struct ubi_device *ubi)
639 {
640 int ret;
641 struct ubi_fm_pool *pool = &ubi->fm_pool;
642 struct ubi_fm_pool *wl_pool = &ubi->fm_wl_pool;
643
644 if (!pool->size || !wl_pool->size || pool->used == pool->size ||
645 wl_pool->used == wl_pool->size)
646 ubi_update_fastmap(ubi);
647
648 /* we got not a single free PEB */
649 if (!pool->size)
650 ret = -ENOSPC;
651 else {
652 spin_lock(&ubi->wl_lock);
653 ret = pool->pebs[pool->used++];
654 prot_queue_add(ubi, ubi->lookuptbl[ret]);
655 spin_unlock(&ubi->wl_lock);
656 }
657
658 return ret;
659 }
660
661 /* get_peb_for_wl - returns a PEB to be used internally by the WL sub-system.
662 *
663 * @ubi: UBI device description object
664 */
665 static struct ubi_wl_entry *get_peb_for_wl(struct ubi_device *ubi)
666 {
667 struct ubi_fm_pool *pool = &ubi->fm_wl_pool;
668 int pnum;
669
670 if (pool->used == pool->size || !pool->size) {
671 /* We cannot update the fastmap here because this
672 * function is called in atomic context.
673 * Let's fail here and refill/update it as soon as possible. */
674 schedule_work(&ubi->fm_work);
675 return NULL;
676 } else {
677 pnum = pool->pebs[pool->used++];
678 return ubi->lookuptbl[pnum];
679 }
680 }
681 #else
682 static struct ubi_wl_entry *get_peb_for_wl(struct ubi_device *ubi)
683 {
684 struct ubi_wl_entry *e;
685
686 e = find_wl_entry(ubi, &ubi->free, ubi->wl_th*2);
687 self_check_in_wl_tree(ubi, e, &ubi->free);
688 rb_erase(&e->u.rb, &ubi->free);
689
690 return e;
691 }
692
693 int ubi_wl_get_peb(struct ubi_device *ubi)
694 {
695 int peb, err;
696
697 spin_lock(&ubi->wl_lock);
698 peb = __wl_get_peb(ubi);
699 spin_unlock(&ubi->wl_lock);
700
701 err = ubi_self_check_all_ff(ubi, peb, ubi->vid_hdr_aloffset,
702 ubi->peb_size - ubi->vid_hdr_aloffset);
703 if (err) {
704 ubi_err("new PEB %d does not contain all 0xFF bytes", peb);
705 return err;
706 }
707
708 return peb;
709 }
710 #endif
711
712 /**
713 * prot_queue_del - remove a physical eraseblock from the protection queue.
714 * @ubi: UBI device description object
715 * @pnum: the physical eraseblock to remove
716 *
717 * This function deletes PEB @pnum from the protection queue and returns zero
718 * in case of success and %-ENODEV if the PEB was not found.
719 */
720 static int prot_queue_del(struct ubi_device *ubi, int pnum)
721 {
722 struct ubi_wl_entry *e;
723
724 e = ubi->lookuptbl[pnum];
725 if (!e)
726 return -ENODEV;
727
728 if (self_check_in_pq(ubi, e))
729 return -ENODEV;
730
731 list_del(&e->u.list);
732 dbg_wl("deleted PEB %d from the protection queue", e->pnum);
733 return 0;
734 }
735
736 /**
737 * sync_erase - synchronously erase a physical eraseblock.
738 * @ubi: UBI device description object
739 * @e: the the physical eraseblock to erase
740 * @torture: if the physical eraseblock has to be tortured
741 *
742 * This function returns zero in case of success and a negative error code in
743 * case of failure.
744 */
745 int sync_erase(struct ubi_device *ubi, struct ubi_wl_entry *e,
746 int torture)
747 {
748 int err;
749 struct ubi_ec_hdr *ec_hdr;
750 unsigned long long old_ec = e->ec, ec = e->ec; //MTK: old_ec
751
752 dbg_wl("erase PEB %d, old EC %llu", e->pnum, ec);
753
754 err = self_check_ec(ubi, e->pnum, e->ec);
755 if (err)
756 return -EINVAL;
757
758 ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
759 if (!ec_hdr)
760 return -ENOMEM;
761
762 err = ubi_io_sync_erase(ubi, e->pnum, torture);
763 if (err < 0)
764 goto out_free;
765
766 ec += err;
767 if (ec > UBI_MAX_ERASECOUNTER) {
768 /*
769 * Erase counter overflow. Upgrade UBI and use 64-bit
770 * erase counters internally.
771 */
772 ubi_err("erase counter overflow at PEB %d, EC %llu",
773 e->pnum, ec);
774 err = -EINVAL;
775 goto out_free;
776 }
777
778 dbg_wl("erased PEB %d, new EC %llu", e->pnum, ec);
779
780 ec_hdr->ec = cpu_to_be64(ec);
781
782 err = ubi_io_write_ec_hdr(ubi, e->pnum, ec_hdr);
783 if (err)
784 goto out_free;
785
786 e->ec = ec;
787 spin_lock(&ubi->wl_lock);
788 if (e->ec > ubi->max_ec)
789 ubi->max_ec = e->ec;
790 //MTK start: the incresing of ec > 1 is doing by torture
791 if(ec - old_ec > 1)
792 ubi->torture+=(ec - old_ec);
793 ubi->ec_sum += (ec - old_ec);
794 ubi->mean_ec = div_u64(ubi->ec_sum, ubi->rsvd_pebs);
795 //MTK end
796 spin_unlock(&ubi->wl_lock);
797
798 out_free:
799 kfree(ec_hdr);
800 return err;
801 }
802
803 /**
804 * serve_prot_queue - check if it is time to stop protecting PEBs.
805 * @ubi: UBI device description object
806 *
807 * This function is called after each erase operation and removes PEBs from the
808 * tail of the protection queue. These PEBs have been protected for long enough
809 * and should be moved to the used tree.
810 */
811 static void serve_prot_queue(struct ubi_device *ubi)
812 {
813 struct ubi_wl_entry *e, *tmp;
814 int count;
815
816 /*
817 * There may be several protected physical eraseblock to remove,
818 * process them all.
819 */
820 repeat:
821 count = 0;
822 spin_lock(&ubi->wl_lock);
823 list_for_each_entry_safe(e, tmp, &ubi->pq[ubi->pq_head], u.list) {
824 dbg_wl("PEB %d EC %d protection over, move to used tree",
825 e->pnum, e->ec);
826
827 list_del(&e->u.list);
828 wl_tree_add(e, &ubi->used);
829 if (count++ > 32) {
830 /*
831 * Let's be nice and avoid holding the spinlock for
832 * too long.
833 */
834 spin_unlock(&ubi->wl_lock);
835 cond_resched();
836 goto repeat;
837 }
838 }
839
840 ubi->pq_head += 1;
841 if (ubi->pq_head == UBI_PROT_QUEUE_LEN)
842 ubi->pq_head = 0;
843 ubi_assert(ubi->pq_head >= 0 && ubi->pq_head < UBI_PROT_QUEUE_LEN);
844 spin_unlock(&ubi->wl_lock);
845 }
846
847 /**
848 * __schedule_ubi_work - schedule a work.
849 * @ubi: UBI device description object
850 * @wrk: the work to schedule
851 *
852 * This function adds a work defined by @wrk to the tail of the pending works
853 * list. Can only be used of ubi->work_sem is already held in read mode!
854 */
855 static void __schedule_ubi_work(struct ubi_device *ubi, struct ubi_work *wrk)
856 {
857 spin_lock(&ubi->wl_lock);
858 list_add_tail(&wrk->list, &ubi->works);
859 ubi_assert(ubi->works_count >= 0);
860 ubi->works_count += 1;
861 if (ubi->thread_enabled && !ubi_dbg_is_bgt_disabled(ubi))
862 wake_up_process(ubi->bgt_thread);
863 spin_unlock(&ubi->wl_lock);
864 }
865
866 /**
867 * schedule_ubi_work - schedule a work.
868 * @ubi: UBI device description object
869 * @wrk: the work to schedule
870 *
871 * This function adds a work defined by @wrk to the tail of the pending works
872 * list.
873 */
874 static void schedule_ubi_work(struct ubi_device *ubi, struct ubi_work *wrk)
875 {
876 down_read(&ubi->work_sem);
877 __schedule_ubi_work(ubi, wrk);
878 up_read(&ubi->work_sem);
879 }
880
881 static int erase_worker(struct ubi_device *ubi, struct ubi_work *wl_wrk,
882 int cancel);
883
884 #ifdef CONFIG_MTD_UBI_FASTMAP
885 /**
886 * ubi_is_erase_work - checks whether a work is erase work.
887 * @wrk: The work object to be checked
888 */
889 int ubi_is_erase_work(struct ubi_work *wrk)
890 {
891 return wrk->func == erase_worker;
892 }
893 #endif
894
895 /**
896 * schedule_erase - schedule an erase work.
897 * @ubi: UBI device description object
898 * @e: the WL entry of the physical eraseblock to erase
899 * @vol_id: the volume ID that last used this PEB
900 * @lnum: the last used logical eraseblock number for the PEB
901 * @torture: if the physical eraseblock has to be tortured
902 *
903 * This function returns zero in case of success and a %-ENOMEM in case of
904 * failure.
905 */
906 static int schedule_erase(struct ubi_device *ubi, struct ubi_wl_entry *e,
907 int vol_id, int lnum, int torture)
908 {
909 struct ubi_work *wl_wrk;
910
911 ubi_assert(e);
912 ubi_assert(!ubi_is_fm_block(ubi, e->pnum));
913
914 dbg_wl("schedule erasure of PEB %d, EC %d, torture %d",
915 e->pnum, e->ec, torture);
916
917 wl_wrk = kmalloc(sizeof(struct ubi_work), GFP_NOFS);
918 if (!wl_wrk)
919 return -ENOMEM;
920
921 wl_wrk->func = &erase_worker;
922 wl_wrk->e = e;
923 wl_wrk->vol_id = vol_id;
924 wl_wrk->lnum = lnum;
925 wl_wrk->torture = torture;
926
927 schedule_ubi_work(ubi, wl_wrk);
928 return 0;
929 }
930
931 /**
932 * do_sync_erase - run the erase worker synchronously.
933 * @ubi: UBI device description object
934 * @e: the WL entry of the physical eraseblock to erase
935 * @vol_id: the volume ID that last used this PEB
936 * @lnum: the last used logical eraseblock number for the PEB
937 * @torture: if the physical eraseblock has to be tortured
938 *
939 */
940 static int do_sync_erase(struct ubi_device *ubi, struct ubi_wl_entry *e,
941 int vol_id, int lnum, int torture)
942 {
943 struct ubi_work *wl_wrk;
944
945 dbg_wl("sync erase of PEB %i", e->pnum);
946
947 wl_wrk = kmalloc(sizeof(struct ubi_work), GFP_NOFS);
948 if (!wl_wrk)
949 return -ENOMEM;
950
951 wl_wrk->e = e;
952 wl_wrk->vol_id = vol_id;
953 wl_wrk->lnum = lnum;
954 wl_wrk->torture = torture;
955
956 return erase_worker(ubi, wl_wrk, 0);
957 }
958
959 #ifdef CONFIG_MTD_UBI_FASTMAP
960 /**
961 * ubi_wl_put_fm_peb - returns a PEB used in a fastmap to the wear-leveling
962 * sub-system.
963 * see: ubi_wl_put_peb()
964 *
965 * @ubi: UBI device description object
966 * @fm_e: physical eraseblock to return
967 * @lnum: the last used logical eraseblock number for the PEB
968 * @torture: if this physical eraseblock has to be tortured
969 */
970 int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *fm_e,
971 int lnum, int torture)
972 {
973 struct ubi_wl_entry *e;
974 int vol_id, pnum = fm_e->pnum;
975
976 dbg_wl("PEB %d", pnum);
977
978 ubi_assert(pnum >= 0);
979 ubi_assert(pnum < ubi->peb_count);
980
981 spin_lock(&ubi->wl_lock);
982 e = ubi->lookuptbl[pnum];
983
984 /* This can happen if we recovered from a fastmap the very
985 * first time and writing now a new one. In this case the wl system
986 * has never seen any PEB used by the original fastmap.
987 */
988 if (!e) {
989 e = fm_e;
990 ubi_assert(e->ec >= 0);
991 ubi->lookuptbl[pnum] = e;
992 } else {
993 e->ec = fm_e->ec;
994 kfree(fm_e);
995 }
996
997 spin_unlock(&ubi->wl_lock);
998
999 vol_id = lnum ? UBI_FM_DATA_VOLUME_ID : UBI_FM_SB_VOLUME_ID;
1000 return schedule_erase(ubi, e, vol_id, lnum, torture);
1001 }
1002 #endif
1003
1004 /**
1005 * wear_leveling_worker - wear-leveling worker function.
1006 * @ubi: UBI device description object
1007 * @wrk: the work object
1008 * @cancel: non-zero if the worker has to free memory and exit
1009 *
1010 * This function copies a more worn out physical eraseblock to a less worn out
1011 * one. Returns zero in case of success and a negative error code in case of
1012 * failure.
1013 */
1014 static int wear_leveling_worker(struct ubi_device *ubi, struct ubi_work *wrk,
1015 int cancel)
1016 {
1017 int erase_e2=1, err, scrubbing = 0, torture = 0, protect = 0, erroneous = 0;
1018 int vol_id = -1, uninitialized_var(lnum);
1019 #ifdef CONFIG_MTD_UBI_FASTMAP
1020 int anchor = wrk->anchor;
1021 #endif
1022 struct ubi_wl_entry *e1, *e2;
1023 struct ubi_vid_hdr *vid_hdr;
1024 int do_wl = 0; //wl or not, 1 for wl, 2 for scrubbing
1025
1026 kfree(wrk);
1027 if (cancel)
1028 return 0;
1029
1030 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
1031 if (!vid_hdr)
1032 return -ENOMEM;
1033
1034 mutex_lock(&ubi->move_mutex);
1035 spin_lock(&ubi->wl_lock);
1036 ubi_assert(!ubi->move_from && !ubi->move_to);
1037 ubi_assert(!ubi->move_to_put);
1038
1039 if (!ubi->free.rb_node ||
1040 (!ubi->used.rb_node && !ubi->scrub.rb_node)) {
1041 /*
1042 * No free physical eraseblocks? Well, they must be waiting in
1043 * the queue to be erased. Cancel movement - it will be
1044 * triggered again when a free physical eraseblock appears.
1045 *
1046 * No used physical eraseblocks? They must be temporarily
1047 * protected from being moved. They will be moved to the
1048 * @ubi->used tree later and the wear-leveling will be
1049 * triggered again.
1050 */
1051 dbg_wl("cancel WL, a list is empty: free %d, used %d",
1052 !ubi->free.rb_node, !ubi->used.rb_node);
1053 goto out_cancel;
1054 }
1055
1056 #ifdef CONFIG_MTD_UBI_FASTMAP
1057 /* Check whether we need to produce an anchor PEB */
1058 if (!anchor)
1059 anchor = !anchor_pebs_avalible(&ubi->free);
1060
1061 if (anchor) {
1062 e1 = find_anchor_wl_entry(&ubi->used);
1063 if (!e1)
1064 goto out_cancel;
1065 e2 = get_peb_for_wl(ubi);
1066 if (!e2)
1067 goto out_cancel;
1068
1069 self_check_in_wl_tree(ubi, e1, &ubi->used);
1070 rb_erase(&e1->u.rb, &ubi->used);
1071 dbg_wl("anchor-move PEB %d to PEB %d", e1->pnum, e2->pnum);
1072 } else if (!ubi->scrub.rb_node) {
1073 #else
1074 if (!ubi->scrub.rb_node) {
1075 #endif
1076 /*
1077 * Now pick the least worn-out used physical eraseblock and a
1078 * highly worn-out free physical eraseblock. If the erase
1079 * counters differ much enough, start wear-leveling.
1080 */
1081 e1 = rb_entry(rb_first(&ubi->used), struct ubi_wl_entry, u.rb);
1082 e2 = get_peb_for_wl(ubi);
1083 if (!e2)
1084 goto out_cancel;
1085
1086 if (!(e2->ec - e1->ec >= ubi->wl_th)) {
1087 dbg_wl("no WL needed: min used EC %d, max free EC %d",
1088 e1->ec, e2->ec);
1089
1090 /* Give the unused PEB back */
1091 wl_tree_add(e2, &ubi->free);
1092 goto out_cancel;
1093 }
1094 self_check_in_wl_tree(ubi, e1, &ubi->used);
1095 rb_erase(&e1->u.rb, &ubi->used);
1096 dbg_wl("move PEB %d EC %d to PEB %d EC %d",
1097 e1->pnum, e1->ec, e2->pnum, e2->ec);
1098 do_wl = 1; //MTK
1099 } else {
1100 /* Perform scrubbing */
1101 scrubbing = 1;
1102 e1 = rb_entry(rb_first(&ubi->scrub), struct ubi_wl_entry, u.rb);
1103 e2 = get_peb_for_wl(ubi);
1104 if (!e2)
1105 goto out_cancel;
1106
1107 self_check_in_wl_tree(ubi, e1, &ubi->scrub);
1108 rb_erase(&e1->u.rb, &ubi->scrub);
1109 dbg_wl("scrub PEB %d to PEB %d", e1->pnum, e2->pnum);
1110 do_wl = 2; //MTK
1111 }
1112
1113 ubi->move_from = e1;
1114 ubi->move_to = e2;
1115 spin_unlock(&ubi->wl_lock);
1116
1117 /*
1118 * Now we are going to copy physical eraseblock @e1->pnum to @e2->pnum.
1119 * We so far do not know which logical eraseblock our physical
1120 * eraseblock (@e1) belongs to. We have to read the volume identifier
1121 * header first.
1122 *
1123 * Note, we are protected from this PEB being unmapped and erased. The
1124 * 'ubi_wl_put_peb()' would wait for moving to be finished if the PEB
1125 * which is being moved was unmapped.
1126 */
1127
1128 err = ubi_io_read_vid_hdr(ubi, e1->pnum, vid_hdr, 0);
1129 if (err && err != UBI_IO_BITFLIPS) {
1130 if (err == UBI_IO_FF) {
1131 /*
1132 * We are trying to move PEB without a VID header. UBI
1133 * always write VID headers shortly after the PEB was
1134 * given, so we have a situation when it has not yet
1135 * had a chance to write it, because it was preempted.
1136 * So add this PEB to the protection queue so far,
1137 * because presumably more data will be written there
1138 * (including the missing VID header), and then we'll
1139 * move it.
1140 */
1141 dbg_wl("PEB %d has no VID header", e1->pnum);
1142 protect = 1;
1143 erase_e2 = 0; //MTK
1144 goto out_not_moved;
1145 } else if (err == UBI_IO_FF_BITFLIPS) {
1146 /*
1147 * The same situation as %UBI_IO_FF, but bit-flips were
1148 * detected. It is better to schedule this PEB for
1149 * scrubbing.
1150 */
1151 dbg_wl("PEB %d has no VID header but has bit-flips",
1152 e1->pnum);
1153 scrubbing = 1;
1154 erase_e2 = 0; //MTK
1155 goto out_not_moved;
1156 }
1157
1158 ubi_err("error %d while reading VID header from PEB %d",
1159 err, e1->pnum);
1160 goto out_error;
1161 }
1162
1163 vol_id = be32_to_cpu(vid_hdr->vol_id);
1164 lnum = be32_to_cpu(vid_hdr->lnum);
1165
1166 err = ubi_eba_copy_leb(ubi, e1->pnum, e2->pnum, vid_hdr, do_wl); //MTK: pass do_wl
1167 if (err) {
1168 if (err == MOVE_CANCEL_RACE) {
1169 /*
1170 * The LEB has not been moved because the volume is
1171 * being deleted or the PEB has been put meanwhile. We
1172 * should prevent this PEB from being selected for
1173 * wear-leveling movement again, so put it to the
1174 * protection queue.
1175 */
1176 protect = 1;
1177 erase_e2 = 0; //MTK
1178 goto out_not_moved;
1179 }
1180 if (err == MOVE_RETRY) {
1181 scrubbing = 1;
1182 atomic_inc(&ubi->move_retry); //MTK
1183 erase_e2 = 0; //MTK
1184 goto out_not_moved;
1185 }
1186 if (err == MOVE_TARGET_BITFLIPS || err == MOVE_TARGET_WR_ERR ||
1187 err == MOVE_TARGET_RD_ERR) {
1188 /*
1189 * Target PEB had bit-flips or write error - torture it.
1190 */
1191 torture = 1;
1192 goto out_not_moved;
1193 }
1194
1195 if (err == MOVE_SOURCE_RD_ERR) {
1196 /*
1197 * An error happened while reading the source PEB. Do
1198 * not switch to R/O mode in this case, and give the
1199 * upper layers a possibility to recover from this,
1200 * e.g. by unmapping corresponding LEB. Instead, just
1201 * put this PEB to the @ubi->erroneous list to prevent
1202 * UBI from trying to move it over and over again.
1203 */
1204 if (ubi->erroneous_peb_count > ubi->max_erroneous) {
1205 ubi_err("too many erroneous eraseblocks (%d)",
1206 ubi->erroneous_peb_count);
1207 goto out_error;
1208 }
1209 erroneous = 1;
1210 goto out_not_moved;
1211 }
1212
1213 if (err < 0)
1214 goto out_error;
1215
1216 ubi_assert(0);
1217 }
1218
1219 /* The PEB has been successfully moved */
1220 if (scrubbing)
1221 ubi_msg("scrubbed PEB %d (LEB %d:%d), data moved to PEB %d",
1222 e1->pnum, vol_id, lnum, e2->pnum);
1223 ubi_free_vid_hdr(ubi, vid_hdr);
1224
1225 spin_lock(&ubi->wl_lock);
1226 if (!ubi->move_to_put) {
1227 wl_tree_add(e2, &ubi->used);
1228 e2 = NULL;
1229 }
1230 ubi->move_from = ubi->move_to = NULL;
1231 ubi->move_to_put = ubi->wl_scheduled = 0;
1232 spin_unlock(&ubi->wl_lock);
1233
1234 err = do_sync_erase(ubi, e1, vol_id, lnum, 0);
1235 if (err) {
1236 if (e2)
1237 kmem_cache_free(ubi_wl_entry_slab, e2);
1238 goto out_ro;
1239 }
1240
1241 if (e2) {
1242 /*
1243 * Well, the target PEB was put meanwhile, schedule it for
1244 * erasure.
1245 */
1246 dbg_wl("PEB %d (LEB %d:%d) was put meanwhile, erase",
1247 e2->pnum, vol_id, lnum);
1248 err = do_sync_erase(ubi, e2, vol_id, lnum, 0);
1249 if (err)
1250 goto out_ro;
1251 }
1252
1253 dbg_wl("done");
1254 mutex_unlock(&ubi->move_mutex);
1255 return 0;
1256
1257 /*
1258 * For some reasons the LEB was not moved, might be an error, might be
1259 * something else. @e1 was not changed, so return it back. @e2 might
1260 * have been changed, schedule it for erasure.
1261 */
1262 out_not_moved:
1263 if (vol_id != -1)
1264 dbg_wl("cancel moving PEB %d (LEB %d:%d) to PEB %d (%d)",
1265 e1->pnum, vol_id, lnum, e2->pnum, err);
1266 else
1267 dbg_wl("cancel moving PEB %d to PEB %d (%d)",
1268 e1->pnum, e2->pnum, err);
1269 spin_lock(&ubi->wl_lock);
1270 if (protect)
1271 prot_queue_add(ubi, e1);
1272 else if (erroneous) {
1273 wl_tree_add(e1, &ubi->erroneous);
1274 ubi->erroneous_peb_count += 1;
1275 } else if (scrubbing)
1276 wl_tree_add(e1, &ubi->scrub);
1277 else
1278 wl_tree_add(e1, &ubi->used);
1279 ubi_assert(!ubi->move_to_put);
1280 ubi->move_from = ubi->move_to = NULL;
1281 ubi->wl_scheduled = 0;
1282 spin_unlock(&ubi->wl_lock);
1283
1284 ubi_free_vid_hdr(ubi, vid_hdr);
1285 //MTK start
1286 if(erase_e2 == 1) {
1287 err = do_sync_erase(ubi, e2, vol_id, lnum, torture);
1288 if (err) {
1289 kmem_cache_free(ubi_wl_entry_slab, e2);
1290 goto out_ro;
1291 }
1292 } else {
1293 spin_lock(&ubi->wl_lock);
1294 wl_tree_add(e2, &ubi->free);
1295 spin_unlock(&ubi->wl_lock);
1296 }
1297 //MTK end
1298 mutex_unlock(&ubi->move_mutex);
1299 return 0;
1300
1301 out_error:
1302 if (vol_id != -1)
1303 ubi_err("error %d while moving PEB %d to PEB %d",
1304 err, e1->pnum, e2->pnum);
1305 else
1306 ubi_err("error %d while moving PEB %d (LEB %d:%d) to PEB %d",
1307 err, e1->pnum, vol_id, lnum, e2->pnum);
1308 spin_lock(&ubi->wl_lock);
1309 ubi->move_from = ubi->move_to = NULL;
1310 ubi->move_to_put = ubi->wl_scheduled = 0;
1311 spin_unlock(&ubi->wl_lock);
1312
1313 ubi_free_vid_hdr(ubi, vid_hdr);
1314 kmem_cache_free(ubi_wl_entry_slab, e1);
1315 kmem_cache_free(ubi_wl_entry_slab, e2);
1316
1317 out_ro:
1318 ubi_ro_mode(ubi);
1319 mutex_unlock(&ubi->move_mutex);
1320 ubi_assert(err != 0);
1321 return err < 0 ? err : -EIO;
1322
1323 out_cancel:
1324 ubi->wl_scheduled = 0;
1325 spin_unlock(&ubi->wl_lock);
1326 mutex_unlock(&ubi->move_mutex);
1327 ubi_free_vid_hdr(ubi, vid_hdr);
1328 return 0;
1329 }
1330
1331 /**
1332 * ensure_wear_leveling - schedule wear-leveling if it is needed.
1333 * @ubi: UBI device description object
1334 * @nested: set to non-zero if this function is called from UBI worker
1335 *
1336 * This function checks if it is time to start wear-leveling and schedules it
1337 * if yes. This function returns zero in case of success and a negative error
1338 * code in case of failure.
1339 */
1340 static int ensure_wear_leveling(struct ubi_device *ubi, int nested)
1341 {
1342 int err = 0;
1343 struct ubi_wl_entry *e1;
1344 struct ubi_wl_entry *e2;
1345 struct ubi_work *wrk;
1346
1347 spin_lock(&ubi->wl_lock);
1348 if (ubi->wl_scheduled)
1349 /* Wear-leveling is already in the work queue */
1350 goto out_unlock;
1351
1352 /*
1353 * If the ubi->scrub tree is not empty, scrubbing is needed, and the
1354 * the WL worker has to be scheduled anyway.
1355 */
1356 if (!ubi->scrub.rb_node) {
1357 if (!ubi->used.rb_node || !ubi->free.rb_node)
1358 /* No physical eraseblocks - no deal */
1359 goto out_unlock;
1360
1361 /*
1362 * We schedule wear-leveling only if the difference between the
1363 * lowest erase counter of used physical eraseblocks and a high
1364 * erase counter of free physical eraseblocks is greater than
1365 * %UBI_WL_THRESHOLD.
1366 */
1367 e1 = rb_entry(rb_first(&ubi->used), struct ubi_wl_entry, u.rb);
1368 e2 = find_wl_entry(ubi, &ubi->free, ubi->wl_th*2);
1369
1370 if (!(e2->ec - e1->ec >= ubi->wl_th))
1371 goto out_unlock;
1372 dbg_wl("schedule wear-leveling");
1373 } else
1374 dbg_wl("schedule scrubbing");
1375
1376 ubi->wl_scheduled = 1;
1377 spin_unlock(&ubi->wl_lock);
1378
1379 wrk = kmalloc(sizeof(struct ubi_work), GFP_NOFS);
1380 if (!wrk) {
1381 err = -ENOMEM;
1382 goto out_cancel;
1383 }
1384
1385 wrk->anchor = 0;
1386 wrk->func = &wear_leveling_worker;
1387 if (nested)
1388 __schedule_ubi_work(ubi, wrk);
1389 else
1390 schedule_ubi_work(ubi, wrk);
1391 return err;
1392
1393 out_cancel:
1394 spin_lock(&ubi->wl_lock);
1395 ubi->wl_scheduled = 0;
1396 out_unlock:
1397 spin_unlock(&ubi->wl_lock);
1398 return err;
1399 }
1400
1401 #ifdef CONFIG_MTD_UBI_FASTMAP
1402 /**
1403 * ubi_ensure_anchor_pebs - schedule wear-leveling to produce an anchor PEB.
1404 * @ubi: UBI device description object
1405 */
1406 int ubi_ensure_anchor_pebs(struct ubi_device *ubi)
1407 {
1408 struct ubi_work *wrk;
1409
1410 spin_lock(&ubi->wl_lock);
1411 if (ubi->wl_scheduled) {
1412 spin_unlock(&ubi->wl_lock);
1413 return 0;
1414 }
1415 ubi->wl_scheduled = 1;
1416 spin_unlock(&ubi->wl_lock);
1417
1418 wrk = kmalloc(sizeof(struct ubi_work), GFP_NOFS);
1419 if (!wrk) {
1420 spin_lock(&ubi->wl_lock);
1421 ubi->wl_scheduled = 0;
1422 spin_unlock(&ubi->wl_lock);
1423 return -ENOMEM;
1424 }
1425
1426 wrk->anchor = 1;
1427 wrk->func = &wear_leveling_worker;
1428 schedule_ubi_work(ubi, wrk);
1429 return 0;
1430 }
1431 #endif
1432
1433 /**
1434 * erase_worker - physical eraseblock erase worker function.
1435 * @ubi: UBI device description object
1436 * @wl_wrk: the work object
1437 * @cancel: non-zero if the worker has to free memory and exit
1438 *
1439 * This function erases a physical eraseblock and perform torture testing if
1440 * needed. It also takes care about marking the physical eraseblock bad if
1441 * needed. Returns zero in case of success and a negative error code in case of
1442 * failure.
1443 */
1444 static int erase_worker(struct ubi_device *ubi, struct ubi_work *wl_wrk,
1445 int cancel)
1446 {
1447 struct ubi_wl_entry *e = wl_wrk->e;
1448 int pnum = e->pnum;
1449 int vol_id = wl_wrk->vol_id;
1450 int lnum = wl_wrk->lnum;
1451 int err, available_consumed = 0;
1452
1453 if (cancel) {
1454 dbg_wl("cancel erasure of PEB %d EC %d", pnum, e->ec);
1455 kfree(wl_wrk);
1456 kmem_cache_free(ubi_wl_entry_slab, e);
1457 return 0;
1458 }
1459
1460 dbg_wl("erase PEB %d EC %d LEB %d:%d",
1461 pnum, e->ec, wl_wrk->vol_id, wl_wrk->lnum);
1462
1463 ubi_assert(!ubi_is_fm_block(ubi, e->pnum));
1464
1465 err = sync_erase(ubi, e, wl_wrk->torture);
1466 if (!err) {
1467 /* Fine, we've erased it successfully */
1468 kfree(wl_wrk);
1469
1470 spin_lock(&ubi->wl_lock);
1471 wl_tree_add(e, &ubi->free);
1472 ubi->free_count++;
1473 spin_unlock(&ubi->wl_lock);
1474
1475 /*
1476 * One more erase operation has happened, take care about
1477 * protected physical eraseblocks.
1478 */
1479 serve_prot_queue(ubi);
1480
1481 /* And take care about wear-leveling */
1482 err = ensure_wear_leveling(ubi, 1);
1483 return err;
1484 }
1485
1486 ubi_err("failed to erase PEB %d, error %d", pnum, err);
1487 kfree(wl_wrk);
1488
1489 if (err == -EINTR || err == -ENOMEM || err == -EAGAIN ||
1490 err == -EBUSY) {
1491 int err1;
1492
1493 /* Re-schedule the LEB for erasure */
1494 err1 = schedule_erase(ubi, e, vol_id, lnum, 0);
1495 if (err1) {
1496 err = err1;
1497 goto out_ro;
1498 }
1499 return err;
1500 }
1501
1502 kmem_cache_free(ubi_wl_entry_slab, e);
1503 if (err != -EIO)
1504 /*
1505 * If this is not %-EIO, we have no idea what to do. Scheduling
1506 * this physical eraseblock for erasure again would cause
1507 * errors again and again. Well, lets switch to R/O mode.
1508 */
1509 goto out_ro;
1510
1511 /* It is %-EIO, the PEB went bad */
1512
1513 if (!ubi->bad_allowed) {
1514 ubi_err("bad physical eraseblock %d detected", pnum);
1515 goto out_ro;
1516 }
1517
1518 spin_lock(&ubi->volumes_lock);
1519 if (ubi->beb_rsvd_pebs == 0) {
1520 if (ubi->avail_pebs == 0) {
1521 spin_unlock(&ubi->volumes_lock);
1522 ubi_err("no reserved/available physical eraseblocks");
1523 goto out_ro;
1524 }
1525 ubi->avail_pebs -= 1;
1526 available_consumed = 1;
1527 }
1528 spin_unlock(&ubi->volumes_lock);
1529
1530 ubi_msg("mark PEB %d as bad", pnum);
1531 err = ubi_io_mark_bad(ubi, pnum);
1532 if (err)
1533 goto out_ro;
1534
1535 spin_lock(&ubi->volumes_lock);
1536 if (ubi->beb_rsvd_pebs > 0) {
1537 if (available_consumed) {
1538 /*
1539 * The amount of reserved PEBs increased since we last
1540 * checked.
1541 */
1542 ubi->avail_pebs += 1;
1543 available_consumed = 0;
1544 }
1545 ubi->beb_rsvd_pebs -= 1;
1546 }
1547 ubi->bad_peb_count += 1;
1548 ubi->good_peb_count -= 1;
1549 ubi_calculate_reserved(ubi);
1550 if (available_consumed)
1551 ubi_warn("no PEBs in the reserved pool, used an available PEB");
1552 else if (ubi->beb_rsvd_pebs)
1553 ubi_msg("%d PEBs left in the reserve", ubi->beb_rsvd_pebs);
1554 else
1555 ubi_warn("last PEB from the reserve was used");
1556 spin_unlock(&ubi->volumes_lock);
1557
1558 return err;
1559
1560 out_ro:
1561 if (available_consumed) {
1562 spin_lock(&ubi->volumes_lock);
1563 ubi->avail_pebs += 1;
1564 spin_unlock(&ubi->volumes_lock);
1565 }
1566 ubi_ro_mode(ubi);
1567 return err;
1568 }
1569
1570 /**
1571 * ubifs_erase_peb - erase physical eraseblock for mtk.
1572 * @ubi: UBI device description object
1573 * @wl_wrk: the work object
1574 * @cancel: non-zero if the worker has to free memory and exit
1575 *
1576 * This function erases a physical eraseblock and perform torture testing if
1577 * needed. It also takes care about marking the physical eraseblock bad if
1578 * needed. Returns zero in case of success and a negative error code in case of
1579 * failure.
1580 */
1581 static int ubi_erase_peb(struct ubi_device *ubi, struct ubi_wl_entry *e,
1582 int torture)
1583 {
1584 int pnum = e->pnum, err, need;
1585 int retry=0;
1586
1587 retry_erase:
1588 retry++;
1589
1590 err = sync_erase(ubi, e, torture);
1591 if (!err) {
1592 /* Fine, we've erased it successfully */
1593 spin_lock(&ubi->wl_lock);
1594 wl_tree_add(e, &ubi->free);
1595 ubi->free_count++;
1596 spin_unlock(&ubi->wl_lock);
1597
1598 /*
1599 * One more erase operation has happened, take care about
1600 * protected physical eraseblocks.
1601 */
1602 serve_prot_queue(ubi);
1603
1604 /* And take care about wear-leveling */
1605 err = ensure_wear_leveling(ubi, 1);
1606 return err;
1607 }
1608
1609 ubi_err("failed to erase PEB %d, error %d", pnum, err);
1610
1611 if (err == -EINTR || err == -ENOMEM || err == -EAGAIN ||
1612 err == -EBUSY) {
1613 if(retry < 4){
1614 goto retry_erase;
1615 }else{
1616 goto out_ro;
1617 }
1618 }
1619
1620 kmem_cache_free(ubi_wl_entry_slab, e);
1621 if (err != -EIO)
1622 /*
1623 * If this is not %-EIO, we have no idea what to do. Scheduling
1624 * this physical eraseblock for erasure again would cause
1625 * errors again and again. Well, lets switch to R/O mode.
1626 */
1627 goto out_ro;
1628
1629 /* It is %-EIO, the PEB went bad */
1630
1631 if (!ubi->bad_allowed) {
1632 ubi_err("bad physical eraseblock %d detected", pnum);
1633 goto out_ro;
1634 }
1635
1636 spin_lock(&ubi->volumes_lock);
1637 need = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs + 1;
1638 if (need > 0) {
1639 need = ubi->avail_pebs >= need ? need : ubi->avail_pebs;
1640 ubi->avail_pebs -= need;
1641 ubi->rsvd_pebs += need;
1642 ubi->beb_rsvd_pebs += need;
1643 if (need > 0)
1644 ubi_msg("reserve more %d PEBs", need);
1645 }
1646
1647 if (ubi->beb_rsvd_pebs == 0) {
1648 spin_unlock(&ubi->volumes_lock);
1649 ubi_err("no reserved physical eraseblocks");
1650 goto out_ro;
1651 }
1652 spin_unlock(&ubi->volumes_lock);
1653
1654 ubi_msg("mark PEB %d as bad", pnum);
1655 err = ubi_io_mark_bad(ubi, pnum);
1656 if (err)
1657 goto out_ro;
1658
1659 spin_lock(&ubi->volumes_lock);
1660 ubi->beb_rsvd_pebs -= 1;
1661 ubi->bad_peb_count += 1;
1662 ubi->good_peb_count -= 1;
1663 ubi_calculate_reserved(ubi);
1664 if (ubi->beb_rsvd_pebs)
1665 ubi_msg("%d PEBs left in the reserve", ubi->beb_rsvd_pebs);
1666 else
1667 ubi_warn("last PEB from the reserved pool was used");
1668 spin_unlock(&ubi->volumes_lock);
1669
1670 return err;
1671
1672 out_ro:
1673 ubi_ro_mode(ubi);
1674 return err;
1675 }
1676
1677 /**
1678 * ubi_wl_put_peb - return a PEB to the wear-leveling sub-system.
1679 * @ubi: UBI device description object
1680 * @vol_id: the volume ID that last used this PEB
1681 * @lnum: the last used logical eraseblock number for the PEB
1682 * @pnum: physical eraseblock to return
1683 * @torture: if this physical eraseblock has to be tortured
1684 *
1685 * This function is called to return physical eraseblock @pnum to the pool of
1686 * free physical eraseblocks. The @torture flag has to be set if an I/O error
1687 * occurred to this @pnum and it has to be tested. This function returns zero
1688 * in case of success, and a negative error code in case of failure.
1689 */
1690 int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
1691 int pnum, int torture)
1692 {
1693 int err;
1694 struct ubi_wl_entry *e;
1695
1696 dbg_wl("PEB %d", pnum);
1697 ubi_assert(pnum >= 0);
1698 ubi_assert(pnum < ubi->peb_count);
1699
1700 retry:
1701 spin_lock(&ubi->wl_lock);
1702 e = ubi->lookuptbl[pnum];
1703 if (e == ubi->move_from) {
1704 /*
1705 * User is putting the physical eraseblock which was selected to
1706 * be moved. It will be scheduled for erasure in the
1707 * wear-leveling worker.
1708 */
1709 dbg_wl("PEB %d is being moved, wait", pnum);
1710 spin_unlock(&ubi->wl_lock);
1711
1712 /* Wait for the WL worker by taking the @ubi->move_mutex */
1713 mutex_lock(&ubi->move_mutex);
1714 mutex_unlock(&ubi->move_mutex);
1715 goto retry;
1716 } else if (e == ubi->move_to) {
1717 /*
1718 * User is putting the physical eraseblock which was selected
1719 * as the target the data is moved to. It may happen if the EBA
1720 * sub-system already re-mapped the LEB in 'ubi_eba_copy_leb()'
1721 * but the WL sub-system has not put the PEB to the "used" tree
1722 * yet, but it is about to do this. So we just set a flag which
1723 * will tell the WL worker that the PEB is not needed anymore
1724 * and should be scheduled for erasure.
1725 */
1726 dbg_wl("PEB %d is the target of data moving", pnum);
1727 ubi_assert(!ubi->move_to_put);
1728 ubi->move_to_put = 1;
1729 spin_unlock(&ubi->wl_lock);
1730 return 0;
1731 } else {
1732 if (in_wl_tree(e, &ubi->used)) {
1733 self_check_in_wl_tree(ubi, e, &ubi->used);
1734 rb_erase(&e->u.rb, &ubi->used);
1735 } else if (in_wl_tree(e, &ubi->scrub)) {
1736 self_check_in_wl_tree(ubi, e, &ubi->scrub);
1737 rb_erase(&e->u.rb, &ubi->scrub);
1738 } else if (in_wl_tree(e, &ubi->erroneous)) {
1739 self_check_in_wl_tree(ubi, e, &ubi->erroneous);
1740 rb_erase(&e->u.rb, &ubi->erroneous);
1741 ubi->erroneous_peb_count -= 1;
1742 ubi_assert(ubi->erroneous_peb_count >= 0);
1743 /* Erroneous PEBs should be tortured */
1744 torture = 1;
1745 } else {
1746 err = prot_queue_del(ubi, e->pnum);
1747 if (err) {
1748 ubi_err("PEB %d not found", pnum);
1749 ubi_ro_mode(ubi);
1750 spin_unlock(&ubi->wl_lock);
1751 return err;
1752 }
1753 }
1754 }
1755 spin_unlock(&ubi->wl_lock);
1756
1757 err = schedule_erase(ubi, e, vol_id, lnum, torture);
1758 if (err) {
1759 spin_lock(&ubi->wl_lock);
1760 wl_tree_add(e, &ubi->used);
1761 spin_unlock(&ubi->wl_lock);
1762 }
1763
1764 return err;
1765 }
1766
1767 /**
1768 * ubi_wl_scrub_peb - schedule a physical eraseblock for scrubbing.
1769 * @ubi: UBI device description object
1770 * @pnum: the physical eraseblock to schedule
1771 *
1772 * If a bit-flip in a physical eraseblock is detected, this physical eraseblock
1773 * needs scrubbing. This function schedules a physical eraseblock for
1774 * scrubbing which is done in background. This function returns zero in case of
1775 * success and a negative error code in case of failure.
1776 */
1777 int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum)
1778 {
1779 struct ubi_wl_entry *e;
1780
1781 ubi_msg("schedule PEB %d for scrubbing", pnum);
1782
1783 retry:
1784 spin_lock(&ubi->wl_lock);
1785 e = ubi->lookuptbl[pnum];
1786 if (e == ubi->move_from || in_wl_tree(e, &ubi->scrub) ||
1787 in_wl_tree(e, &ubi->erroneous)) {
1788 spin_unlock(&ubi->wl_lock);
1789 return 0;
1790 }
1791
1792 if (e == ubi->move_to) {
1793 /*
1794 * This physical eraseblock was used to move data to. The data
1795 * was moved but the PEB was not yet inserted to the proper
1796 * tree. We should just wait a little and let the WL worker
1797 * proceed.
1798 */
1799 spin_unlock(&ubi->wl_lock);
1800 dbg_wl("the PEB %d is not in proper tree, retry", pnum);
1801 yield();
1802 goto retry;
1803 }
1804
1805 if (in_wl_tree(e, &ubi->used)) {
1806 self_check_in_wl_tree(ubi, e, &ubi->used);
1807 rb_erase(&e->u.rb, &ubi->used);
1808 } else {
1809 int err;
1810
1811 err = prot_queue_del(ubi, e->pnum);
1812 if (err) {
1813 ubi_err("PEB %d not found", pnum);
1814 ubi_ro_mode(ubi);
1815 spin_unlock(&ubi->wl_lock);
1816 return err;
1817 }
1818 }
1819
1820 wl_tree_add(e, &ubi->scrub);
1821 spin_unlock(&ubi->wl_lock);
1822
1823 /*
1824 * Technically scrubbing is the same as wear-leveling, so it is done
1825 * by the WL worker.
1826 */
1827 return ensure_wear_leveling(ubi, 0);
1828 }
1829
1830 /**
1831 * ubi_wl_flush - flush all pending works.
1832 * @ubi: UBI device description object
1833 * @vol_id: the volume id to flush for
1834 * @lnum: the logical eraseblock number to flush for
1835 *
1836 * This function executes all pending works for a particular volume id /
1837 * logical eraseblock number pair. If either value is set to %UBI_ALL, then it
1838 * acts as a wildcard for all of the corresponding volume numbers or logical
1839 * eraseblock numbers. It returns zero in case of success and a negative error
1840 * code in case of failure.
1841 */
1842 int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum)
1843 {
1844 int err = 0;
1845 int found = 1;
1846
1847 /*
1848 * Erase while the pending works queue is not empty, but not more than
1849 * the number of currently pending works.
1850 */
1851 dbg_wl("flush pending work for LEB %d:%d (%d pending works)",
1852 vol_id, lnum, ubi->works_count);
1853
1854 while (found) {
1855 struct ubi_work *wrk;
1856 found = 0;
1857
1858 down_read(&ubi->work_sem);
1859 spin_lock(&ubi->wl_lock);
1860 list_for_each_entry(wrk, &ubi->works, list) {
1861 if ((vol_id == UBI_ALL || wrk->vol_id == vol_id) &&
1862 (lnum == UBI_ALL || wrk->lnum == lnum)) {
1863 list_del(&wrk->list);
1864 ubi->works_count -= 1;
1865 ubi_assert(ubi->works_count >= 0);
1866 spin_unlock(&ubi->wl_lock);
1867
1868 err = wrk->func(ubi, wrk, 0);
1869 if (err) {
1870 up_read(&ubi->work_sem);
1871 return err;
1872 }
1873
1874 spin_lock(&ubi->wl_lock);
1875 found = 1;
1876 break;
1877 }
1878 }
1879 spin_unlock(&ubi->wl_lock);
1880 up_read(&ubi->work_sem);
1881 }
1882
1883 /*
1884 * Make sure all the works which have been done in parallel are
1885 * finished.
1886 */
1887 down_write(&ubi->work_sem);
1888 up_write(&ubi->work_sem);
1889
1890 return err;
1891 }
1892
1893 /**
1894 * tree_destroy - destroy an RB-tree.
1895 * @root: the root of the tree to destroy
1896 */
1897 static void tree_destroy(struct rb_root *root)
1898 {
1899 struct rb_node *rb;
1900 struct ubi_wl_entry *e;
1901
1902 rb = root->rb_node;
1903 while (rb) {
1904 if (rb->rb_left)
1905 rb = rb->rb_left;
1906 else if (rb->rb_right)
1907 rb = rb->rb_right;
1908 else {
1909 e = rb_entry(rb, struct ubi_wl_entry, u.rb);
1910
1911 rb = rb_parent(rb);
1912 if (rb) {
1913 if (rb->rb_left == &e->u.rb)
1914 rb->rb_left = NULL;
1915 else
1916 rb->rb_right = NULL;
1917 }
1918
1919 kmem_cache_free(ubi_wl_entry_slab, e);
1920 }
1921 }
1922 }
1923
1924 /**
1925 * ubi_thread - UBI background thread.
1926 * @u: the UBI device description object pointer
1927 */
1928 int ubi_thread(void *u)
1929 {
1930 int failures = 0;
1931 struct ubi_device *ubi = u;
1932
1933 ubi_msg("background thread \"%s\" started, PID %d",
1934 ubi->bgt_name, task_pid_nr(current));
1935
1936 set_freezable();
1937 for (;;) {
1938 int err;
1939
1940 if (kthread_should_stop())
1941 break;
1942
1943 if (try_to_freeze())
1944 continue;
1945
1946 spin_lock(&ubi->wl_lock);
1947 if (list_empty(&ubi->works) || ubi->ro_mode ||
1948 !ubi->thread_enabled || ubi_dbg_is_bgt_disabled(ubi)) {
1949 set_current_state(TASK_INTERRUPTIBLE);
1950 spin_unlock(&ubi->wl_lock);
1951 schedule();
1952 continue;
1953 }
1954 spin_unlock(&ubi->wl_lock);
1955
1956 err = do_work(ubi);
1957 if (err) {
1958 ubi_err("%s: work failed with error code %d",
1959 ubi->bgt_name, err);
1960 if (failures++ > WL_MAX_FAILURES) {
1961 /*
1962 * Too many failures, disable the thread and
1963 * switch to read-only mode.
1964 */
1965 ubi_msg("%s: %d consecutive failures",
1966 ubi->bgt_name, WL_MAX_FAILURES);
1967 ubi_ro_mode(ubi);
1968 ubi->thread_enabled = 0;
1969 continue;
1970 }
1971 } else
1972 failures = 0;
1973
1974 cond_resched();
1975 }
1976
1977 dbg_wl("background thread \"%s\" is killed", ubi->bgt_name);
1978 return 0;
1979 }
1980
1981 /**
1982 * cancel_pending - cancel all pending works.
1983 * @ubi: UBI device description object
1984 */
1985 static void cancel_pending(struct ubi_device *ubi)
1986 {
1987 while (!list_empty(&ubi->works)) {
1988 struct ubi_work *wrk;
1989
1990 wrk = list_entry(ubi->works.next, struct ubi_work, list);
1991 list_del(&wrk->list);
1992 wrk->func(ubi, wrk, 1);
1993 ubi->works_count -= 1;
1994 ubi_assert(ubi->works_count >= 0);
1995 }
1996 }
1997
1998 /**
1999 * ubi_wl_init - initialize the WL sub-system using attaching information.
2000 * @ubi: UBI device description object
2001 * @ai: attaching information
2002 *
2003 * This function returns zero in case of success, and a negative error code in
2004 * case of failure.
2005 */
2006 int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
2007 {
2008 int err, i, reserved_pebs, found_pebs = 0;
2009 struct rb_node *rb1, *rb2;
2010 struct ubi_ainf_volume *av;
2011 struct ubi_ainf_peb *aeb, *tmp;
2012 struct ubi_wl_entry *e;
2013
2014 ubi->used = ubi->erroneous = ubi->free = ubi->scrub = RB_ROOT;
2015 spin_lock_init(&ubi->wl_lock);
2016 mutex_init(&ubi->move_mutex);
2017 init_rwsem(&ubi->work_sem);
2018 ubi->max_ec = ai->max_ec;
2019 INIT_LIST_HEAD(&ubi->works);
2020 #ifdef CONFIG_MTD_UBI_FASTMAP
2021 INIT_WORK(&ubi->fm_work, update_fastmap_work_fn);
2022 #endif
2023
2024 sprintf(ubi->bgt_name, UBI_BGT_NAME_PATTERN, ubi->ubi_num);
2025
2026 err = -ENOMEM;
2027 ubi->lookuptbl = kzalloc(ubi->peb_count * sizeof(void *), GFP_KERNEL);
2028 if (!ubi->lookuptbl)
2029 return err;
2030
2031 for (i = 0; i < UBI_PROT_QUEUE_LEN; i++)
2032 INIT_LIST_HEAD(&ubi->pq[i]);
2033 ubi->pq_head = 0;
2034
2035 list_for_each_entry_safe(aeb, tmp, &ai->erase, u.list) {
2036 cond_resched();
2037
2038 e = kmem_cache_alloc(ubi_wl_entry_slab, GFP_KERNEL);
2039 if (!e)
2040 goto out_free;
2041
2042 e->pnum = aeb->pnum;
2043 e->ec = aeb->ec;
2044 ubi_assert(!ubi_is_fm_block(ubi, e->pnum));
2045 ubi->lookuptbl[e->pnum] = e;
2046 #if 1
2047 if(!ubi->ro_mode){
2048 if(ubi_erase_peb(ubi,e,0)){
2049 kmem_cache_free(ubi_wl_entry_slab, e);
2050 goto out_free;
2051 }
2052 }
2053 #else
2054 if(schedule_erase(ubi, e, aeb->vol_id, aeb->lnum, 0)) {
2055 kmem_cache_free(ubi_wl_entry_slab, e);
2056 goto out_free;
2057 }
2058 #endif
2059 found_pebs++;
2060 }
2061
2062 ubi->free_count = 0;
2063 list_for_each_entry(aeb, &ai->free, u.list) {
2064 cond_resched();
2065
2066 e = kmem_cache_alloc(ubi_wl_entry_slab, GFP_KERNEL);
2067 if (!e)
2068 goto out_free;
2069
2070 e->pnum = aeb->pnum;
2071 e->ec = aeb->ec;
2072 ubi_assert(e->ec >= 0);
2073 ubi_assert(!ubi_is_fm_block(ubi, e->pnum));
2074
2075 wl_tree_add(e, &ubi->free);
2076 ubi->free_count++;
2077
2078 ubi->lookuptbl[e->pnum] = e;
2079
2080 found_pebs++;
2081 }
2082
2083 ubi_rb_for_each_entry(rb1, av, &ai->volumes, rb) {
2084 ubi_rb_for_each_entry(rb2, aeb, &av->root, u.rb) {
2085 cond_resched();
2086
2087 e = kmem_cache_alloc(ubi_wl_entry_slab, GFP_KERNEL);
2088 if (!e)
2089 goto out_free;
2090
2091 e->pnum = aeb->pnum;
2092 e->ec = aeb->ec;
2093 ubi->lookuptbl[e->pnum] = e;
2094
2095 if (!aeb->scrub) {
2096 dbg_wl("add PEB %d EC %d to the used tree",
2097 e->pnum, e->ec);
2098 wl_tree_add(e, &ubi->used);
2099 } else {
2100 dbg_wl("add PEB %d EC %d to the scrub tree",
2101 e->pnum, e->ec);
2102 wl_tree_add(e, &ubi->scrub);
2103 }
2104
2105 found_pebs++;
2106 }
2107 }
2108
2109 dbg_wl("found %i PEBs", found_pebs);
2110
2111 if (ubi->fm)
2112 ubi_assert(ubi->good_peb_count == \
2113 found_pebs + ubi->fm->used_blocks);
2114 else
2115 ubi_assert(ubi->good_peb_count == found_pebs);
2116
2117 reserved_pebs = WL_RESERVED_PEBS;
2118 #ifdef CONFIG_MTD_UBI_FASTMAP
2119 /* Reserve enough LEBs to store two fastmaps. */
2120 reserved_pebs += (ubi->fm_size / ubi->leb_size) * 2;
2121 #endif
2122
2123 if (ubi->avail_pebs < reserved_pebs) {
2124 ubi_err("no enough physical eraseblocks (%d, need %d)",
2125 ubi->avail_pebs, reserved_pebs);
2126 if (ubi->corr_peb_count)
2127 ubi_err("%d PEBs are corrupted and not used",
2128 ubi->corr_peb_count);
2129 goto out_free;
2130 }
2131 ubi->avail_pebs -= reserved_pebs;
2132 ubi->rsvd_pebs += reserved_pebs;
2133
2134 /* Schedule wear-leveling if needed */
2135 err = ensure_wear_leveling(ubi, 0);
2136 if (err)
2137 goto out_free;
2138
2139 return 0;
2140
2141 out_free:
2142 cancel_pending(ubi);
2143 tree_destroy(&ubi->used);
2144 tree_destroy(&ubi->free);
2145 tree_destroy(&ubi->scrub);
2146 kfree(ubi->lookuptbl);
2147 return err;
2148 }
2149
2150 /**
2151 * protection_queue_destroy - destroy the protection queue.
2152 * @ubi: UBI device description object
2153 */
2154 static void protection_queue_destroy(struct ubi_device *ubi)
2155 {
2156 int i;
2157 struct ubi_wl_entry *e, *tmp;
2158
2159 for (i = 0; i < UBI_PROT_QUEUE_LEN; ++i) {
2160 list_for_each_entry_safe(e, tmp, &ubi->pq[i], u.list) {
2161 list_del(&e->u.list);
2162 kmem_cache_free(ubi_wl_entry_slab, e);
2163 }
2164 }
2165 }
2166
2167 /**
2168 * ubi_wl_close - close the wear-leveling sub-system.
2169 * @ubi: UBI device description object
2170 */
2171 void ubi_wl_close(struct ubi_device *ubi)
2172 {
2173 dbg_wl("close the WL sub-system");
2174 cancel_pending(ubi);
2175 protection_queue_destroy(ubi);
2176 tree_destroy(&ubi->used);
2177 tree_destroy(&ubi->erroneous);
2178 tree_destroy(&ubi->free);
2179 tree_destroy(&ubi->scrub);
2180 kfree(ubi->lookuptbl);
2181 }
2182
2183 #ifdef MTK_IPOH_SUPPORT
2184 void ubi_wl_move_pg_to_used(struct ubi_device *ubi, int pnum) {
2185 struct ubi_wl_entry *e;
2186 e = ubi->lookuptbl[pnum];
2187 if(in_wl_tree(e, &ubi->used) == 0) {
2188 prot_queue_del(ubi, e->pnum);
2189 wl_tree_add(e, &ubi->used);
2190 }
2191 }
2192 #endif
2193
2194 /**
2195 * self_check_ec - make sure that the erase counter of a PEB is correct.
2196 * @ubi: UBI device description object
2197 * @pnum: the physical eraseblock number to check
2198 * @ec: the erase counter to check
2199 *
2200 * This function returns zero if the erase counter of physical eraseblock @pnum
2201 * is equivalent to @ec, and a negative error code if not or if an error
2202 * occurred.
2203 */
2204 static int self_check_ec(struct ubi_device *ubi, int pnum, int ec)
2205 {
2206 int err;
2207 long long read_ec;
2208 struct ubi_ec_hdr *ec_hdr;
2209
2210 if (!ubi_dbg_chk_gen(ubi))
2211 return 0;
2212
2213 ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
2214 if (!ec_hdr)
2215 return -ENOMEM;
2216
2217 err = ubi_io_read_ec_hdr(ubi, pnum, ec_hdr, 0);
2218 if (err && err != UBI_IO_BITFLIPS) {
2219 /* The header does not have to exist */
2220 err = 0;
2221 goto out_free;
2222 }
2223
2224 read_ec = be64_to_cpu(ec_hdr->ec);
2225 if (ec != read_ec && read_ec - ec > 1) {
2226 ubi_err("self-check failed for PEB %d", pnum);
2227 ubi_err("read EC is %lld, should be %d", read_ec, ec);
2228 dump_stack();
2229 err = 1;
2230 } else
2231 err = 0;
2232
2233 out_free:
2234 kfree(ec_hdr);
2235 return err;
2236 }
2237
2238 /**
2239 * self_check_in_wl_tree - check that wear-leveling entry is in WL RB-tree.
2240 * @ubi: UBI device description object
2241 * @e: the wear-leveling entry to check
2242 * @root: the root of the tree
2243 *
2244 * This function returns zero if @e is in the @root RB-tree and %-EINVAL if it
2245 * is not.
2246 */
2247 static int self_check_in_wl_tree(const struct ubi_device *ubi,
2248 struct ubi_wl_entry *e, struct rb_root *root)
2249 {
2250 if (!ubi_dbg_chk_gen(ubi))
2251 return 0;
2252
2253 if (in_wl_tree(e, root))
2254 return 0;
2255
2256 ubi_err("self-check failed for PEB %d, EC %d, RB-tree %p ",
2257 e->pnum, e->ec, root);
2258 dump_stack();
2259 return -EINVAL;
2260 }
2261
2262 /**
2263 * self_check_in_pq - check if wear-leveling entry is in the protection
2264 * queue.
2265 * @ubi: UBI device description object
2266 * @e: the wear-leveling entry to check
2267 *
2268 * This function returns zero if @e is in @ubi->pq and %-EINVAL if it is not.
2269 */
2270 static int self_check_in_pq(const struct ubi_device *ubi,
2271 struct ubi_wl_entry *e)
2272 {
2273 struct ubi_wl_entry *p;
2274 int i;
2275
2276 if (!ubi_dbg_chk_gen(ubi))
2277 return 0;
2278
2279 for (i = 0; i < UBI_PROT_QUEUE_LEN; ++i)
2280 list_for_each_entry(p, &ubi->pq[i], u.list)
2281 if (p == e)
2282 return 0;
2283
2284 ubi_err("self-check failed for PEB %d, EC %d, Protect queue",
2285 e->pnum, e->ec);
2286 dump_stack();
2287 return -EINVAL;
2288 }