miscutils/ubi_tools.c

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