blob: fd7e0f923b38e39f8156a862e0175dc292f4599e [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/*
22 * This file includes implementation of UBI character device operations.
23 *
24 * There are two kinds of character devices in UBI: UBI character devices and
25 * UBI volume character devices. UBI character devices allow users to
26 * manipulate whole volumes: create, remove, and re-size them. Volume character
27 * devices provide volume I/O capabilities.
28 *
29 * Major and minor numbers are assigned dynamically to both UBI and volume
30 * character devices.
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020031 *
32 * Well, there is the third kind of character devices - the UBI control
33 * character device, which allows to manipulate by UBI devices - create and
34 * delete them. In other words, it is used for attaching and detaching MTD
35 * devices.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040036 */
37
38#include <linux/module.h>
39#include <linux/stat.h>
40#include <linux/ioctl.h>
41#include <linux/capability.h>
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +030042#include <linux/uaccess.h>
Jonathan Corbet72b67042008-05-15 10:15:38 -060043#include <linux/smp_lock.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040044#include <mtd/ubi-user.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040045#include <asm/div64.h>
46#include "ubi.h"
47
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040048/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040049 * get_exclusive - get exclusive access to an UBI volume.
50 * @desc: volume descriptor
51 *
52 * This function changes UBI volume open mode to "exclusive". Returns previous
53 * mode value (positive integer) in case of success and a negative error code
54 * in case of failure.
55 */
56static int get_exclusive(struct ubi_volume_desc *desc)
57{
58 int users, err;
59 struct ubi_volume *vol = desc->vol;
60
61 spin_lock(&vol->ubi->volumes_lock);
62 users = vol->readers + vol->writers + vol->exclusive;
63 ubi_assert(users > 0);
64 if (users > 1) {
65 dbg_err("%d users for volume %d", users, vol->vol_id);
66 err = -EBUSY;
67 } else {
68 vol->readers = vol->writers = 0;
69 vol->exclusive = 1;
70 err = desc->mode;
71 desc->mode = UBI_EXCLUSIVE;
72 }
73 spin_unlock(&vol->ubi->volumes_lock);
74
75 return err;
76}
77
78/**
79 * revoke_exclusive - revoke exclusive mode.
80 * @desc: volume descriptor
81 * @mode: new mode to switch to
82 */
83static void revoke_exclusive(struct ubi_volume_desc *desc, int mode)
84{
85 struct ubi_volume *vol = desc->vol;
86
87 spin_lock(&vol->ubi->volumes_lock);
88 ubi_assert(vol->readers == 0 && vol->writers == 0);
89 ubi_assert(vol->exclusive == 1 && desc->mode == UBI_EXCLUSIVE);
90 vol->exclusive = 0;
91 if (mode == UBI_READONLY)
92 vol->readers = 1;
93 else if (mode == UBI_READWRITE)
94 vol->writers = 1;
95 else
96 vol->exclusive = 1;
97 spin_unlock(&vol->ubi->volumes_lock);
98
99 desc->mode = mode;
100}
101
102static int vol_cdev_open(struct inode *inode, struct file *file)
103{
104 struct ubi_volume_desc *desc;
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200105 int vol_id = iminor(inode) - 1, mode, ubi_num;
106
107 ubi_num = ubi_major2num(imajor(inode));
Artem Bityutskiy7d200e82008-08-31 19:32:13 +0300108 if (ubi_num < 0)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200109 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400110
111 if (file->f_mode & FMODE_WRITE)
112 mode = UBI_READWRITE;
113 else
114 mode = UBI_READONLY;
115
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300116 dbg_gen("open volume %d, mode %d", vol_id, mode);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400117
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200118 desc = ubi_open_volume(ubi_num, vol_id, mode);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400119 if (IS_ERR(desc))
120 return PTR_ERR(desc);
121
122 file->private_data = desc;
123 return 0;
124}
125
126static int vol_cdev_release(struct inode *inode, struct file *file)
127{
128 struct ubi_volume_desc *desc = file->private_data;
129 struct ubi_volume *vol = desc->vol;
130
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300131 dbg_gen("release volume %d, mode %d", vol->vol_id, desc->mode);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400132
133 if (vol->updating) {
134 ubi_warn("update of volume %d not finished, volume is damaged",
135 vol->vol_id);
Artem Bityutskiye6538792008-01-24 18:48:21 +0200136 ubi_assert(!vol->changing_leb);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400137 vol->updating = 0;
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +0300138 vfree(vol->upd_buf);
Artem Bityutskiye6538792008-01-24 18:48:21 +0200139 } else if (vol->changing_leb) {
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300140 dbg_gen("only %lld of %lld bytes received for atomic LEB change"
Artem Bityutskiye6538792008-01-24 18:48:21 +0200141 " for volume %d:%d, cancel", vol->upd_received,
142 vol->upd_bytes, vol->ubi->ubi_num, vol->vol_id);
143 vol->changing_leb = 0;
144 vfree(vol->upd_buf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400145 }
146
147 ubi_close_volume(desc);
148 return 0;
149}
150
151static loff_t vol_cdev_llseek(struct file *file, loff_t offset, int origin)
152{
153 struct ubi_volume_desc *desc = file->private_data;
154 struct ubi_volume *vol = desc->vol;
155 loff_t new_offset;
156
157 if (vol->updating) {
158 /* Update is in progress, seeking is prohibited */
159 dbg_err("updating");
160 return -EBUSY;
161 }
162
163 switch (origin) {
164 case 0: /* SEEK_SET */
165 new_offset = offset;
166 break;
167 case 1: /* SEEK_CUR */
168 new_offset = file->f_pos + offset;
169 break;
170 case 2: /* SEEK_END */
171 new_offset = vol->used_bytes + offset;
172 break;
173 default:
174 return -EINVAL;
175 }
176
177 if (new_offset < 0 || new_offset > vol->used_bytes) {
178 dbg_err("bad seek %lld", new_offset);
179 return -EINVAL;
180 }
181
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300182 dbg_gen("seek volume %d, offset %lld, origin %d, new offset %lld",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400183 vol->vol_id, offset, origin, new_offset);
184
185 file->f_pos = new_offset;
186 return new_offset;
187}
188
189static ssize_t vol_cdev_read(struct file *file, __user char *buf, size_t count,
190 loff_t *offp)
191{
192 struct ubi_volume_desc *desc = file->private_data;
193 struct ubi_volume *vol = desc->vol;
194 struct ubi_device *ubi = vol->ubi;
Artem Bityutskiyae616e12008-01-16 12:15:47 +0200195 int err, lnum, off, len, tbuf_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400196 size_t count_save = count;
197 void *tbuf;
198 uint64_t tmp;
199
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300200 dbg_gen("read %zd bytes from offset %lld of volume %d",
Artem Bityutskiyae616e12008-01-16 12:15:47 +0200201 count, *offp, vol->vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400202
203 if (vol->updating) {
204 dbg_err("updating");
205 return -EBUSY;
206 }
207 if (vol->upd_marker) {
208 dbg_err("damaged volume, update marker is set");
209 return -EBADF;
210 }
211 if (*offp == vol->used_bytes || count == 0)
212 return 0;
213
214 if (vol->corrupted)
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300215 dbg_gen("read from corrupted volume %d", vol->vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400216
217 if (*offp + count > vol->used_bytes)
218 count_save = count = vol->used_bytes - *offp;
219
220 tbuf_size = vol->usable_leb_size;
221 if (count < tbuf_size)
222 tbuf_size = ALIGN(count, ubi->min_io_size);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +0300223 tbuf = vmalloc(tbuf_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400224 if (!tbuf)
225 return -ENOMEM;
226
227 len = count > tbuf_size ? tbuf_size : count;
228
229 tmp = *offp;
230 off = do_div(tmp, vol->usable_leb_size);
231 lnum = tmp;
232
233 do {
234 cond_resched();
235
236 if (off + len >= vol->usable_leb_size)
237 len = vol->usable_leb_size - off;
238
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200239 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400240 if (err)
241 break;
242
243 off += len;
244 if (off == vol->usable_leb_size) {
245 lnum += 1;
246 off -= vol->usable_leb_size;
247 }
248
249 count -= len;
250 *offp += len;
251
252 err = copy_to_user(buf, tbuf, len);
253 if (err) {
254 err = -EFAULT;
255 break;
256 }
257
258 buf += len;
259 len = count > tbuf_size ? tbuf_size : count;
260 } while (count);
261
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +0300262 vfree(tbuf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400263 return err ? err : count_save - count;
264}
265
266#ifdef CONFIG_MTD_UBI_DEBUG_USERSPACE_IO
267
268/*
269 * This function allows to directly write to dynamic UBI volumes, without
270 * issuing the volume update operation. Available only as a debugging feature.
271 * Very useful for testing UBI.
272 */
273static ssize_t vol_cdev_direct_write(struct file *file, const char __user *buf,
274 size_t count, loff_t *offp)
275{
276 struct ubi_volume_desc *desc = file->private_data;
277 struct ubi_volume *vol = desc->vol;
278 struct ubi_device *ubi = vol->ubi;
Artem Bityutskiyae616e12008-01-16 12:15:47 +0200279 int lnum, off, len, tbuf_size, err = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400280 size_t count_save = count;
281 char *tbuf;
282 uint64_t tmp;
283
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300284 dbg_gen("requested: write %zd bytes to offset %lld of volume %u",
Artem Bityutskiyae616e12008-01-16 12:15:47 +0200285 count, *offp, vol->vol_id);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400286
287 if (vol->vol_type == UBI_STATIC_VOLUME)
288 return -EROFS;
289
290 tmp = *offp;
291 off = do_div(tmp, vol->usable_leb_size);
292 lnum = tmp;
293
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900294 if (off & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400295 dbg_err("unaligned position");
296 return -EINVAL;
297 }
298
299 if (*offp + count > vol->used_bytes)
300 count_save = count = vol->used_bytes - *offp;
301
302 /* We can write only in fractions of the minimum I/O unit */
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900303 if (count & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400304 dbg_err("unaligned write length");
305 return -EINVAL;
306 }
307
308 tbuf_size = vol->usable_leb_size;
309 if (count < tbuf_size)
310 tbuf_size = ALIGN(count, ubi->min_io_size);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +0300311 tbuf = vmalloc(tbuf_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400312 if (!tbuf)
313 return -ENOMEM;
314
315 len = count > tbuf_size ? tbuf_size : count;
316
317 while (count) {
318 cond_resched();
319
320 if (off + len >= vol->usable_leb_size)
321 len = vol->usable_leb_size - off;
322
323 err = copy_from_user(tbuf, buf, len);
324 if (err) {
325 err = -EFAULT;
326 break;
327 }
328
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200329 err = ubi_eba_write_leb(ubi, vol, lnum, tbuf, off, len,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400330 UBI_UNKNOWN);
331 if (err)
332 break;
333
334 off += len;
335 if (off == vol->usable_leb_size) {
336 lnum += 1;
337 off -= vol->usable_leb_size;
338 }
339
340 count -= len;
341 *offp += len;
342 buf += len;
343 len = count > tbuf_size ? tbuf_size : count;
344 }
345
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +0300346 vfree(tbuf);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400347 return err ? err : count_save - count;
348}
349
350#else
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300351#define vol_cdev_direct_write(file, buf, count, offp) (-EPERM)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400352#endif /* CONFIG_MTD_UBI_DEBUG_USERSPACE_IO */
353
354static ssize_t vol_cdev_write(struct file *file, const char __user *buf,
355 size_t count, loff_t *offp)
356{
357 int err = 0;
358 struct ubi_volume_desc *desc = file->private_data;
359 struct ubi_volume *vol = desc->vol;
360 struct ubi_device *ubi = vol->ubi;
361
Artem Bityutskiye6538792008-01-24 18:48:21 +0200362 if (!vol->updating && !vol->changing_leb)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400363 return vol_cdev_direct_write(file, buf, count, offp);
364
Artem Bityutskiye6538792008-01-24 18:48:21 +0200365 if (vol->updating)
366 err = ubi_more_update_data(ubi, vol, buf, count);
367 else
368 err = ubi_more_leb_change_data(ubi, vol, buf, count);
369
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400370 if (err < 0) {
Artem Bityutskiye6538792008-01-24 18:48:21 +0200371 ubi_err("cannot accept more %zd bytes of data, error %d",
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200372 count, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400373 return err;
374 }
375
376 if (err) {
377 /*
Artem Bityutskiye6538792008-01-24 18:48:21 +0200378 * The operation is finished, @err contains number of actually
379 * written bytes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400380 */
381 count = err;
382
Artem Bityutskiye6538792008-01-24 18:48:21 +0200383 if (vol->changing_leb) {
384 revoke_exclusive(desc, UBI_READWRITE);
385 return count;
386 }
387
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400388 err = ubi_check_volume(ubi, vol->vol_id);
389 if (err < 0)
390 return err;
391
392 if (err) {
393 ubi_warn("volume %d on UBI device %d is corrupted",
394 vol->vol_id, ubi->ubi_num);
395 vol->corrupted = 1;
396 }
397 vol->checked = 1;
Artem Bityutskiy941dfb02007-05-05 16:33:13 +0300398 ubi_gluebi_updated(vol);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400399 revoke_exclusive(desc, UBI_READWRITE);
400 }
401
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400402 return count;
403}
404
405static int vol_cdev_ioctl(struct inode *inode, struct file *file,
406 unsigned int cmd, unsigned long arg)
407{
408 int err = 0;
409 struct ubi_volume_desc *desc = file->private_data;
410 struct ubi_volume *vol = desc->vol;
411 struct ubi_device *ubi = vol->ubi;
412 void __user *argp = (void __user *)arg;
413
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400414 switch (cmd) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400415 /* Volume update command */
416 case UBI_IOCVOLUP:
417 {
418 int64_t bytes, rsvd_bytes;
419
420 if (!capable(CAP_SYS_RESOURCE)) {
421 err = -EPERM;
422 break;
423 }
424
425 err = copy_from_user(&bytes, argp, sizeof(int64_t));
426 if (err) {
427 err = -EFAULT;
428 break;
429 }
430
431 if (desc->mode == UBI_READONLY) {
432 err = -EROFS;
433 break;
434 }
435
Bruce Leonard73789a32008-07-03 10:35:49 +0300436 rsvd_bytes = (long long)vol->reserved_pebs *
437 ubi->leb_size-vol->data_pad;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400438 if (bytes < 0 || bytes > rsvd_bytes) {
439 err = -EINVAL;
440 break;
441 }
442
443 err = get_exclusive(desc);
444 if (err < 0)
445 break;
446
Artem Bityutskiy1b68d0e2008-01-24 17:04:01 +0200447 err = ubi_start_update(ubi, vol, bytes);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400448 if (bytes == 0)
449 revoke_exclusive(desc, UBI_READWRITE);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400450 break;
451 }
452
Artem Bityutskiye6538792008-01-24 18:48:21 +0200453 /* Atomic logical eraseblock change command */
454 case UBI_IOCEBCH:
455 {
456 struct ubi_leb_change_req req;
457
458 err = copy_from_user(&req, argp,
459 sizeof(struct ubi_leb_change_req));
460 if (err) {
461 err = -EFAULT;
462 break;
463 }
464
465 if (desc->mode == UBI_READONLY ||
466 vol->vol_type == UBI_STATIC_VOLUME) {
467 err = -EROFS;
468 break;
469 }
470
471 /* Validate the request */
472 err = -EINVAL;
473 if (req.lnum < 0 || req.lnum >= vol->reserved_pebs ||
474 req.bytes < 0 || req.lnum >= vol->usable_leb_size)
475 break;
476 if (req.dtype != UBI_LONGTERM && req.dtype != UBI_SHORTTERM &&
477 req.dtype != UBI_UNKNOWN)
478 break;
479
480 err = get_exclusive(desc);
481 if (err < 0)
482 break;
483
484 err = ubi_start_leb_change(ubi, vol, &req);
485 if (req.bytes == 0)
486 revoke_exclusive(desc, UBI_READWRITE);
487 break;
488 }
489
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400490#ifdef CONFIG_MTD_UBI_DEBUG_USERSPACE_IO
491 /* Logical eraseblock erasure command */
492 case UBI_IOCEBER:
493 {
494 int32_t lnum;
495
Christoph Hellwigbf078032007-05-17 16:32:10 +0200496 err = get_user(lnum, (__user int32_t *)argp);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400497 if (err) {
498 err = -EFAULT;
499 break;
500 }
501
Artem Bityutskiye6538792008-01-24 18:48:21 +0200502 if (desc->mode == UBI_READONLY ||
503 vol->vol_type == UBI_STATIC_VOLUME) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400504 err = -EROFS;
505 break;
506 }
507
508 if (lnum < 0 || lnum >= vol->reserved_pebs) {
509 err = -EINVAL;
510 break;
511 }
512
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300513 dbg_gen("erase LEB %d:%d", vol->vol_id, lnum);
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200514 err = ubi_eba_unmap_leb(ubi, vol, lnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400515 if (err)
516 break;
517
518 err = ubi_wl_flush(ubi);
519 break;
520 }
Corentin Chary141e6eb2009-01-05 14:44:11 +0100521
522 /* Logical eraseblock map command */
523 case UBI_IOCEBMAP:
524 {
525 struct ubi_map_req req;
526
527 err = copy_from_user(&req, argp, sizeof(struct ubi_map_req));
528 if (err) {
529 err = -EFAULT;
530 break;
531 }
532 err = ubi_leb_map(desc, req.lnum, req.dtype);
533 break;
534 }
Corentin Charyc3da23b2009-01-05 14:46:19 +0100535
536 /* Logical eraseblock un-map command */
537 case UBI_IOCEBUNMAP:
538 {
539 int32_t lnum;
540
541 err = get_user(lnum, (__user int32_t *)argp);
542 if (err) {
543 err = -EFAULT;
544 break;
545 }
546 err = ubi_leb_unmap(desc, lnum);
547 break;
548 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400549#endif
550
551 default:
552 err = -ENOTTY;
553 break;
554 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400555 return err;
556}
557
558/**
559 * verify_mkvol_req - verify volume creation request.
560 * @ubi: UBI device description object
561 * @req: the request to check
562 *
563 * This function zero if the request is correct, and %-EINVAL if not.
564 */
565static int verify_mkvol_req(const struct ubi_device *ubi,
566 const struct ubi_mkvol_req *req)
567{
568 int n, err = -EINVAL;
569
570 if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
571 req->name_len < 0)
572 goto bad;
573
574 if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
575 req->vol_id != UBI_VOL_NUM_AUTO)
576 goto bad;
577
578 if (req->alignment == 0)
579 goto bad;
580
581 if (req->bytes == 0)
582 goto bad;
583
584 if (req->vol_type != UBI_DYNAMIC_VOLUME &&
585 req->vol_type != UBI_STATIC_VOLUME)
586 goto bad;
587
588 if (req->alignment > ubi->leb_size)
589 goto bad;
590
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900591 n = req->alignment & (ubi->min_io_size - 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400592 if (req->alignment != 1 && n)
593 goto bad;
594
595 if (req->name_len > UBI_VOL_NAME_MAX) {
596 err = -ENAMETOOLONG;
597 goto bad;
598 }
599
Artem Bityutskiya6ea4402008-07-13 21:46:24 +0300600 n = strnlen(req->name, req->name_len + 1);
601 if (n != req->name_len)
602 goto bad;
603
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400604 return 0;
605
606bad:
607 dbg_err("bad volume creation request");
608 ubi_dbg_dump_mkvol_req(req);
609 return err;
610}
611
612/**
613 * verify_rsvol_req - verify volume re-size request.
614 * @ubi: UBI device description object
615 * @req: the request to check
616 *
617 * This function returns zero if the request is correct, and %-EINVAL if not.
618 */
619static int verify_rsvol_req(const struct ubi_device *ubi,
620 const struct ubi_rsvol_req *req)
621{
622 if (req->bytes <= 0)
623 return -EINVAL;
624
625 if (req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots)
626 return -EINVAL;
627
628 return 0;
629}
630
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300631/**
632 * rename_volumes - rename UBI volumes.
633 * @ubi: UBI device description object
634 * @req: volumes re-name request
635 *
636 * This is a helper function for the volume re-name IOCTL which validates the
637 * the request, opens the volume and calls corresponding volumes management
638 * function. Returns zero in case of success and a negative error code in case
639 * of failure.
640 */
641static int rename_volumes(struct ubi_device *ubi,
642 struct ubi_rnvol_req *req)
643{
644 int i, n, err;
645 struct list_head rename_list;
646 struct ubi_rename_entry *re, *re1;
647
648 if (req->count < 0 || req->count > UBI_MAX_RNVOL)
649 return -EINVAL;
650
651 if (req->count == 0)
652 return 0;
653
654 /* Validate volume IDs and names in the request */
655 for (i = 0; i < req->count; i++) {
656 if (req->ents[i].vol_id < 0 ||
657 req->ents[i].vol_id >= ubi->vtbl_slots)
658 return -EINVAL;
659 if (req->ents[i].name_len < 0)
660 return -EINVAL;
661 if (req->ents[i].name_len > UBI_VOL_NAME_MAX)
662 return -ENAMETOOLONG;
663 req->ents[i].name[req->ents[i].name_len] = '\0';
664 n = strlen(req->ents[i].name);
665 if (n != req->ents[i].name_len)
666 err = -EINVAL;
667 }
668
669 /* Make sure volume IDs and names are unique */
670 for (i = 0; i < req->count - 1; i++) {
671 for (n = i + 1; n < req->count; n++) {
672 if (req->ents[i].vol_id == req->ents[n].vol_id) {
673 dbg_err("duplicated volume id %d",
674 req->ents[i].vol_id);
675 return -EINVAL;
676 }
677 if (!strcmp(req->ents[i].name, req->ents[n].name)) {
678 dbg_err("duplicated volume name \"%s\"",
679 req->ents[i].name);
680 return -EINVAL;
681 }
682 }
683 }
684
685 /* Create the re-name list */
686 INIT_LIST_HEAD(&rename_list);
687 for (i = 0; i < req->count; i++) {
688 int vol_id = req->ents[i].vol_id;
689 int name_len = req->ents[i].name_len;
690 const char *name = req->ents[i].name;
691
692 re = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
693 if (!re) {
694 err = -ENOMEM;
695 goto out_free;
696 }
697
698 re->desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
699 if (IS_ERR(re->desc)) {
700 err = PTR_ERR(re->desc);
701 dbg_err("cannot open volume %d, error %d", vol_id, err);
702 kfree(re);
703 goto out_free;
704 }
705
706 /* Skip this re-naming if the name does not really change */
707 if (re->desc->vol->name_len == name_len &&
708 !memcmp(re->desc->vol->name, name, name_len)) {
709 ubi_close_volume(re->desc);
710 kfree(re);
711 continue;
712 }
713
714 re->new_name_len = name_len;
715 memcpy(re->new_name, name, name_len);
716 list_add_tail(&re->list, &rename_list);
717 dbg_msg("will rename volume %d from \"%s\" to \"%s\"",
718 vol_id, re->desc->vol->name, name);
719 }
720
721 if (list_empty(&rename_list))
722 return 0;
723
724 /* Find out the volumes which have to be removed */
725 list_for_each_entry(re, &rename_list, list) {
726 struct ubi_volume_desc *desc;
727 int no_remove_needed = 0;
728
729 /*
730 * Volume @re->vol_id is going to be re-named to
731 * @re->new_name, while its current name is @name. If a volume
732 * with name @re->new_name currently exists, it has to be
733 * removed, unless it is also re-named in the request (@req).
734 */
735 list_for_each_entry(re1, &rename_list, list) {
736 if (re->new_name_len == re1->desc->vol->name_len &&
737 !memcmp(re->new_name, re1->desc->vol->name,
738 re1->desc->vol->name_len)) {
739 no_remove_needed = 1;
740 break;
741 }
742 }
743
744 if (no_remove_needed)
745 continue;
746
747 /*
748 * It seems we need to remove volume with name @re->new_name,
749 * if it exists.
750 */
Artem Bityutskiyf2863c52008-12-28 12:20:51 +0200751 desc = ubi_open_volume_nm(ubi->ubi_num, re->new_name,
752 UBI_EXCLUSIVE);
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300753 if (IS_ERR(desc)) {
754 err = PTR_ERR(desc);
755 if (err == -ENODEV)
756 /* Re-naming into a non-existing volume name */
757 continue;
758
759 /* The volume exists but busy, or an error occurred */
760 dbg_err("cannot open volume \"%s\", error %d",
761 re->new_name, err);
762 goto out_free;
763 }
764
765 re = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
766 if (!re) {
767 err = -ENOMEM;
768 ubi_close_volume(desc);
769 goto out_free;
770 }
771
772 re->remove = 1;
773 re->desc = desc;
774 list_add(&re->list, &rename_list);
775 dbg_msg("will remove volume %d, name \"%s\"",
776 re->desc->vol->vol_id, re->desc->vol->name);
777 }
778
779 mutex_lock(&ubi->volumes_mutex);
780 err = ubi_rename_volumes(ubi, &rename_list);
781 mutex_unlock(&ubi->volumes_mutex);
782
783out_free:
784 list_for_each_entry_safe(re, re1, &rename_list, list) {
785 ubi_close_volume(re->desc);
786 list_del(&re->list);
787 kfree(re);
788 }
789 return err;
790}
791
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400792static int ubi_cdev_ioctl(struct inode *inode, struct file *file,
793 unsigned int cmd, unsigned long arg)
794{
795 int err = 0;
796 struct ubi_device *ubi;
797 struct ubi_volume_desc *desc;
798 void __user *argp = (void __user *)arg;
799
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400800 if (!capable(CAP_SYS_RESOURCE))
801 return -EPERM;
802
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200803 ubi = ubi_get_by_major(imajor(inode));
804 if (!ubi)
805 return -ENODEV;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400806
807 switch (cmd) {
808 /* Create volume command */
809 case UBI_IOCMKVOL:
810 {
811 struct ubi_mkvol_req req;
812
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300813 dbg_gen("create volume");
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200814 err = copy_from_user(&req, argp, sizeof(struct ubi_mkvol_req));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400815 if (err) {
816 err = -EFAULT;
817 break;
818 }
819
Artem Bityutskiya6ea4402008-07-13 21:46:24 +0300820 req.name[req.name_len] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400821 err = verify_mkvol_req(ubi, &req);
822 if (err)
823 break;
824
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200825 mutex_lock(&ubi->volumes_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400826 err = ubi_create_volume(ubi, &req);
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200827 mutex_unlock(&ubi->volumes_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400828 if (err)
829 break;
830
Christoph Hellwigbf078032007-05-17 16:32:10 +0200831 err = put_user(req.vol_id, (__user int32_t *)argp);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400832 if (err)
833 err = -EFAULT;
834
835 break;
836 }
837
838 /* Remove volume command */
839 case UBI_IOCRMVOL:
840 {
841 int vol_id;
842
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300843 dbg_gen("remove volume");
Christoph Hellwigbf078032007-05-17 16:32:10 +0200844 err = get_user(vol_id, (__user int32_t *)argp);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400845 if (err) {
846 err = -EFAULT;
847 break;
848 }
849
850 desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
851 if (IS_ERR(desc)) {
852 err = PTR_ERR(desc);
853 break;
854 }
855
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200856 mutex_lock(&ubi->volumes_mutex);
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300857 err = ubi_remove_volume(desc, 0);
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200858 mutex_unlock(&ubi->volumes_mutex);
859
Artem Bityutskiy450f8722007-12-17 13:09:09 +0200860 /*
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200861 * The volume is deleted (unless an error occurred), and the
862 * 'struct ubi_volume' object will be freed when
863 * 'ubi_close_volume()' will call 'put_device()'.
Artem Bityutskiy450f8722007-12-17 13:09:09 +0200864 */
865 ubi_close_volume(desc);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400866 break;
867 }
868
869 /* Re-size volume command */
870 case UBI_IOCRSVOL:
871 {
872 int pebs;
873 uint64_t tmp;
874 struct ubi_rsvol_req req;
875
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300876 dbg_gen("re-size volume");
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200877 err = copy_from_user(&req, argp, sizeof(struct ubi_rsvol_req));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400878 if (err) {
879 err = -EFAULT;
880 break;
881 }
882
883 err = verify_rsvol_req(ubi, &req);
884 if (err)
885 break;
886
887 desc = ubi_open_volume(ubi->ubi_num, req.vol_id, UBI_EXCLUSIVE);
888 if (IS_ERR(desc)) {
889 err = PTR_ERR(desc);
890 break;
891 }
892
893 tmp = req.bytes;
894 pebs = !!do_div(tmp, desc->vol->usable_leb_size);
895 pebs += tmp;
896
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200897 mutex_lock(&ubi->volumes_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400898 err = ubi_resize_volume(desc, pebs);
Artem Bityutskiy40e4d0c2007-12-17 17:08:55 +0200899 mutex_unlock(&ubi->volumes_mutex);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400900 ubi_close_volume(desc);
901 break;
902 }
903
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300904 /* Re-name volumes command */
905 case UBI_IOCRNVOL:
906 {
907 struct ubi_rnvol_req *req;
908
909 dbg_msg("re-name volumes");
910 req = kmalloc(sizeof(struct ubi_rnvol_req), GFP_KERNEL);
911 if (!req) {
912 err = -ENOMEM;
913 break;
914 };
915
916 err = copy_from_user(req, argp, sizeof(struct ubi_rnvol_req));
917 if (err) {
918 err = -EFAULT;
919 kfree(req);
920 break;
921 }
922
923 mutex_lock(&ubi->mult_mutex);
924 err = rename_volumes(ubi, req);
925 mutex_unlock(&ubi->mult_mutex);
926 kfree(req);
927 break;
928 }
929
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400930 default:
931 err = -ENOTTY;
932 break;
933 }
934
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200935 ubi_put_device(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400936 return err;
937}
938
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200939static int ctrl_cdev_ioctl(struct inode *inode, struct file *file,
940 unsigned int cmd, unsigned long arg)
941{
942 int err = 0;
943 void __user *argp = (void __user *)arg;
944
945 if (!capable(CAP_SYS_RESOURCE))
946 return -EPERM;
947
948 switch (cmd) {
949 /* Attach an MTD device command */
950 case UBI_IOCATT:
951 {
952 struct ubi_attach_req req;
953 struct mtd_info *mtd;
954
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300955 dbg_gen("attach MTD device");
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200956 err = copy_from_user(&req, argp, sizeof(struct ubi_attach_req));
957 if (err) {
958 err = -EFAULT;
959 break;
960 }
961
962 if (req.mtd_num < 0 ||
963 (req.ubi_num < 0 && req.ubi_num != UBI_DEV_NUM_AUTO)) {
964 err = -EINVAL;
965 break;
966 }
967
968 mtd = get_mtd_device(NULL, req.mtd_num);
969 if (IS_ERR(mtd)) {
970 err = PTR_ERR(mtd);
971 break;
972 }
973
974 /*
975 * Note, further request verification is done by
976 * 'ubi_attach_mtd_dev()'.
977 */
978 mutex_lock(&ubi_devices_mutex);
979 err = ubi_attach_mtd_dev(mtd, req.ubi_num, req.vid_hdr_offset);
980 mutex_unlock(&ubi_devices_mutex);
981 if (err < 0)
982 put_mtd_device(mtd);
983 else
984 /* @err contains UBI device number */
985 err = put_user(err, (__user int32_t *)argp);
986
987 break;
988 }
989
990 /* Detach an MTD device command */
991 case UBI_IOCDET:
992 {
993 int ubi_num;
994
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300995 dbg_gen("dettach MTD device");
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200996 err = get_user(ubi_num, (__user int32_t *)argp);
997 if (err) {
998 err = -EFAULT;
999 break;
1000 }
1001
1002 mutex_lock(&ubi_devices_mutex);
1003 err = ubi_detach_mtd_dev(ubi_num, 0);
1004 mutex_unlock(&ubi_devices_mutex);
1005 break;
1006 }
1007
1008 default:
1009 err = -ENOTTY;
1010 break;
1011 }
1012
1013 return err;
1014}
1015
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001016/* UBI control character device operations */
1017struct file_operations ubi_ctrl_cdev_operations = {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001018 .ioctl = ctrl_cdev_ioctl,
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001019 .owner = THIS_MODULE,
1020};
1021
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001022/* UBI character device operations */
1023struct file_operations ubi_cdev_operations = {
1024 .owner = THIS_MODULE,
1025 .ioctl = ubi_cdev_ioctl,
Artem Bityutskiyf800f092007-05-06 16:45:43 +03001026 .llseek = no_llseek,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001027};
1028
1029/* UBI volume character device operations */
1030struct file_operations ubi_vol_cdev_operations = {
1031 .owner = THIS_MODULE,
1032 .open = vol_cdev_open,
1033 .release = vol_cdev_release,
1034 .llseek = vol_cdev_llseek,
1035 .read = vol_cdev_read,
1036 .write = vol_cdev_write,
Artem Bityutskiyf800f092007-05-06 16:45:43 +03001037 .ioctl = vol_cdev_ioctl,
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001038};