Commit | Line | Data |
---|---|---|
801c135c AB |
1 | /* |
2 | * Copyright (c) International Business Machines Corp., 2006 | |
3 | * Copyright (c) Nokia Corporation, 2006 | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation; either version 2 of the License, or | |
8 | * (at your option) any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See | |
13 | * the GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with this program; if not, write to the Free Software | |
17 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
18 | * | |
19 | * Author: Artem Bityutskiy (Битюцкий Артём) | |
20 | * | |
21 | * Jan 2007: Alexander Schmidt, hacked per-volume update. | |
22 | */ | |
23 | ||
24 | /* | |
e653879c AB |
25 | * This file contains implementation of the volume update and atomic LEB change |
26 | * functionality. | |
801c135c AB |
27 | * |
28 | * The update operation is based on the per-volume update marker which is | |
29 | * stored in the volume table. The update marker is set before the update | |
30 | * starts, and removed after the update has been finished. So if the update was | |
31 | * interrupted by an unclean re-boot or due to some other reasons, the update | |
32 | * marker stays on the flash media and UBI finds it when it attaches the MTD | |
33 | * device next time. If the update marker is set for a volume, the volume is | |
34 | * treated as damaged and most I/O operations are prohibited. Only a new update | |
35 | * operation is allowed. | |
36 | * | |
37 | * Note, in general it is possible to implement the update operation as a | |
38 | * transaction with a roll-back capability. | |
39 | */ | |
40 | ||
41 | #include <linux/err.h> | |
9c9ec147 | 42 | #include <linux/uaccess.h> |
801c135c AB |
43 | #include <asm/div64.h> |
44 | #include "ubi.h" | |
45 | ||
46 | /** | |
47 | * set_update_marker - set update marker. | |
48 | * @ubi: UBI device description object | |
1b68d0ee | 49 | * @vol: volume description object |
801c135c | 50 | * |
1b68d0ee | 51 | * This function sets the update marker flag for volume @vol. Returns zero |
801c135c AB |
52 | * in case of success and a negative error code in case of failure. |
53 | */ | |
1b68d0ee | 54 | static int set_update_marker(struct ubi_device *ubi, struct ubi_volume *vol) |
801c135c AB |
55 | { |
56 | int err; | |
57 | struct ubi_vtbl_record vtbl_rec; | |
801c135c | 58 | |
c8566350 | 59 | dbg_gen("set update marker for volume %d", vol->vol_id); |
801c135c AB |
60 | |
61 | if (vol->upd_marker) { | |
1b68d0ee | 62 | ubi_assert(ubi->vtbl[vol->vol_id].upd_marker); |
c8566350 | 63 | dbg_gen("already set"); |
801c135c AB |
64 | return 0; |
65 | } | |
66 | ||
1b68d0ee AB |
67 | memcpy(&vtbl_rec, &ubi->vtbl[vol->vol_id], |
68 | sizeof(struct ubi_vtbl_record)); | |
801c135c AB |
69 | vtbl_rec.upd_marker = 1; |
70 | ||
cae0a771 | 71 | mutex_lock(&ubi->volumes_mutex); |
1b68d0ee | 72 | err = ubi_change_vtbl_record(ubi, vol->vol_id, &vtbl_rec); |
cae0a771 | 73 | mutex_unlock(&ubi->volumes_mutex); |
801c135c AB |
74 | vol->upd_marker = 1; |
75 | return err; | |
76 | } | |
77 | ||
78 | /** | |
79 | * clear_update_marker - clear update marker. | |
80 | * @ubi: UBI device description object | |
1b68d0ee | 81 | * @vol: volume description object |
801c135c AB |
82 | * @bytes: new data size in bytes |
83 | * | |
1b68d0ee | 84 | * This function clears the update marker for volume @vol, sets new volume |
801c135c AB |
85 | * data size and clears the "corrupted" flag (static volumes only). Returns |
86 | * zero in case of success and a negative error code in case of failure. | |
87 | */ | |
1b68d0ee AB |
88 | static int clear_update_marker(struct ubi_device *ubi, struct ubi_volume *vol, |
89 | long long bytes) | |
801c135c AB |
90 | { |
91 | int err; | |
92 | uint64_t tmp; | |
93 | struct ubi_vtbl_record vtbl_rec; | |
801c135c | 94 | |
c8566350 | 95 | dbg_gen("clear update marker for volume %d", vol->vol_id); |
801c135c | 96 | |
1b68d0ee AB |
97 | memcpy(&vtbl_rec, &ubi->vtbl[vol->vol_id], |
98 | sizeof(struct ubi_vtbl_record)); | |
801c135c AB |
99 | ubi_assert(vol->upd_marker && vtbl_rec.upd_marker); |
100 | vtbl_rec.upd_marker = 0; | |
101 | ||
102 | if (vol->vol_type == UBI_STATIC_VOLUME) { | |
103 | vol->corrupted = 0; | |
104 | vol->used_bytes = tmp = bytes; | |
105 | vol->last_eb_bytes = do_div(tmp, vol->usable_leb_size); | |
106 | vol->used_ebs = tmp; | |
107 | if (vol->last_eb_bytes) | |
108 | vol->used_ebs += 1; | |
109 | else | |
110 | vol->last_eb_bytes = vol->usable_leb_size; | |
111 | } | |
112 | ||
cae0a771 | 113 | mutex_lock(&ubi->volumes_mutex); |
1b68d0ee | 114 | err = ubi_change_vtbl_record(ubi, vol->vol_id, &vtbl_rec); |
cae0a771 | 115 | mutex_unlock(&ubi->volumes_mutex); |
801c135c AB |
116 | vol->upd_marker = 0; |
117 | return err; | |
118 | } | |
119 | ||
120 | /** | |
121 | * ubi_start_update - start volume update. | |
122 | * @ubi: UBI device description object | |
1b68d0ee | 123 | * @vol: volume description object |
801c135c AB |
124 | * @bytes: update bytes |
125 | * | |
126 | * This function starts volume update operation. If @bytes is zero, the volume | |
127 | * is just wiped out. Returns zero in case of success and a negative error code | |
128 | * in case of failure. | |
129 | */ | |
1b68d0ee AB |
130 | int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol, |
131 | long long bytes) | |
801c135c AB |
132 | { |
133 | int i, err; | |
134 | uint64_t tmp; | |
801c135c | 135 | |
c8566350 | 136 | dbg_gen("start update of volume %d, %llu bytes", vol->vol_id, bytes); |
e653879c | 137 | ubi_assert(!vol->updating && !vol->changing_leb); |
801c135c AB |
138 | vol->updating = 1; |
139 | ||
1b68d0ee | 140 | err = set_update_marker(ubi, vol); |
801c135c AB |
141 | if (err) |
142 | return err; | |
143 | ||
144 | /* Before updating - wipe out the volume */ | |
145 | for (i = 0; i < vol->reserved_pebs; i++) { | |
89b96b69 | 146 | err = ubi_eba_unmap_leb(ubi, vol, i); |
801c135c AB |
147 | if (err) |
148 | return err; | |
149 | } | |
150 | ||
151 | if (bytes == 0) { | |
1b68d0ee | 152 | err = clear_update_marker(ubi, vol, 0); |
801c135c AB |
153 | if (err) |
154 | return err; | |
155 | err = ubi_wl_flush(ubi); | |
156 | if (!err) | |
157 | vol->updating = 0; | |
158 | } | |
159 | ||
92ad8f37 | 160 | vol->upd_buf = vmalloc(ubi->leb_size); |
801c135c AB |
161 | if (!vol->upd_buf) |
162 | return -ENOMEM; | |
163 | ||
164 | tmp = bytes; | |
165 | vol->upd_ebs = !!do_div(tmp, vol->usable_leb_size); | |
166 | vol->upd_ebs += tmp; | |
167 | vol->upd_bytes = bytes; | |
168 | vol->upd_received = 0; | |
169 | return 0; | |
170 | } | |
171 | ||
e653879c AB |
172 | /** |
173 | * ubi_start_leb_change - start atomic LEB change. | |
174 | * @ubi: UBI device description object | |
175 | * @vol: volume description object | |
176 | * @req: operation request | |
177 | * | |
178 | * This function starts atomic LEB change operation. Returns zero in case of | |
179 | * success and a negative error code in case of failure. | |
180 | */ | |
181 | int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol, | |
182 | const struct ubi_leb_change_req *req) | |
183 | { | |
184 | ubi_assert(!vol->updating && !vol->changing_leb); | |
185 | ||
c8566350 | 186 | dbg_gen("start changing LEB %d:%d, %u bytes", |
e653879c AB |
187 | vol->vol_id, req->lnum, req->bytes); |
188 | if (req->bytes == 0) | |
189 | return ubi_eba_atomic_leb_change(ubi, vol, req->lnum, NULL, 0, | |
190 | req->dtype); | |
191 | ||
192 | vol->upd_bytes = req->bytes; | |
193 | vol->upd_received = 0; | |
194 | vol->changing_leb = 1; | |
195 | vol->ch_lnum = req->lnum; | |
196 | vol->ch_dtype = req->dtype; | |
197 | ||
198 | vol->upd_buf = vmalloc(req->bytes); | |
199 | if (!vol->upd_buf) | |
200 | return -ENOMEM; | |
201 | ||
202 | return 0; | |
203 | } | |
204 | ||
801c135c AB |
205 | /** |
206 | * write_leb - write update data. | |
207 | * @ubi: UBI device description object | |
1b68d0ee | 208 | * @vol: volume description object |
801c135c AB |
209 | * @lnum: logical eraseblock number |
210 | * @buf: data to write | |
211 | * @len: data size | |
212 | * @used_ebs: how many logical eraseblocks will this volume contain (static | |
213 | * volumes only) | |
214 | * | |
215 | * This function writes update data to corresponding logical eraseblock. In | |
216 | * case of dynamic volume, this function checks if the data contains 0xFF bytes | |
217 | * at the end. If yes, the 0xFF bytes are cut and not written. So if the whole | |
218 | * buffer contains only 0xFF bytes, the LEB is left unmapped. | |
219 | * | |
220 | * The reason why we skip the trailing 0xFF bytes in case of dynamic volume is | |
221 | * that we want to make sure that more data may be appended to the logical | |
222 | * eraseblock in future. Indeed, writing 0xFF bytes may have side effects and | |
223 | * this PEB won't be writable anymore. So if one writes the file-system image | |
224 | * to the UBI volume where 0xFFs mean free space - UBI makes sure this free | |
225 | * space is writable after the update. | |
226 | * | |
227 | * We do not do this for static volumes because they are read-only. But this | |
228 | * also cannot be done because we have to store per-LEB CRC and the correct | |
229 | * data length. | |
230 | * | |
231 | * This function returns zero in case of success and a negative error code in | |
232 | * case of failure. | |
233 | */ | |
1b68d0ee AB |
234 | static int write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum, |
235 | void *buf, int len, int used_ebs) | |
801c135c | 236 | { |
e653879c | 237 | int err; |
801c135c AB |
238 | |
239 | if (vol->vol_type == UBI_DYNAMIC_VOLUME) { | |
a0fd1efd | 240 | int l = ALIGN(len, ubi->min_io_size); |
801c135c | 241 | |
a0fd1efd KP |
242 | memset(buf + len, 0xFF, l - len); |
243 | len = ubi_calc_data_len(ubi, buf, l); | |
e653879c | 244 | if (len == 0) { |
c8566350 | 245 | dbg_gen("all %d bytes contain 0xFF - skip", len); |
801c135c AB |
246 | return 0; |
247 | } | |
801c135c | 248 | |
9c9ec147 AB |
249 | err = ubi_eba_write_leb(ubi, vol, lnum, buf, 0, len, |
250 | UBI_UNKNOWN); | |
801c135c AB |
251 | } else { |
252 | /* | |
253 | * When writing static volume, and this is the last logical | |
254 | * eraseblock, the length (@len) does not have to be aligned to | |
255 | * the minimal flash I/O unit. The 'ubi_eba_write_leb_st()' | |
256 | * function accepts exact (unaligned) length and stores it in | |
257 | * the VID header. And it takes care of proper alignment by | |
258 | * padding the buffer. Here we just make sure the padding will | |
259 | * contain zeros, not random trash. | |
260 | */ | |
261 | memset(buf + len, 0, vol->usable_leb_size - len); | |
89b96b69 | 262 | err = ubi_eba_write_leb_st(ubi, vol, lnum, buf, len, |
801c135c AB |
263 | UBI_UNKNOWN, used_ebs); |
264 | } | |
265 | ||
266 | return err; | |
267 | } | |
268 | ||
269 | /** | |
270 | * ubi_more_update_data - write more update data. | |
271 | * @vol: volume description object | |
272 | * @buf: write data (user-space memory buffer) | |
273 | * @count: how much bytes to write | |
274 | * | |
275 | * This function writes more data to the volume which is being updated. It may | |
e653879c AB |
276 | * be called arbitrary number of times until all the update data arriveis. This |
277 | * function returns %0 in case of success, number of bytes written during the | |
278 | * last call if the whole volume update has been successfully finished, and a | |
801c135c AB |
279 | * negative error code in case of failure. |
280 | */ | |
1b68d0ee | 281 | int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol, |
801c135c AB |
282 | const void __user *buf, int count) |
283 | { | |
284 | uint64_t tmp; | |
801c135c AB |
285 | int lnum, offs, err = 0, len, to_write = count; |
286 | ||
c8566350 | 287 | dbg_gen("write %d of %lld bytes, %lld already passed", |
801c135c AB |
288 | count, vol->upd_bytes, vol->upd_received); |
289 | ||
290 | if (ubi->ro_mode) | |
291 | return -EROFS; | |
292 | ||
293 | tmp = vol->upd_received; | |
294 | offs = do_div(tmp, vol->usable_leb_size); | |
295 | lnum = tmp; | |
296 | ||
297 | if (vol->upd_received + count > vol->upd_bytes) | |
298 | to_write = count = vol->upd_bytes - vol->upd_received; | |
299 | ||
300 | /* | |
301 | * When updating volumes, we accumulate whole logical eraseblock of | |
302 | * data and write it at once. | |
303 | */ | |
304 | if (offs != 0) { | |
305 | /* | |
306 | * This is a write to the middle of the logical eraseblock. We | |
307 | * copy the data to our update buffer and wait for more data or | |
308 | * flush it if the whole eraseblock is written or the update | |
309 | * is finished. | |
310 | */ | |
311 | ||
312 | len = vol->usable_leb_size - offs; | |
313 | if (len > count) | |
314 | len = count; | |
315 | ||
316 | err = copy_from_user(vol->upd_buf + offs, buf, len); | |
317 | if (err) | |
318 | return -EFAULT; | |
319 | ||
320 | if (offs + len == vol->usable_leb_size || | |
321 | vol->upd_received + len == vol->upd_bytes) { | |
322 | int flush_len = offs + len; | |
323 | ||
324 | /* | |
325 | * OK, we gathered either the whole eraseblock or this | |
326 | * is the last chunk, it's time to flush the buffer. | |
327 | */ | |
328 | ubi_assert(flush_len <= vol->usable_leb_size); | |
1b68d0ee AB |
329 | err = write_leb(ubi, vol, lnum, vol->upd_buf, flush_len, |
330 | vol->upd_ebs); | |
801c135c AB |
331 | if (err) |
332 | return err; | |
333 | } | |
334 | ||
335 | vol->upd_received += len; | |
336 | count -= len; | |
337 | buf += len; | |
338 | lnum += 1; | |
339 | } | |
340 | ||
341 | /* | |
342 | * If we've got more to write, let's continue. At this point we know we | |
343 | * are starting from the beginning of an eraseblock. | |
344 | */ | |
345 | while (count) { | |
346 | if (count > vol->usable_leb_size) | |
347 | len = vol->usable_leb_size; | |
348 | else | |
349 | len = count; | |
350 | ||
351 | err = copy_from_user(vol->upd_buf, buf, len); | |
352 | if (err) | |
353 | return -EFAULT; | |
354 | ||
355 | if (len == vol->usable_leb_size || | |
356 | vol->upd_received + len == vol->upd_bytes) { | |
1b68d0ee AB |
357 | err = write_leb(ubi, vol, lnum, vol->upd_buf, |
358 | len, vol->upd_ebs); | |
801c135c AB |
359 | if (err) |
360 | break; | |
361 | } | |
362 | ||
363 | vol->upd_received += len; | |
364 | count -= len; | |
365 | lnum += 1; | |
366 | buf += len; | |
367 | } | |
368 | ||
369 | ubi_assert(vol->upd_received <= vol->upd_bytes); | |
370 | if (vol->upd_received == vol->upd_bytes) { | |
371 | /* The update is finished, clear the update marker */ | |
1b68d0ee | 372 | err = clear_update_marker(ubi, vol, vol->upd_bytes); |
801c135c AB |
373 | if (err) |
374 | return err; | |
375 | err = ubi_wl_flush(ubi); | |
376 | if (err == 0) { | |
e653879c | 377 | vol->updating = 0; |
801c135c | 378 | err = to_write; |
92ad8f37 | 379 | vfree(vol->upd_buf); |
801c135c AB |
380 | } |
381 | } | |
382 | ||
383 | return err; | |
384 | } | |
e653879c AB |
385 | |
386 | /** | |
387 | * ubi_more_leb_change_data - accept more data for atomic LEB change. | |
388 | * @vol: volume description object | |
389 | * @buf: write data (user-space memory buffer) | |
390 | * @count: how much bytes to write | |
391 | * | |
392 | * This function accepts more data to the volume which is being under the | |
393 | * "atomic LEB change" operation. It may be called arbitrary number of times | |
394 | * until all data arrives. This function returns %0 in case of success, number | |
395 | * of bytes written during the last call if the whole "atomic LEB change" | |
396 | * operation has been successfully finished, and a negative error code in case | |
397 | * of failure. | |
398 | */ | |
399 | int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol, | |
400 | const void __user *buf, int count) | |
401 | { | |
402 | int err; | |
403 | ||
c8566350 | 404 | dbg_gen("write %d of %lld bytes, %lld already passed", |
e653879c AB |
405 | count, vol->upd_bytes, vol->upd_received); |
406 | ||
407 | if (ubi->ro_mode) | |
408 | return -EROFS; | |
409 | ||
410 | if (vol->upd_received + count > vol->upd_bytes) | |
411 | count = vol->upd_bytes - vol->upd_received; | |
412 | ||
413 | err = copy_from_user(vol->upd_buf + vol->upd_received, buf, count); | |
414 | if (err) | |
415 | return -EFAULT; | |
416 | ||
417 | vol->upd_received += count; | |
418 | ||
419 | if (vol->upd_received == vol->upd_bytes) { | |
420 | int len = ALIGN((int)vol->upd_bytes, ubi->min_io_size); | |
421 | ||
9c9ec147 AB |
422 | memset(vol->upd_buf + vol->upd_bytes, 0xFF, |
423 | len - vol->upd_bytes); | |
e653879c AB |
424 | len = ubi_calc_data_len(ubi, vol->upd_buf, len); |
425 | err = ubi_eba_atomic_leb_change(ubi, vol, vol->ch_lnum, | |
426 | vol->upd_buf, len, UBI_UNKNOWN); | |
427 | if (err) | |
428 | return err; | |
429 | } | |
430 | ||
431 | ubi_assert(vol->upd_received <= vol->upd_bytes); | |
432 | if (vol->upd_received == vol->upd_bytes) { | |
433 | vol->changing_leb = 0; | |
434 | err = count; | |
435 | vfree(vol->upd_buf); | |
436 | } | |
437 | ||
438 | return err; | |
439 | } |