summaryrefslogtreecommitdiff
path: root/miscutils/ubi_tools.c (plain)
blob: b7139353269e186978ed4f25154088a714458187
1/* Ported to busybox from mtd-utils.
2 *
3 * Licensed under GPLv2, see file LICENSE in this source tree.
4 */
5
6//config:config UBIATTACH
7//config: bool "ubiattach"
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"
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"
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"
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"
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"
43//config: default y
44//config: select PLATFORM_LINUX
45//config: help
46//config: Update a UBI volume.
47
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
55//kbuild:lib-$(CONFIG_UBIATTACH) += ubi_tools.o
56//kbuild:lib-$(CONFIG_UBIDETACH) += ubi_tools.o
57//kbuild:lib-$(CONFIG_UBIMKVOL) += ubi_tools.o
58//kbuild:lib-$(CONFIG_UBIRMVOL) += ubi_tools.o
59//kbuild:lib-$(CONFIG_UBIRSVOL) += ubi_tools.o
60//kbuild:lib-$(CONFIG_UBIUPDATEVOL) += ubi_tools.o
61
62#include "libbb.h"
63/* Some versions of kernel have broken headers, need this hack */
64#ifndef __packed
65# define __packed __attribute__((packed))
66#endif
67#include <mtd/ubi-user.h>
68
69#define do_attach (ENABLE_UBIATTACH && applet_name[3] == 'a')
70#define do_detach (ENABLE_UBIDETACH && applet_name[3] == 'd')
71#define do_mkvol (ENABLE_UBIMKVOL && applet_name[3] == 'm')
72#define do_rmvol (ENABLE_UBIRMVOL && applet_name[4] == 'm')
73#define do_rsvol (ENABLE_UBIRSVOL && applet_name[4] == 's')
74#define do_update (ENABLE_UBIUPDATEVOL && applet_name[3] == 'u')
75
76static unsigned get_num_from_file(const char *path, unsigned max, const char *errmsg)
77{
78 char buf[sizeof(long long)*3];
79 unsigned long long num;
80
81 if (open_read_close(path, buf, sizeof(buf)) < 0)
82 bb_perror_msg_and_die(errmsg, path);
83 /* It can be \n terminated, xatoull won't work well */
84 if (sscanf(buf, "%llu", &num) != 1 || num > max)
85 bb_error_msg_and_die(errmsg, path);
86 return num;
87}
88
89/* To prevent malloc(1G) accidents */
90#define MAX_SANE_ERASEBLOCK (16*1024*1024)
91
92int ubi_tools_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
93int ubi_tools_main(int argc UNUSED_PARAM, char **argv)
94{
95 static const struct suffix_mult size_suffixes[] = {
96 { "KiB", 1024 },
97 { "MiB", 1024*1024 },
98 { "GiB", 1024*1024*1024 },
99 { "", 0 }
100 };
101
102 unsigned opts;
103 char *ubi_ctrl;
104 int fd;
105 int mtd_num;
106 int dev_num = UBI_DEV_NUM_AUTO;
107 int vol_id = UBI_VOL_NUM_AUTO;
108 char *vol_name;
109 unsigned long long size_bytes = size_bytes; /* for compiler */
110 char *size_bytes_str;
111 int alignment = 1;
112 char *type;
113 union {
114 struct ubi_attach_req attach_req;
115 struct ubi_mkvol_req mkvol_req;
116 struct ubi_rsvol_req rsvol_req;
117 } req_structs;
118#define attach_req req_structs.attach_req
119#define mkvol_req req_structs.mkvol_req
120#define rsvol_req req_structs.rsvol_req
121 char path[sizeof("/sys/class/ubi/ubi%d_%d/usable_eb_size")
122 + 2 * sizeof(int)*3 + /*just in case:*/ 16];
123#define path_sys_class_ubi_ubi (path + sizeof("/sys/class/ubi/ubi")-1)
124
125 strcpy(path, "/sys/class/ubi/ubi");
126 memset(&req_structs, 0, sizeof(req_structs));
127
128 if (do_mkvol) {
129 opt_complementary = "-1:d+:n+:a+";
130 opts = getopt32(argv, "md:n:N:s:a:t:",
131 &dev_num, &vol_id,
132 &vol_name, &size_bytes_str, &alignment, &type
133 );
134 } else {
135 opt_complementary = "-1:m+:d+:n+:a+";
136 opts = getopt32(argv, "m:d:n:N:s:a:t:",
137 &mtd_num, &dev_num, &vol_id,
138 &vol_name, &size_bytes_str, &alignment, &type
139 );
140 }
141#define OPTION_m (1 << 0)
142#define OPTION_d (1 << 1)
143#define OPTION_n (1 << 2)
144#define OPTION_N (1 << 3)
145#define OPTION_s (1 << 4)
146#define OPTION_a (1 << 5)
147#define OPTION_t (1 << 6)
148
149 if (opts & OPTION_s)
150 size_bytes = xatoull_sfx(size_bytes_str, size_suffixes);
151 argv += optind;
152 ubi_ctrl = *argv++;
153
154 fd = xopen(ubi_ctrl, O_RDWR);
155 //xfstat(fd, &st, ubi_ctrl);
156 //if (!S_ISCHR(st.st_mode))
157 // bb_error_msg_and_die("%s: not a char device", ubi_ctrl);
158
159//usage:#define ubiattach_trivial_usage
160//usage: "-m MTD_NUM [-d UBI_NUM] UBI_CTRL_DEV"
161//usage:#define ubiattach_full_usage "\n\n"
162//usage: "Attach MTD device to UBI\n"
163//usage: "\n -m MTD_NUM MTD device number to attach"
164//usage: "\n -d UBI_NUM UBI device number to assign"
165 if (do_attach) {
166 if (!(opts & OPTION_m))
167 bb_error_msg_and_die("%s device not specified", "MTD");
168
169 attach_req.mtd_num = mtd_num;
170 attach_req.ubi_num = dev_num;
171
172 xioctl(fd, UBI_IOCATT, &attach_req);
173 } else
174
175//usage:#define ubidetach_trivial_usage
176//usage: "-d UBI_NUM UBI_CTRL_DEV"
177//usage:#define ubidetach_full_usage "\n\n"
178//usage: "Detach MTD device from UBI\n"
179//usage: "\n -d UBI_NUM UBI device number"
180 if (do_detach) {
181 if (!(opts & OPTION_d))
182 bb_error_msg_and_die("%s device not specified", "UBI");
183
184 /* FIXME? kernel expects int32_t* here: */
185 xioctl(fd, UBI_IOCDET, &dev_num);
186 } else
187
188//usage:#define ubimkvol_trivial_usage
189//usage: "UBI_DEVICE -N NAME [-s SIZE | -m]"
190//usage:#define ubimkvol_full_usage "\n\n"
191//usage: "Create UBI volume\n"
192//usage: "\n -a ALIGNMENT Volume alignment (default 1)"
193//usage: "\n -m Set volume size to maximum available"
194//usage: "\n -n VOLID Volume ID. If not specified,"
195//usage: "\n assigned automatically"
196//usage: "\n -N NAME Volume name"
197//usage: "\n -s SIZE Size in bytes"
198//usage: "\n -t TYPE Volume type (static|dynamic)"
199 if (do_mkvol) {
200 if (opts & OPTION_m) {
201 unsigned leb_avail;
202 unsigned leb_size;
203 unsigned num;
204 char *p;
205
206 if (sscanf(ubi_ctrl, "/dev/ubi%u", &num) != 1)
207 bb_error_msg_and_die("wrong format of UBI device name");
208
209 p = path_sys_class_ubi_ubi + sprintf(path_sys_class_ubi_ubi, "%u/", num);
210
211 strcpy(p, "avail_eraseblocks");
212 leb_avail = get_num_from_file(path, UINT_MAX, "Can't get available eraseblocks from '%s'");
213
214 strcpy(p, "eraseblock_size");
215 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get eraseblock size from '%s'");
216
217 size_bytes = leb_avail * (unsigned long long)leb_size;
218 //if (size_bytes <= 0)
219 // bb_error_msg_and_die("%s invalid maximum size calculated", "UBI");
220 } else
221 if (!(opts & OPTION_s))
222 bb_error_msg_and_die("size not specified");
223
224 if (!(opts & OPTION_N))
225 bb_error_msg_and_die("name not specified");
226
227 mkvol_req.vol_id = vol_id;
228 mkvol_req.vol_type = UBI_DYNAMIC_VOLUME;
229 if ((opts & OPTION_t) && type[0] == 's')
230 mkvol_req.vol_type = UBI_STATIC_VOLUME;
231 mkvol_req.alignment = alignment;
232 mkvol_req.bytes = size_bytes; /* signed int64_t */
233 strncpy(mkvol_req.name, vol_name, UBI_MAX_VOLUME_NAME);
234 mkvol_req.name_len = strlen(vol_name);
235 if (mkvol_req.name_len > UBI_MAX_VOLUME_NAME)
236 bb_error_msg_and_die("volume name too long: '%s'", vol_name);
237
238 xioctl(fd, UBI_IOCMKVOL, &mkvol_req);
239 } else
240
241//usage:#define ubirmvol_trivial_usage
242//usage: "UBI_DEVICE -n VOLID"
243//usage:#define ubirmvol_full_usage "\n\n"
244//usage: "Remove UBI volume\n"
245//usage: "\n -n VOLID Volume ID"
246 if (do_rmvol) {
247 if (!(opts & OPTION_n))
248 bb_error_msg_and_die("volume id not specified");
249
250 /* FIXME? kernel expects int32_t* here: */
251 xioctl(fd, UBI_IOCRMVOL, &vol_id);
252 } else
253
254//usage:#define ubirsvol_trivial_usage
255//usage: "UBI_DEVICE -n VOLID -s SIZE"
256//usage:#define ubirsvol_full_usage "\n\n"
257//usage: "Resize UBI volume\n"
258//usage: "\n -n VOLID Volume ID"
259//usage: "\n -s SIZE Size in bytes"
260 if (do_rsvol) {
261 if (!(opts & OPTION_s))
262 bb_error_msg_and_die("size not specified");
263 if (!(opts & OPTION_n))
264 bb_error_msg_and_die("volume id not specified");
265
266 rsvol_req.bytes = size_bytes; /* signed int64_t */
267 rsvol_req.vol_id = vol_id;
268
269 xioctl(fd, UBI_IOCRSVOL, &rsvol_req);
270 } else
271
272//usage:#define ubiupdatevol_trivial_usage
273//usage: "UBI_DEVICE [-t | [-s SIZE] IMG_FILE]"
274//usage:#define ubiupdatevol_full_usage "\n\n"
275//usage: "Update UBI volume\n"
276//usage: "\n -t Truncate to zero size"
277//usage: "\n -s SIZE Size in bytes to resize to"
278 if (do_update) {
279 int64_t bytes64;
280
281 if (opts & OPTION_t) {
282 /* truncate the volume by starting an update for size 0 */
283 bytes64 = 0;
284 /* this ioctl expects int64_t* parameter */
285 xioctl(fd, UBI_IOCVOLUP, &bytes64);
286 }
287 else {
288 struct stat st;
289 unsigned ubinum, volnum;
290 unsigned leb_size;
291 ssize_t len;
292 char *input_data;
293
294 /* Assume that device is in normal format. */
295 /* Removes need for scanning sysfs tree as full libubi does. */
296 if (sscanf(ubi_ctrl, "/dev/ubi%u_%u", &ubinum, &volnum) != 2)
297 bb_error_msg_and_die("wrong format of UBI device name");
298
299 sprintf(path_sys_class_ubi_ubi, "%u_%u/usable_eb_size", ubinum, volnum);
300 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get usable eraseblock size from '%s'");
301
302 if (!(opts & OPTION_s)) {
303 if (!*argv)
304 bb_show_usage();
305 xstat(*argv, &st);
306 size_bytes = st.st_size;
307 xmove_fd(xopen(*argv, O_RDONLY), STDIN_FILENO);
308 }
309
310 bytes64 = size_bytes;
311 /* this ioctl expects signed int64_t* parameter */
312 xioctl(fd, UBI_IOCVOLUP, &bytes64);
313
314 input_data = xmalloc(leb_size);
315 while ((len = full_read(STDIN_FILENO, input_data, leb_size)) > 0) {
316 xwrite(fd, input_data, len);
317 }
318 if (len < 0)
319 bb_perror_msg_and_die("UBI volume update failed");
320 }
321 }
322
323 if (ENABLE_FEATURE_CLEAN_UP)
324 close(fd);
325
326 return EXIT_SUCCESS;
327}
328
generated by cgit at 2024-05-15 15:47:36 (GMT)