2 * Copyright (c) International Business Machines Corp., 2006
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.
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.
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
18 * Author: Artem Bityutskiy (Битюцкий Артём)
22 * This file includes implementation of UBI character device operations.
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.
29 * Major and minor numbers are assigned dynamically to both UBI and volume
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
38 #include <linux/module.h>
39 #include <linux/stat.h>
40 #include <linux/slab.h>
41 #include <linux/ioctl.h>
42 #include <linux/capability.h>
43 #include <linux/uaccess.h>
44 #include <linux/compat.h>
45 #include <linux/math64.h>
46 #include <mtd/ubi-user.h>
50 * get_exclusive - get exclusive access to an UBI volume.
51 * @desc: volume descriptor
53 * This function changes UBI volume open mode to "exclusive". Returns previous
54 * mode value (positive integer) in case of success and a negative error code
57 static int get_exclusive(struct ubi_volume_desc *desc)
60 struct ubi_volume *vol = desc->vol;
62 spin_lock(&vol->ubi->volumes_lock);
63 users = vol->readers + vol->writers + vol->exclusive;
64 ubi_assert(users > 0);
66 ubi_err("%d users for volume %d", users, vol->vol_id);
69 vol->readers = vol->writers = 0;
72 desc->mode = UBI_EXCLUSIVE;
74 spin_unlock(&vol->ubi->volumes_lock);
80 * revoke_exclusive - revoke exclusive mode.
81 * @desc: volume descriptor
82 * @mode: new mode to switch to
84 static void revoke_exclusive(struct ubi_volume_desc *desc, int mode)
86 struct ubi_volume *vol = desc->vol;
88 spin_lock(&vol->ubi->volumes_lock);
89 ubi_assert(vol->readers == 0 && vol->writers == 0);
90 ubi_assert(vol->exclusive == 1 && desc->mode == UBI_EXCLUSIVE);
92 if (mode == UBI_READONLY)
94 else if (mode == UBI_READWRITE)
98 spin_unlock(&vol->ubi->volumes_lock);
103 static int vol_cdev_open(struct inode *inode, struct file *file)
105 struct ubi_volume_desc *desc;
106 int vol_id = iminor(inode) - 1, mode, ubi_num;
108 ubi_num = ubi_major2num(imajor(inode));
112 if (file->f_mode & FMODE_WRITE)
113 mode = UBI_READWRITE;
117 dbg_gen("open device %d, volume %d, mode %d",
118 ubi_num, vol_id, mode);
120 desc = ubi_open_volume(ubi_num, vol_id, mode);
122 return PTR_ERR(desc);
124 file->private_data = desc;
128 static int vol_cdev_release(struct inode *inode, struct file *file)
130 struct ubi_volume_desc *desc = file->private_data;
131 struct ubi_volume *vol = desc->vol;
133 dbg_gen("release device %d, volume %d, mode %d",
134 vol->ubi->ubi_num, vol->vol_id, desc->mode);
137 ubi_warn("update of volume %d not finished, volume is damaged",
139 ubi_assert(!vol->changing_leb);
142 } else if (vol->changing_leb) {
143 dbg_gen("only %lld of %lld bytes received for atomic LEB change"
144 " for volume %d:%d, cancel", vol->upd_received,
145 vol->upd_bytes, vol->ubi->ubi_num, vol->vol_id);
146 vol->changing_leb = 0;
150 ubi_close_volume(desc);
154 static loff_t vol_cdev_llseek(struct file *file, loff_t offset, int origin)
156 struct ubi_volume_desc *desc = file->private_data;
157 struct ubi_volume *vol = desc->vol;
161 /* Update is in progress, seeking is prohibited */
167 case 0: /* SEEK_SET */
170 case 1: /* SEEK_CUR */
171 new_offset = file->f_pos + offset;
173 case 2: /* SEEK_END */
174 new_offset = vol->used_bytes + offset;
180 if (new_offset < 0 || new_offset > vol->used_bytes) {
181 ubi_err("bad seek %lld", new_offset);
185 dbg_gen("seek volume %d, offset %lld, origin %d, new offset %lld",
186 vol->vol_id, offset, origin, new_offset);
188 file->f_pos = new_offset;
192 static int vol_cdev_fsync(struct file *file, loff_t start, loff_t end, int datasync)
194 struct ubi_volume_desc *desc = file->private_data;
195 struct ubi_device *ubi = desc->vol->ubi;
196 struct inode *inode = file->f_path.dentry->d_inode;
198 mutex_lock(&inode->i_mutex);
199 err = ubi_sync(ubi->ubi_num);
200 mutex_unlock(&inode->i_mutex);
205 static ssize_t vol_cdev_read(struct file *file, __user char *buf, size_t count,
208 struct ubi_volume_desc *desc = file->private_data;
209 struct ubi_volume *vol = desc->vol;
210 struct ubi_device *ubi = vol->ubi;
211 int err, lnum, off, len, tbuf_size;
212 size_t count_save = count;
215 dbg_gen("read %zd bytes from offset %lld of volume %d",
216 count, *offp, vol->vol_id);
222 if (vol->upd_marker) {
223 ubi_err("damaged volume, update marker is set");
226 if (*offp == vol->used_bytes || count == 0)
230 dbg_gen("read from corrupted volume %d", vol->vol_id);
232 if (*offp + count > vol->used_bytes)
233 count_save = count = vol->used_bytes - *offp;
235 tbuf_size = vol->usable_leb_size;
236 if (count < tbuf_size)
237 tbuf_size = ALIGN(count, ubi->min_io_size);
238 tbuf = vmalloc(tbuf_size);
242 len = count > tbuf_size ? tbuf_size : count;
243 lnum = div_u64_rem(*offp, vol->usable_leb_size, &off);
248 if (off + len >= vol->usable_leb_size)
249 len = vol->usable_leb_size - off;
251 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
256 if (off == vol->usable_leb_size) {
258 off -= vol->usable_leb_size;
264 err = copy_to_user(buf, tbuf, len);
271 len = count > tbuf_size ? tbuf_size : count;
275 return err ? err : count_save - count;
279 * This function allows to directly write to dynamic UBI volumes, without
280 * issuing the volume update operation.
282 static ssize_t vol_cdev_direct_write(struct file *file, const char __user *buf,
283 size_t count, loff_t *offp)
285 struct ubi_volume_desc *desc = file->private_data;
286 struct ubi_volume *vol = desc->vol;
287 struct ubi_device *ubi = vol->ubi;
288 int lnum, off, len, tbuf_size, err = 0;
289 size_t count_save = count;
292 if (!vol->direct_writes)
295 dbg_gen("requested: write %zd bytes to offset %lld of volume %u",
296 count, *offp, vol->vol_id);
298 if (vol->vol_type == UBI_STATIC_VOLUME)
301 lnum = div_u64_rem(*offp, vol->usable_leb_size, &off);
302 if (off & (ubi->min_io_size - 1)) {
303 ubi_err("unaligned position");
307 if (*offp + count > vol->used_bytes)
308 count_save = count = vol->used_bytes - *offp;
310 /* We can write only in fractions of the minimum I/O unit */
311 if (count & (ubi->min_io_size - 1)) {
312 ubi_err("unaligned write length");
316 tbuf_size = vol->usable_leb_size;
317 if (count < tbuf_size)
318 tbuf_size = ALIGN(count, ubi->min_io_size);
319 tbuf = vmalloc(tbuf_size);
323 len = count > tbuf_size ? tbuf_size : count;
328 if (off + len >= vol->usable_leb_size)
329 len = vol->usable_leb_size - off;
331 err = copy_from_user(tbuf, buf, len);
337 err = ubi_eba_write_leb(ubi, vol, lnum, tbuf, off, len);
342 if (off == vol->usable_leb_size) {
344 off -= vol->usable_leb_size;
350 len = count > tbuf_size ? tbuf_size : count;
354 return err ? err : count_save - count;
357 static ssize_t vol_cdev_write(struct file *file, const char __user *buf,
358 size_t count, loff_t *offp)
361 struct ubi_volume_desc *desc = file->private_data;
362 struct ubi_volume *vol = desc->vol;
363 struct ubi_device *ubi = vol->ubi;
365 if (!vol->updating && !vol->changing_leb)
366 return vol_cdev_direct_write(file, buf, count, offp);
369 err = ubi_more_update_data(ubi, vol, buf, count);
371 err = ubi_more_leb_change_data(ubi, vol, buf, count);
374 ubi_err("cannot accept more %zd bytes of data, error %d",
381 * The operation is finished, @err contains number of actually
386 if (vol->changing_leb) {
387 revoke_exclusive(desc, UBI_READWRITE);
391 err = ubi_check_volume(ubi, vol->vol_id);
396 ubi_warn("volume %d on UBI device %d is corrupted",
397 vol->vol_id, ubi->ubi_num);
401 ubi_volume_notify(ubi, vol, UBI_VOLUME_UPDATED);
402 revoke_exclusive(desc, UBI_READWRITE);
408 static long vol_cdev_ioctl(struct file *file, unsigned int cmd,
412 struct ubi_volume_desc *desc = file->private_data;
413 struct ubi_volume *vol = desc->vol;
414 struct ubi_device *ubi = vol->ubi;
415 void __user *argp = (void __user *)arg;
418 /* Volume update command */
421 int64_t bytes, rsvd_bytes;
423 if (!capable(CAP_SYS_RESOURCE)) {
428 err = copy_from_user(&bytes, argp, sizeof(int64_t));
434 if (desc->mode == UBI_READONLY) {
439 rsvd_bytes = (long long)vol->reserved_pebs *
440 ubi->leb_size-vol->data_pad;
441 if (bytes < 0 || bytes > rsvd_bytes) {
446 err = get_exclusive(desc);
450 err = ubi_start_update(ubi, vol, bytes);
452 revoke_exclusive(desc, UBI_READWRITE);
456 /* Atomic logical eraseblock change command */
459 struct ubi_leb_change_req req;
461 err = copy_from_user(&req, argp,
462 sizeof(struct ubi_leb_change_req));
468 if (desc->mode == UBI_READONLY ||
469 vol->vol_type == UBI_STATIC_VOLUME) {
474 /* Validate the request */
476 if (req.lnum < 0 || req.lnum >= vol->reserved_pebs ||
477 req.bytes < 0 || req.lnum >= vol->usable_leb_size)
480 err = get_exclusive(desc);
484 err = ubi_start_leb_change(ubi, vol, &req);
486 revoke_exclusive(desc, UBI_READWRITE);
490 /* Logical eraseblock erasure command */
495 err = get_user(lnum, (__user int32_t *)argp);
501 if (desc->mode == UBI_READONLY ||
502 vol->vol_type == UBI_STATIC_VOLUME) {
507 if (lnum < 0 || lnum >= vol->reserved_pebs) {
512 dbg_gen("erase LEB %d:%d", vol->vol_id, lnum);
513 err = ubi_eba_unmap_leb(ubi, vol, lnum);
517 err = ubi_wl_flush(ubi, UBI_ALL, UBI_ALL);
521 /* Logical eraseblock map command */
524 struct ubi_map_req req;
526 err = copy_from_user(&req, argp, sizeof(struct ubi_map_req));
531 err = ubi_leb_map(desc, req.lnum);
535 /* Logical eraseblock un-map command */
540 err = get_user(lnum, (__user int32_t *)argp);
545 err = ubi_leb_unmap(desc, lnum);
549 /* Check if logical eraseblock is mapped command */
554 err = get_user(lnum, (__user int32_t *)argp);
559 err = ubi_is_mapped(desc, lnum);
563 /* Set volume property command */
564 case UBI_IOCSETVOLPROP:
566 struct ubi_set_vol_prop_req req;
568 err = copy_from_user(&req, argp,
569 sizeof(struct ubi_set_vol_prop_req));
574 switch (req.property) {
575 case UBI_VOL_PROP_DIRECT_WRITE:
576 mutex_lock(&ubi->device_mutex);
577 desc->vol->direct_writes = !!req.value;
578 mutex_unlock(&ubi->device_mutex);
595 * verify_mkvol_req - verify volume creation request.
596 * @ubi: UBI device description object
597 * @req: the request to check
599 * This function zero if the request is correct, and %-EINVAL if not.
601 static int verify_mkvol_req(const struct ubi_device *ubi,
602 const struct ubi_mkvol_req *req)
604 int n, err = -EINVAL;
606 if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
610 if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
611 req->vol_id != UBI_VOL_NUM_AUTO)
614 if (req->alignment == 0)
620 if (req->vol_type != UBI_DYNAMIC_VOLUME &&
621 req->vol_type != UBI_STATIC_VOLUME)
624 if (req->alignment > ubi->leb_size)
627 n = req->alignment & (ubi->min_io_size - 1);
628 if (req->alignment != 1 && n)
631 if (!req->name[0] || !req->name_len)
634 if (req->name_len > UBI_VOL_NAME_MAX) {
639 n = strnlen(req->name, req->name_len + 1);
640 if (n != req->name_len)
646 ubi_err("bad volume creation request");
647 ubi_dump_mkvol_req(req);
652 * verify_rsvol_req - verify volume re-size request.
653 * @ubi: UBI device description object
654 * @req: the request to check
656 * This function returns zero if the request is correct, and %-EINVAL if not.
658 static int verify_rsvol_req(const struct ubi_device *ubi,
659 const struct ubi_rsvol_req *req)
664 if (req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots)
671 * rename_volumes - rename UBI volumes.
672 * @ubi: UBI device description object
673 * @req: volumes re-name request
675 * This is a helper function for the volume re-name IOCTL which validates the
676 * the request, opens the volume and calls corresponding volumes management
677 * function. Returns zero in case of success and a negative error code in case
680 static int rename_volumes(struct ubi_device *ubi,
681 struct ubi_rnvol_req *req)
684 struct list_head rename_list;
685 struct ubi_rename_entry *re, *re1;
687 if (req->count < 0 || req->count > UBI_MAX_RNVOL)
693 /* Validate volume IDs and names in the request */
694 for (i = 0; i < req->count; i++) {
695 if (req->ents[i].vol_id < 0 ||
696 req->ents[i].vol_id >= ubi->vtbl_slots)
698 if (req->ents[i].name_len < 0)
700 if (req->ents[i].name_len > UBI_VOL_NAME_MAX)
701 return -ENAMETOOLONG;
702 req->ents[i].name[req->ents[i].name_len] = '\0';
703 n = strlen(req->ents[i].name);
704 if (n != req->ents[i].name_len)
708 /* Make sure volume IDs and names are unique */
709 for (i = 0; i < req->count - 1; i++) {
710 for (n = i + 1; n < req->count; n++) {
711 if (req->ents[i].vol_id == req->ents[n].vol_id) {
712 ubi_err("duplicated volume id %d",
713 req->ents[i].vol_id);
716 if (!strcmp(req->ents[i].name, req->ents[n].name)) {
717 ubi_err("duplicated volume name \"%s\"",
724 /* Create the re-name list */
725 INIT_LIST_HEAD(&rename_list);
726 for (i = 0; i < req->count; i++) {
727 int vol_id = req->ents[i].vol_id;
728 int name_len = req->ents[i].name_len;
729 const char *name = req->ents[i].name;
731 re = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
737 re->desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
738 if (IS_ERR(re->desc)) {
739 err = PTR_ERR(re->desc);
740 ubi_err("cannot open volume %d, error %d", vol_id, err);
745 /* Skip this re-naming if the name does not really change */
746 if (re->desc->vol->name_len == name_len &&
747 !memcmp(re->desc->vol->name, name, name_len)) {
748 ubi_close_volume(re->desc);
753 re->new_name_len = name_len;
754 memcpy(re->new_name, name, name_len);
755 list_add_tail(&re->list, &rename_list);
756 dbg_msg("will rename volume %d from \"%s\" to \"%s\"",
757 vol_id, re->desc->vol->name, name);
760 if (list_empty(&rename_list))
763 /* Find out the volumes which have to be removed */
764 list_for_each_entry(re, &rename_list, list) {
765 struct ubi_volume_desc *desc;
766 int no_remove_needed = 0;
769 * Volume @re->vol_id is going to be re-named to
770 * @re->new_name, while its current name is @name. If a volume
771 * with name @re->new_name currently exists, it has to be
772 * removed, unless it is also re-named in the request (@req).
774 list_for_each_entry(re1, &rename_list, list) {
775 if (re->new_name_len == re1->desc->vol->name_len &&
776 !memcmp(re->new_name, re1->desc->vol->name,
777 re1->desc->vol->name_len)) {
778 no_remove_needed = 1;
783 if (no_remove_needed)
787 * It seems we need to remove volume with name @re->new_name,
790 desc = ubi_open_volume_nm(ubi->ubi_num, re->new_name,
795 /* Re-naming into a non-existing volume name */
798 /* The volume exists but busy, or an error occurred */
799 ubi_err("cannot open volume \"%s\", error %d",
804 re1 = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
807 ubi_close_volume(desc);
813 list_add(&re1->list, &rename_list);
814 dbg_msg("will remove volume %d, name \"%s\"",
815 re1->desc->vol->vol_id, re1->desc->vol->name);
818 mutex_lock(&ubi->device_mutex);
819 err = ubi_rename_volumes(ubi, &rename_list);
820 mutex_unlock(&ubi->device_mutex);
823 list_for_each_entry_safe(re, re1, &rename_list, list) {
824 ubi_close_volume(re->desc);
831 static long ubi_cdev_ioctl(struct file *file, unsigned int cmd,
835 struct ubi_device *ubi;
836 struct ubi_volume_desc *desc;
837 void __user *argp = (void __user *)arg;
839 if (!capable(CAP_SYS_RESOURCE))
842 ubi = ubi_get_by_major(imajor(file->f_mapping->host));
847 /* Create volume command */
850 struct ubi_mkvol_req req;
852 dbg_gen("create volume");
853 err = copy_from_user(&req, argp, sizeof(struct ubi_mkvol_req));
859 err = verify_mkvol_req(ubi, &req);
863 mutex_lock(&ubi->device_mutex);
864 err = ubi_create_volume(ubi, &req);
865 mutex_unlock(&ubi->device_mutex);
869 err = put_user(req.vol_id, (__user int32_t *)argp);
876 /* Remove volume command */
881 dbg_gen("remove volume");
882 err = get_user(vol_id, (__user int32_t *)argp);
888 desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
894 mutex_lock(&ubi->device_mutex);
895 err = ubi_remove_volume(desc, 0);
896 mutex_unlock(&ubi->device_mutex);
899 * The volume is deleted (unless an error occurred), and the
900 * 'struct ubi_volume' object will be freed when
901 * 'ubi_close_volume()' will call 'put_device()'.
903 ubi_close_volume(desc);
907 /* Re-size volume command */
911 struct ubi_rsvol_req req;
913 dbg_gen("re-size volume");
914 err = copy_from_user(&req, argp, sizeof(struct ubi_rsvol_req));
920 err = verify_rsvol_req(ubi, &req);
924 desc = ubi_open_volume(ubi->ubi_num, req.vol_id, UBI_EXCLUSIVE);
930 pebs = div_u64(req.bytes + desc->vol->usable_leb_size - 1,
931 desc->vol->usable_leb_size);
933 mutex_lock(&ubi->device_mutex);
934 err = ubi_resize_volume(desc, pebs);
935 mutex_unlock(&ubi->device_mutex);
936 ubi_close_volume(desc);
940 /* Re-name volumes command */
943 struct ubi_rnvol_req *req;
945 dbg_msg("re-name volumes");
946 req = kmalloc(sizeof(struct ubi_rnvol_req), GFP_KERNEL);
952 err = copy_from_user(req, argp, sizeof(struct ubi_rnvol_req));
959 err = rename_volumes(ubi, req);
973 static long ctrl_cdev_ioctl(struct file *file, unsigned int cmd,
977 void __user *argp = (void __user *)arg;
979 if (!capable(CAP_SYS_RESOURCE))
983 /* Attach an MTD device command */
986 struct ubi_attach_req req;
987 struct mtd_info *mtd;
989 dbg_gen("attach MTD device");
990 err = copy_from_user(&req, argp, sizeof(struct ubi_attach_req));
996 if (req.mtd_num < 0 ||
997 (req.ubi_num < 0 && req.ubi_num != UBI_DEV_NUM_AUTO)) {
1002 mtd = get_mtd_device(NULL, req.mtd_num);
1009 * Note, further request verification is done by
1010 * 'ubi_attach_mtd_dev()'.
1012 mutex_lock(&ubi_devices_mutex);
1013 err = ubi_attach_mtd_dev(mtd, req.ubi_num, req.vid_hdr_offset);
1014 mutex_unlock(&ubi_devices_mutex);
1016 put_mtd_device(mtd);
1018 /* @err contains UBI device number */
1019 err = put_user(err, (__user int32_t *)argp);
1024 /* Detach an MTD device command */
1029 dbg_gen("detach MTD device");
1030 err = get_user(ubi_num, (__user int32_t *)argp);
1036 mutex_lock(&ubi_devices_mutex);
1037 err = ubi_detach_mtd_dev(ubi_num, 0);
1038 mutex_unlock(&ubi_devices_mutex);
1050 #ifdef CONFIG_COMPAT
1051 static long vol_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1054 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1056 return vol_cdev_ioctl(file, cmd, translated_arg);
1059 static long ubi_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1062 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1064 return ubi_cdev_ioctl(file, cmd, translated_arg);
1067 static long ctrl_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1070 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1072 return ctrl_cdev_ioctl(file, cmd, translated_arg);
1075 #define vol_cdev_compat_ioctl NULL
1076 #define ubi_cdev_compat_ioctl NULL
1077 #define ctrl_cdev_compat_ioctl NULL
1080 /* UBI volume character device operations */
1081 const struct file_operations ubi_vol_cdev_operations = {
1082 .owner = THIS_MODULE,
1083 .open = vol_cdev_open,
1084 .release = vol_cdev_release,
1085 .llseek = vol_cdev_llseek,
1086 .read = vol_cdev_read,
1087 .write = vol_cdev_write,
1088 .fsync = vol_cdev_fsync,
1089 .unlocked_ioctl = vol_cdev_ioctl,
1090 .compat_ioctl = vol_cdev_compat_ioctl,
1093 /* UBI character device operations */
1094 const struct file_operations ubi_cdev_operations = {
1095 .owner = THIS_MODULE,
1096 .llseek = no_llseek,
1097 .unlocked_ioctl = ubi_cdev_ioctl,
1098 .compat_ioctl = ubi_cdev_compat_ioctl,
1101 /* UBI control character device operations */
1102 const struct file_operations ubi_ctrl_cdev_operations = {
1103 .owner = THIS_MODULE,
1104 .unlocked_ioctl = ctrl_cdev_ioctl,
1105 .compat_ioctl = ctrl_cdev_compat_ioctl,
1106 .llseek = no_llseek,