blob: 884c91ffe7ba52d2b0cdff75a722348a33cd7e00 [file] [log] [blame]
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001/*
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 * Author: Artem Bityutskiy (Битюцкий Артём)
19 */
20
21/*
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030022 * The UBI Eraseblock Association (EBA) sub-system.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040023 *
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030024 * This sub-system is responsible for I/O to/from logical eraseblock.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040025 *
26 * Although in this implementation the EBA table is fully kept and managed in
27 * RAM, which assumes poor scalability, it might be (partially) maintained on
28 * flash in future implementations.
29 *
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +030030 * The EBA sub-system implements per-logical eraseblock locking. Before
31 * accessing a logical eraseblock it is locked for reading or writing. The
32 * per-logical eraseblock locking is implemented by means of the lock tree. The
33 * lock tree is an RB-tree which refers all the currently locked logical
34 * eraseblocks. The lock tree elements are &struct ubi_ltree_entry objects.
35 * They are indexed by (@vol_id, @lnum) pairs.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040036 *
37 * EBA also maintains the global sequence counter which is incremented each
38 * time a logical eraseblock is mapped to a physical eraseblock and it is
39 * stored in the volume identifier header. This means that each VID header has
40 * a unique sequence number. The sequence number is only increased an we assume
41 * 64 bits is enough to never overflow.
42 */
43
44#include <linux/slab.h>
45#include <linux/crc32.h>
46#include <linux/err.h>
47#include "ubi.h"
48
Artem Bityutskiye8823bd2007-09-13 14:28:14 +030049/* Number of physical eraseblocks reserved for atomic LEB change operation */
50#define EBA_RESERVED_PEBS 1
51
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040052/**
Boris Brezillon799dca32016-09-16 16:59:25 +020053 * struct ubi_eba_entry - structure encoding a single LEB -> PEB association
54 * @pnum: the physical eraseblock number attached to the LEB
55 *
56 * This structure is encoding a LEB -> PEB association. Note that the LEB
57 * number is not stored here, because it is the index used to access the
58 * entries table.
59 */
60struct ubi_eba_entry {
61 int pnum;
62};
63
64/**
65 * struct ubi_eba_table - LEB -> PEB association information
66 * @entries: the LEB to PEB mapping (one entry per LEB).
67 *
68 * This structure is private to the EBA logic and should be kept here.
69 * It is encoding the LEB to PEB association table, and is subject to
70 * changes.
71 */
72struct ubi_eba_table {
73 struct ubi_eba_entry *entries;
74};
75
76/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040077 * next_sqnum - get next sequence number.
78 * @ubi: UBI device description object
79 *
80 * This function returns next sequence number to use, which is just the current
81 * global sequence counter value. It also increases the global sequence
82 * counter.
83 */
Richard Weinbergera7306652012-09-26 17:51:43 +020084unsigned long long ubi_next_sqnum(struct ubi_device *ubi)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040085{
86 unsigned long long sqnum;
87
88 spin_lock(&ubi->ltree_lock);
89 sqnum = ubi->global_sqnum++;
90 spin_unlock(&ubi->ltree_lock);
91
92 return sqnum;
93}
94
95/**
96 * ubi_get_compat - get compatibility flags of a volume.
97 * @ubi: UBI device description object
98 * @vol_id: volume ID
99 *
100 * This function returns compatibility flags for an internal volume. User
101 * volumes have no compatibility flags, so %0 is returned.
102 */
103static int ubi_get_compat(const struct ubi_device *ubi, int vol_id)
104{
Artem Bityutskiy91f2d532008-01-24 11:23:23 +0200105 if (vol_id == UBI_LAYOUT_VOLUME_ID)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400106 return UBI_LAYOUT_VOLUME_COMPAT;
107 return 0;
108}
109
110/**
Boris Brezillon1f81a5c2016-09-16 16:59:24 +0200111 * ubi_eba_get_ldesc - get information about a LEB
112 * @vol: volume description object
113 * @lnum: logical eraseblock number
114 * @ldesc: the LEB descriptor to fill
115 *
116 * Used to query information about a specific LEB.
117 * It is currently only returning the physical position of the LEB, but will be
118 * extended to provide more information.
119 */
120void ubi_eba_get_ldesc(struct ubi_volume *vol, int lnum,
121 struct ubi_eba_leb_desc *ldesc)
122{
123 ldesc->lnum = lnum;
Boris Brezillon799dca32016-09-16 16:59:25 +0200124 ldesc->pnum = vol->eba_tbl->entries[lnum].pnum;
125}
126
127/**
128 * ubi_eba_create_table - allocate a new EBA table and initialize it with all
129 * LEBs unmapped
130 * @vol: volume containing the EBA table to copy
131 * @nentries: number of entries in the table
132 *
133 * Allocate a new EBA table and initialize it with all LEBs unmapped.
134 * Returns a valid pointer if it succeed, an ERR_PTR() otherwise.
135 */
136struct ubi_eba_table *ubi_eba_create_table(struct ubi_volume *vol,
137 int nentries)
138{
139 struct ubi_eba_table *tbl;
140 int err = -ENOMEM;
141 int i;
142
143 tbl = kzalloc(sizeof(*tbl), GFP_KERNEL);
144 if (!tbl)
145 return ERR_PTR(-ENOMEM);
146
147 tbl->entries = kmalloc_array(nentries, sizeof(*tbl->entries),
148 GFP_KERNEL);
149 if (!tbl->entries)
150 goto err;
151
152 for (i = 0; i < nentries; i++)
153 tbl->entries[i].pnum = UBI_LEB_UNMAPPED;
154
155 return tbl;
156
157err:
158 kfree(tbl->entries);
159 kfree(tbl);
160
161 return ERR_PTR(err);
162}
163
164/**
165 * ubi_eba_destroy_table - destroy an EBA table
166 * @tbl: the table to destroy
167 *
168 * Destroy an EBA table.
169 */
170void ubi_eba_destroy_table(struct ubi_eba_table *tbl)
171{
172 if (!tbl)
173 return;
174
175 kfree(tbl->entries);
176 kfree(tbl);
177}
178
179/**
180 * ubi_eba_copy_table - copy the EBA table attached to vol into another table
181 * @vol: volume containing the EBA table to copy
182 * @dst: destination
183 * @nentries: number of entries to copy
184 *
185 * Copy the EBA table stored in vol into the one pointed by dst.
186 */
187void ubi_eba_copy_table(struct ubi_volume *vol, struct ubi_eba_table *dst,
188 int nentries)
189{
190 struct ubi_eba_table *src;
191 int i;
192
193 ubi_assert(dst && vol && vol->eba_tbl);
194
195 src = vol->eba_tbl;
196
197 for (i = 0; i < nentries; i++)
198 dst->entries[i].pnum = src->entries[i].pnum;
199}
200
201/**
202 * ubi_eba_replace_table - assign a new EBA table to a volume
203 * @vol: volume containing the EBA table to copy
204 * @tbl: new EBA table
205 *
206 * Assign a new EBA table to the volume and release the old one.
207 */
208void ubi_eba_replace_table(struct ubi_volume *vol, struct ubi_eba_table *tbl)
209{
210 ubi_eba_destroy_table(vol->eba_tbl);
211 vol->eba_tbl = tbl;
Boris Brezillon1f81a5c2016-09-16 16:59:24 +0200212}
213
214/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400215 * ltree_lookup - look up the lock tree.
216 * @ubi: UBI device description object
217 * @vol_id: volume ID
218 * @lnum: logical eraseblock number
219 *
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200220 * This function returns a pointer to the corresponding &struct ubi_ltree_entry
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400221 * object if the logical eraseblock is locked and %NULL if it is not.
222 * @ubi->ltree_lock has to be locked.
223 */
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200224static struct ubi_ltree_entry *ltree_lookup(struct ubi_device *ubi, int vol_id,
225 int lnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400226{
227 struct rb_node *p;
228
229 p = ubi->ltree.rb_node;
230 while (p) {
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200231 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400232
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200233 le = rb_entry(p, struct ubi_ltree_entry, rb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400234
235 if (vol_id < le->vol_id)
236 p = p->rb_left;
237 else if (vol_id > le->vol_id)
238 p = p->rb_right;
239 else {
240 if (lnum < le->lnum)
241 p = p->rb_left;
242 else if (lnum > le->lnum)
243 p = p->rb_right;
244 else
245 return le;
246 }
247 }
248
249 return NULL;
250}
251
252/**
253 * ltree_add_entry - add new entry to the lock tree.
254 * @ubi: UBI device description object
255 * @vol_id: volume ID
256 * @lnum: logical eraseblock number
257 *
258 * This function adds new entry for logical eraseblock (@vol_id, @lnum) to the
259 * lock tree. If such entry is already there, its usage counter is increased.
260 * Returns pointer to the lock tree entry or %-ENOMEM if memory allocation
261 * failed.
262 */
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200263static struct ubi_ltree_entry *ltree_add_entry(struct ubi_device *ubi,
264 int vol_id, int lnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400265{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200266 struct ubi_ltree_entry *le, *le1, *le_free;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400267
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200268 le = kmalloc(sizeof(struct ubi_ltree_entry), GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400269 if (!le)
270 return ERR_PTR(-ENOMEM);
271
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200272 le->users = 0;
273 init_rwsem(&le->mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400274 le->vol_id = vol_id;
275 le->lnum = lnum;
276
277 spin_lock(&ubi->ltree_lock);
278 le1 = ltree_lookup(ubi, vol_id, lnum);
279
280 if (le1) {
281 /*
282 * This logical eraseblock is already locked. The newly
283 * allocated lock entry is not needed.
284 */
285 le_free = le;
286 le = le1;
287 } else {
288 struct rb_node **p, *parent = NULL;
289
290 /*
291 * No lock entry, add the newly allocated one to the
292 * @ubi->ltree RB-tree.
293 */
294 le_free = NULL;
295
296 p = &ubi->ltree.rb_node;
297 while (*p) {
298 parent = *p;
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200299 le1 = rb_entry(parent, struct ubi_ltree_entry, rb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400300
301 if (vol_id < le1->vol_id)
302 p = &(*p)->rb_left;
303 else if (vol_id > le1->vol_id)
304 p = &(*p)->rb_right;
305 else {
306 ubi_assert(lnum != le1->lnum);
307 if (lnum < le1->lnum)
308 p = &(*p)->rb_left;
309 else
310 p = &(*p)->rb_right;
311 }
312 }
313
314 rb_link_node(&le->rb, parent, p);
315 rb_insert_color(&le->rb, &ubi->ltree);
316 }
317 le->users += 1;
318 spin_unlock(&ubi->ltree_lock);
319
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300320 kfree(le_free);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400321 return le;
322}
323
324/**
325 * leb_read_lock - lock logical eraseblock for reading.
326 * @ubi: UBI device description object
327 * @vol_id: volume ID
328 * @lnum: logical eraseblock number
329 *
330 * This function locks a logical eraseblock for reading. Returns zero in case
331 * of success and a negative error code in case of failure.
332 */
333static int leb_read_lock(struct ubi_device *ubi, int vol_id, int lnum)
334{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200335 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400336
337 le = ltree_add_entry(ubi, vol_id, lnum);
338 if (IS_ERR(le))
339 return PTR_ERR(le);
340 down_read(&le->mutex);
341 return 0;
342}
343
344/**
345 * leb_read_unlock - unlock logical eraseblock.
346 * @ubi: UBI device description object
347 * @vol_id: volume ID
348 * @lnum: logical eraseblock number
349 */
350static void leb_read_unlock(struct ubi_device *ubi, int vol_id, int lnum)
351{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200352 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400353
354 spin_lock(&ubi->ltree_lock);
355 le = ltree_lookup(ubi, vol_id, lnum);
356 le->users -= 1;
357 ubi_assert(le->users >= 0);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300358 up_read(&le->mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400359 if (le->users == 0) {
360 rb_erase(&le->rb, &ubi->ltree);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300361 kfree(le);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400362 }
363 spin_unlock(&ubi->ltree_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400364}
365
366/**
367 * leb_write_lock - lock logical eraseblock for writing.
368 * @ubi: UBI device description object
369 * @vol_id: volume ID
370 * @lnum: logical eraseblock number
371 *
372 * This function locks a logical eraseblock for writing. Returns zero in case
373 * of success and a negative error code in case of failure.
374 */
375static int leb_write_lock(struct ubi_device *ubi, int vol_id, int lnum)
376{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200377 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400378
379 le = ltree_add_entry(ubi, vol_id, lnum);
380 if (IS_ERR(le))
381 return PTR_ERR(le);
382 down_write(&le->mutex);
383 return 0;
384}
385
386/**
Artem Bityutskiy43f9b252007-12-18 15:06:55 +0200387 * leb_write_lock - lock logical eraseblock for writing.
388 * @ubi: UBI device description object
389 * @vol_id: volume ID
390 * @lnum: logical eraseblock number
391 *
392 * This function locks a logical eraseblock for writing if there is no
393 * contention and does nothing if there is contention. Returns %0 in case of
394 * success, %1 in case of contention, and and a negative error code in case of
395 * failure.
396 */
397static int leb_write_trylock(struct ubi_device *ubi, int vol_id, int lnum)
398{
Artem Bityutskiy43f9b252007-12-18 15:06:55 +0200399 struct ubi_ltree_entry *le;
400
401 le = ltree_add_entry(ubi, vol_id, lnum);
402 if (IS_ERR(le))
403 return PTR_ERR(le);
404 if (down_write_trylock(&le->mutex))
405 return 0;
406
407 /* Contention, cancel */
408 spin_lock(&ubi->ltree_lock);
409 le->users -= 1;
410 ubi_assert(le->users >= 0);
411 if (le->users == 0) {
412 rb_erase(&le->rb, &ubi->ltree);
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200413 kfree(le);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300414 }
415 spin_unlock(&ubi->ltree_lock);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +0200416
417 return 1;
418}
419
420/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400421 * leb_write_unlock - unlock logical eraseblock.
422 * @ubi: UBI device description object
423 * @vol_id: volume ID
424 * @lnum: logical eraseblock number
425 */
426static void leb_write_unlock(struct ubi_device *ubi, int vol_id, int lnum)
427{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200428 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400429
430 spin_lock(&ubi->ltree_lock);
431 le = ltree_lookup(ubi, vol_id, lnum);
432 le->users -= 1;
433 ubi_assert(le->users >= 0);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300434 up_write(&le->mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400435 if (le->users == 0) {
436 rb_erase(&le->rb, &ubi->ltree);
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200437 kfree(le);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300438 }
439 spin_unlock(&ubi->ltree_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400440}
441
442/**
Boris Brezillon75547692016-09-16 16:59:23 +0200443 * ubi_eba_is_mapped - check if a LEB is mapped.
444 * @vol: volume description object
445 * @lnum: logical eraseblock number
446 *
447 * This function returns true if the LEB is mapped, false otherwise.
448 */
449bool ubi_eba_is_mapped(struct ubi_volume *vol, int lnum)
450{
Boris Brezillon799dca32016-09-16 16:59:25 +0200451 return vol->eba_tbl->entries[lnum].pnum >= 0;
Boris Brezillon75547692016-09-16 16:59:23 +0200452}
453
454/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400455 * ubi_eba_unmap_leb - un-map logical eraseblock.
456 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200457 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400458 * @lnum: logical eraseblock number
459 *
460 * This function un-maps logical eraseblock @lnum and schedules corresponding
461 * physical eraseblock for erasure. Returns zero in case of success and a
462 * negative error code in case of failure.
463 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200464int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
465 int lnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400466{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200467 int err, pnum, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400468
469 if (ubi->ro_mode)
470 return -EROFS;
471
472 err = leb_write_lock(ubi, vol_id, lnum);
473 if (err)
474 return err;
475
Boris Brezillon799dca32016-09-16 16:59:25 +0200476 pnum = vol->eba_tbl->entries[lnum].pnum;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400477 if (pnum < 0)
478 /* This logical eraseblock is already unmapped */
479 goto out_unlock;
480
481 dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
482
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100483 down_read(&ubi->fm_eba_sem);
Boris Brezillon799dca32016-09-16 16:59:25 +0200484 vol->eba_tbl->entries[lnum].pnum = UBI_LEB_UNMAPPED;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100485 up_read(&ubi->fm_eba_sem);
Joel Reardond36e59e2012-05-18 15:40:24 +0200486 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400487
488out_unlock:
489 leb_write_unlock(ubi, vol_id, lnum);
490 return err;
491}
492
493/**
494 * ubi_eba_read_leb - read data.
495 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200496 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400497 * @lnum: logical eraseblock number
498 * @buf: buffer to store the read data
499 * @offset: offset from where to read
500 * @len: how many bytes to read
501 * @check: data CRC check flag
502 *
503 * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
504 * bytes. The @check flag only makes sense for static volumes and forces
505 * eraseblock data CRC checking.
506 *
507 * In case of success this function returns zero. In case of a static volume,
508 * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
509 * returned for any volume type if an ECC error was detected by the MTD device
510 * driver. Other negative error cored may be returned in case of other errors.
511 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200512int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
513 void *buf, int offset, int len, int check)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400514{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200515 int err, pnum, scrub = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400516 struct ubi_vid_hdr *vid_hdr;
Jeff Garzika6343af2007-07-17 05:39:58 -0400517 uint32_t uninitialized_var(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400518
519 err = leb_read_lock(ubi, vol_id, lnum);
520 if (err)
521 return err;
522
Boris Brezillon799dca32016-09-16 16:59:25 +0200523 pnum = vol->eba_tbl->entries[lnum].pnum;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400524 if (pnum < 0) {
525 /*
526 * The logical eraseblock is not mapped, fill the whole buffer
527 * with 0xFF bytes. The exception is static volumes for which
528 * it is an error to read unmapped logical eraseblocks.
529 */
530 dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
531 len, offset, vol_id, lnum);
532 leb_read_unlock(ubi, vol_id, lnum);
533 ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
534 memset(buf, 0xFF, len);
535 return 0;
536 }
537
538 dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
539 len, offset, vol_id, lnum, pnum);
540
541 if (vol->vol_type == UBI_DYNAMIC_VOLUME)
542 check = 0;
543
544retry:
545 if (check) {
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300546 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400547 if (!vid_hdr) {
548 err = -ENOMEM;
549 goto out_unlock;
550 }
551
552 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
553 if (err && err != UBI_IO_BITFLIPS) {
554 if (err > 0) {
555 /*
556 * The header is either absent or corrupted.
557 * The former case means there is a bug -
558 * switch to read-only mode just in case.
559 * The latter case means a real corruption - we
560 * may try to recover data. FIXME: but this is
561 * not implemented.
562 */
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300563 if (err == UBI_IO_BAD_HDR_EBADMSG ||
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300564 err == UBI_IO_BAD_HDR) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300565 ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300566 pnum, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400567 err = -EBADMSG;
Brian Norrisb388e6a2015-02-23 13:07:22 -0800568 } else {
Richard Weinberger19001492016-04-26 16:39:48 +0200569 /*
570 * Ending up here in the non-Fastmap case
571 * is a clear bug as the VID header had to
572 * be present at scan time to have it referenced.
573 * With fastmap the story is more complicated.
574 * Fastmap has the mapping info without the need
575 * of a full scan. So the LEB could have been
576 * unmapped, Fastmap cannot know this and keeps
577 * the LEB referenced.
578 * This is valid and works as the layer above UBI
579 * has to do bookkeeping about used/referenced
580 * LEBs in any case.
581 */
582 if (ubi->fast_attach) {
583 err = -EBADMSG;
584 } else {
585 err = -EINVAL;
586 ubi_ro_mode(ubi);
587 }
Brian Norrisb388e6a2015-02-23 13:07:22 -0800588 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400589 }
590 goto out_free;
591 } else if (err == UBI_IO_BITFLIPS)
592 scrub = 1;
593
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300594 ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
595 ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400596
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300597 crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400598 ubi_free_vid_hdr(ubi, vid_hdr);
599 }
600
601 err = ubi_io_read_data(ubi, buf, pnum, offset, len);
602 if (err) {
Richard Weinberger170505f2014-09-22 10:45:34 +0200603 if (err == UBI_IO_BITFLIPS)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400604 scrub = 1;
Richard Weinberger170505f2014-09-22 10:45:34 +0200605 else if (mtd_is_eccerr(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400606 if (vol->vol_type == UBI_DYNAMIC_VOLUME)
607 goto out_unlock;
608 scrub = 1;
609 if (!check) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300610 ubi_msg(ubi, "force data checking");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400611 check = 1;
612 goto retry;
613 }
614 } else
615 goto out_unlock;
616 }
617
618 if (check) {
Jeff Garzik2ab934b2007-07-17 01:49:56 -0400619 uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400620 if (crc1 != crc) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300621 ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400622 crc1, crc);
623 err = -EBADMSG;
624 goto out_unlock;
625 }
626 }
627
628 if (scrub)
629 err = ubi_wl_scrub_peb(ubi, pnum);
630
631 leb_read_unlock(ubi, vol_id, lnum);
632 return err;
633
634out_free:
635 ubi_free_vid_hdr(ubi, vid_hdr);
636out_unlock:
637 leb_read_unlock(ubi, vol_id, lnum);
638 return err;
639}
640
641/**
Richard Weinberger9ff08972015-01-10 22:52:13 +0100642 * ubi_eba_read_leb_sg - read data into a scatter gather list.
643 * @ubi: UBI device description object
644 * @vol: volume description object
645 * @lnum: logical eraseblock number
646 * @sgl: UBI scatter gather list to store the read data
647 * @offset: offset from where to read
648 * @len: how many bytes to read
649 * @check: data CRC check flag
650 *
651 * This function works exactly like ubi_eba_read_leb(). But instead of
652 * storing the read data into a buffer it writes to an UBI scatter gather
653 * list.
654 */
655int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
656 struct ubi_sgl *sgl, int lnum, int offset, int len,
657 int check)
658{
659 int to_read;
660 int ret;
661 struct scatterlist *sg;
662
663 for (;;) {
664 ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
665 sg = &sgl->sg[sgl->list_pos];
666 if (len < sg->length - sgl->page_pos)
667 to_read = len;
668 else
669 to_read = sg->length - sgl->page_pos;
670
671 ret = ubi_eba_read_leb(ubi, vol, lnum,
672 sg_virt(sg) + sgl->page_pos, offset,
673 to_read, check);
674 if (ret < 0)
675 return ret;
676
677 offset += to_read;
678 len -= to_read;
679 if (!len) {
680 sgl->page_pos += to_read;
681 if (sgl->page_pos == sg->length) {
682 sgl->list_pos++;
683 sgl->page_pos = 0;
684 }
685
686 break;
687 }
688
689 sgl->list_pos++;
690 sgl->page_pos = 0;
691 }
692
693 return ret;
694}
695
696/**
Boris Brezillonf036dfe2016-09-16 16:59:20 +0200697 * try_recover_peb - try to recover from write failure.
698 * @vol: volume description object
699 * @pnum: the physical eraseblock to recover
700 * @lnum: logical eraseblock number
701 * @buf: data which was not written because of the write failure
702 * @offset: offset of the failed write
703 * @len: how many bytes should have been written
704 * @vid: VID header
705 * @retry: whether the caller should retry in case of failure
706 *
707 * This function is called in case of a write failure and moves all good data
708 * from the potentially bad physical eraseblock to a good physical eraseblock.
709 * This function also writes the data which was not written due to the failure.
710 * Returns 0 in case of success, and a negative error code in case of failure.
711 * In case of failure, the %retry parameter is set to false if this is a fatal
712 * error (retrying won't help), and true otherwise.
713 */
714static int try_recover_peb(struct ubi_volume *vol, int pnum, int lnum,
715 const void *buf, int offset, int len,
716 struct ubi_vid_hdr *vid_hdr, bool *retry)
717{
718 struct ubi_device *ubi = vol->ubi;
719 int new_pnum, err, vol_id = vol->vol_id, data_size;
720 uint32_t crc;
721
722 *retry = false;
723
724 new_pnum = ubi_wl_get_peb(ubi);
725 if (new_pnum < 0) {
726 err = new_pnum;
727 goto out_put;
728 }
729
730 ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
731 pnum, new_pnum);
732
733 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
734 if (err && err != UBI_IO_BITFLIPS) {
735 if (err > 0)
736 err = -EIO;
737 goto out_put;
738 }
739
740 ubi_assert(vid_hdr->vol_type == UBI_VID_DYNAMIC);
741
742 mutex_lock(&ubi->buf_mutex);
743 memset(ubi->peb_buf + offset, 0xFF, len);
744
745 /* Read everything before the area where the write failure happened */
746 if (offset > 0) {
747 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
748 if (err && err != UBI_IO_BITFLIPS)
749 goto out_unlock;
750 }
751
752 *retry = true;
753
754 memcpy(ubi->peb_buf + offset, buf, len);
755
756 data_size = offset + len;
757 crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
758 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
759 vid_hdr->copy_flag = 1;
760 vid_hdr->data_size = cpu_to_be32(data_size);
761 vid_hdr->data_crc = cpu_to_be32(crc);
762 err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
763 if (err)
764 goto out_unlock;
765
766 err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
767
768out_unlock:
769 mutex_unlock(&ubi->buf_mutex);
770
771 if (!err)
Boris Brezillon799dca32016-09-16 16:59:25 +0200772 vol->eba_tbl->entries[lnum].pnum = new_pnum;
Boris Brezillonf036dfe2016-09-16 16:59:20 +0200773
774out_put:
775 up_read(&ubi->fm_eba_sem);
776
777 if (!err) {
778 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
779 ubi_msg(ubi, "data was successfully recovered");
780 } else if (new_pnum >= 0) {
781 /*
782 * Bad luck? This physical eraseblock is bad too? Crud. Let's
783 * try to get another one.
784 */
785 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
786 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
787 }
788
789 return err;
790}
791
792/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400793 * recover_peb - recover from write failure.
794 * @ubi: UBI device description object
795 * @pnum: the physical eraseblock to recover
796 * @vol_id: volume ID
797 * @lnum: logical eraseblock number
798 * @buf: data which was not written because of the write failure
799 * @offset: offset of the failed write
800 * @len: how many bytes should have been written
801 *
802 * This function is called in case of a write failure and moves all good data
803 * from the potentially bad physical eraseblock to a good physical eraseblock.
804 * This function also writes the data which was not written due to the failure.
Boris Brezillonf036dfe2016-09-16 16:59:20 +0200805 * Returns 0 in case of success, and a negative error code in case of failure.
806 * This function tries %UBI_IO_RETRIES before giving up.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400807 */
808static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
809 const void *buf, int offset, int len)
810{
Boris Brezillonf036dfe2016-09-16 16:59:20 +0200811 int err, idx = vol_id2idx(ubi, vol_id), tries;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400812 struct ubi_volume *vol = ubi->volumes[idx];
813 struct ubi_vid_hdr *vid_hdr;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400814
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300815 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300816 if (!vid_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400817 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400818
Boris Brezillonf036dfe2016-09-16 16:59:20 +0200819 for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
820 bool retry;
821
822 err = try_recover_peb(vol, pnum, lnum, buf, offset, len,
823 vid_hdr, &retry);
824 if (!err || !retry)
825 break;
826
827 ubi_msg(ubi, "try again");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400828 }
829
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400830 ubi_free_vid_hdr(ubi, vid_hdr);
831
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400832 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400833}
834
835/**
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200836 * try_write_vid_and_data - try to write VID header and data to a new PEB.
837 * @vol: volume description object
838 * @lnum: logical eraseblock number
839 * @vid_hdr: VID header to write
840 * @buf: buffer containing the data
841 * @offset: where to start writing data
842 * @len: how many bytes should be written
843 *
844 * This function tries to write VID header and data belonging to logical
845 * eraseblock @lnum of volume @vol to a new physical eraseblock. Returns zero
846 * in case of success and a negative error code in case of failure.
847 * In case of error, it is possible that something was still written to the
848 * flash media, but may be some garbage.
849 */
850static int try_write_vid_and_data(struct ubi_volume *vol, int lnum,
851 struct ubi_vid_hdr *vid_hdr, const void *buf,
852 int offset, int len)
853{
854 struct ubi_device *ubi = vol->ubi;
855 int pnum, opnum, err, vol_id = vol->vol_id;
856
857 pnum = ubi_wl_get_peb(ubi);
858 if (pnum < 0) {
859 err = pnum;
860 goto out_put;
861 }
862
Boris Brezillon799dca32016-09-16 16:59:25 +0200863 opnum = vol->eba_tbl->entries[lnum].pnum;
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200864
865 dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
866 len, offset, vol_id, lnum, pnum);
867
868 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
869 if (err) {
870 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
871 vol_id, lnum, pnum);
872 goto out_put;
873 }
874
875 if (len) {
876 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
877 if (err) {
878 ubi_warn(ubi,
879 "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
880 len, offset, vol_id, lnum, pnum);
881 goto out_put;
882 }
883 }
884
Boris Brezillon799dca32016-09-16 16:59:25 +0200885 vol->eba_tbl->entries[lnum].pnum = pnum;
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200886
887out_put:
888 up_read(&ubi->fm_eba_sem);
889
890 if (err && pnum >= 0)
891 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
892 else if (!err && opnum >= 0)
893 err = ubi_wl_put_peb(ubi, vol_id, lnum, opnum, 0);
894
895 return err;
896}
897
898/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400899 * ubi_eba_write_leb - write data to dynamic volume.
900 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200901 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400902 * @lnum: logical eraseblock number
903 * @buf: the data to write
904 * @offset: offset within the logical eraseblock where to write
905 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400906 *
907 * This function writes data to logical eraseblock @lnum of a dynamic volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200908 * @vol. Returns zero in case of success and a negative error code in case
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400909 * of failure. In case of error, it is possible that something was still
910 * written to the flash media, but may be some garbage.
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200911 * This function retries %UBI_IO_RETRIES times before giving up.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400912 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200913int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200914 const void *buf, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400915{
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200916 int err, pnum, tries, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400917 struct ubi_vid_hdr *vid_hdr;
918
919 if (ubi->ro_mode)
920 return -EROFS;
921
922 err = leb_write_lock(ubi, vol_id, lnum);
923 if (err)
924 return err;
925
Boris Brezillon799dca32016-09-16 16:59:25 +0200926 pnum = vol->eba_tbl->entries[lnum].pnum;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400927 if (pnum >= 0) {
928 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
929 len, offset, vol_id, lnum, pnum);
930
931 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
932 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300933 ubi_warn(ubi, "failed to write data to PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400934 if (err == -EIO && ubi->bad_allowed)
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200935 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
936 offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400937 }
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200938
939 goto out;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400940 }
941
942 /*
943 * The logical eraseblock is not mapped. We have to get a free physical
944 * eraseblock and write the volume identifier header there first.
945 */
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300946 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400947 if (!vid_hdr) {
948 leb_write_unlock(ubi, vol_id, lnum);
949 return -ENOMEM;
950 }
951
952 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Richard Weinbergera7306652012-09-26 17:51:43 +0200953 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300954 vid_hdr->vol_id = cpu_to_be32(vol_id);
955 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400956 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300957 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400958
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200959 for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
960 err = try_write_vid_and_data(vol, lnum, vid_hdr, buf, offset,
961 len);
962 if (err != -EIO || !ubi->bad_allowed)
963 break;
964
965 /*
966 * Fortunately, this is the first write operation to this
967 * physical eraseblock, so just put it and request a new one.
968 * We assume that if this physical eraseblock went bad, the
969 * erase code will handle that.
970 */
971 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
972 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400973 }
974
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200975 ubi_free_vid_hdr(ubi, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400976
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200977out:
978 if (err)
979 ubi_ro_mode(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400980
981 leb_write_unlock(ubi, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400982
Boris Brezillon2d78aee2016-09-16 16:59:21 +0200983 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400984}
985
986/**
987 * ubi_eba_write_leb_st - write data to static volume.
988 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200989 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400990 * @lnum: logical eraseblock number
991 * @buf: data to write
992 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400993 * @used_ebs: how many logical eraseblocks will this volume contain
994 *
995 * This function writes data to logical eraseblock @lnum of static volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200996 * @vol. The @used_ebs argument should contain total number of logical
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400997 * eraseblock in this static volume.
998 *
999 * When writing to the last logical eraseblock, the @len argument doesn't have
1000 * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
1001 * to the real data size, although the @buf buffer has to contain the
1002 * alignment. In all other cases, @len has to be aligned.
1003 *
Frederik Schwarzer025dfda2008-10-16 19:02:37 +02001004 * It is prohibited to write more than once to logical eraseblocks of static
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001005 * volumes. This function returns zero in case of success and a negative error
1006 * code in case of failure.
1007 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +02001008int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001009 int lnum, const void *buf, int len, int used_ebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001010{
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001011 int err, tries, data_size = len, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001012 struct ubi_vid_hdr *vid_hdr;
1013 uint32_t crc;
1014
1015 if (ubi->ro_mode)
1016 return -EROFS;
1017
1018 if (lnum == used_ebs - 1)
1019 /* If this is the last LEB @len may be unaligned */
1020 len = ALIGN(data_size, ubi->min_io_size);
1021 else
Kyungmin Parkcadb40c2008-05-22 10:32:18 +09001022 ubi_assert(!(len & (ubi->min_io_size - 1)));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001023
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001024 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001025 if (!vid_hdr)
1026 return -ENOMEM;
1027
1028 err = leb_write_lock(ubi, vol_id, lnum);
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001029 if (err)
1030 goto out;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001031
Richard Weinbergera7306652012-09-26 17:51:43 +02001032 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001033 vid_hdr->vol_id = cpu_to_be32(vol_id);
1034 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001035 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001036 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001037
1038 crc = crc32(UBI_CRC32_INIT, buf, data_size);
1039 vid_hdr->vol_type = UBI_VID_STATIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001040 vid_hdr->data_size = cpu_to_be32(data_size);
1041 vid_hdr->used_ebs = cpu_to_be32(used_ebs);
1042 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001043
Boris Brezillon799dca32016-09-16 16:59:25 +02001044 ubi_assert(vol->eba_tbl->entries[lnum].pnum < 0);
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001045
1046 for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1047 err = try_write_vid_and_data(vol, lnum, vid_hdr, buf, 0, len);
1048 if (err != -EIO || !ubi->bad_allowed)
1049 break;
1050
1051 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1052 ubi_msg(ubi, "try another PEB");
1053 }
1054
1055 if (err)
1056 ubi_ro_mode(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001057
1058 leb_write_unlock(ubi, vol_id, lnum);
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001059
1060out:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001061 ubi_free_vid_hdr(ubi, vid_hdr);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001062
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001063 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001064}
1065
1066/*
1067 * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
1068 * @ubi: UBI device description object
Artem Bityutskiyc63a4912007-12-17 13:21:07 +02001069 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001070 * @lnum: logical eraseblock number
1071 * @buf: data to write
1072 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 *
1074 * This function changes the contents of a logical eraseblock atomically. @buf
1075 * has to contain new logical eraseblock data, and @len - the length of the
1076 * data, which has to be aligned. This function guarantees that in case of an
1077 * unclean reboot the old contents is preserved. Returns zero in case of
1078 * success and a negative error code in case of failure.
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001079 *
1080 * UBI reserves one LEB for the "atomic LEB change" operation, so only one
1081 * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001082 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +02001083int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001084 int lnum, const void *buf, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001085{
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001086 int err, tries, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001087 struct ubi_vid_hdr *vid_hdr;
1088 uint32_t crc;
1089
1090 if (ubi->ro_mode)
1091 return -EROFS;
1092
Artem Bityutskiy60c03152008-01-24 17:56:14 +02001093 if (len == 0) {
1094 /*
1095 * Special case when data length is zero. In this case the LEB
1096 * has to be unmapped and mapped somewhere else.
1097 */
1098 err = ubi_eba_unmap_leb(ubi, vol, lnum);
1099 if (err)
1100 return err;
Richard Weinbergerb36a2612012-05-14 17:55:51 +02001101 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
Artem Bityutskiy60c03152008-01-24 17:56:14 +02001102 }
1103
Artem Bityutskiy33818bb2007-08-28 21:29:32 +03001104 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001105 if (!vid_hdr)
1106 return -ENOMEM;
1107
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001108 mutex_lock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001109 err = leb_write_lock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001110 if (err)
1111 goto out_mutex;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001112
Richard Weinbergera7306652012-09-26 17:51:43 +02001113 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001114 vid_hdr->vol_id = cpu_to_be32(vol_id);
1115 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001116 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001117 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001118
1119 crc = crc32(UBI_CRC32_INIT, buf, len);
Artem Bityutskiy84a92582007-07-04 16:16:51 +03001120 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001121 vid_hdr->data_size = cpu_to_be32(len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001122 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001123 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001124
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001125 dbg_eba("change LEB %d:%d", vol_id, lnum);
1126
1127 for (tries = 0; tries <= UBI_IO_RETRIES; tries++) {
1128 err = try_write_vid_and_data(vol, lnum, vid_hdr, buf, 0, len);
1129 if (err != -EIO || !ubi->bad_allowed)
1130 break;
1131
1132 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
1133 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001134 }
1135
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001136 /*
1137 * This flash device does not admit of bad eraseblocks or
1138 * something nasty and unexpected happened. Switch to read-only
1139 * mode just in case.
1140 */
1141 if (err)
1142 ubi_ro_mode(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001143
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001144 leb_write_unlock(ubi, vol_id, lnum);
Boris Brezillon2d78aee2016-09-16 16:59:21 +02001145
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001146out_mutex:
1147 mutex_unlock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001148 ubi_free_vid_hdr(ubi, vid_hdr);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001149 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001150}
1151
1152/**
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001153 * is_error_sane - check whether a read error is sane.
1154 * @err: code of the error happened during reading
1155 *
1156 * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1157 * cannot read data from the target PEB (an error @err happened). If the error
1158 * code is sane, then we treat this error as non-fatal. Otherwise the error is
1159 * fatal and UBI will be switched to R/O mode later.
1160 *
1161 * The idea is that we try not to switch to R/O mode if the read error is
1162 * something which suggests there was a real read problem. E.g., %-EIO. Or a
1163 * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1164 * mode, simply because we do not know what happened at the MTD level, and we
1165 * cannot handle this. E.g., the underlying driver may have become crazy, and
1166 * it is safer to switch to R/O mode to preserve the data.
1167 *
1168 * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1169 * which we have just written.
1170 */
1171static int is_error_sane(int err)
1172{
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001173 if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
Artem Bityutskiy756e1df2010-09-03 01:30:16 +03001174 err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001175 return 0;
1176 return 1;
1177}
1178
1179/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001180 * ubi_eba_copy_leb - copy logical eraseblock.
1181 * @ubi: UBI device description object
1182 * @from: physical eraseblock number from where to copy
1183 * @to: physical eraseblock number where to copy
1184 * @vid_hdr: VID header of the @from physical eraseblock
1185 *
1186 * This function copies logical eraseblock from physical eraseblock @from to
1187 * physical eraseblock @to. The @vid_hdr buffer may be changed by this
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001188 * function. Returns:
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001189 * o %0 in case of success;
Artem Bityutskiycc831462012-03-09 10:31:18 +02001190 * o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001191 * o a negative error code in case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001192 */
1193int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1194 struct ubi_vid_hdr *vid_hdr)
1195{
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001196 int err, vol_id, lnum, data_size, aldata_size, idx;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001197 struct ubi_volume *vol;
1198 uint32_t crc;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001199
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001200 vol_id = be32_to_cpu(vid_hdr->vol_id);
1201 lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001202
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001203 dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001204
1205 if (vid_hdr->vol_type == UBI_VID_STATIC) {
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001206 data_size = be32_to_cpu(vid_hdr->data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001207 aldata_size = ALIGN(data_size, ubi->min_io_size);
1208 } else
1209 data_size = aldata_size =
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001210 ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001211
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001212 idx = vol_id2idx(ubi, vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001213 spin_lock(&ubi->volumes_lock);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001214 /*
1215 * Note, we may race with volume deletion, which means that the volume
1216 * this logical eraseblock belongs to might be being deleted. Since the
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001217 * volume deletion un-maps all the volume's logical eraseblocks, it will
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001218 * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1219 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001220 vol = ubi->volumes[idx];
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001221 spin_unlock(&ubi->volumes_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001222 if (!vol) {
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001223 /* No need to do further work, cancel */
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001224 dbg_wl("volume %d is being removed, cancel", vol_id);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001225 return MOVE_CANCEL_RACE;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001226 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001227
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001228 /*
1229 * We do not want anybody to write to this logical eraseblock while we
1230 * are moving it, so lock it.
1231 *
1232 * Note, we are using non-waiting locking here, because we cannot sleep
1233 * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1234 * unmapping the LEB which is mapped to the PEB we are going to move
1235 * (@from). This task locks the LEB and goes sleep in the
1236 * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1237 * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001238 * LEB is already locked, we just do not move it and return
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301239 * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1240 * we do not know the reasons of the contention - it may be just a
1241 * normal I/O on this LEB, so we want to re-try.
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001242 */
1243 err = leb_write_trylock(ubi, vol_id, lnum);
1244 if (err) {
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001245 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301246 return MOVE_RETRY;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001247 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001248
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001249 /*
1250 * The LEB might have been put meanwhile, and the task which put it is
1251 * probably waiting on @ubi->move_mutex. No need to continue the work,
1252 * cancel it.
1253 */
Boris Brezillon799dca32016-09-16 16:59:25 +02001254 if (vol->eba_tbl->entries[lnum].pnum != from) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001255 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
Boris Brezillon799dca32016-09-16 16:59:25 +02001256 vol_id, lnum, from, vol->eba_tbl->entries[lnum].pnum);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001257 err = MOVE_CANCEL_RACE;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001258 goto out_unlock_leb;
1259 }
1260
1261 /*
Zoltan Sogorb77bcb02008-10-29 09:50:02 +01001262 * OK, now the LEB is locked and we can safely start moving it. Since
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001263 * this function utilizes the @ubi->peb_buf buffer which is shared
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001264 * with some other functions - we lock the buffer by taking the
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001265 * @ubi->buf_mutex.
1266 */
1267 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001268 dbg_wl("read %d bytes of data", aldata_size);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001269 err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001270 if (err && err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001271 ubi_warn(ubi, "error %d while reading data from PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001272 err, from);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001273 err = MOVE_SOURCE_RD_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001274 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001275 }
1276
1277 /*
Anand Gadiyarfd589a82009-07-16 17:13:03 +02001278 * Now we have got to calculate how much data we have to copy. In
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001279 * case of a static volume it is fairly easy - the VID header contains
1280 * the data size. In case of a dynamic volume it is more difficult - we
1281 * have to read the contents, cut 0xFF bytes from the end and copy only
1282 * the first part. We must do this to avoid writing 0xFF bytes as it
1283 * may have some side-effects. And not only this. It is important not
1284 * to include those 0xFFs to CRC because later the they may be filled
1285 * by data.
1286 */
1287 if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1288 aldata_size = data_size =
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001289 ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001290
1291 cond_resched();
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001292 crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001293 cond_resched();
1294
1295 /*
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001296 * It may turn out to be that the whole @from physical eraseblock
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001297 * contains only 0xFF bytes. Then we have to only write the VID header
1298 * and do not write any data. This also means we should not set
1299 * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1300 */
1301 if (data_size > 0) {
1302 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001303 vid_hdr->data_size = cpu_to_be32(data_size);
1304 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001305 }
Richard Weinbergera7306652012-09-26 17:51:43 +02001306 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001307
1308 err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001309 if (err) {
1310 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001311 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001312 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001313 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001314
1315 cond_resched();
1316
1317 /* Read the VID header back and check if it was written correctly */
1318 err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1319 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001320 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001321 ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001322 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001323 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001324 err = MOVE_TARGET_RD_ERR;
1325 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001326 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001327 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001328 }
1329
1330 if (data_size > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001331 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001332 if (err) {
1333 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001334 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001335 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001336 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001337
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001338 cond_resched();
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001339 }
1340
Boris Brezillon799dca32016-09-16 16:59:25 +02001341 ubi_assert(vol->eba_tbl->entries[lnum].pnum == from);
Richard Weinberger111ab0b2014-11-10 16:28:08 +01001342 down_read(&ubi->fm_eba_sem);
Boris Brezillon799dca32016-09-16 16:59:25 +02001343 vol->eba_tbl->entries[lnum].pnum = to;
Richard Weinberger111ab0b2014-11-10 16:28:08 +01001344 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001345
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001346out_unlock_buf:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001347 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001348out_unlock_leb:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001349 leb_write_unlock(ubi, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001350 return err;
1351}
1352
1353/**
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001354 * print_rsvd_warning - warn about not having enough reserved PEBs.
1355 * @ubi: UBI device description object
1356 *
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001357 * This is a helper function for 'ubi_eba_init()' which is called when UBI
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001358 * cannot reserve enough PEBs for bad block handling. This function makes a
1359 * decision whether we have to print a warning or not. The algorithm is as
1360 * follows:
1361 * o if this is a new UBI image, then just print the warning
1362 * o if this is an UBI image which has already been used for some time, print
1363 * a warning only if we can reserve less than 10% of the expected amount of
1364 * the reserved PEB.
1365 *
1366 * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1367 * of PEBs becomes smaller, which is normal and we do not want to scare users
1368 * with a warning every time they attach the MTD device. This was an issue
1369 * reported by real users.
1370 */
1371static void print_rsvd_warning(struct ubi_device *ubi,
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001372 struct ubi_attach_info *ai)
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001373{
1374 /*
1375 * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1376 * large number to distinguish between newly flashed and used images.
1377 */
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001378 if (ai->max_sqnum > (1 << 18)) {
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001379 int min = ubi->beb_rsvd_level / 10;
1380
1381 if (!min)
1382 min = 1;
1383 if (ubi->beb_rsvd_pebs > min)
1384 return;
1385 }
1386
Tanya Brokhman326087032014-10-20 19:57:00 +03001387 ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001388 ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001389 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001390 ubi_warn(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001391 ubi->corr_peb_count);
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001392}
1393
1394/**
Richard Weinberger00abf302012-09-26 17:51:44 +02001395 * self_check_eba - run a self check on the EBA table constructed by fastmap.
1396 * @ubi: UBI device description object
1397 * @ai_fastmap: UBI attach info object created by fastmap
1398 * @ai_scan: UBI attach info object created by scanning
1399 *
1400 * Returns < 0 in case of an internal error, 0 otherwise.
1401 * If a bad EBA table entry was found it will be printed out and
1402 * ubi_assert() triggers.
1403 */
1404int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1405 struct ubi_attach_info *ai_scan)
1406{
1407 int i, j, num_volumes, ret = 0;
1408 int **scan_eba, **fm_eba;
1409 struct ubi_ainf_volume *av;
1410 struct ubi_volume *vol;
1411 struct ubi_ainf_peb *aeb;
1412 struct rb_node *rb;
1413
1414 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1415
1416 scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1417 if (!scan_eba)
1418 return -ENOMEM;
1419
1420 fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1421 if (!fm_eba) {
1422 kfree(scan_eba);
1423 return -ENOMEM;
1424 }
1425
1426 for (i = 0; i < num_volumes; i++) {
1427 vol = ubi->volumes[i];
1428 if (!vol)
1429 continue;
1430
1431 scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1432 GFP_KERNEL);
1433 if (!scan_eba[i]) {
1434 ret = -ENOMEM;
1435 goto out_free;
1436 }
1437
1438 fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1439 GFP_KERNEL);
1440 if (!fm_eba[i]) {
1441 ret = -ENOMEM;
1442 goto out_free;
1443 }
1444
1445 for (j = 0; j < vol->reserved_pebs; j++)
1446 scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1447
1448 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1449 if (!av)
1450 continue;
1451
1452 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1453 scan_eba[i][aeb->lnum] = aeb->pnum;
1454
1455 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1456 if (!av)
1457 continue;
1458
1459 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1460 fm_eba[i][aeb->lnum] = aeb->pnum;
1461
1462 for (j = 0; j < vol->reserved_pebs; j++) {
1463 if (scan_eba[i][j] != fm_eba[i][j]) {
1464 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1465 fm_eba[i][j] == UBI_LEB_UNMAPPED)
1466 continue;
1467
Tanya Brokhman326087032014-10-20 19:57:00 +03001468 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
Richard Weinberger53474172015-07-03 10:36:16 +02001469 vol->vol_id, j, fm_eba[i][j],
Richard Weinberger00abf302012-09-26 17:51:44 +02001470 scan_eba[i][j]);
1471 ubi_assert(0);
1472 }
1473 }
1474 }
1475
1476out_free:
1477 for (i = 0; i < num_volumes; i++) {
1478 if (!ubi->volumes[i])
1479 continue;
1480
1481 kfree(scan_eba[i]);
1482 kfree(fm_eba[i]);
1483 }
1484
1485 kfree(scan_eba);
1486 kfree(fm_eba);
1487 return ret;
1488}
1489
1490/**
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001491 * ubi_eba_init - initialize the EBA sub-system using attaching information.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001492 * @ubi: UBI device description object
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001493 * @ai: attaching information
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001494 *
1495 * This function returns zero in case of success and a negative error code in
1496 * case of failure.
1497 */
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001498int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001499{
Boris Brezillon799dca32016-09-16 16:59:25 +02001500 int i, err, num_volumes;
Artem Bityutskiy517af482012-05-17 14:38:34 +03001501 struct ubi_ainf_volume *av;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001502 struct ubi_volume *vol;
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001503 struct ubi_ainf_peb *aeb;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001504 struct rb_node *rb;
1505
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001506 dbg_eba("initialize EBA sub-system");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001507
1508 spin_lock_init(&ubi->ltree_lock);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001509 mutex_init(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001510 ubi->ltree = RB_ROOT;
1511
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001512 ubi->global_sqnum = ai->max_sqnum + 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001513 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1514
1515 for (i = 0; i < num_volumes; i++) {
Boris Brezillon799dca32016-09-16 16:59:25 +02001516 struct ubi_eba_table *tbl;
1517
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001518 vol = ubi->volumes[i];
1519 if (!vol)
1520 continue;
1521
1522 cond_resched();
1523
Boris Brezillon799dca32016-09-16 16:59:25 +02001524 tbl = ubi_eba_create_table(vol, vol->reserved_pebs);
1525 if (IS_ERR(tbl)) {
1526 err = PTR_ERR(tbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001527 goto out_free;
1528 }
1529
Boris Brezillon799dca32016-09-16 16:59:25 +02001530 ubi_eba_replace_table(vol, tbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001531
Artem Bityutskiydcd85fd2012-05-17 15:33:20 +03001532 av = ubi_find_av(ai, idx2vol_id(ubi, i));
Artem Bityutskiy517af482012-05-17 14:38:34 +03001533 if (!av)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001534 continue;
1535
Artem Bityutskiy517af482012-05-17 14:38:34 +03001536 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
Boris Brezillon799dca32016-09-16 16:59:25 +02001537 if (aeb->lnum >= vol->reserved_pebs) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001538 /*
1539 * This may happen in case of an unclean reboot
1540 * during re-size.
1541 */
Artem Bityutskiy0bae2882012-05-17 15:53:10 +03001542 ubi_move_aeb_to_list(av, aeb, &ai->erase);
Boris Brezillon799dca32016-09-16 16:59:25 +02001543 } else {
1544 struct ubi_eba_entry *entry;
1545
1546 entry = &vol->eba_tbl->entries[aeb->lnum];
1547 entry->pnum = aeb->pnum;
1548 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001549 }
1550 }
1551
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001552 if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001553 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001554 ubi->avail_pebs, EBA_RESERVED_PEBS);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001555 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001556 ubi_err(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001557 ubi->corr_peb_count);
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001558 err = -ENOSPC;
1559 goto out_free;
1560 }
1561 ubi->avail_pebs -= EBA_RESERVED_PEBS;
1562 ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1563
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001564 if (ubi->bad_allowed) {
1565 ubi_calculate_reserved(ubi);
1566
1567 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1568 /* No enough free physical eraseblocks */
1569 ubi->beb_rsvd_pebs = ubi->avail_pebs;
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001570 print_rsvd_warning(ubi, ai);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001571 } else
1572 ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1573
1574 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1575 ubi->rsvd_pebs += ubi->beb_rsvd_pebs;
1576 }
1577
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001578 dbg_eba("EBA sub-system is initialized");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001579 return 0;
1580
1581out_free:
1582 for (i = 0; i < num_volumes; i++) {
1583 if (!ubi->volumes[i])
1584 continue;
Boris Brezillon799dca32016-09-16 16:59:25 +02001585 ubi_eba_replace_table(ubi->volumes[i], NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001586 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001587 return err;
1588}