LXR busybox/miscutils/ubi

   1/*
   2 * Ported to busybox from mtd-utils.
   3 *
   4 * Licensed under GPLv2, see file LICENSE in this source tree.
   5 */
   6//config:config UBIATTACH
   7//config:       bool "ubiattach (4.2 kb)"
   8//config:       default y
   9//config:       select PLATFORM_LINUX
  10//config:       help
  11//config:       Attach MTD device to an UBI device.
  12//config:
  13//config:config UBIDETACH
  14//config:       bool "ubidetach (4.1 kb)"
  15//config:       default y
  16//config:       select PLATFORM_LINUX
  17//config:       help
  18//config:       Detach MTD device from an UBI device.
  19//config:
  20//config:config UBIMKVOL
  21//config:       bool "ubimkvol (5.3 kb)"
  22//config:       default y
  23//config:       select PLATFORM_LINUX
  24//config:       help
  25//config:       Create a UBI volume.
  26//config:
  27//config:config UBIRMVOL
  28//config:       bool "ubirmvol (4.9 kb)"
  29//config:       default y
  30//config:       select PLATFORM_LINUX
  31//config:       help
  32//config:       Delete a UBI volume.
  33//config:
  34//config:config UBIRSVOL
  35//config:       bool "ubirsvol (4.2 kb)"
  36//config:       default y
  37//config:       select PLATFORM_LINUX
  38//config:       help
  39//config:       Resize a UBI volume.
  40//config:
  41//config:config UBIUPDATEVOL
  42//config:       bool "ubiupdatevol (5.2 kb)"
  43//config:       default y
  44//config:       select PLATFORM_LINUX
  45//config:       help
  46//config:       Update a UBI volume.
  47
  48//                       APPLET_ODDNAME:name       main       location         suid_type     help
  49//applet:IF_UBIATTACH(   APPLET_ODDNAME(ubiattach, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubiattach))
  50//applet:IF_UBIDETACH(   APPLET_ODDNAME(ubidetach, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubidetach))
  51//applet:IF_UBIMKVOL(    APPLET_ODDNAME(ubimkvol,  ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubimkvol))
  52//applet:IF_UBIRMVOL(    APPLET_ODDNAME(ubirmvol,  ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubirmvol))
  53//applet:IF_UBIRSVOL(    APPLET_ODDNAME(ubirsvol,  ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubirsvol))
  54//applet:IF_UBIUPDATEVOL(APPLET_ODDNAME(ubiupdatevol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubiupdatevol))
  55/* not NOEXEC: if flash operation stalls, use less memory in "hung" process */
  56
  57//kbuild:lib-$(CONFIG_UBIATTACH) += ubi_tools.o
  58//kbuild:lib-$(CONFIG_UBIDETACH) += ubi_tools.o
  59//kbuild:lib-$(CONFIG_UBIMKVOL)  += ubi_tools.o
  60//kbuild:lib-$(CONFIG_UBIRMVOL)  += ubi_tools.o
  61//kbuild:lib-$(CONFIG_UBIRSVOL)  += ubi_tools.o
  62//kbuild:lib-$(CONFIG_UBIUPDATEVOL) += ubi_tools.o
  63
  64#include "libbb.h"
  65/* Some versions of kernel have broken headers, need this hack */
  66#ifndef __packed
  67# define __packed __attribute__((packed))
  68#endif
  69#include <mtd/ubi-user.h>
  70
  71#define UBI_APPLET_CNT (0 \
  72        + ENABLE_UBIATTACH \
  73        + ENABLE_UBIDETACH \
  74        + ENABLE_UBIMKVOL \
  75        + ENABLE_UBIRMVOL \
  76        + ENABLE_UBIRSVOL \
  77        + ENABLE_UBIUPDATEVOL \
  78        )
  79
  80#define do_attach (ENABLE_UBIATTACH    && (UBI_APPLET_CNT == 1 || applet_name[4] == 't'))
  81#define do_detach (ENABLE_UBIDETACH    && (UBI_APPLET_CNT == 1 || applet_name[4] == 'e'))
  82#define do_mkvol  (ENABLE_UBIMKVOL     && (UBI_APPLET_CNT == 1 || applet_name[4] == 'k'))
  83#define do_rmvol  (ENABLE_UBIRMVOL     && (UBI_APPLET_CNT == 1 || applet_name[4] == 'm'))
  84#define do_rsvol  (ENABLE_UBIRSVOL     && (UBI_APPLET_CNT == 1 || applet_name[4] == 's'))
  85#define do_update (ENABLE_UBIUPDATEVOL && (UBI_APPLET_CNT == 1 || applet_name[4] == 'p'))
  86
  87static unsigned get_num_from_file(const char *path, unsigned max)
  88{
  89        char buf[sizeof(long long)*3];
  90        unsigned long long num;
  91
  92        if (open_read_close(path, buf, sizeof(buf)) < 0)
  93                bb_perror_msg_and_die("can't open '%s'", path);
  94        /* It can be \n terminated, xatoull won't work well */
  95        if (sscanf(buf, "%llu", &num) != 1 || num > max)
  96                bb_error_msg_and_die("number in '%s' is malformed or too large", path);
  97        return num;
  98}
  99
 100/* To prevent malloc(1G) accidents */
 101#define MAX_SANE_ERASEBLOCK (16*1024*1024)
 102
 103int ubi_tools_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 104int ubi_tools_main(int argc UNUSED_PARAM, char **argv)
 105{
 106        static const struct suffix_mult size_suffixes[] = {
 107                { "KiB", 1024 },
 108                { "MiB", 1024*1024 },
 109                { "GiB", 1024*1024*1024 },
 110                { "", 0 }
 111        };
 112
 113        unsigned opts;
 114        char *ubi_ctrl;
 115        int fd;
 116        int mtd_num;
 117        int dev_num = UBI_DEV_NUM_AUTO;
 118        int vol_id = UBI_VOL_NUM_AUTO;
 119        int vid_hdr_offset = 0;
 120        char *vol_name;
 121        unsigned long long size_bytes = size_bytes; /* for compiler */
 122        char *size_bytes_str;
 123        int alignment = 1;
 124        char *type;
 125        union {
 126                struct ubi_attach_req attach_req;
 127                struct ubi_mkvol_req  mkvol_req;
 128                struct ubi_rsvol_req  rsvol_req;
 129        } req_structs;
 130#define attach_req req_structs.attach_req
 131#define mkvol_req  req_structs.mkvol_req
 132#define rsvol_req  req_structs.rsvol_req
 133        char path[sizeof("/sys/class/ubi/ubi%d_%d/usable_eb_size")
 134                                + 2 * sizeof(int)*3 + /*just in case:*/ 16];
 135#define path_sys_class_ubi_ubi (path + sizeof("/sys/class/ubi/ubi")-1)
 136
 137        strcpy(path, "/sys/class/ubi/ubi");
 138        memset(&req_structs, 0, sizeof(req_structs));
 139
 140#define OPTION_m  (1 << 0)
 141#define OPTION_d  (1 << 1)
 142#define OPTION_n  (1 << 2)
 143#define OPTION_N  (1 << 3)
 144#define OPTION_s  (1 << 4)
 145#define OPTION_a  (1 << 5)
 146#define OPTION_t  (1 << 6)
 147        if (do_mkvol) {
 148                opts = getopt32(argv, "^" "md:+n:+N:s:a:+t:O:+" "\0" "-1",
 149                                &dev_num, &vol_id,
 150                                &vol_name, &size_bytes_str, &alignment, &type,
 151                                &vid_hdr_offset
 152                        );
 153        } else
 154        if (do_update) {
 155                opts = getopt32(argv, "^" "s:at" "\0" "-1", &size_bytes_str);
 156                opts *= OPTION_s;
 157        } else {
 158                opts = getopt32(argv, "^" "m:+d:+n:+N:s:a:+t:" "\0" "-1",
 159                                &mtd_num, &dev_num, &vol_id,
 160                                &vol_name, &size_bytes_str, &alignment, &type
 161                );
 162        }
 163
 164        if (opts & OPTION_s)
 165                size_bytes = xatoull_sfx(size_bytes_str, size_suffixes);
 166        argv += optind;
 167        ubi_ctrl = *argv++;
 168
 169        fd = xopen(ubi_ctrl, O_RDWR);
 170        //xfstat(fd, &st, ubi_ctrl);
 171        //if (!S_ISCHR(st.st_mode))
 172        //      bb_error_msg_and_die("%s: not a char device", ubi_ctrl);
 173
 174//usage:#define ubiattach_trivial_usage
 175//usage:       "-m MTD_NUM [-d UBI_NUM] [-O VID_HDR_OFF] UBI_CTRL_DEV"
 176//usage:#define ubiattach_full_usage "\n\n"
 177//usage:       "Attach MTD device to UBI\n"
 178//usage:     "\n        -m MTD_NUM      MTD device number to attach"
 179//usage:     "\n        -d UBI_NUM      UBI device number to assign"
 180//usage:     "\n        -O VID_HDR_OFF  VID header offset"
 181        if (do_attach) {
 182                if (!(opts & OPTION_m))
 183                        bb_error_msg_and_die("%s device not specified", "MTD");
 184
 185                attach_req.mtd_num = mtd_num;
 186                attach_req.ubi_num = dev_num;
 187                attach_req.vid_hdr_offset = vid_hdr_offset;
 188
 189                xioctl(fd, UBI_IOCATT, &attach_req);
 190        } else
 191
 192//usage:#define ubidetach_trivial_usage
 193//usage:       "-d UBI_NUM UBI_CTRL_DEV"
 194//usage:#define ubidetach_full_usage "\n\n"
 195//usage:       "Detach MTD device from UBI\n"
 196//usage:     "\n        -d UBI_NUM      UBI device number"
 197        if (do_detach) {
 198                if (!(opts & OPTION_d))
 199                        bb_error_msg_and_die("%s device not specified", "UBI");
 200
 201                /* FIXME? kernel expects int32_t* here: */
 202                xioctl(fd, UBI_IOCDET, &dev_num);
 203        } else
 204
 205//usage:#define ubimkvol_trivial_usage
 206//usage:       "-N NAME [-s SIZE | -m] UBI_DEVICE"
 207//usage:#define ubimkvol_full_usage "\n\n"
 208//usage:       "Create UBI volume\n"
 209//usage:     "\n        -a ALIGNMENT    Volume alignment (default 1)"
 210//usage:     "\n        -m              Set volume size to maximum available"
 211//usage:     "\n        -n VOLID        Volume ID. If not specified,"
 212//usage:     "\n                        assigned automatically"
 213//usage:     "\n        -N NAME         Volume name"
 214//usage:     "\n        -s SIZE         Size in bytes"
 215//usage:     "\n        -t TYPE         Volume type (static|dynamic)"
 216        if (do_mkvol) {
 217                if (opts & OPTION_m) {
 218                        unsigned leb_avail;
 219                        unsigned leb_size;
 220                        unsigned num;
 221                        char *p;
 222
 223                        num = ubi_devnum_from_devname(ubi_ctrl);
 224                        p = path_sys_class_ubi_ubi + sprintf(path_sys_class_ubi_ubi, "%u/", num);
 225
 226                        strcpy(p, "avail_eraseblocks");
 227                        leb_avail = get_num_from_file(path, UINT_MAX);
 228
 229                        strcpy(p, "eraseblock_size");
 230                        leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK);
 231
 232                        size_bytes = leb_avail * (unsigned long long)leb_size;
 233                        //if (size_bytes <= 0)
 234                        //      bb_error_msg_and_die("%s invalid maximum size calculated", "UBI");
 235                } else
 236                if (!(opts & OPTION_s))
 237                        bb_error_msg_and_die("size not specified");
 238
 239                if (!(opts & OPTION_N))
 240                        bb_error_msg_and_die("name not specified");
 241
 242                /* the structure is memset(0) above */
 243                mkvol_req.vol_id = vol_id;
 244                mkvol_req.vol_type = UBI_DYNAMIC_VOLUME;
 245                if ((opts & OPTION_t) && type[0] == 's')
 246                        mkvol_req.vol_type = UBI_STATIC_VOLUME;
 247                mkvol_req.alignment = alignment;
 248                mkvol_req.bytes = size_bytes; /* signed int64_t */
 249                /* strnlen avoids overflow of 16-bit field (paranoia) */
 250                mkvol_req.name_len = strnlen(vol_name, UBI_MAX_VOLUME_NAME+1);
 251                if (mkvol_req.name_len > UBI_MAX_VOLUME_NAME)
 252                        bb_error_msg_and_die("volume name too long: '%s'", vol_name);
 253                /* this is safe: .name[] is UBI_MAX_VOLUME_NAME+1 bytes */
 254                strcpy(mkvol_req.name, vol_name);
 255
 256                xioctl(fd, UBI_IOCMKVOL, &mkvol_req);
 257        } else
 258
 259//usage:#define ubirmvol_trivial_usage
 260//usage:       "-n VOLID / -N VOLNAME UBI_DEVICE"
 261//usage:#define ubirmvol_full_usage "\n\n"
 262//usage:       "Remove UBI volume\n"
 263//usage:     "\n        -n VOLID        Volume ID"
 264//usage:     "\n        -N VOLNAME      Volume name"
 265        if (do_rmvol) {
 266                if (!(opts & (OPTION_n|OPTION_N)))
 267                        bb_error_msg_and_die("volume id not specified");
 268
 269                if (opts & OPTION_N) {
 270                        unsigned num = ubi_devnum_from_devname(ubi_ctrl);
 271                        vol_id = ubi_get_volid_by_name(num, vol_name);
 272                }
 273
 274                if (sizeof(vol_id) != 4) {
 275                        /* kernel expects int32_t* in this ioctl */
 276                        int32_t t = vol_id;
 277                        xioctl(fd, UBI_IOCRMVOL, &t);
 278                } else {
 279                        xioctl(fd, UBI_IOCRMVOL, &vol_id);
 280                }
 281        } else
 282
 283//usage:#define ubirsvol_trivial_usage
 284//usage:       "-n VOLID -s SIZE UBI_DEVICE"
 285//usage:#define ubirsvol_full_usage "\n\n"
 286//usage:       "Resize UBI volume\n"
 287//usage:     "\n        -n VOLID        Volume ID"
 288//usage:     "\n        -s SIZE         Size in bytes"
 289        if (do_rsvol) {
 290                if (!(opts & OPTION_s))
 291                        bb_error_msg_and_die("size not specified");
 292                if (!(opts & OPTION_n))
 293                        bb_error_msg_and_die("volume id not specified");
 294
 295                rsvol_req.bytes = size_bytes; /* signed int64_t */
 296                rsvol_req.vol_id = vol_id;
 297
 298                xioctl(fd, UBI_IOCRSVOL, &rsvol_req);
 299        } else
 300
 301//usage:#define ubiupdatevol_trivial_usage
 302//usage:       "-t UBI_DEVICE | [-s SIZE] UBI_DEVICE IMG_FILE"
 303//usage:#define ubiupdatevol_full_usage "\n\n"
 304//usage:       "Update UBI volume\n"
 305//usage:     "\n        -t      Truncate to zero size"
 306//usage:     "\n        -s SIZE Size in bytes to resize to"
 307        if (do_update) {
 308                int64_t bytes64;
 309
 310                if (opts & OPTION_t) {
 311                        /* truncate the volume by starting an update for size 0 */
 312                        bytes64 = 0;
 313                        /* this ioctl expects int64_t* parameter */
 314                        xioctl(fd, UBI_IOCVOLUP, &bytes64);
 315                }
 316                else {
 317                        unsigned ubinum, volnum;
 318                        unsigned leb_size;
 319                        char *buf;
 320
 321                        /* Assume that device is in normal format. */
 322                        /* Removes need for scanning sysfs tree as full libubi does. */
 323                        if (sscanf(ubi_ctrl, "/dev/ubi%u_%u", &ubinum, &volnum) != 2)
 324                                bb_error_msg_and_die("UBI device name '%s' is not /dev/ubiN_M", ubi_ctrl);
 325
 326                        sprintf(path_sys_class_ubi_ubi, "%u_%u/usable_eb_size", ubinum, volnum);
 327                        leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK);
 328
 329                        if (!*argv)
 330                                bb_show_usage();
 331                        if (NOT_LONE_DASH(*argv)) /* mtd-utils supports "-" as stdin */
 332                                xmove_fd(xopen(*argv, O_RDONLY), STDIN_FILENO);
 333
 334                        if (!(opts & OPTION_s)) {
 335                                struct stat st;
 336                                xfstat(STDIN_FILENO, &st, *argv);
 337                                size_bytes = st.st_size;
 338                        }
 339
 340                        bytes64 = size_bytes;
 341                        /* this ioctl expects signed int64_t* parameter */
 342                        xioctl(fd, UBI_IOCVOLUP, &bytes64);
 343
 344                        /* can't use bb_copyfd_exact_size(): copy in blocks of exactly leb_size */
 345                        buf = xmalloc(leb_size);
 346                        while (size_bytes != 0) {
 347                                int len = full_read(STDIN_FILENO, buf, leb_size);
 348                                if (len <= 0) {
 349                                        if (len < 0)
 350                                                bb_perror_msg_and_die("read error from '%s'", *argv);
 351                                        break;
 352                                }
 353                                if ((unsigned)len > size_bytes) {
 354                                        /* for this case: "ubiupdatevol -s 1024000 $UBIDEV /dev/urandom" */
 355                                        len = size_bytes;
 356                                }
 357                                xwrite(fd, buf, len);
 358                                size_bytes -= len;
 359                        }
 360                        if (ENABLE_FEATURE_CLEAN_UP)
 361                                free(buf);
 362                }
 363        }
 364
 365        if (ENABLE_FEATURE_CLEAN_UP)
 366                close(fd);
 367
 368        return EXIT_SUCCESS;
 369}
 370