blob: 5b9834cf2820f184577345b74993868149bdc985 [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/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040053 * next_sqnum - get next sequence number.
54 * @ubi: UBI device description object
55 *
56 * This function returns next sequence number to use, which is just the current
57 * global sequence counter value. It also increases the global sequence
58 * counter.
59 */
Richard Weinbergera7306652012-09-26 17:51:43 +020060unsigned long long ubi_next_sqnum(struct ubi_device *ubi)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040061{
62 unsigned long long sqnum;
63
64 spin_lock(&ubi->ltree_lock);
65 sqnum = ubi->global_sqnum++;
66 spin_unlock(&ubi->ltree_lock);
67
68 return sqnum;
69}
70
71/**
72 * ubi_get_compat - get compatibility flags of a volume.
73 * @ubi: UBI device description object
74 * @vol_id: volume ID
75 *
76 * This function returns compatibility flags for an internal volume. User
77 * volumes have no compatibility flags, so %0 is returned.
78 */
79static int ubi_get_compat(const struct ubi_device *ubi, int vol_id)
80{
Artem Bityutskiy91f2d532008-01-24 11:23:23 +020081 if (vol_id == UBI_LAYOUT_VOLUME_ID)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040082 return UBI_LAYOUT_VOLUME_COMPAT;
83 return 0;
84}
85
86/**
87 * ltree_lookup - look up the lock tree.
88 * @ubi: UBI device description object
89 * @vol_id: volume ID
90 * @lnum: logical eraseblock number
91 *
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +020092 * This function returns a pointer to the corresponding &struct ubi_ltree_entry
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040093 * object if the logical eraseblock is locked and %NULL if it is not.
94 * @ubi->ltree_lock has to be locked.
95 */
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +020096static struct ubi_ltree_entry *ltree_lookup(struct ubi_device *ubi, int vol_id,
97 int lnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040098{
99 struct rb_node *p;
100
101 p = ubi->ltree.rb_node;
102 while (p) {
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200103 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400104
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200105 le = rb_entry(p, struct ubi_ltree_entry, rb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400106
107 if (vol_id < le->vol_id)
108 p = p->rb_left;
109 else if (vol_id > le->vol_id)
110 p = p->rb_right;
111 else {
112 if (lnum < le->lnum)
113 p = p->rb_left;
114 else if (lnum > le->lnum)
115 p = p->rb_right;
116 else
117 return le;
118 }
119 }
120
121 return NULL;
122}
123
124/**
125 * ltree_add_entry - add new entry to the lock tree.
126 * @ubi: UBI device description object
127 * @vol_id: volume ID
128 * @lnum: logical eraseblock number
129 *
130 * This function adds new entry for logical eraseblock (@vol_id, @lnum) to the
131 * lock tree. If such entry is already there, its usage counter is increased.
132 * Returns pointer to the lock tree entry or %-ENOMEM if memory allocation
133 * failed.
134 */
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200135static struct ubi_ltree_entry *ltree_add_entry(struct ubi_device *ubi,
136 int vol_id, int lnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400137{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200138 struct ubi_ltree_entry *le, *le1, *le_free;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400139
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200140 le = kmalloc(sizeof(struct ubi_ltree_entry), GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400141 if (!le)
142 return ERR_PTR(-ENOMEM);
143
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200144 le->users = 0;
145 init_rwsem(&le->mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400146 le->vol_id = vol_id;
147 le->lnum = lnum;
148
149 spin_lock(&ubi->ltree_lock);
150 le1 = ltree_lookup(ubi, vol_id, lnum);
151
152 if (le1) {
153 /*
154 * This logical eraseblock is already locked. The newly
155 * allocated lock entry is not needed.
156 */
157 le_free = le;
158 le = le1;
159 } else {
160 struct rb_node **p, *parent = NULL;
161
162 /*
163 * No lock entry, add the newly allocated one to the
164 * @ubi->ltree RB-tree.
165 */
166 le_free = NULL;
167
168 p = &ubi->ltree.rb_node;
169 while (*p) {
170 parent = *p;
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200171 le1 = rb_entry(parent, struct ubi_ltree_entry, rb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400172
173 if (vol_id < le1->vol_id)
174 p = &(*p)->rb_left;
175 else if (vol_id > le1->vol_id)
176 p = &(*p)->rb_right;
177 else {
178 ubi_assert(lnum != le1->lnum);
179 if (lnum < le1->lnum)
180 p = &(*p)->rb_left;
181 else
182 p = &(*p)->rb_right;
183 }
184 }
185
186 rb_link_node(&le->rb, parent, p);
187 rb_insert_color(&le->rb, &ubi->ltree);
188 }
189 le->users += 1;
190 spin_unlock(&ubi->ltree_lock);
191
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300192 kfree(le_free);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400193 return le;
194}
195
196/**
197 * leb_read_lock - lock logical eraseblock for reading.
198 * @ubi: UBI device description object
199 * @vol_id: volume ID
200 * @lnum: logical eraseblock number
201 *
202 * This function locks a logical eraseblock for reading. Returns zero in case
203 * of success and a negative error code in case of failure.
204 */
205static int leb_read_lock(struct ubi_device *ubi, int vol_id, int lnum)
206{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200207 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400208
209 le = ltree_add_entry(ubi, vol_id, lnum);
210 if (IS_ERR(le))
211 return PTR_ERR(le);
212 down_read(&le->mutex);
213 return 0;
214}
215
216/**
217 * leb_read_unlock - unlock logical eraseblock.
218 * @ubi: UBI device description object
219 * @vol_id: volume ID
220 * @lnum: logical eraseblock number
221 */
222static void leb_read_unlock(struct ubi_device *ubi, int vol_id, int lnum)
223{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200224 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400225
226 spin_lock(&ubi->ltree_lock);
227 le = ltree_lookup(ubi, vol_id, lnum);
228 le->users -= 1;
229 ubi_assert(le->users >= 0);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300230 up_read(&le->mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400231 if (le->users == 0) {
232 rb_erase(&le->rb, &ubi->ltree);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300233 kfree(le);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400234 }
235 spin_unlock(&ubi->ltree_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400236}
237
238/**
239 * leb_write_lock - lock logical eraseblock for writing.
240 * @ubi: UBI device description object
241 * @vol_id: volume ID
242 * @lnum: logical eraseblock number
243 *
244 * This function locks a logical eraseblock for writing. Returns zero in case
245 * of success and a negative error code in case of failure.
246 */
247static int leb_write_lock(struct ubi_device *ubi, int vol_id, int lnum)
248{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200249 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400250
251 le = ltree_add_entry(ubi, vol_id, lnum);
252 if (IS_ERR(le))
253 return PTR_ERR(le);
254 down_write(&le->mutex);
255 return 0;
256}
257
258/**
Artem Bityutskiy43f9b252007-12-18 15:06:55 +0200259 * leb_write_lock - lock logical eraseblock for writing.
260 * @ubi: UBI device description object
261 * @vol_id: volume ID
262 * @lnum: logical eraseblock number
263 *
264 * This function locks a logical eraseblock for writing if there is no
265 * contention and does nothing if there is contention. Returns %0 in case of
266 * success, %1 in case of contention, and and a negative error code in case of
267 * failure.
268 */
269static int leb_write_trylock(struct ubi_device *ubi, int vol_id, int lnum)
270{
Artem Bityutskiy43f9b252007-12-18 15:06:55 +0200271 struct ubi_ltree_entry *le;
272
273 le = ltree_add_entry(ubi, vol_id, lnum);
274 if (IS_ERR(le))
275 return PTR_ERR(le);
276 if (down_write_trylock(&le->mutex))
277 return 0;
278
279 /* Contention, cancel */
280 spin_lock(&ubi->ltree_lock);
281 le->users -= 1;
282 ubi_assert(le->users >= 0);
283 if (le->users == 0) {
284 rb_erase(&le->rb, &ubi->ltree);
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200285 kfree(le);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300286 }
287 spin_unlock(&ubi->ltree_lock);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +0200288
289 return 1;
290}
291
292/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400293 * leb_write_unlock - unlock logical eraseblock.
294 * @ubi: UBI device description object
295 * @vol_id: volume ID
296 * @lnum: logical eraseblock number
297 */
298static void leb_write_unlock(struct ubi_device *ubi, int vol_id, int lnum)
299{
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200300 struct ubi_ltree_entry *le;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400301
302 spin_lock(&ubi->ltree_lock);
303 le = ltree_lookup(ubi, vol_id, lnum);
304 le->users -= 1;
305 ubi_assert(le->users >= 0);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300306 up_write(&le->mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400307 if (le->users == 0) {
308 rb_erase(&le->rb, &ubi->ltree);
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200309 kfree(le);
Artem Bityutskiy23add742008-06-16 13:35:23 +0300310 }
311 spin_unlock(&ubi->ltree_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400312}
313
314/**
315 * ubi_eba_unmap_leb - un-map logical eraseblock.
316 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200317 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400318 * @lnum: logical eraseblock number
319 *
320 * This function un-maps logical eraseblock @lnum and schedules corresponding
321 * physical eraseblock for erasure. Returns zero in case of success and a
322 * negative error code in case of failure.
323 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200324int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
325 int lnum)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400326{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200327 int err, pnum, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400328
329 if (ubi->ro_mode)
330 return -EROFS;
331
332 err = leb_write_lock(ubi, vol_id, lnum);
333 if (err)
334 return err;
335
336 pnum = vol->eba_tbl[lnum];
337 if (pnum < 0)
338 /* This logical eraseblock is already unmapped */
339 goto out_unlock;
340
341 dbg_eba("erase LEB %d:%d, PEB %d", vol_id, lnum, pnum);
342
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100343 down_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400344 vol->eba_tbl[lnum] = UBI_LEB_UNMAPPED;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100345 up_read(&ubi->fm_eba_sem);
Joel Reardond36e59e2012-05-18 15:40:24 +0200346 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400347
348out_unlock:
349 leb_write_unlock(ubi, vol_id, lnum);
350 return err;
351}
352
353/**
354 * ubi_eba_read_leb - read data.
355 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200356 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400357 * @lnum: logical eraseblock number
358 * @buf: buffer to store the read data
359 * @offset: offset from where to read
360 * @len: how many bytes to read
361 * @check: data CRC check flag
362 *
363 * If the logical eraseblock @lnum is unmapped, @buf is filled with 0xFF
364 * bytes. The @check flag only makes sense for static volumes and forces
365 * eraseblock data CRC checking.
366 *
367 * In case of success this function returns zero. In case of a static volume,
368 * if data CRC mismatches - %-EBADMSG is returned. %-EBADMSG may also be
369 * returned for any volume type if an ECC error was detected by the MTD device
370 * driver. Other negative error cored may be returned in case of other errors.
371 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200372int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
373 void *buf, int offset, int len, int check)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400374{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200375 int err, pnum, scrub = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400376 struct ubi_vid_hdr *vid_hdr;
Jeff Garzika6343af2007-07-17 05:39:58 -0400377 uint32_t uninitialized_var(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400378
379 err = leb_read_lock(ubi, vol_id, lnum);
380 if (err)
381 return err;
382
383 pnum = vol->eba_tbl[lnum];
384 if (pnum < 0) {
385 /*
386 * The logical eraseblock is not mapped, fill the whole buffer
387 * with 0xFF bytes. The exception is static volumes for which
388 * it is an error to read unmapped logical eraseblocks.
389 */
390 dbg_eba("read %d bytes from offset %d of LEB %d:%d (unmapped)",
391 len, offset, vol_id, lnum);
392 leb_read_unlock(ubi, vol_id, lnum);
393 ubi_assert(vol->vol_type != UBI_STATIC_VOLUME);
394 memset(buf, 0xFF, len);
395 return 0;
396 }
397
398 dbg_eba("read %d bytes from offset %d of LEB %d:%d, PEB %d",
399 len, offset, vol_id, lnum, pnum);
400
401 if (vol->vol_type == UBI_DYNAMIC_VOLUME)
402 check = 0;
403
404retry:
405 if (check) {
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300406 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400407 if (!vid_hdr) {
408 err = -ENOMEM;
409 goto out_unlock;
410 }
411
412 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
413 if (err && err != UBI_IO_BITFLIPS) {
414 if (err > 0) {
415 /*
416 * The header is either absent or corrupted.
417 * The former case means there is a bug -
418 * switch to read-only mode just in case.
419 * The latter case means a real corruption - we
420 * may try to recover data. FIXME: but this is
421 * not implemented.
422 */
Artem Bityutskiy756e1df2010-09-03 01:30:16 +0300423 if (err == UBI_IO_BAD_HDR_EBADMSG ||
Artem Bityutskiyeb895802010-05-03 09:04:39 +0300424 err == UBI_IO_BAD_HDR) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300425 ubi_warn(ubi, "corrupted VID header at PEB %d, LEB %d:%d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300426 pnum, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400427 err = -EBADMSG;
Brian Norrisb388e6a2015-02-23 13:07:22 -0800428 } else {
Artem Bityutskiy0e707ae2014-11-25 11:34:02 +0200429 err = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400430 ubi_ro_mode(ubi);
Brian Norrisb388e6a2015-02-23 13:07:22 -0800431 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400432 }
433 goto out_free;
434 } else if (err == UBI_IO_BITFLIPS)
435 scrub = 1;
436
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300437 ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
438 ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400439
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300440 crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400441 ubi_free_vid_hdr(ubi, vid_hdr);
442 }
443
444 err = ubi_io_read_data(ubi, buf, pnum, offset, len);
445 if (err) {
Richard Weinberger170505f2014-09-22 10:45:34 +0200446 if (err == UBI_IO_BITFLIPS)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400447 scrub = 1;
Richard Weinberger170505f2014-09-22 10:45:34 +0200448 else if (mtd_is_eccerr(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400449 if (vol->vol_type == UBI_DYNAMIC_VOLUME)
450 goto out_unlock;
451 scrub = 1;
452 if (!check) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300453 ubi_msg(ubi, "force data checking");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400454 check = 1;
455 goto retry;
456 }
457 } else
458 goto out_unlock;
459 }
460
461 if (check) {
Jeff Garzik2ab934b2007-07-17 01:49:56 -0400462 uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400463 if (crc1 != crc) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300464 ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400465 crc1, crc);
466 err = -EBADMSG;
467 goto out_unlock;
468 }
469 }
470
471 if (scrub)
472 err = ubi_wl_scrub_peb(ubi, pnum);
473
474 leb_read_unlock(ubi, vol_id, lnum);
475 return err;
476
477out_free:
478 ubi_free_vid_hdr(ubi, vid_hdr);
479out_unlock:
480 leb_read_unlock(ubi, vol_id, lnum);
481 return err;
482}
483
484/**
Richard Weinberger9ff08972015-01-10 22:52:13 +0100485 * ubi_eba_read_leb_sg - read data into a scatter gather list.
486 * @ubi: UBI device description object
487 * @vol: volume description object
488 * @lnum: logical eraseblock number
489 * @sgl: UBI scatter gather list to store the read data
490 * @offset: offset from where to read
491 * @len: how many bytes to read
492 * @check: data CRC check flag
493 *
494 * This function works exactly like ubi_eba_read_leb(). But instead of
495 * storing the read data into a buffer it writes to an UBI scatter gather
496 * list.
497 */
498int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
499 struct ubi_sgl *sgl, int lnum, int offset, int len,
500 int check)
501{
502 int to_read;
503 int ret;
504 struct scatterlist *sg;
505
506 for (;;) {
507 ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
508 sg = &sgl->sg[sgl->list_pos];
509 if (len < sg->length - sgl->page_pos)
510 to_read = len;
511 else
512 to_read = sg->length - sgl->page_pos;
513
514 ret = ubi_eba_read_leb(ubi, vol, lnum,
515 sg_virt(sg) + sgl->page_pos, offset,
516 to_read, check);
517 if (ret < 0)
518 return ret;
519
520 offset += to_read;
521 len -= to_read;
522 if (!len) {
523 sgl->page_pos += to_read;
524 if (sgl->page_pos == sg->length) {
525 sgl->list_pos++;
526 sgl->page_pos = 0;
527 }
528
529 break;
530 }
531
532 sgl->list_pos++;
533 sgl->page_pos = 0;
534 }
535
536 return ret;
537}
538
539/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400540 * recover_peb - recover from write failure.
541 * @ubi: UBI device description object
542 * @pnum: the physical eraseblock to recover
543 * @vol_id: volume ID
544 * @lnum: logical eraseblock number
545 * @buf: data which was not written because of the write failure
546 * @offset: offset of the failed write
547 * @len: how many bytes should have been written
548 *
549 * This function is called in case of a write failure and moves all good data
550 * from the potentially bad physical eraseblock to a good physical eraseblock.
551 * This function also writes the data which was not written due to the failure.
552 * Returns new physical eraseblock number in case of success, and a negative
553 * error code in case of failure.
554 */
555static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
556 const void *buf, int offset, int len)
557{
558 int err, idx = vol_id2idx(ubi, vol_id), new_pnum, data_size, tries = 0;
559 struct ubi_volume *vol = ubi->volumes[idx];
560 struct ubi_vid_hdr *vid_hdr;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400561
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300562 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300563 if (!vid_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400564 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400565
566retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200567 new_pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400568 if (new_pnum < 0) {
569 ubi_free_vid_hdr(ubi, vid_hdr);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100570 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400571 return new_pnum;
572 }
573
Tanya Brokhman326087032014-10-20 19:57:00 +0300574 ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
575 pnum, new_pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400576
577 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
578 if (err && err != UBI_IO_BITFLIPS) {
579 if (err > 0)
580 err = -EIO;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100581 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400582 goto out_put;
583 }
584
Richard Weinbergera7306652012-09-26 17:51:43 +0200585 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400586 err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
Richard Weinberger8fb2a512014-11-10 16:27:10 +0100587 if (err) {
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100588 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400589 goto write_error;
Richard Weinberger8fb2a512014-11-10 16:27:10 +0100590 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400591
592 data_size = offset + len;
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200593 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200594 memset(ubi->peb_buf + offset, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400595
596 /* Read everything before the area where the write failure happened */
597 if (offset > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200598 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
Richard Weinberger8fb2a512014-11-10 16:27:10 +0100599 if (err && err != UBI_IO_BITFLIPS) {
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100600 up_read(&ubi->fm_eba_sem);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200601 goto out_unlock;
Richard Weinberger8fb2a512014-11-10 16:27:10 +0100602 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400603 }
604
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200605 memcpy(ubi->peb_buf + offset, buf, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400606
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200607 err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200608 if (err) {
609 mutex_unlock(&ubi->buf_mutex);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100610 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400611 goto write_error;
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200612 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400613
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300614 mutex_unlock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400615 ubi_free_vid_hdr(ubi, vid_hdr);
616
617 vol->eba_tbl[lnum] = new_pnum;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100618 up_read(&ubi->fm_eba_sem);
Joel Reardond36e59e2012-05-18 15:40:24 +0200619 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400620
Tanya Brokhman326087032014-10-20 19:57:00 +0300621 ubi_msg(ubi, "data was successfully recovered");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400622 return 0;
623
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200624out_unlock:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300625 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200626out_put:
Joel Reardond36e59e2012-05-18 15:40:24 +0200627 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400628 ubi_free_vid_hdr(ubi, vid_hdr);
629 return err;
630
631write_error:
632 /*
633 * Bad luck? This physical eraseblock is bad too? Crud. Let's try to
634 * get another one.
635 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300636 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
Joel Reardond36e59e2012-05-18 15:40:24 +0200637 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400638 if (++tries > UBI_IO_RETRIES) {
639 ubi_free_vid_hdr(ubi, vid_hdr);
640 return err;
641 }
Tanya Brokhman326087032014-10-20 19:57:00 +0300642 ubi_msg(ubi, "try again");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400643 goto retry;
644}
645
646/**
647 * ubi_eba_write_leb - write data to dynamic volume.
648 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200649 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400650 * @lnum: logical eraseblock number
651 * @buf: the data to write
652 * @offset: offset within the logical eraseblock where to write
653 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400654 *
655 * This function writes data to logical eraseblock @lnum of a dynamic volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200656 * @vol. Returns zero in case of success and a negative error code in case
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400657 * of failure. In case of error, it is possible that something was still
658 * written to the flash media, but may be some garbage.
659 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200660int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200661 const void *buf, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400662{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200663 int err, pnum, tries = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400664 struct ubi_vid_hdr *vid_hdr;
665
666 if (ubi->ro_mode)
667 return -EROFS;
668
669 err = leb_write_lock(ubi, vol_id, lnum);
670 if (err)
671 return err;
672
673 pnum = vol->eba_tbl[lnum];
674 if (pnum >= 0) {
675 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
676 len, offset, vol_id, lnum, pnum);
677
678 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
679 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300680 ubi_warn(ubi, "failed to write data to PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400681 if (err == -EIO && ubi->bad_allowed)
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200682 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
683 offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400684 if (err)
685 ubi_ro_mode(ubi);
686 }
687 leb_write_unlock(ubi, vol_id, lnum);
688 return err;
689 }
690
691 /*
692 * The logical eraseblock is not mapped. We have to get a free physical
693 * eraseblock and write the volume identifier header there first.
694 */
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300695 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400696 if (!vid_hdr) {
697 leb_write_unlock(ubi, vol_id, lnum);
698 return -ENOMEM;
699 }
700
701 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Richard Weinbergera7306652012-09-26 17:51:43 +0200702 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300703 vid_hdr->vol_id = cpu_to_be32(vol_id);
704 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400705 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300706 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400707
708retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200709 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400710 if (pnum < 0) {
711 ubi_free_vid_hdr(ubi, vid_hdr);
712 leb_write_unlock(ubi, vol_id, lnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100713 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400714 return pnum;
715 }
716
717 dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
718 len, offset, vol_id, lnum, pnum);
719
720 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
721 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300722 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400723 vol_id, lnum, pnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100724 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400725 goto write_error;
726 }
727
Artem Bityutskiy393852e2007-12-06 18:47:30 +0200728 if (len) {
729 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
730 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300731 ubi_warn(ubi, "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300732 len, offset, vol_id, lnum, pnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100733 up_read(&ubi->fm_eba_sem);
Artem Bityutskiy393852e2007-12-06 18:47:30 +0200734 goto write_error;
735 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400736 }
737
738 vol->eba_tbl[lnum] = pnum;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100739 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400740
741 leb_write_unlock(ubi, vol_id, lnum);
742 ubi_free_vid_hdr(ubi, vid_hdr);
743 return 0;
744
745write_error:
746 if (err != -EIO || !ubi->bad_allowed) {
747 ubi_ro_mode(ubi);
748 leb_write_unlock(ubi, vol_id, lnum);
749 ubi_free_vid_hdr(ubi, vid_hdr);
750 return err;
751 }
752
753 /*
754 * Fortunately, this is the first write operation to this physical
755 * eraseblock, so just put it and request a new one. We assume that if
756 * this physical eraseblock went bad, the erase code will handle that.
757 */
Joel Reardond36e59e2012-05-18 15:40:24 +0200758 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400759 if (err || ++tries > UBI_IO_RETRIES) {
760 ubi_ro_mode(ubi);
761 leb_write_unlock(ubi, vol_id, lnum);
762 ubi_free_vid_hdr(ubi, vid_hdr);
763 return err;
764 }
765
Richard Weinbergera7306652012-09-26 17:51:43 +0200766 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300767 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400768 goto retry;
769}
770
771/**
772 * ubi_eba_write_leb_st - write data to static volume.
773 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200774 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400775 * @lnum: logical eraseblock number
776 * @buf: data to write
777 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400778 * @used_ebs: how many logical eraseblocks will this volume contain
779 *
780 * This function writes data to logical eraseblock @lnum of static volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200781 * @vol. The @used_ebs argument should contain total number of logical
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400782 * eraseblock in this static volume.
783 *
784 * When writing to the last logical eraseblock, the @len argument doesn't have
785 * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
786 * to the real data size, although the @buf buffer has to contain the
787 * alignment. In all other cases, @len has to be aligned.
788 *
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200789 * It is prohibited to write more than once to logical eraseblocks of static
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400790 * volumes. This function returns zero in case of success and a negative error
791 * code in case of failure.
792 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200793int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200794 int lnum, const void *buf, int len, int used_ebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400795{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200796 int err, pnum, tries = 0, data_size = len, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400797 struct ubi_vid_hdr *vid_hdr;
798 uint32_t crc;
799
800 if (ubi->ro_mode)
801 return -EROFS;
802
803 if (lnum == used_ebs - 1)
804 /* If this is the last LEB @len may be unaligned */
805 len = ALIGN(data_size, ubi->min_io_size);
806 else
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900807 ubi_assert(!(len & (ubi->min_io_size - 1)));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400808
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300809 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400810 if (!vid_hdr)
811 return -ENOMEM;
812
813 err = leb_write_lock(ubi, vol_id, lnum);
814 if (err) {
815 ubi_free_vid_hdr(ubi, vid_hdr);
816 return err;
817 }
818
Richard Weinbergera7306652012-09-26 17:51:43 +0200819 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300820 vid_hdr->vol_id = cpu_to_be32(vol_id);
821 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400822 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300823 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400824
825 crc = crc32(UBI_CRC32_INIT, buf, data_size);
826 vid_hdr->vol_type = UBI_VID_STATIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300827 vid_hdr->data_size = cpu_to_be32(data_size);
828 vid_hdr->used_ebs = cpu_to_be32(used_ebs);
829 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400830
831retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200832 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400833 if (pnum < 0) {
834 ubi_free_vid_hdr(ubi, vid_hdr);
835 leb_write_unlock(ubi, vol_id, lnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100836 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400837 return pnum;
838 }
839
840 dbg_eba("write VID hdr and %d bytes at LEB %d:%d, PEB %d, used_ebs %d",
841 len, vol_id, lnum, pnum, used_ebs);
842
843 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
844 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300845 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400846 vol_id, lnum, pnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100847 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400848 goto write_error;
849 }
850
851 err = ubi_io_write_data(ubi, buf, pnum, 0, len);
852 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300853 ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400854 len, pnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100855 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400856 goto write_error;
857 }
858
859 ubi_assert(vol->eba_tbl[lnum] < 0);
860 vol->eba_tbl[lnum] = pnum;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100861 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400862
863 leb_write_unlock(ubi, vol_id, lnum);
864 ubi_free_vid_hdr(ubi, vid_hdr);
865 return 0;
866
867write_error:
868 if (err != -EIO || !ubi->bad_allowed) {
869 /*
870 * This flash device does not admit of bad eraseblocks or
871 * something nasty and unexpected happened. Switch to read-only
872 * mode just in case.
873 */
874 ubi_ro_mode(ubi);
875 leb_write_unlock(ubi, vol_id, lnum);
876 ubi_free_vid_hdr(ubi, vid_hdr);
877 return err;
878 }
879
Joel Reardond36e59e2012-05-18 15:40:24 +0200880 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400881 if (err || ++tries > UBI_IO_RETRIES) {
882 ubi_ro_mode(ubi);
883 leb_write_unlock(ubi, vol_id, lnum);
884 ubi_free_vid_hdr(ubi, vid_hdr);
885 return err;
886 }
887
Richard Weinbergera7306652012-09-26 17:51:43 +0200888 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300889 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400890 goto retry;
891}
892
893/*
894 * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
895 * @ubi: UBI device description object
Artem Bityutskiyc63a4912007-12-17 13:21:07 +0200896 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400897 * @lnum: logical eraseblock number
898 * @buf: data to write
899 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400900 *
901 * This function changes the contents of a logical eraseblock atomically. @buf
902 * has to contain new logical eraseblock data, and @len - the length of the
903 * data, which has to be aligned. This function guarantees that in case of an
904 * unclean reboot the old contents is preserved. Returns zero in case of
905 * success and a negative error code in case of failure.
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300906 *
907 * UBI reserves one LEB for the "atomic LEB change" operation, so only one
908 * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400909 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200910int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200911 int lnum, const void *buf, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400912{
Richard Weinberger36a87e42014-10-07 16:31:22 +0200913 int err, pnum, old_pnum, tries = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400914 struct ubi_vid_hdr *vid_hdr;
915 uint32_t crc;
916
917 if (ubi->ro_mode)
918 return -EROFS;
919
Artem Bityutskiy60c03152008-01-24 17:56:14 +0200920 if (len == 0) {
921 /*
922 * Special case when data length is zero. In this case the LEB
923 * has to be unmapped and mapped somewhere else.
924 */
925 err = ubi_eba_unmap_leb(ubi, vol, lnum);
926 if (err)
927 return err;
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200928 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
Artem Bityutskiy60c03152008-01-24 17:56:14 +0200929 }
930
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300931 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400932 if (!vid_hdr)
933 return -ENOMEM;
934
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300935 mutex_lock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400936 err = leb_write_lock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300937 if (err)
938 goto out_mutex;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400939
Richard Weinbergera7306652012-09-26 17:51:43 +0200940 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300941 vid_hdr->vol_id = cpu_to_be32(vol_id);
942 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400943 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300944 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400945
946 crc = crc32(UBI_CRC32_INIT, buf, len);
Artem Bityutskiy84a92582007-07-04 16:16:51 +0300947 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300948 vid_hdr->data_size = cpu_to_be32(len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400949 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300950 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400951
952retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200953 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400954 if (pnum < 0) {
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300955 err = pnum;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100956 up_read(&ubi->fm_eba_sem);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300957 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400958 }
959
960 dbg_eba("change LEB %d:%d, PEB %d, write VID hdr to PEB %d",
961 vol_id, lnum, vol->eba_tbl[lnum], pnum);
962
963 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
964 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300965 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400966 vol_id, lnum, pnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100967 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400968 goto write_error;
969 }
970
971 err = ubi_io_write_data(ubi, buf, pnum, 0, len);
972 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300973 ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400974 len, pnum);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100975 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400976 goto write_error;
977 }
978
Richard Weinberger36a87e42014-10-07 16:31:22 +0200979 old_pnum = vol->eba_tbl[lnum];
980 vol->eba_tbl[lnum] = pnum;
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100981 up_read(&ubi->fm_eba_sem);
Richard Weinberger36a87e42014-10-07 16:31:22 +0200982
983 if (old_pnum >= 0) {
984 err = ubi_wl_put_peb(ubi, vol_id, lnum, old_pnum, 0);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300985 if (err)
986 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400987 }
988
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300989out_leb_unlock:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400990 leb_write_unlock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300991out_mutex:
992 mutex_unlock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400993 ubi_free_vid_hdr(ubi, vid_hdr);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300994 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400995
996write_error:
997 if (err != -EIO || !ubi->bad_allowed) {
998 /*
999 * This flash device does not admit of bad eraseblocks or
1000 * something nasty and unexpected happened. Switch to read-only
1001 * mode just in case.
1002 */
1003 ubi_ro_mode(ubi);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001004 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001005 }
1006
Joel Reardond36e59e2012-05-18 15:40:24 +02001007 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001008 if (err || ++tries > UBI_IO_RETRIES) {
1009 ubi_ro_mode(ubi);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001010 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001011 }
1012
Richard Weinbergera7306652012-09-26 17:51:43 +02001013 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +03001014 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001015 goto retry;
1016}
1017
1018/**
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001019 * is_error_sane - check whether a read error is sane.
1020 * @err: code of the error happened during reading
1021 *
1022 * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1023 * cannot read data from the target PEB (an error @err happened). If the error
1024 * code is sane, then we treat this error as non-fatal. Otherwise the error is
1025 * fatal and UBI will be switched to R/O mode later.
1026 *
1027 * The idea is that we try not to switch to R/O mode if the read error is
1028 * something which suggests there was a real read problem. E.g., %-EIO. Or a
1029 * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1030 * mode, simply because we do not know what happened at the MTD level, and we
1031 * cannot handle this. E.g., the underlying driver may have become crazy, and
1032 * it is safer to switch to R/O mode to preserve the data.
1033 *
1034 * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1035 * which we have just written.
1036 */
1037static int is_error_sane(int err)
1038{
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001039 if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
Artem Bityutskiy756e1df2010-09-03 01:30:16 +03001040 err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001041 return 0;
1042 return 1;
1043}
1044
1045/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001046 * ubi_eba_copy_leb - copy logical eraseblock.
1047 * @ubi: UBI device description object
1048 * @from: physical eraseblock number from where to copy
1049 * @to: physical eraseblock number where to copy
1050 * @vid_hdr: VID header of the @from physical eraseblock
1051 *
1052 * This function copies logical eraseblock from physical eraseblock @from to
1053 * physical eraseblock @to. The @vid_hdr buffer may be changed by this
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001054 * function. Returns:
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001055 * o %0 in case of success;
Artem Bityutskiycc831462012-03-09 10:31:18 +02001056 * o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001057 * o a negative error code in case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001058 */
1059int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1060 struct ubi_vid_hdr *vid_hdr)
1061{
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001062 int err, vol_id, lnum, data_size, aldata_size, idx;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001063 struct ubi_volume *vol;
1064 uint32_t crc;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001065
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001066 vol_id = be32_to_cpu(vid_hdr->vol_id);
1067 lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001068
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001069 dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001070
1071 if (vid_hdr->vol_type == UBI_VID_STATIC) {
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001072 data_size = be32_to_cpu(vid_hdr->data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 aldata_size = ALIGN(data_size, ubi->min_io_size);
1074 } else
1075 data_size = aldata_size =
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001076 ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001077
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001078 idx = vol_id2idx(ubi, vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001079 spin_lock(&ubi->volumes_lock);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001080 /*
1081 * Note, we may race with volume deletion, which means that the volume
1082 * this logical eraseblock belongs to might be being deleted. Since the
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001083 * volume deletion un-maps all the volume's logical eraseblocks, it will
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001084 * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1085 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001086 vol = ubi->volumes[idx];
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001087 spin_unlock(&ubi->volumes_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001088 if (!vol) {
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001089 /* No need to do further work, cancel */
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001090 dbg_wl("volume %d is being removed, cancel", vol_id);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001091 return MOVE_CANCEL_RACE;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001092 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001093
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001094 /*
1095 * We do not want anybody to write to this logical eraseblock while we
1096 * are moving it, so lock it.
1097 *
1098 * Note, we are using non-waiting locking here, because we cannot sleep
1099 * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1100 * unmapping the LEB which is mapped to the PEB we are going to move
1101 * (@from). This task locks the LEB and goes sleep in the
1102 * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1103 * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001104 * LEB is already locked, we just do not move it and return
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301105 * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1106 * we do not know the reasons of the contention - it may be just a
1107 * normal I/O on this LEB, so we want to re-try.
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001108 */
1109 err = leb_write_trylock(ubi, vol_id, lnum);
1110 if (err) {
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001111 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301112 return MOVE_RETRY;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001113 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001114
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001115 /*
1116 * The LEB might have been put meanwhile, and the task which put it is
1117 * probably waiting on @ubi->move_mutex. No need to continue the work,
1118 * cancel it.
1119 */
1120 if (vol->eba_tbl[lnum] != from) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001121 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1122 vol_id, lnum, from, vol->eba_tbl[lnum]);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001123 err = MOVE_CANCEL_RACE;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001124 goto out_unlock_leb;
1125 }
1126
1127 /*
Zoltan Sogorb77bcb02008-10-29 09:50:02 +01001128 * OK, now the LEB is locked and we can safely start moving it. Since
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001129 * this function utilizes the @ubi->peb_buf buffer which is shared
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001130 * with some other functions - we lock the buffer by taking the
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001131 * @ubi->buf_mutex.
1132 */
1133 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001134 dbg_wl("read %d bytes of data", aldata_size);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001135 err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001136 if (err && err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001137 ubi_warn(ubi, "error %d while reading data from PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001138 err, from);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001139 err = MOVE_SOURCE_RD_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001140 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001141 }
1142
1143 /*
Anand Gadiyarfd589a82009-07-16 17:13:03 +02001144 * Now we have got to calculate how much data we have to copy. In
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001145 * case of a static volume it is fairly easy - the VID header contains
1146 * the data size. In case of a dynamic volume it is more difficult - we
1147 * have to read the contents, cut 0xFF bytes from the end and copy only
1148 * the first part. We must do this to avoid writing 0xFF bytes as it
1149 * may have some side-effects. And not only this. It is important not
1150 * to include those 0xFFs to CRC because later the they may be filled
1151 * by data.
1152 */
1153 if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1154 aldata_size = data_size =
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001155 ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001156
1157 cond_resched();
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001158 crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001159 cond_resched();
1160
1161 /*
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001162 * It may turn out to be that the whole @from physical eraseblock
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001163 * contains only 0xFF bytes. Then we have to only write the VID header
1164 * and do not write any data. This also means we should not set
1165 * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1166 */
1167 if (data_size > 0) {
1168 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001169 vid_hdr->data_size = cpu_to_be32(data_size);
1170 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001171 }
Richard Weinbergera7306652012-09-26 17:51:43 +02001172 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001173
1174 err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001175 if (err) {
1176 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001177 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001178 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001179 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001180
1181 cond_resched();
1182
1183 /* Read the VID header back and check if it was written correctly */
1184 err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1185 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001186 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001187 ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001188 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001189 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001190 err = MOVE_TARGET_RD_ERR;
1191 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001192 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001193 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001194 }
1195
1196 if (data_size > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001197 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001198 if (err) {
1199 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001200 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001201 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001202 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001203
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001204 cond_resched();
1205
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001206 /*
1207 * We've written the data and are going to read it back to make
1208 * sure it was written correctly.
1209 */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001210 memset(ubi->peb_buf, 0xFF, aldata_size);
1211 err = ubi_io_read_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001212 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001213 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001214 ubi_warn(ubi, "error %d while reading data back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001215 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001216 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001217 err = MOVE_TARGET_RD_ERR;
1218 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001219 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001220 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001221 }
1222
1223 cond_resched();
1224
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001225 if (crc != crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size)) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001226 ubi_warn(ubi, "read data back from PEB %d and it is different",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001227 to);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001228 err = -EINVAL;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001229 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001230 }
1231 }
1232
1233 ubi_assert(vol->eba_tbl[lnum] == from);
Richard Weinberger111ab0b2014-11-10 16:28:08 +01001234 down_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001235 vol->eba_tbl[lnum] = to;
Richard Weinberger111ab0b2014-11-10 16:28:08 +01001236 up_read(&ubi->fm_eba_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001237
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001238out_unlock_buf:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001239 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001240out_unlock_leb:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001241 leb_write_unlock(ubi, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001242 return err;
1243}
1244
1245/**
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001246 * print_rsvd_warning - warn about not having enough reserved PEBs.
1247 * @ubi: UBI device description object
1248 *
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001249 * This is a helper function for 'ubi_eba_init()' which is called when UBI
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001250 * cannot reserve enough PEBs for bad block handling. This function makes a
1251 * decision whether we have to print a warning or not. The algorithm is as
1252 * follows:
1253 * o if this is a new UBI image, then just print the warning
1254 * o if this is an UBI image which has already been used for some time, print
1255 * a warning only if we can reserve less than 10% of the expected amount of
1256 * the reserved PEB.
1257 *
1258 * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1259 * of PEBs becomes smaller, which is normal and we do not want to scare users
1260 * with a warning every time they attach the MTD device. This was an issue
1261 * reported by real users.
1262 */
1263static void print_rsvd_warning(struct ubi_device *ubi,
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001264 struct ubi_attach_info *ai)
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001265{
1266 /*
1267 * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1268 * large number to distinguish between newly flashed and used images.
1269 */
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001270 if (ai->max_sqnum > (1 << 18)) {
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001271 int min = ubi->beb_rsvd_level / 10;
1272
1273 if (!min)
1274 min = 1;
1275 if (ubi->beb_rsvd_pebs > min)
1276 return;
1277 }
1278
Tanya Brokhman326087032014-10-20 19:57:00 +03001279 ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001280 ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001281 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001282 ubi_warn(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001283 ubi->corr_peb_count);
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001284}
1285
1286/**
Richard Weinberger00abf302012-09-26 17:51:44 +02001287 * self_check_eba - run a self check on the EBA table constructed by fastmap.
1288 * @ubi: UBI device description object
1289 * @ai_fastmap: UBI attach info object created by fastmap
1290 * @ai_scan: UBI attach info object created by scanning
1291 *
1292 * Returns < 0 in case of an internal error, 0 otherwise.
1293 * If a bad EBA table entry was found it will be printed out and
1294 * ubi_assert() triggers.
1295 */
1296int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1297 struct ubi_attach_info *ai_scan)
1298{
1299 int i, j, num_volumes, ret = 0;
1300 int **scan_eba, **fm_eba;
1301 struct ubi_ainf_volume *av;
1302 struct ubi_volume *vol;
1303 struct ubi_ainf_peb *aeb;
1304 struct rb_node *rb;
1305
1306 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1307
1308 scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1309 if (!scan_eba)
1310 return -ENOMEM;
1311
1312 fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1313 if (!fm_eba) {
1314 kfree(scan_eba);
1315 return -ENOMEM;
1316 }
1317
1318 for (i = 0; i < num_volumes; i++) {
1319 vol = ubi->volumes[i];
1320 if (!vol)
1321 continue;
1322
1323 scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1324 GFP_KERNEL);
1325 if (!scan_eba[i]) {
1326 ret = -ENOMEM;
1327 goto out_free;
1328 }
1329
1330 fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1331 GFP_KERNEL);
1332 if (!fm_eba[i]) {
1333 ret = -ENOMEM;
1334 goto out_free;
1335 }
1336
1337 for (j = 0; j < vol->reserved_pebs; j++)
1338 scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1339
1340 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1341 if (!av)
1342 continue;
1343
1344 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1345 scan_eba[i][aeb->lnum] = aeb->pnum;
1346
1347 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1348 if (!av)
1349 continue;
1350
1351 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1352 fm_eba[i][aeb->lnum] = aeb->pnum;
1353
1354 for (j = 0; j < vol->reserved_pebs; j++) {
1355 if (scan_eba[i][j] != fm_eba[i][j]) {
1356 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1357 fm_eba[i][j] == UBI_LEB_UNMAPPED)
1358 continue;
1359
Tanya Brokhman326087032014-10-20 19:57:00 +03001360 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
Richard Weinberger53474172015-07-03 10:36:16 +02001361 vol->vol_id, j, fm_eba[i][j],
Richard Weinberger00abf302012-09-26 17:51:44 +02001362 scan_eba[i][j]);
1363 ubi_assert(0);
1364 }
1365 }
1366 }
1367
1368out_free:
1369 for (i = 0; i < num_volumes; i++) {
1370 if (!ubi->volumes[i])
1371 continue;
1372
1373 kfree(scan_eba[i]);
1374 kfree(fm_eba[i]);
1375 }
1376
1377 kfree(scan_eba);
1378 kfree(fm_eba);
1379 return ret;
1380}
1381
1382/**
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001383 * ubi_eba_init - initialize the EBA sub-system using attaching information.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001384 * @ubi: UBI device description object
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001385 * @ai: attaching information
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001386 *
1387 * This function returns zero in case of success and a negative error code in
1388 * case of failure.
1389 */
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001390int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001391{
1392 int i, j, err, num_volumes;
Artem Bityutskiy517af482012-05-17 14:38:34 +03001393 struct ubi_ainf_volume *av;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001394 struct ubi_volume *vol;
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001395 struct ubi_ainf_peb *aeb;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001396 struct rb_node *rb;
1397
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001398 dbg_eba("initialize EBA sub-system");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001399
1400 spin_lock_init(&ubi->ltree_lock);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001401 mutex_init(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001402 ubi->ltree = RB_ROOT;
1403
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001404 ubi->global_sqnum = ai->max_sqnum + 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001405 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1406
1407 for (i = 0; i < num_volumes; i++) {
1408 vol = ubi->volumes[i];
1409 if (!vol)
1410 continue;
1411
1412 cond_resched();
1413
1414 vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1415 GFP_KERNEL);
1416 if (!vol->eba_tbl) {
1417 err = -ENOMEM;
1418 goto out_free;
1419 }
1420
1421 for (j = 0; j < vol->reserved_pebs; j++)
1422 vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1423
Artem Bityutskiydcd85fd2012-05-17 15:33:20 +03001424 av = ubi_find_av(ai, idx2vol_id(ubi, i));
Artem Bityutskiy517af482012-05-17 14:38:34 +03001425 if (!av)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001426 continue;
1427
Artem Bityutskiy517af482012-05-17 14:38:34 +03001428 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001429 if (aeb->lnum >= vol->reserved_pebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001430 /*
1431 * This may happen in case of an unclean reboot
1432 * during re-size.
1433 */
Artem Bityutskiy0bae2882012-05-17 15:53:10 +03001434 ubi_move_aeb_to_list(av, aeb, &ai->erase);
Brian Norrisd74adbd2015-02-28 02:23:26 -08001435 else
1436 vol->eba_tbl[aeb->lnum] = aeb->pnum;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001437 }
1438 }
1439
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001440 if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001441 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001442 ubi->avail_pebs, EBA_RESERVED_PEBS);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001443 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001444 ubi_err(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001445 ubi->corr_peb_count);
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001446 err = -ENOSPC;
1447 goto out_free;
1448 }
1449 ubi->avail_pebs -= EBA_RESERVED_PEBS;
1450 ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1451
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001452 if (ubi->bad_allowed) {
1453 ubi_calculate_reserved(ubi);
1454
1455 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1456 /* No enough free physical eraseblocks */
1457 ubi->beb_rsvd_pebs = ubi->avail_pebs;
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001458 print_rsvd_warning(ubi, ai);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001459 } else
1460 ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1461
1462 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1463 ubi->rsvd_pebs += ubi->beb_rsvd_pebs;
1464 }
1465
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001466 dbg_eba("EBA sub-system is initialized");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001467 return 0;
1468
1469out_free:
1470 for (i = 0; i < num_volumes; i++) {
1471 if (!ubi->volumes[i])
1472 continue;
1473 kfree(ubi->volumes[i]->eba_tbl);
Adrian Hunter7194e6f2009-07-24 17:05:00 +03001474 ubi->volumes[i]->eba_tbl = NULL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001475 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001476 return err;
1477}