blob: e0a06e4b95a421599defab169351ed3210dc82e4 [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;
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);
570 return new_pnum;
571 }
572
Tanya Brokhman326087032014-10-20 19:57:00 +0300573 ubi_msg(ubi, "recover PEB %d, move data to PEB %d",
574 pnum, new_pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400575
576 err = ubi_io_read_vid_hdr(ubi, pnum, vid_hdr, 1);
577 if (err && err != UBI_IO_BITFLIPS) {
578 if (err > 0)
579 err = -EIO;
580 goto out_put;
581 }
582
Richard Weinbergera7306652012-09-26 17:51:43 +0200583 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400584 err = ubi_io_write_vid_hdr(ubi, new_pnum, vid_hdr);
585 if (err)
586 goto write_error;
587
588 data_size = offset + len;
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200589 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200590 memset(ubi->peb_buf + offset, 0xFF, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400591
592 /* Read everything before the area where the write failure happened */
593 if (offset > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200594 err = ubi_io_read_data(ubi, ubi->peb_buf, pnum, 0, offset);
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300595 if (err && err != UBI_IO_BITFLIPS)
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200596 goto out_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400597 }
598
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200599 memcpy(ubi->peb_buf + offset, buf, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400600
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200601 err = ubi_io_write_data(ubi, ubi->peb_buf, new_pnum, 0, data_size);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200602 if (err) {
603 mutex_unlock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400604 goto write_error;
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200605 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400606
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300607 mutex_unlock(&ubi->buf_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400608 ubi_free_vid_hdr(ubi, vid_hdr);
609
Richard Weinberger8974b152012-09-26 17:51:46 +0200610 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400611 vol->eba_tbl[lnum] = new_pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200612 up_read(&ubi->fm_sem);
Joel Reardond36e59e2012-05-18 15:40:24 +0200613 ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400614
Tanya Brokhman326087032014-10-20 19:57:00 +0300615 ubi_msg(ubi, "data was successfully recovered");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400616 return 0;
617
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200618out_unlock:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300619 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy4df581f2008-12-04 20:52:44 +0200620out_put:
Joel Reardond36e59e2012-05-18 15:40:24 +0200621 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400622 ubi_free_vid_hdr(ubi, vid_hdr);
623 return err;
624
625write_error:
626 /*
627 * Bad luck? This physical eraseblock is bad too? Crud. Let's try to
628 * get another one.
629 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300630 ubi_warn(ubi, "failed to write to PEB %d", new_pnum);
Joel Reardond36e59e2012-05-18 15:40:24 +0200631 ubi_wl_put_peb(ubi, vol_id, lnum, new_pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400632 if (++tries > UBI_IO_RETRIES) {
633 ubi_free_vid_hdr(ubi, vid_hdr);
634 return err;
635 }
Tanya Brokhman326087032014-10-20 19:57:00 +0300636 ubi_msg(ubi, "try again");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400637 goto retry;
638}
639
640/**
641 * ubi_eba_write_leb - write data to dynamic volume.
642 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200643 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400644 * @lnum: logical eraseblock number
645 * @buf: the data to write
646 * @offset: offset within the logical eraseblock where to write
647 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400648 *
649 * This function writes data to logical eraseblock @lnum of a dynamic volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200650 * @vol. Returns zero in case of success and a negative error code in case
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400651 * of failure. In case of error, it is possible that something was still
652 * written to the flash media, but may be some garbage.
653 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200654int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200655 const void *buf, int offset, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400656{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200657 int err, pnum, tries = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400658 struct ubi_vid_hdr *vid_hdr;
659
660 if (ubi->ro_mode)
661 return -EROFS;
662
663 err = leb_write_lock(ubi, vol_id, lnum);
664 if (err)
665 return err;
666
667 pnum = vol->eba_tbl[lnum];
668 if (pnum >= 0) {
669 dbg_eba("write %d bytes at offset %d of LEB %d:%d, PEB %d",
670 len, offset, vol_id, lnum, pnum);
671
672 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
673 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300674 ubi_warn(ubi, "failed to write data to PEB %d", pnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400675 if (err == -EIO && ubi->bad_allowed)
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200676 err = recover_peb(ubi, pnum, vol_id, lnum, buf,
677 offset, len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400678 if (err)
679 ubi_ro_mode(ubi);
680 }
681 leb_write_unlock(ubi, vol_id, lnum);
682 return err;
683 }
684
685 /*
686 * The logical eraseblock is not mapped. We have to get a free physical
687 * eraseblock and write the volume identifier header there first.
688 */
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300689 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400690 if (!vid_hdr) {
691 leb_write_unlock(ubi, vol_id, lnum);
692 return -ENOMEM;
693 }
694
695 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Richard Weinbergera7306652012-09-26 17:51:43 +0200696 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300697 vid_hdr->vol_id = cpu_to_be32(vol_id);
698 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400699 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300700 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400701
702retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200703 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400704 if (pnum < 0) {
705 ubi_free_vid_hdr(ubi, vid_hdr);
706 leb_write_unlock(ubi, vol_id, lnum);
707 return pnum;
708 }
709
710 dbg_eba("write VID hdr and %d bytes at offset %d of LEB %d:%d, PEB %d",
711 len, offset, vol_id, lnum, pnum);
712
713 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
714 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300715 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400716 vol_id, lnum, pnum);
717 goto write_error;
718 }
719
Artem Bityutskiy393852e2007-12-06 18:47:30 +0200720 if (len) {
721 err = ubi_io_write_data(ubi, buf, pnum, offset, len);
722 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300723 ubi_warn(ubi, "failed to write %d bytes at offset %d of LEB %d:%d, PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300724 len, offset, vol_id, lnum, pnum);
Artem Bityutskiy393852e2007-12-06 18:47:30 +0200725 goto write_error;
726 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400727 }
728
Richard Weinberger8974b152012-09-26 17:51:46 +0200729 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400730 vol->eba_tbl[lnum] = pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200731 up_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400732
733 leb_write_unlock(ubi, vol_id, lnum);
734 ubi_free_vid_hdr(ubi, vid_hdr);
735 return 0;
736
737write_error:
738 if (err != -EIO || !ubi->bad_allowed) {
739 ubi_ro_mode(ubi);
740 leb_write_unlock(ubi, vol_id, lnum);
741 ubi_free_vid_hdr(ubi, vid_hdr);
742 return err;
743 }
744
745 /*
746 * Fortunately, this is the first write operation to this physical
747 * eraseblock, so just put it and request a new one. We assume that if
748 * this physical eraseblock went bad, the erase code will handle that.
749 */
Joel Reardond36e59e2012-05-18 15:40:24 +0200750 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400751 if (err || ++tries > UBI_IO_RETRIES) {
752 ubi_ro_mode(ubi);
753 leb_write_unlock(ubi, vol_id, lnum);
754 ubi_free_vid_hdr(ubi, vid_hdr);
755 return err;
756 }
757
Richard Weinbergera7306652012-09-26 17:51:43 +0200758 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300759 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400760 goto retry;
761}
762
763/**
764 * ubi_eba_write_leb_st - write data to static volume.
765 * @ubi: UBI device description object
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200766 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400767 * @lnum: logical eraseblock number
768 * @buf: data to write
769 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400770 * @used_ebs: how many logical eraseblocks will this volume contain
771 *
772 * This function writes data to logical eraseblock @lnum of static volume
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200773 * @vol. The @used_ebs argument should contain total number of logical
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400774 * eraseblock in this static volume.
775 *
776 * When writing to the last logical eraseblock, the @len argument doesn't have
777 * to be aligned to the minimal I/O unit size. Instead, it has to be equivalent
778 * to the real data size, although the @buf buffer has to contain the
779 * alignment. In all other cases, @len has to be aligned.
780 *
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200781 * It is prohibited to write more than once to logical eraseblocks of static
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400782 * volumes. This function returns zero in case of success and a negative error
783 * code in case of failure.
784 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200785int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200786 int lnum, const void *buf, int len, int used_ebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400787{
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200788 int err, pnum, tries = 0, data_size = len, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400789 struct ubi_vid_hdr *vid_hdr;
790 uint32_t crc;
791
792 if (ubi->ro_mode)
793 return -EROFS;
794
795 if (lnum == used_ebs - 1)
796 /* If this is the last LEB @len may be unaligned */
797 len = ALIGN(data_size, ubi->min_io_size);
798 else
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900799 ubi_assert(!(len & (ubi->min_io_size - 1)));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400800
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300801 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400802 if (!vid_hdr)
803 return -ENOMEM;
804
805 err = leb_write_lock(ubi, vol_id, lnum);
806 if (err) {
807 ubi_free_vid_hdr(ubi, vid_hdr);
808 return err;
809 }
810
Richard Weinbergera7306652012-09-26 17:51:43 +0200811 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300812 vid_hdr->vol_id = cpu_to_be32(vol_id);
813 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400814 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300815 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400816
817 crc = crc32(UBI_CRC32_INIT, buf, data_size);
818 vid_hdr->vol_type = UBI_VID_STATIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300819 vid_hdr->data_size = cpu_to_be32(data_size);
820 vid_hdr->used_ebs = cpu_to_be32(used_ebs);
821 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400822
823retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200824 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400825 if (pnum < 0) {
826 ubi_free_vid_hdr(ubi, vid_hdr);
827 leb_write_unlock(ubi, vol_id, lnum);
828 return pnum;
829 }
830
831 dbg_eba("write VID hdr and %d bytes at LEB %d:%d, PEB %d, used_ebs %d",
832 len, vol_id, lnum, pnum, used_ebs);
833
834 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
835 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300836 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400837 vol_id, lnum, pnum);
838 goto write_error;
839 }
840
841 err = ubi_io_write_data(ubi, buf, pnum, 0, len);
842 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300843 ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400844 len, pnum);
845 goto write_error;
846 }
847
848 ubi_assert(vol->eba_tbl[lnum] < 0);
Richard Weinberger8974b152012-09-26 17:51:46 +0200849 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400850 vol->eba_tbl[lnum] = pnum;
Richard Weinberger8974b152012-09-26 17:51:46 +0200851 up_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400852
853 leb_write_unlock(ubi, vol_id, lnum);
854 ubi_free_vid_hdr(ubi, vid_hdr);
855 return 0;
856
857write_error:
858 if (err != -EIO || !ubi->bad_allowed) {
859 /*
860 * This flash device does not admit of bad eraseblocks or
861 * something nasty and unexpected happened. Switch to read-only
862 * mode just in case.
863 */
864 ubi_ro_mode(ubi);
865 leb_write_unlock(ubi, vol_id, lnum);
866 ubi_free_vid_hdr(ubi, vid_hdr);
867 return err;
868 }
869
Joel Reardond36e59e2012-05-18 15:40:24 +0200870 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400871 if (err || ++tries > UBI_IO_RETRIES) {
872 ubi_ro_mode(ubi);
873 leb_write_unlock(ubi, vol_id, lnum);
874 ubi_free_vid_hdr(ubi, vid_hdr);
875 return err;
876 }
877
Richard Weinbergera7306652012-09-26 17:51:43 +0200878 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +0300879 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400880 goto retry;
881}
882
883/*
884 * ubi_eba_atomic_leb_change - change logical eraseblock atomically.
885 * @ubi: UBI device description object
Artem Bityutskiyc63a4912007-12-17 13:21:07 +0200886 * @vol: volume description object
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400887 * @lnum: logical eraseblock number
888 * @buf: data to write
889 * @len: how many bytes to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400890 *
891 * This function changes the contents of a logical eraseblock atomically. @buf
892 * has to contain new logical eraseblock data, and @len - the length of the
893 * data, which has to be aligned. This function guarantees that in case of an
894 * unclean reboot the old contents is preserved. Returns zero in case of
895 * success and a negative error code in case of failure.
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300896 *
897 * UBI reserves one LEB for the "atomic LEB change" operation, so only one
898 * LEB change may be done at a time. This is ensured by @ubi->alc_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400899 */
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200900int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200901 int lnum, const void *buf, int len)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400902{
Richard Weinberger36a87e42014-10-07 16:31:22 +0200903 int err, pnum, old_pnum, tries = 0, vol_id = vol->vol_id;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400904 struct ubi_vid_hdr *vid_hdr;
905 uint32_t crc;
906
907 if (ubi->ro_mode)
908 return -EROFS;
909
Artem Bityutskiy60c03152008-01-24 17:56:14 +0200910 if (len == 0) {
911 /*
912 * Special case when data length is zero. In this case the LEB
913 * has to be unmapped and mapped somewhere else.
914 */
915 err = ubi_eba_unmap_leb(ubi, vol, lnum);
916 if (err)
917 return err;
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200918 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0);
Artem Bityutskiy60c03152008-01-24 17:56:14 +0200919 }
920
Artem Bityutskiy33818bb2007-08-28 21:29:32 +0300921 vid_hdr = ubi_zalloc_vid_hdr(ubi, GFP_NOFS);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400922 if (!vid_hdr)
923 return -ENOMEM;
924
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300925 mutex_lock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400926 err = leb_write_lock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300927 if (err)
928 goto out_mutex;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400929
Richard Weinbergera7306652012-09-26 17:51:43 +0200930 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300931 vid_hdr->vol_id = cpu_to_be32(vol_id);
932 vid_hdr->lnum = cpu_to_be32(lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400933 vid_hdr->compat = ubi_get_compat(ubi, vol_id);
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300934 vid_hdr->data_pad = cpu_to_be32(vol->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400935
936 crc = crc32(UBI_CRC32_INIT, buf, len);
Artem Bityutskiy84a92582007-07-04 16:16:51 +0300937 vid_hdr->vol_type = UBI_VID_DYNAMIC;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300938 vid_hdr->data_size = cpu_to_be32(len);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400939 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +0300940 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400941
942retry:
Richard Weinbergerb36a2612012-05-14 17:55:51 +0200943 pnum = ubi_wl_get_peb(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400944 if (pnum < 0) {
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300945 err = pnum;
946 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400947 }
948
949 dbg_eba("change LEB %d:%d, PEB %d, write VID hdr to PEB %d",
950 vol_id, lnum, vol->eba_tbl[lnum], pnum);
951
952 err = ubi_io_write_vid_hdr(ubi, pnum, vid_hdr);
953 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300954 ubi_warn(ubi, "failed to write VID header to LEB %d:%d, PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400955 vol_id, lnum, pnum);
956 goto write_error;
957 }
958
959 err = ubi_io_write_data(ubi, buf, pnum, 0, len);
960 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300961 ubi_warn(ubi, "failed to write %d bytes of data to PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400962 len, pnum);
963 goto write_error;
964 }
965
Richard Weinberger36a87e42014-10-07 16:31:22 +0200966 down_read(&ubi->fm_sem);
967 old_pnum = vol->eba_tbl[lnum];
968 vol->eba_tbl[lnum] = pnum;
969 up_read(&ubi->fm_sem);
970
971 if (old_pnum >= 0) {
972 err = ubi_wl_put_peb(ubi, vol_id, lnum, old_pnum, 0);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300973 if (err)
974 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400975 }
976
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300977out_leb_unlock:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400978 leb_write_unlock(ubi, vol_id, lnum);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300979out_mutex:
980 mutex_unlock(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400981 ubi_free_vid_hdr(ubi, vid_hdr);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300982 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400983
984write_error:
985 if (err != -EIO || !ubi->bad_allowed) {
986 /*
987 * This flash device does not admit of bad eraseblocks or
988 * something nasty and unexpected happened. Switch to read-only
989 * mode just in case.
990 */
991 ubi_ro_mode(ubi);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300992 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400993 }
994
Joel Reardond36e59e2012-05-18 15:40:24 +0200995 err = ubi_wl_put_peb(ubi, vol_id, lnum, pnum, 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400996 if (err || ++tries > UBI_IO_RETRIES) {
997 ubi_ro_mode(ubi);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +0300998 goto out_leb_unlock;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400999 }
1000
Richard Weinbergera7306652012-09-26 17:51:43 +02001001 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Tanya Brokhman326087032014-10-20 19:57:00 +03001002 ubi_msg(ubi, "try another PEB");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001003 goto retry;
1004}
1005
1006/**
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001007 * is_error_sane - check whether a read error is sane.
1008 * @err: code of the error happened during reading
1009 *
1010 * This is a helper function for 'ubi_eba_copy_leb()' which is called when we
1011 * cannot read data from the target PEB (an error @err happened). If the error
1012 * code is sane, then we treat this error as non-fatal. Otherwise the error is
1013 * fatal and UBI will be switched to R/O mode later.
1014 *
1015 * The idea is that we try not to switch to R/O mode if the read error is
1016 * something which suggests there was a real read problem. E.g., %-EIO. Or a
1017 * memory allocation failed (-%ENOMEM). Otherwise, it is safer to switch to R/O
1018 * mode, simply because we do not know what happened at the MTD level, and we
1019 * cannot handle this. E.g., the underlying driver may have become crazy, and
1020 * it is safer to switch to R/O mode to preserve the data.
1021 *
1022 * And bear in mind, this is about reading from the target PEB, i.e. the PEB
1023 * which we have just written.
1024 */
1025static int is_error_sane(int err)
1026{
Artem Bityutskiy786d7832010-04-30 16:50:22 +03001027 if (err == -EIO || err == -ENOMEM || err == UBI_IO_BAD_HDR ||
Artem Bityutskiy756e1df2010-09-03 01:30:16 +03001028 err == UBI_IO_BAD_HDR_EBADMSG || err == -ETIMEDOUT)
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001029 return 0;
1030 return 1;
1031}
1032
1033/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001034 * ubi_eba_copy_leb - copy logical eraseblock.
1035 * @ubi: UBI device description object
1036 * @from: physical eraseblock number from where to copy
1037 * @to: physical eraseblock number where to copy
1038 * @vid_hdr: VID header of the @from physical eraseblock
1039 *
1040 * This function copies logical eraseblock from physical eraseblock @from to
1041 * physical eraseblock @to. The @vid_hdr buffer may be changed by this
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001042 * function. Returns:
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001043 * o %0 in case of success;
Artem Bityutskiycc831462012-03-09 10:31:18 +02001044 * o %MOVE_CANCEL_RACE, %MOVE_TARGET_WR_ERR, %MOVE_TARGET_BITFLIPS, etc;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001045 * o a negative error code in case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001046 */
1047int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
1048 struct ubi_vid_hdr *vid_hdr)
1049{
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001050 int err, vol_id, lnum, data_size, aldata_size, idx;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001051 struct ubi_volume *vol;
1052 uint32_t crc;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001053
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001054 vol_id = be32_to_cpu(vid_hdr->vol_id);
1055 lnum = be32_to_cpu(vid_hdr->lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001056
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001057 dbg_wl("copy LEB %d:%d, PEB %d to PEB %d", vol_id, lnum, from, to);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001058
1059 if (vid_hdr->vol_type == UBI_VID_STATIC) {
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001060 data_size = be32_to_cpu(vid_hdr->data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001061 aldata_size = ALIGN(data_size, ubi->min_io_size);
1062 } else
1063 data_size = aldata_size =
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001064 ubi->leb_size - be32_to_cpu(vid_hdr->data_pad);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001065
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001066 idx = vol_id2idx(ubi, vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001067 spin_lock(&ubi->volumes_lock);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001068 /*
1069 * Note, we may race with volume deletion, which means that the volume
1070 * this logical eraseblock belongs to might be being deleted. Since the
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001071 * volume deletion un-maps all the volume's logical eraseblocks, it will
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001072 * be locked in 'ubi_wl_put_peb()' and wait for the WL worker to finish.
1073 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001074 vol = ubi->volumes[idx];
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001075 spin_unlock(&ubi->volumes_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001076 if (!vol) {
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001077 /* No need to do further work, cancel */
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001078 dbg_wl("volume %d is being removed, cancel", vol_id);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001079 return MOVE_CANCEL_RACE;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001080 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001081
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001082 /*
1083 * We do not want anybody to write to this logical eraseblock while we
1084 * are moving it, so lock it.
1085 *
1086 * Note, we are using non-waiting locking here, because we cannot sleep
1087 * on the LEB, since it may cause deadlocks. Indeed, imagine a task is
1088 * unmapping the LEB which is mapped to the PEB we are going to move
1089 * (@from). This task locks the LEB and goes sleep in the
1090 * 'ubi_wl_put_peb()' function on the @ubi->move_mutex. In turn, we are
1091 * holding @ubi->move_mutex and go sleep on the LEB lock. So, if the
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001092 * LEB is already locked, we just do not move it and return
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301093 * %MOVE_RETRY. Note, we do not return %MOVE_CANCEL_RACE here because
1094 * we do not know the reasons of the contention - it may be just a
1095 * normal I/O on this LEB, so we want to re-try.
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001096 */
1097 err = leb_write_trylock(ubi, vol_id, lnum);
1098 if (err) {
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001099 dbg_wl("contention on LEB %d:%d, cancel", vol_id, lnum);
Bhavesh Parekhe801e122011-11-30 17:43:42 +05301100 return MOVE_RETRY;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001101 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001102
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001103 /*
1104 * The LEB might have been put meanwhile, and the task which put it is
1105 * probably waiting on @ubi->move_mutex. No need to continue the work,
1106 * cancel it.
1107 */
1108 if (vol->eba_tbl[lnum] != from) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001109 dbg_wl("LEB %d:%d is no longer mapped to PEB %d, mapped to PEB %d, cancel",
1110 vol_id, lnum, from, vol->eba_tbl[lnum]);
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001111 err = MOVE_CANCEL_RACE;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001112 goto out_unlock_leb;
1113 }
1114
1115 /*
Zoltan Sogorb77bcb02008-10-29 09:50:02 +01001116 * OK, now the LEB is locked and we can safely start moving it. Since
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001117 * this function utilizes the @ubi->peb_buf buffer which is shared
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001118 * with some other functions - we lock the buffer by taking the
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001119 * @ubi->buf_mutex.
1120 */
1121 mutex_lock(&ubi->buf_mutex);
Artem Bityutskiy87960c02009-05-24 11:58:58 +03001122 dbg_wl("read %d bytes of data", aldata_size);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001123 err = ubi_io_read_data(ubi, ubi->peb_buf, from, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001124 if (err && err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001125 ubi_warn(ubi, "error %d while reading data from PEB %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001126 err, from);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001127 err = MOVE_SOURCE_RD_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001128 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001129 }
1130
1131 /*
Anand Gadiyarfd589a82009-07-16 17:13:03 +02001132 * Now we have got to calculate how much data we have to copy. In
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001133 * case of a static volume it is fairly easy - the VID header contains
1134 * the data size. In case of a dynamic volume it is more difficult - we
1135 * have to read the contents, cut 0xFF bytes from the end and copy only
1136 * the first part. We must do this to avoid writing 0xFF bytes as it
1137 * may have some side-effects. And not only this. It is important not
1138 * to include those 0xFFs to CRC because later the they may be filled
1139 * by data.
1140 */
1141 if (vid_hdr->vol_type == UBI_VID_DYNAMIC)
1142 aldata_size = data_size =
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001143 ubi_calc_data_len(ubi, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001144
1145 cond_resched();
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001146 crc = crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001147 cond_resched();
1148
1149 /*
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001150 * It may turn out to be that the whole @from physical eraseblock
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001151 * contains only 0xFF bytes. Then we have to only write the VID header
1152 * and do not write any data. This also means we should not set
1153 * @vid_hdr->copy_flag, @vid_hdr->data_size, and @vid_hdr->data_crc.
1154 */
1155 if (data_size > 0) {
1156 vid_hdr->copy_flag = 1;
Christoph Hellwig3261ebd2007-05-21 17:41:46 +03001157 vid_hdr->data_size = cpu_to_be32(data_size);
1158 vid_hdr->data_crc = cpu_to_be32(crc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001159 }
Richard Weinbergera7306652012-09-26 17:51:43 +02001160 vid_hdr->sqnum = cpu_to_be64(ubi_next_sqnum(ubi));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001161
1162 err = ubi_io_write_vid_hdr(ubi, to, vid_hdr);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001163 if (err) {
1164 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001165 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001166 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001167 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001168
1169 cond_resched();
1170
1171 /* Read the VID header back and check if it was written correctly */
1172 err = ubi_io_read_vid_hdr(ubi, to, vid_hdr, 1);
1173 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001174 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001175 ubi_warn(ubi, "error %d while reading VID header back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001176 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001177 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001178 err = MOVE_TARGET_RD_ERR;
1179 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001180 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001181 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001182 }
1183
1184 if (data_size > 0) {
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001185 err = ubi_io_write_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001186 if (err) {
1187 if (err == -EIO)
Artem Bityutskiy90bf0262009-05-23 16:04:17 +03001188 err = MOVE_TARGET_WR_ERR;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001189 goto out_unlock_buf;
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001190 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001191
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001192 cond_resched();
1193
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001194 /*
1195 * We've written the data and are going to read it back to make
1196 * sure it was written correctly.
1197 */
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001198 memset(ubi->peb_buf, 0xFF, aldata_size);
1199 err = ubi_io_read_data(ubi, ubi->peb_buf, to, 0, aldata_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001200 if (err) {
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001201 if (err != UBI_IO_BITFLIPS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001202 ubi_warn(ubi, "error %d while reading data back from PEB %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001203 err, to);
Artem Bityutskiy6b5c94c2009-06-10 11:32:05 +03001204 if (is_error_sane(err))
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +03001205 err = MOVE_TARGET_RD_ERR;
1206 } else
Artem Bityutskiycc831462012-03-09 10:31:18 +02001207 err = MOVE_TARGET_BITFLIPS;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001208 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001209 }
1210
1211 cond_resched();
1212
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001213 if (crc != crc32(UBI_CRC32_INIT, ubi->peb_buf, data_size)) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001214 ubi_warn(ubi, "read data back from PEB %d and it is different",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001215 to);
Artem Bityutskiy6fa6f5b2008-12-05 13:37:02 +02001216 err = -EINVAL;
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001217 goto out_unlock_buf;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001218 }
1219 }
1220
1221 ubi_assert(vol->eba_tbl[lnum] == from);
Richard Weinberger8974b152012-09-26 17:51:46 +02001222 down_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001223 vol->eba_tbl[lnum] = to;
Richard Weinberger8974b152012-09-26 17:51:46 +02001224 up_read(&ubi->fm_sem);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001225
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001226out_unlock_buf:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001227 mutex_unlock(&ubi->buf_mutex);
Artem Bityutskiy43f9b252007-12-18 15:06:55 +02001228out_unlock_leb:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001229 leb_write_unlock(ubi, vol_id, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001230 return err;
1231}
1232
1233/**
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001234 * print_rsvd_warning - warn about not having enough reserved PEBs.
1235 * @ubi: UBI device description object
1236 *
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001237 * This is a helper function for 'ubi_eba_init()' which is called when UBI
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001238 * cannot reserve enough PEBs for bad block handling. This function makes a
1239 * decision whether we have to print a warning or not. The algorithm is as
1240 * follows:
1241 * o if this is a new UBI image, then just print the warning
1242 * o if this is an UBI image which has already been used for some time, print
1243 * a warning only if we can reserve less than 10% of the expected amount of
1244 * the reserved PEB.
1245 *
1246 * The idea is that when UBI is used, PEBs become bad, and the reserved pool
1247 * of PEBs becomes smaller, which is normal and we do not want to scare users
1248 * with a warning every time they attach the MTD device. This was an issue
1249 * reported by real users.
1250 */
1251static void print_rsvd_warning(struct ubi_device *ubi,
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001252 struct ubi_attach_info *ai)
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001253{
1254 /*
1255 * The 1 << 18 (256KiB) number is picked randomly, just a reasonably
1256 * large number to distinguish between newly flashed and used images.
1257 */
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001258 if (ai->max_sqnum > (1 << 18)) {
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001259 int min = ubi->beb_rsvd_level / 10;
1260
1261 if (!min)
1262 min = 1;
1263 if (ubi->beb_rsvd_pebs > min)
1264 return;
1265 }
1266
Tanya Brokhman326087032014-10-20 19:57:00 +03001267 ubi_warn(ubi, "cannot reserve enough PEBs for bad PEB handling, reserved %d, need %d",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001268 ubi->beb_rsvd_pebs, ubi->beb_rsvd_level);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001269 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001270 ubi_warn(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy049333c2012-08-27 14:43:54 +03001271 ubi->corr_peb_count);
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +03001272}
1273
1274/**
Richard Weinberger00abf302012-09-26 17:51:44 +02001275 * self_check_eba - run a self check on the EBA table constructed by fastmap.
1276 * @ubi: UBI device description object
1277 * @ai_fastmap: UBI attach info object created by fastmap
1278 * @ai_scan: UBI attach info object created by scanning
1279 *
1280 * Returns < 0 in case of an internal error, 0 otherwise.
1281 * If a bad EBA table entry was found it will be printed out and
1282 * ubi_assert() triggers.
1283 */
1284int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
1285 struct ubi_attach_info *ai_scan)
1286{
1287 int i, j, num_volumes, ret = 0;
1288 int **scan_eba, **fm_eba;
1289 struct ubi_ainf_volume *av;
1290 struct ubi_volume *vol;
1291 struct ubi_ainf_peb *aeb;
1292 struct rb_node *rb;
1293
1294 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1295
1296 scan_eba = kmalloc(sizeof(*scan_eba) * num_volumes, GFP_KERNEL);
1297 if (!scan_eba)
1298 return -ENOMEM;
1299
1300 fm_eba = kmalloc(sizeof(*fm_eba) * num_volumes, GFP_KERNEL);
1301 if (!fm_eba) {
1302 kfree(scan_eba);
1303 return -ENOMEM;
1304 }
1305
1306 for (i = 0; i < num_volumes; i++) {
1307 vol = ubi->volumes[i];
1308 if (!vol)
1309 continue;
1310
1311 scan_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**scan_eba),
1312 GFP_KERNEL);
1313 if (!scan_eba[i]) {
1314 ret = -ENOMEM;
1315 goto out_free;
1316 }
1317
1318 fm_eba[i] = kmalloc(vol->reserved_pebs * sizeof(**fm_eba),
1319 GFP_KERNEL);
1320 if (!fm_eba[i]) {
1321 ret = -ENOMEM;
1322 goto out_free;
1323 }
1324
1325 for (j = 0; j < vol->reserved_pebs; j++)
1326 scan_eba[i][j] = fm_eba[i][j] = UBI_LEB_UNMAPPED;
1327
1328 av = ubi_find_av(ai_scan, idx2vol_id(ubi, i));
1329 if (!av)
1330 continue;
1331
1332 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1333 scan_eba[i][aeb->lnum] = aeb->pnum;
1334
1335 av = ubi_find_av(ai_fastmap, idx2vol_id(ubi, i));
1336 if (!av)
1337 continue;
1338
1339 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb)
1340 fm_eba[i][aeb->lnum] = aeb->pnum;
1341
1342 for (j = 0; j < vol->reserved_pebs; j++) {
1343 if (scan_eba[i][j] != fm_eba[i][j]) {
1344 if (scan_eba[i][j] == UBI_LEB_UNMAPPED ||
1345 fm_eba[i][j] == UBI_LEB_UNMAPPED)
1346 continue;
1347
Tanya Brokhman326087032014-10-20 19:57:00 +03001348 ubi_err(ubi, "LEB:%i:%i is PEB:%i instead of %i!",
Richard Weinberger00abf302012-09-26 17:51:44 +02001349 vol->vol_id, i, fm_eba[i][j],
1350 scan_eba[i][j]);
1351 ubi_assert(0);
1352 }
1353 }
1354 }
1355
1356out_free:
1357 for (i = 0; i < num_volumes; i++) {
1358 if (!ubi->volumes[i])
1359 continue;
1360
1361 kfree(scan_eba[i]);
1362 kfree(fm_eba[i]);
1363 }
1364
1365 kfree(scan_eba);
1366 kfree(fm_eba);
1367 return ret;
1368}
1369
1370/**
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001371 * ubi_eba_init - initialize the EBA sub-system using attaching information.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001372 * @ubi: UBI device description object
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001373 * @ai: attaching information
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001374 *
1375 * This function returns zero in case of success and a negative error code in
1376 * case of failure.
1377 */
Artem Bityutskiy41e0cd92012-05-17 21:05:33 +03001378int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001379{
1380 int i, j, err, num_volumes;
Artem Bityutskiy517af482012-05-17 14:38:34 +03001381 struct ubi_ainf_volume *av;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001382 struct ubi_volume *vol;
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001383 struct ubi_ainf_peb *aeb;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001384 struct rb_node *rb;
1385
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001386 dbg_eba("initialize EBA sub-system");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001387
1388 spin_lock_init(&ubi->ltree_lock);
Artem Bityutskiye8823bd2007-09-13 14:28:14 +03001389 mutex_init(&ubi->alc_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001390 ubi->ltree = RB_ROOT;
1391
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001392 ubi->global_sqnum = ai->max_sqnum + 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001393 num_volumes = ubi->vtbl_slots + UBI_INT_VOL_COUNT;
1394
1395 for (i = 0; i < num_volumes; i++) {
1396 vol = ubi->volumes[i];
1397 if (!vol)
1398 continue;
1399
1400 cond_resched();
1401
1402 vol->eba_tbl = kmalloc(vol->reserved_pebs * sizeof(int),
1403 GFP_KERNEL);
1404 if (!vol->eba_tbl) {
1405 err = -ENOMEM;
1406 goto out_free;
1407 }
1408
1409 for (j = 0; j < vol->reserved_pebs; j++)
1410 vol->eba_tbl[j] = UBI_LEB_UNMAPPED;
1411
Artem Bityutskiydcd85fd2012-05-17 15:33:20 +03001412 av = ubi_find_av(ai, idx2vol_id(ubi, i));
Artem Bityutskiy517af482012-05-17 14:38:34 +03001413 if (!av)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001414 continue;
1415
Artem Bityutskiy517af482012-05-17 14:38:34 +03001416 ubi_rb_for_each_entry(rb, aeb, &av->root, u.rb) {
Artem Bityutskiy2c5ec5c2012-05-17 08:26:24 +03001417 if (aeb->lnum >= vol->reserved_pebs)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001418 /*
1419 * This may happen in case of an unclean reboot
1420 * during re-size.
1421 */
Artem Bityutskiy0bae2882012-05-17 15:53:10 +03001422 ubi_move_aeb_to_list(av, aeb, &ai->erase);
Brian Norrisd74adbd2015-02-28 02:23:26 -08001423 else
1424 vol->eba_tbl[aeb->lnum] = aeb->pnum;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001425 }
1426 }
1427
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001428 if (ubi->avail_pebs < EBA_RESERVED_PEBS) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001429 ubi_err(ubi, "no enough physical eraseblocks (%d, need %d)",
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001430 ubi->avail_pebs, EBA_RESERVED_PEBS);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001431 if (ubi->corr_peb_count)
Tanya Brokhman326087032014-10-20 19:57:00 +03001432 ubi_err(ubi, "%d PEBs are corrupted and not used",
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +03001433 ubi->corr_peb_count);
Artem Bityutskiy94780d42007-12-04 21:36:12 +02001434 err = -ENOSPC;
1435 goto out_free;
1436 }
1437 ubi->avail_pebs -= EBA_RESERVED_PEBS;
1438 ubi->rsvd_pebs += EBA_RESERVED_PEBS;
1439
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001440 if (ubi->bad_allowed) {
1441 ubi_calculate_reserved(ubi);
1442
1443 if (ubi->avail_pebs < ubi->beb_rsvd_level) {
1444 /* No enough free physical eraseblocks */
1445 ubi->beb_rsvd_pebs = ubi->avail_pebs;
Artem Bityutskiya4e60422012-05-17 13:09:08 +03001446 print_rsvd_warning(ubi, ai);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001447 } else
1448 ubi->beb_rsvd_pebs = ubi->beb_rsvd_level;
1449
1450 ubi->avail_pebs -= ubi->beb_rsvd_pebs;
1451 ubi->rsvd_pebs += ubi->beb_rsvd_pebs;
1452 }
1453
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +03001454 dbg_eba("EBA sub-system is initialized");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001455 return 0;
1456
1457out_free:
1458 for (i = 0; i < num_volumes; i++) {
1459 if (!ubi->volumes[i])
1460 continue;
1461 kfree(ubi->volumes[i]->eba_tbl);
Adrian Hunter7194e6f2009-07-24 17:05:00 +03001462 ubi->volumes[i]->eba_tbl = NULL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001463 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001464 return err;
1465}