blob: f1db73da79756c378b88ff9d52b5c2f924a7aa50 [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 Weinberger8974b152012-09-26 17:51:46 +0200343 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400344 vol->eba_tbl[lnum] = UBI_LEB_UNMAPPED;
Richard Weinberger8974b152012-09-26 17:51:46 +0200345 up_read(&ubi->fm_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;
428 } else
429 ubi_ro_mode(ubi);
430 }
431 goto out_free;
432 } else if (err == UBI_IO_BITFLIPS)
433 scrub = 1;
434
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300435 ubi_assert(lnum < be32_to_cpu(vid_hdr->used_ebs));
436 ubi_assert(len == be32_to_cpu(vid_hdr->data_size));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400437
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300438 crc = be32_to_cpu(vid_hdr->data_crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400439 ubi_free_vid_hdr(ubi, vid_hdr);
440 }
441
442 err = ubi_io_read_data(ubi, buf, pnum, offset, len);
443 if (err) {
Richard Weinberger170505f2014-09-22 10:45:34 +0200444 if (err == UBI_IO_BITFLIPS)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400445 scrub = 1;
Richard Weinberger170505f2014-09-22 10:45:34 +0200446 else if (mtd_is_eccerr(err)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400447 if (vol->vol_type == UBI_DYNAMIC_VOLUME)
448 goto out_unlock;
449 scrub = 1;
450 if (!check) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300451 ubi_msg(ubi, "force data checking");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400452 check = 1;
453 goto retry;
454 }
455 } else
456 goto out_unlock;
457 }
458
459 if (check) {
Jeff Garzik2ab934b2007-07-17 01:49:56 -0400460 uint32_t crc1 = crc32(UBI_CRC32_INIT, buf, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400461 if (crc1 != crc) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300462 ubi_warn(ubi, "CRC error: calculated %#08x, must be %#08x",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400463 crc1, crc);
464 err = -EBADMSG;
465 goto out_unlock;
466 }
467 }
468
469 if (scrub)
470 err = ubi_wl_scrub_peb(ubi, pnum);
471
472 leb_read_unlock(ubi, vol_id, lnum);
473 return err;
474
475out_free:
476 ubi_free_vid_hdr(ubi, vid_hdr);
477out_unlock:
478 leb_read_unlock(ubi, vol_id, lnum);
479 return err;
480}
481
482/**
Richard Weinberger9ff08972015-01-10 22:52:13 +0100483 * ubi_eba_read_leb_sg - read data into a scatter gather list.
484 * @ubi: UBI device description object
485 * @vol: volume description object
486 * @lnum: logical eraseblock number
487 * @sgl: UBI scatter gather list to store the read data
488 * @offset: offset from where to read
489 * @len: how many bytes to read
490 * @check: data CRC check flag
491 *
492 * This function works exactly like ubi_eba_read_leb(). But instead of
493 * storing the read data into a buffer it writes to an UBI scatter gather
494 * list.
495 */
496int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
497 struct ubi_sgl *sgl, int lnum, int offset, int len,
498 int check)
499{
500 int to_read;
501 int ret;
502 struct scatterlist *sg;
503
504 for (;;) {
505 ubi_assert(sgl->list_pos < UBI_MAX_SG_COUNT);
506 sg = &sgl->sg[sgl->list_pos];
507 if (len < sg->length - sgl->page_pos)
508 to_read = len;
509 else
510 to_read = sg->length - sgl->page_pos;
511
512 ret = ubi_eba_read_leb(ubi, vol, lnum,
513 sg_virt(sg) + sgl->page_pos, offset,
514 to_read, check);
515 if (ret < 0)
516 return ret;
517
518 offset += to_read;
519 len -= to_read;
520 if (!len) {
521 sgl->page_pos += to_read;
522 if (sgl->page_pos == sg->length) {
523 sgl->list_pos++;
524 sgl->page_pos = 0;
525 }
526
527 break;
528 }
529
530 sgl->list_pos++;
531 sgl->page_pos = 0;
532 }
533
534 return ret;
535}
536
537/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400538 * recover_peb - recover from write failure.
539 * @ubi: UBI device description object
540 * @pnum: the physical eraseblock to recover
541 * @vol_id: volume ID
542 * @lnum: logical eraseblock number
543 * @buf: data which was not written because of the write failure
544 * @offset: offset of the failed write
545 * @len: how many bytes should have been written
546 *
547 * This function is called in case of a write failure and moves all good data
548 * from the potentially bad physical eraseblock to a good physical eraseblock.
549 * This function also writes the data which was not written due to the failure.
550 * Returns new physical eraseblock number in case of success, and a negative
551 * error code in case of failure.
552 */
553static int recover_peb(struct ubi_device *ubi, int pnum, int vol_id, int lnum,
554 const void *buf, int offset, int len)
555{
556 int err, idx = vol_id2idx(ubi, vol_id), new_pnum, data_size, tries = 0;
557 struct ubi_volume *vol = ubi->volumes[idx];
558 struct ubi_vid_hdr *vid_hdr;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400559
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300560 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300561 if (!vid_hdr)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400562 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400563
564retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200565 new_pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400566 if (new_pnum < 0) {
567 ubi_free_vid_hdr(ubi, vid_hdr);
568 return new_pnum;
569 }
570
Tanya Brokhman326087032014-10-20 19:57:00 +0300571 ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
572 pnum, new_pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400573
574 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
575 if (err && err != UBI_IO_BITFLIPS) {
576 if (err > 0)
577 err = -EIO;
578 goto out_put;
579 }
580
Richard Weinbergera7306652012-09-26 17:51:43 +0200581 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400582 err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
583 if (err)
584 goto write_error;
585
586 data_size = offset + len;
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200587 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200588 memset(ubi->peb_buf + offset, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400589
590 /* Read everything before the area where the write failure happened */
591 if (offset > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200592 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300593 if (err && err != UBI_IO_BITFLIPS)
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200594 goto out_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400595 }
596
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200597 memcpy(ubi->peb_buf + offset, buf, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400598
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200599 err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200600 if (err) {
601 mutex_unlock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400602 goto write_error;
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200603 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400604
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300605 mutex_unlock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400606 ubi_free_vid_hdr(ubi, vid_hdr);
607
Richard Weinberger8974b152012-09-26 17:51:46 +0200608 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400609 vol->eba_tbl[lnum] = new_pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200610 up_read(&ubi->fm_sem);
Joel Reardond36e59e2012-05-18 15:40:24 +0200611 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400612
Tanya Brokhman326087032014-10-20 19:57:00 +0300613 ubi_msg(ubi, "data was successfully recovered");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400614 return 0;
615
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200616out_unlock:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300617 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200618out_put:
Joel Reardond36e59e2012-05-18 15:40:24 +0200619 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400620 ubi_free_vid_hdr(ubi, vid_hdr);
621 return err;
622
623write_error:
624 /*
625 * Bad luck? This physical eraseblock is bad too? Crud. Let's try to
626 * get another one.
627 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300628 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
Joel Reardond36e59e2012-05-18 15:40:24 +0200629 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400630 if (++tries > UBI_IO_RETRIES) {
631 ubi_free_vid_hdr(ubi, vid_hdr);
632 return err;
633 }
Tanya Brokhman326087032014-10-20 19:57:00 +0300634 ubi_msg(ubi, "try again");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400635 goto retry;
636}
637
638/**
639 * ubi_eba_write_leb - write data to dynamic volume.
640 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200641 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400642 * @lnum: logical eraseblock number
643 * @buf: the data to write
644 * @offset: offset within the logical eraseblock where to write
645 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400646 *
647 * This function writes data to logical eraseblock @lnum of a dynamic volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200648 * @vol. Returns zero in case of success and a negative error code in case
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400649 * of failure. In case of error, it is possible that something was still
650 * written to the flash media, but may be some garbage.
651 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200652int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200653 const void *buf, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400654{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200655 int err, pnum, tries = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400656 struct ubi_vid_hdr *vid_hdr;
657
658 if (ubi->ro_mode)
659 return -EROFS;
660
661 err = leb_write_lock(ubi, vol_id, lnum);
662 if (err)
663 return err;
664
665 pnum = vol->eba_tbl[lnum];
666 if (pnum >= 0) {
667 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
668 len, offset, vol_id, lnum, pnum);
669
670 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
671 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300672 ubi_warn(ubi, "failed to write data to PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400673 if (err == -EIO && ubi->bad_allowed)
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200674 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
675 offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400676 if (err)
677 ubi_ro_mode(ubi);
678 }
679 leb_write_unlock(ubi, vol_id, lnum);
680 return err;
681 }
682
683 /*
684 * The logical eraseblock is not mapped. We have to get a free physical
685 * eraseblock and write the volume identifier header there first.
686 */
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300687 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400688 if (!vid_hdr) {
689 leb_write_unlock(ubi, vol_id, lnum);
690 return -ENOMEM;
691 }
692
693 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Richard Weinbergera7306652012-09-26 17:51:43 +0200694 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300695 vid_hdr->vol_id = cpu_to_be32(vol_id);
696 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400697 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300698 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400699
700retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200701 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400702 if (pnum < 0) {
703 ubi_free_vid_hdr(ubi, vid_hdr);
704 leb_write_unlock(ubi, vol_id, lnum);
705 return pnum;
706 }
707
708 dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
709 len, offset, vol_id, lnum, pnum);
710
711 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
712 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300713 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400714 vol_id, lnum, pnum);
715 goto write_error;
716 }
717
Artem Bityutskiy393852e2007-12-06 18:47:30 +0200718 if (len) {
719 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
720 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300721 ubi_warn(ubi, "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300722 len, offset, vol_id, lnum, pnum);
Artem Bityutskiy393852e2007-12-06 18:47:30 +0200723 goto write_error;
724 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400725 }
726
Richard Weinberger8974b152012-09-26 17:51:46 +0200727 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400728 vol->eba_tbl[lnum] = pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200729 up_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400730
731 leb_write_unlock(ubi, vol_id, lnum);
732 ubi_free_vid_hdr(ubi, vid_hdr);
733 return 0;
734
735write_error:
736 if (err != -EIO || !ubi->bad_allowed) {
737 ubi_ro_mode(ubi);
738 leb_write_unlock(ubi, vol_id, lnum);
739 ubi_free_vid_hdr(ubi, vid_hdr);
740 return err;
741 }
742
743 /*
744 * Fortunately, this is the first write operation to this physical
745 * eraseblock, so just put it and request a new one. We assume that if
746 * this physical eraseblock went bad, the erase code will handle that.
747 */
Joel Reardond36e59e2012-05-18 15:40:24 +0200748 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400749 if (err || ++tries > UBI_IO_RETRIES) {
750 ubi_ro_mode(ubi);
751 leb_write_unlock(ubi, vol_id, lnum);
752 ubi_free_vid_hdr(ubi, vid_hdr);
753 return err;
754 }
755
Richard Weinbergera7306652012-09-26 17:51:43 +0200756 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300757 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400758 goto retry;
759}
760
761/**
762 * ubi_eba_write_leb_st - write data to static volume.
763 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200764 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400765 * @lnum: logical eraseblock number
766 * @buf: data to write
767 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400768 * @used_ebs: how many logical eraseblocks will this volume contain
769 *
770 * This function writes data to logical eraseblock @lnum of static volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200771 * @vol. The @used_ebs argument should contain total number of logical
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400772 * eraseblock in this static volume.
773 *
774 * When writing to the last logical eraseblock, the @len argument doesn't have
775 * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
776 * to the real data size, although the @buf buffer has to contain the
777 * alignment. In all other cases, @len has to be aligned.
778 *
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200779 * It is prohibited to write more than once to logical eraseblocks of static
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400780 * volumes. This function returns zero in case of success and a negative error
781 * code in case of failure.
782 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200783int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200784 int lnum, const void *buf, int len, int used_ebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400785{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200786 int err, pnum, tries = 0, data_size = len, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400787 struct ubi_vid_hdr *vid_hdr;
788 uint32_t crc;
789
790 if (ubi->ro_mode)
791 return -EROFS;
792
793 if (lnum == used_ebs - 1)
794 /* If this is the last LEB @len may be unaligned */
795 len = ALIGN(data_size, ubi->min_io_size);
796 else
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900797 ubi_assert(!(len & (ubi->min_io_size - 1)));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400798
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300799 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400800 if (!vid_hdr)
801 return -ENOMEM;
802
803 err = leb_write_lock(ubi, vol_id, lnum);
804 if (err) {
805 ubi_free_vid_hdr(ubi, vid_hdr);
806 return err;
807 }
808
Richard Weinbergera7306652012-09-26 17:51:43 +0200809 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300810 vid_hdr->vol_id = cpu_to_be32(vol_id);
811 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400812 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300813 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400814
815 crc = crc32(UBI_CRC32_INIT, buf, data_size);
816 vid_hdr->vol_type = UBI_VID_STATIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300817 vid_hdr->data_size = cpu_to_be32(data_size);
818 vid_hdr->used_ebs = cpu_to_be32(used_ebs);
819 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400820
821retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200822 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400823 if (pnum < 0) {
824 ubi_free_vid_hdr(ubi, vid_hdr);
825 leb_write_unlock(ubi, vol_id, lnum);
826 return pnum;
827 }
828
829 dbg_eba("write VID hdr and %d bytes at LEB %d:%d, PEB %d, used_ebs %d",
830 len, vol_id, lnum, pnum, used_ebs);
831
832 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
833 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300834 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400835 vol_id, lnum, pnum);
836 goto write_error;
837 }
838
839 err = ubi_io_write_data(ubi, buf, pnum, 0, len);
840 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300841 ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400842 len, pnum);
843 goto write_error;
844 }
845
846 ubi_assert(vol->eba_tbl[lnum] < 0);
Richard Weinberger8974b152012-09-26 17:51:46 +0200847 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400848 vol->eba_tbl[lnum] = pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200849 up_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400850
851 leb_write_unlock(ubi, vol_id, lnum);
852 ubi_free_vid_hdr(ubi, vid_hdr);
853 return 0;
854
855write_error:
856 if (err != -EIO || !ubi->bad_allowed) {
857 /*
858 * This flash device does not admit of bad eraseblocks or
859 * something nasty and unexpected happened. Switch to read-only
860 * mode just in case.
861 */
862 ubi_ro_mode(ubi);
863 leb_write_unlock(ubi, vol_id, lnum);
864 ubi_free_vid_hdr(ubi, vid_hdr);
865 return err;
866 }
867
Joel Reardond36e59e2012-05-18 15:40:24 +0200868 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400869 if (err || ++tries > UBI_IO_RETRIES) {
870 ubi_ro_mode(ubi);
871 leb_write_unlock(ubi, vol_id, lnum);
872 ubi_free_vid_hdr(ubi, vid_hdr);
873 return err;
874 }
875
Richard Weinbergera7306652012-09-26 17:51:43 +0200876 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300877 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400878 goto retry;
879}
880
881/*
882 * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
883 * @ubi: UBI device description object
Artem Bityutskiyc63a4912007-12-17 13:21:07 +0200884 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400885 * @lnum: logical eraseblock number
886 * @buf: data to write
887 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400888 *
889 * This function changes the contents of a logical eraseblock atomically. @buf
890 * has to contain new logical eraseblock data, and @len - the length of the
891 * data, which has to be aligned. This function guarantees that in case of an
892 * unclean reboot the old contents is preserved. Returns zero in case of
893 * success and a negative error code in case of failure.
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300894 *
895 * UBI reserves one LEB for the "atomic LEB change" operation, so only one
896 * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400897 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200898int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200899 int lnum, const void *buf, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400900{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200901 int err, pnum, tries = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400902 struct ubi_vid_hdr *vid_hdr;
903 uint32_t crc;
904
905 if (ubi->ro_mode)
906 return -EROFS;
907
Artem Bityutskiy60c03152008-01-24 17:56:14 +0200908 if (len == 0) {
909 /*
910 * Special case when data length is zero. In this case the LEB
911 * has to be unmapped and mapped somewhere else.
912 */
913 err = ubi_eba_unmap_leb(ubi, vol, lnum);
914 if (err)
915 return err;
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200916 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
Artem Bityutskiy60c03152008-01-24 17:56:14 +0200917 }
918
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300919 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400920 if (!vid_hdr)
921 return -ENOMEM;
922
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300923 mutex_lock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400924 err = leb_write_lock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300925 if (err)
926 goto out_mutex;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400927
Richard Weinbergera7306652012-09-26 17:51:43 +0200928 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300929 vid_hdr->vol_id = cpu_to_be32(vol_id);
930 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400931 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300932 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400933
934 crc = crc32(UBI_CRC32_INIT, buf, len);
Artem Bityutskiy84a92582007-07-04 16:16:51 +0300935 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300936 vid_hdr->data_size = cpu_to_be32(len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400937 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300938 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400939
940retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200941 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400942 if (pnum < 0) {
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300943 err = pnum;
944 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400945 }
946
947 dbg_eba("change LEB %d:%d, PEB %d, write VID hdr to PEB %d",
948 vol_id, lnum, vol->eba_tbl[lnum], pnum);
949
950 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
951 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300952 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400953 vol_id, lnum, pnum);
954 goto write_error;
955 }
956
957 err = ubi_io_write_data(ubi, buf, pnum, 0, len);
958 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300959 ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400960 len, pnum);
961 goto write_error;
962 }
963
Artem Bityutskiya443db42007-05-21 20:26:05 +0300964 if (vol->eba_tbl[lnum] >= 0) {
Joel Reardond36e59e2012-05-18 15:40:24 +0200965 err = ubi_wl_put_peb(ubi, vol_id, lnum, vol->eba_tbl[lnum], 0);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300966 if (err)
967 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400968 }
969
Richard Weinberger8974b152012-09-26 17:51:46 +0200970 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400971 vol->eba_tbl[lnum] = pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200972 up_read(&ubi->fm_sem);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300973
974out_leb_unlock:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400975 leb_write_unlock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300976out_mutex:
977 mutex_unlock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400978 ubi_free_vid_hdr(ubi, vid_hdr);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300979 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400980
981write_error:
982 if (err != -EIO || !ubi->bad_allowed) {
983 /*
984 * This flash device does not admit of bad eraseblocks or
985 * something nasty and unexpected happened. Switch to read-only
986 * mode just in case.
987 */
988 ubi_ro_mode(ubi);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300989 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400990 }
991
Joel Reardond36e59e2012-05-18 15:40:24 +0200992 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400993 if (err || ++tries > UBI_IO_RETRIES) {
994 ubi_ro_mode(ubi);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300995 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400996 }
997
Richard Weinbergera7306652012-09-26 17:51:43 +0200998 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300999 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001000 goto retry;
1001}
1002
1003/**
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001004 * is_error_sane - check whether a read error is sane.
1005 * @err: code of the error happened during reading
1006 *
1007 * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1008 * cannot read data from the target PEB (an error @err happened). If the error
1009 * code is sane, then we treat this error as non-fatal. Otherwise the error is
1010 * fatal and UBI will be switched to R/O mode later.
1011 *
1012 * The idea is that we try not to switch to R/O mode if the read error is
1013 * something which suggests there was a real read problem. E.g., %-EIO. Or a
1014 * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1015 * mode, simply because we do not know what happened at the MTD level, and we
1016 * cannot handle this. E.g., the underlying driver may have become crazy, and
1017 * it is safer to switch to R/O mode to preserve the data.
1018 *
1019 * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1020 * which we have just written.
1021 */
1022static int is_error_sane(int err)
1023{
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001024 if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
Artem Bityutskiy756e1df2010-09-03 01:30:16 +03001025 err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001026 return 0;
1027 return 1;
1028}
1029
1030/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001031 * ubi_eba_copy_leb - copy logical eraseblock.
1032 * @ubi: UBI device description object
1033 * @from: physical eraseblock number from where to copy
1034 * @to: physical eraseblock number where to copy
1035 * @vid_hdr: VID header of the @from physical eraseblock
1036 *
1037 * This function copies logical eraseblock from physical eraseblock @from to
1038 * physical eraseblock @to. The @vid_hdr buffer may be changed by this
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001039 * function. Returns:
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001040 * o %0 in case of success;
Artem Bityutskiycc831462012-03-09 10:31:18 +02001041 * o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001042 * o a negative error code in case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001043 */
1044int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1045 struct ubi_vid_hdr *vid_hdr)
1046{
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001047 int err, vol_id, lnum, data_size, aldata_size, idx;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001048 struct ubi_volume *vol;
1049 uint32_t crc;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001050
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001051 vol_id = be32_to_cpu(vid_hdr->vol_id);
1052 lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001053
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001054 dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001055
1056 if (vid_hdr->vol_type == UBI_VID_STATIC) {
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001057 data_size = be32_to_cpu(vid_hdr->data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001058 aldata_size = ALIGN(data_size, ubi->min_io_size);
1059 } else
1060 data_size = aldata_size =
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001061 ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001062
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001063 idx = vol_id2idx(ubi, vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001064 spin_lock(&ubi->volumes_lock);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001065 /*
1066 * Note, we may race with volume deletion, which means that the volume
1067 * this logical eraseblock belongs to might be being deleted. Since the
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001068 * volume deletion un-maps all the volume's logical eraseblocks, it will
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001069 * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1070 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001071 vol = ubi->volumes[idx];
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001072 spin_unlock(&ubi->volumes_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 if (!vol) {
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001074 /* No need to do further work, cancel */
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001075 dbg_wl("volume %d is being removed, cancel", vol_id);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001076 return MOVE_CANCEL_RACE;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001077 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001078
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001079 /*
1080 * We do not want anybody to write to this logical eraseblock while we
1081 * are moving it, so lock it.
1082 *
1083 * Note, we are using non-waiting locking here, because we cannot sleep
1084 * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1085 * unmapping the LEB which is mapped to the PEB we are going to move
1086 * (@from). This task locks the LEB and goes sleep in the
1087 * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1088 * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001089 * LEB is already locked, we just do not move it and return
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301090 * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1091 * we do not know the reasons of the contention - it may be just a
1092 * normal I/O on this LEB, so we want to re-try.
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001093 */
1094 err = leb_write_trylock(ubi, vol_id, lnum);
1095 if (err) {
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001096 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301097 return MOVE_RETRY;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001098 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001099
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001100 /*
1101 * The LEB might have been put meanwhile, and the task which put it is
1102 * probably waiting on @ubi->move_mutex. No need to continue the work,
1103 * cancel it.
1104 */
1105 if (vol->eba_tbl[lnum] != from) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001106 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1107 vol_id, lnum, from, vol->eba_tbl[lnum]);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001108 err = MOVE_CANCEL_RACE;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001109 goto out_unlock_leb;
1110 }
1111
1112 /*
Zoltan Sogorb77bcb02008-10-29 09:50:02 +01001113 * OK, now the LEB is locked and we can safely start moving it. Since
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001114 * this function utilizes the @ubi->peb_buf buffer which is shared
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001115 * with some other functions - we lock the buffer by taking the
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001116 * @ubi->buf_mutex.
1117 */
1118 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001119 dbg_wl("read %d bytes of data", aldata_size);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001120 err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001121 if (err && err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001122 ubi_warn(ubi, "error %d while reading data from PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001123 err, from);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001124 err = MOVE_SOURCE_RD_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001125 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001126 }
1127
1128 /*
Anand Gadiyarfd589a82009-07-16 17:13:03 +02001129 * Now we have got to calculate how much data we have to copy. In
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001130 * case of a static volume it is fairly easy - the VID header contains
1131 * the data size. In case of a dynamic volume it is more difficult - we
1132 * have to read the contents, cut 0xFF bytes from the end and copy only
1133 * the first part. We must do this to avoid writing 0xFF bytes as it
1134 * may have some side-effects. And not only this. It is important not
1135 * to include those 0xFFs to CRC because later the they may be filled
1136 * by data.
1137 */
1138 if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1139 aldata_size = data_size =
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001140 ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001141
1142 cond_resched();
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001143 crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001144 cond_resched();
1145
1146 /*
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001147 * It may turn out to be that the whole @from physical eraseblock
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001148 * contains only 0xFF bytes. Then we have to only write the VID header
1149 * and do not write any data. This also means we should not set
1150 * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1151 */
1152 if (data_size > 0) {
1153 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001154 vid_hdr->data_size = cpu_to_be32(data_size);
1155 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001156 }
Richard Weinbergera7306652012-09-26 17:51:43 +02001157 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001158
1159 err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001160 if (err) {
1161 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001162 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001163 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001164 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001165
1166 cond_resched();
1167
1168 /* Read the VID header back and check if it was written correctly */
1169 err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1170 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001171 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001172 ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001173 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001174 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001175 err = MOVE_TARGET_RD_ERR;
1176 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001177 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001178 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001179 }
1180
1181 if (data_size > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001182 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001183 if (err) {
1184 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001185 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001186 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001187 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001188
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001189 cond_resched();
1190
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001191 /*
1192 * We've written the data and are going to read it back to make
1193 * sure it was written correctly.
1194 */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001195 memset(ubi->peb_buf, 0xFF, aldata_size);
1196 err = ubi_io_read_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001197 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001198 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001199 ubi_warn(ubi, "error %d while reading data back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001200 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001201 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001202 err = MOVE_TARGET_RD_ERR;
1203 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001204 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001205 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001206 }
1207
1208 cond_resched();
1209
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001210 if (crc != crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size)) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001211 ubi_warn(ubi, "read data back from PEB %d and it is different",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001212 to);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001213 err = -EINVAL;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001214 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001215 }
1216 }
1217
1218 ubi_assert(vol->eba_tbl[lnum] == from);
Richard Weinberger8974b152012-09-26 17:51:46 +02001219 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001220 vol->eba_tbl[lnum] = to;
Richard Weinberger8974b152012-09-26 17:51:46 +02001221 up_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001222
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001223out_unlock_buf:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001224 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001225out_unlock_leb:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001226 leb_write_unlock(ubi, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001227 return err;
1228}
1229
1230/**
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001231 * print_rsvd_warning - warn about not having enough reserved PEBs.
1232 * @ubi: UBI device description object
1233 *
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001234 * This is a helper function for 'ubi_eba_init()' which is called when UBI
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001235 * cannot reserve enough PEBs for bad block handling. This function makes a
1236 * decision whether we have to print a warning or not. The algorithm is as
1237 * follows:
1238 * o if this is a new UBI image, then just print the warning
1239 * o if this is an UBI image which has already been used for some time, print
1240 * a warning only if we can reserve less than 10% of the expected amount of
1241 * the reserved PEB.
1242 *
1243 * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1244 * of PEBs becomes smaller, which is normal and we do not want to scare users
1245 * with a warning every time they attach the MTD device. This was an issue
1246 * reported by real users.
1247 */
1248static void print_rsvd_warning(struct ubi_device *ubi,
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001249 struct ubi_attach_info *ai)
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001250{
1251 /*
1252 * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1253 * large number to distinguish between newly flashed and used images.
1254 */
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001255 if (ai->max_sqnum > (1 << 18)) {
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001256 int min = ubi->beb_rsvd_level / 10;
1257
1258 if (!min)
1259 min = 1;
1260 if (ubi->beb_rsvd_pebs > min)
1261 return;
1262 }
1263
Tanya Brokhman326087032014-10-20 19:57:00 +03001264 ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001265 ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001266 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001267 ubi_warn(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001268 ubi->corr_peb_count);
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001269}
1270
1271/**
Richard Weinberger00abf302012-09-26 17:51:44 +02001272 * self_check_eba - run a self check on the EBA table constructed by fastmap.
1273 * @ubi: UBI device description object
1274 * @ai_fastmap: UBI attach info object created by fastmap
1275 * @ai_scan: UBI attach info object created by scanning
1276 *
1277 * Returns < 0 in case of an internal error, 0 otherwise.
1278 * If a bad EBA table entry was found it will be printed out and
1279 * ubi_assert() triggers.
1280 */
1281int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1282 struct ubi_attach_info *ai_scan)
1283{
1284 int i, j, num_volumes, ret = 0;
1285 int **scan_eba, **fm_eba;
1286 struct ubi_ainf_volume *av;
1287 struct ubi_volume *vol;
1288 struct ubi_ainf_peb *aeb;
1289 struct rb_node *rb;
1290
1291 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1292
1293 scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1294 if (!scan_eba)
1295 return -ENOMEM;
1296
1297 fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1298 if (!fm_eba) {
1299 kfree(scan_eba);
1300 return -ENOMEM;
1301 }
1302
1303 for (i = 0; i < num_volumes; i++) {
1304 vol = ubi->volumes[i];
1305 if (!vol)
1306 continue;
1307
1308 scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1309 GFP_KERNEL);
1310 if (!scan_eba[i]) {
1311 ret = -ENOMEM;
1312 goto out_free;
1313 }
1314
1315 fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1316 GFP_KERNEL);
1317 if (!fm_eba[i]) {
1318 ret = -ENOMEM;
1319 goto out_free;
1320 }
1321
1322 for (j = 0; j < vol->reserved_pebs; j++)
1323 scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1324
1325 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1326 if (!av)
1327 continue;
1328
1329 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1330 scan_eba[i][aeb->lnum] = aeb->pnum;
1331
1332 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1333 if (!av)
1334 continue;
1335
1336 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1337 fm_eba[i][aeb->lnum] = aeb->pnum;
1338
1339 for (j = 0; j < vol->reserved_pebs; j++) {
1340 if (scan_eba[i][j] != fm_eba[i][j]) {
1341 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1342 fm_eba[i][j] == UBI_LEB_UNMAPPED)
1343 continue;
1344
Tanya Brokhman326087032014-10-20 19:57:00 +03001345 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
Richard Weinberger00abf302012-09-26 17:51:44 +02001346 vol->vol_id, i, fm_eba[i][j],
1347 scan_eba[i][j]);
1348 ubi_assert(0);
1349 }
1350 }
1351 }
1352
1353out_free:
1354 for (i = 0; i < num_volumes; i++) {
1355 if (!ubi->volumes[i])
1356 continue;
1357
1358 kfree(scan_eba[i]);
1359 kfree(fm_eba[i]);
1360 }
1361
1362 kfree(scan_eba);
1363 kfree(fm_eba);
1364 return ret;
1365}
1366
1367/**
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001368 * ubi_eba_init - initialize the EBA sub-system using attaching information.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001369 * @ubi: UBI device description object
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001370 * @ai: attaching information
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001371 *
1372 * This function returns zero in case of success and a negative error code in
1373 * case of failure.
1374 */
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001375int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001376{
1377 int i, j, err, num_volumes;
Artem Bityutskiy517af482012-05-17 14:38:34 +03001378 struct ubi_ainf_volume *av;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001379 struct ubi_volume *vol;
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001380 struct ubi_ainf_peb *aeb;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001381 struct rb_node *rb;
1382
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001383 dbg_eba("initialize EBA sub-system");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001384
1385 spin_lock_init(&ubi->ltree_lock);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001386 mutex_init(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001387 ubi->ltree = RB_ROOT;
1388
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001389 ubi->global_sqnum = ai->max_sqnum + 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001390 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1391
1392 for (i = 0; i < num_volumes; i++) {
1393 vol = ubi->volumes[i];
1394 if (!vol)
1395 continue;
1396
1397 cond_resched();
1398
1399 vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1400 GFP_KERNEL);
1401 if (!vol->eba_tbl) {
1402 err = -ENOMEM;
1403 goto out_free;
1404 }
1405
1406 for (j = 0; j < vol->reserved_pebs; j++)
1407 vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1408
Artem Bityutskiydcd85fd2012-05-17 15:33:20 +03001409 av = ubi_find_av(ai, idx2vol_id(ubi, i));
Artem Bityutskiy517af482012-05-17 14:38:34 +03001410 if (!av)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001411 continue;
1412
Artem Bityutskiy517af482012-05-17 14:38:34 +03001413 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001414 if (aeb->lnum >= vol->reserved_pebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001415 /*
1416 * This may happen in case of an unclean reboot
1417 * during re-size.
1418 */
Artem Bityutskiy0bae2882012-05-17 15:53:10 +03001419 ubi_move_aeb_to_list(av, aeb, &ai->erase);
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001420 vol->eba_tbl[aeb->lnum] = aeb->pnum;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001421 }
1422 }
1423
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001424 if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001425 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001426 ubi->avail_pebs, EBA_RESERVED_PEBS);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001427 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001428 ubi_err(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001429 ubi->corr_peb_count);
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001430 err = -ENOSPC;
1431 goto out_free;
1432 }
1433 ubi->avail_pebs -= EBA_RESERVED_PEBS;
1434 ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1435
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001436 if (ubi->bad_allowed) {
1437 ubi_calculate_reserved(ubi);
1438
1439 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1440 /* No enough free physical eraseblocks */
1441 ubi->beb_rsvd_pebs = ubi->avail_pebs;
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001442 print_rsvd_warning(ubi, ai);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001443 } else
1444 ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1445
1446 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1447 ubi->rsvd_pebs += ubi->beb_rsvd_pebs;
1448 }
1449
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001450 dbg_eba("EBA sub-system is initialized");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001451 return 0;
1452
1453out_free:
1454 for (i = 0; i < num_volumes; i++) {
1455 if (!ubi->volumes[i])
1456 continue;
1457 kfree(ubi->volumes[i]->eba_tbl);
Adrian Hunter7194e6f2009-07-24 17:05:00 +03001458 ubi->volumes[i]->eba_tbl = NULL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001459 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001460 return err;
1461}