1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2011 The Chromium OS Authors.
21 #include <sys/types.h>
22 #include <linux/types.h>
24 #include <asm/getopt.h>
25 #include <asm/sections.h>
26 #include <asm/state.h>
30 /* Operating System Interface */
33 size_t length; /* number of bytes in the block */
36 ssize_t os_read(int fd, void *buf, size_t count)
38 return read(fd, buf, count);
41 ssize_t os_read_no_block(int fd, void *buf, size_t count)
43 const int flags = fcntl(fd, F_GETFL, 0);
45 fcntl(fd, F_SETFL, flags | O_NONBLOCK);
46 return os_read(fd, buf, count);
49 ssize_t os_write(int fd, const void *buf, size_t count)
51 return write(fd, buf, count);
54 off_t os_lseek(int fd, off_t offset, int whence)
56 if (whence == OS_SEEK_SET)
58 else if (whence == OS_SEEK_CUR)
60 else if (whence == OS_SEEK_END)
64 return lseek(fd, offset, whence);
67 int os_open(const char *pathname, int os_flags)
71 switch (os_flags & OS_O_MASK) {
86 if (os_flags & OS_O_CREAT)
88 if (os_flags & OS_O_TRUNC)
91 return open(pathname, flags, 0777);
99 int os_unlink(const char *pathname)
101 return unlink(pathname);
104 void os_exit(int exit_code)
109 int os_write_file(const char *name, const void *buf, int size)
114 fd = os_open(fname, OS_O_WRONLY | OS_O_CREAT | OS_O_TRUNC);
116 printf("Cannot open file '%s'\n", fname);
119 if (os_write(fd, buf, size) != size) {
120 printf("Cannot write to file '%s'\n", fname);
124 printf("Write '%s', size %#x (%d)\n", name, size, size);
129 /* Restore tty state when we exit */
130 static struct termios orig_term;
131 static bool term_setup;
133 void os_fd_restore(void)
136 tcsetattr(0, TCSANOW, &orig_term);
141 /* Put tty into raw mode so <tab> and <ctrl+c> work */
142 void os_tty_raw(int fd, bool allow_sigs)
149 /* If not a tty, don't complain */
150 if (tcgetattr(fd, &orig_term))
154 term.c_iflag = IGNBRK | IGNPAR;
155 term.c_oflag = OPOST | ONLCR;
156 term.c_cflag = CS8 | CREAD | CLOCAL;
157 term.c_lflag = allow_sigs ? ISIG : 0;
158 if (tcsetattr(fd, TCSANOW, &term))
162 atexit(os_fd_restore);
165 void *os_malloc(size_t length)
167 struct os_mem_hdr *hdr;
168 int page_size = getpagesize();
170 hdr = mmap(NULL, length + page_size,
171 PROT_READ | PROT_WRITE | PROT_EXEC,
172 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
173 if (hdr == MAP_FAILED)
175 hdr->length = length;
177 return (void *)hdr + page_size;
180 void os_free(void *ptr)
182 struct os_mem_hdr *hdr = ptr;
186 munmap(hdr, hdr->length + sizeof(*hdr));
189 void *os_realloc(void *ptr, size_t length)
191 struct os_mem_hdr *hdr = ptr;
196 buf = os_malloc(length);
200 if (length > hdr->length)
201 length = hdr->length;
202 memcpy(buf, ptr, length);
210 void os_usleep(unsigned long usec)
215 uint64_t __attribute__((no_instrument_function)) os_get_nsec(void)
217 #if defined(CLOCK_MONOTONIC) && defined(_POSIX_MONOTONIC_CLOCK)
219 if (EINVAL == clock_gettime(CLOCK_MONOTONIC, &tp)) {
222 gettimeofday(&tv, NULL);
223 tp.tv_sec = tv.tv_sec;
224 tp.tv_nsec = tv.tv_usec * 1000;
226 return tp.tv_sec * 1000000000ULL + tp.tv_nsec;
229 gettimeofday(&tv, NULL);
230 return tv.tv_sec * 1000000000ULL + tv.tv_usec * 1000;
234 static char *short_opts;
235 static struct option *long_opts;
237 int os_parse_args(struct sandbox_state *state, int argc, char *argv[])
239 struct sandbox_cmdline_option **sb_opt = __u_boot_sandbox_option_start;
240 size_t num_options = __u_boot_sandbox_option_count();
243 int hidden_short_opt;
248 if (short_opts || long_opts)
254 /* dynamically construct the arguments to the system getopt_long */
255 short_opts = os_malloc(sizeof(*short_opts) * num_options * 2 + 1);
256 long_opts = os_malloc(sizeof(*long_opts) * num_options);
257 if (!short_opts || !long_opts)
261 * getopt_long requires "val" to be unique (since that is what the
262 * func returns), so generate unique values automatically for flags
263 * that don't have a short option. pick 0x100 as that is above the
264 * single byte range (where ASCII/ISO-XXXX-X charsets live).
266 hidden_short_opt = 0x100;
268 for (i = 0; i < num_options; ++i) {
269 long_opts[i].name = sb_opt[i]->flag;
270 long_opts[i].has_arg = sb_opt[i]->has_arg ?
271 required_argument : no_argument;
272 long_opts[i].flag = NULL;
274 if (sb_opt[i]->flag_short) {
275 short_opts[si++] = long_opts[i].val = sb_opt[i]->flag_short;
276 if (long_opts[i].has_arg == required_argument)
277 short_opts[si++] = ':';
279 long_opts[i].val = sb_opt[i]->flag_short = hidden_short_opt++;
281 short_opts[si] = '\0';
283 /* we need to handle output ourselves since u-boot provides printf */
287 * walk all of the options the user gave us on the command line,
288 * figure out what u-boot option structure they belong to (via
289 * the unique short val key), and call the appropriate callback.
291 while ((c = getopt_long(argc, argv, short_opts, long_opts, NULL)) != -1) {
292 for (i = 0; i < num_options; ++i) {
293 if (sb_opt[i]->flag_short == c) {
294 if (sb_opt[i]->callback(state, optarg)) {
295 state->parse_err = sb_opt[i]->flag;
301 if (i == num_options) {
303 * store the faulting flag for later display. we have to
304 * store the flag itself as the getopt parsing itself is
305 * tricky: need to handle the following flags (assume all
306 * of the below are unknown):
307 * -a optopt='a' optind=<next>
308 * -abbbb optopt='a' optind=<this>
309 * -aaaaa optopt='a' optind=<this>
310 * --a optopt=0 optind=<this>
311 * as you can see, it is impossible to determine the exact
312 * faulting flag without doing the parsing ourselves, so
313 * we just report the specific flag that failed.
316 static char parse_err[3] = { '-', 0, '\0', };
317 parse_err[1] = optopt;
318 state->parse_err = parse_err;
320 state->parse_err = argv[optind - 1];
328 void os_dirent_free(struct os_dirent_node *node)
330 struct os_dirent_node *next;
339 int os_dirent_ls(const char *dirname, struct os_dirent_node **headp)
341 struct dirent *entry;
342 struct os_dirent_node *head, *node, *next;
352 dir = opendir(dirname);
356 /* Create a buffer upfront, with typically sufficient size */
357 dirlen = strlen(dirname) + 2;
365 for (node = head = NULL;; node = next) {
367 entry = readdir(dir);
372 next = malloc(sizeof(*node) + strlen(entry->d_name) + 1);
374 os_dirent_free(head);
378 if (dirlen + strlen(entry->d_name) > len) {
379 len = dirlen + strlen(entry->d_name);
381 fname = realloc(fname, len);
385 os_dirent_free(head);
391 strcpy(next->name, entry->d_name);
392 switch (entry->d_type) {
394 next->type = OS_FILET_REG;
397 next->type = OS_FILET_DIR;
400 next->type = OS_FILET_LNK;
403 next->type = OS_FILET_UNKNOWN;
406 snprintf(fname, len, "%s/%s", dirname, next->name);
407 if (!stat(fname, &buf))
408 next->size = buf.st_size;
422 const char *os_dirent_typename[OS_FILET_COUNT] = {
429 const char *os_dirent_get_typename(enum os_dirent_t type)
431 if (type >= OS_FILET_REG && type < OS_FILET_COUNT)
432 return os_dirent_typename[type];
434 return os_dirent_typename[OS_FILET_UNKNOWN];
437 int os_get_filesize(const char *fname, loff_t *size)
442 ret = stat(fname, &buf);
454 void os_puts(const char *str)
460 int os_write_ram_buf(const char *fname)
462 struct sandbox_state *state = state_get_current();
465 fd = open(fname, O_CREAT | O_WRONLY, 0777);
468 ret = write(fd, state->ram_buf, state->ram_size);
470 if (ret != state->ram_size)
476 int os_read_ram_buf(const char *fname)
478 struct sandbox_state *state = state_get_current();
482 ret = os_get_filesize(fname, &size);
485 if (size != state->ram_size)
487 fd = open(fname, O_RDONLY);
491 ret = read(fd, state->ram_buf, state->ram_size);
493 if (ret != state->ram_size)
499 static int make_exec(char *fname, const void *data, int size)
503 strcpy(fname, "/tmp/u-boot.jump.XXXXXX");
507 if (write(fd, data, size) < 0)
510 if (chmod(fname, 0777))
516 static int add_args(char ***argvp, const char *add_args[], int count)
521 for (argv = *argvp, argc = 0; (*argvp)[argc]; argc++)
524 argv = malloc((argc + count + 1) * sizeof(char *));
526 printf("Out of memory for %d argv\n", count);
529 memcpy(argv, *argvp, argc * sizeof(char *));
530 memcpy(argv + argc, add_args, count * sizeof(char *));
531 argv[argc + count] = NULL;
537 int os_jump_to_image(const void *dest, int size)
539 struct sandbox_state *state = state_get_current();
540 char fname[30], mem_fname[30];
542 const char *extra_args[5];
543 char **argv = state->argv;
548 err = make_exec(fname, dest, size);
552 strcpy(mem_fname, "/tmp/u-boot.mem.XXXXXX");
553 fd = mkstemp(mem_fname);
557 err = os_write_ram_buf(mem_fname);
563 extra_args[0] = "-j";
564 extra_args[1] = fname;
565 extra_args[2] = "-m";
566 extra_args[3] = mem_fname;
567 extra_args[4] = "--rm_memory";
568 err = add_args(&argv, extra_args,
569 sizeof(extra_args) / sizeof(extra_args[0]));
574 for (i = 0; argv[i]; i++)
575 printf("%d %s\n", i, argv[i]);
581 err = execv(fname, argv);
586 return unlink(fname);
589 int os_find_u_boot(char *fname, int maxlen)
591 struct sandbox_state *state = state_get_current();
592 const char *progname = state->argv[0];
593 int len = strlen(progname);
598 if (len >= maxlen || len < 4)
601 strcpy(fname, progname);
602 suffix = fname + len - 4;
604 /* If we are TPL, boot to SPL */
605 if (!strcmp(suffix, "-tpl")) {
606 fname[len - 3] = 's';
607 fd = os_open(fname, O_RDONLY);
613 /* Look for 'u-boot-tpl' in the tpl/ directory */
614 p = strstr(fname, "/tpl/");
617 fd = os_open(fname, O_RDONLY);
626 /* Look for 'u-boot' in the same directory as 'u-boot-spl' */
627 if (!strcmp(suffix, "-spl")) {
628 fname[len - 4] = '\0';
629 fd = os_open(fname, O_RDONLY);
636 /* Look for 'u-boot' in the parent directory of spl/ */
637 p = strstr(fname, "/spl/");
640 fd = os_open(fname, O_RDONLY);
650 int os_spl_to_uboot(const char *fname)
652 struct sandbox_state *state = state_get_current();
653 char *argv[state->argc + 1];
656 memcpy(argv, state->argv, sizeof(char *) * (state->argc + 1));
657 argv[0] = (char *)fname;
658 ret = execv(fname, argv);
662 return unlink(fname);
665 void os_localtime(struct rtc_time *rt)
667 time_t t = time(NULL);
671 rt->tm_sec = tm->tm_sec;
672 rt->tm_min = tm->tm_min;
673 rt->tm_hour = tm->tm_hour;
674 rt->tm_mday = tm->tm_mday;
675 rt->tm_mon = tm->tm_mon + 1;
676 rt->tm_year = tm->tm_year + 1900;
677 rt->tm_wday = tm->tm_wday;
678 rt->tm_yday = tm->tm_yday;
679 rt->tm_isdst = tm->tm_isdst;
687 int os_mprotect_allow(void *start, size_t len)
689 int page_size = getpagesize();
691 /* Move start to the start of a page, len to the end */
692 start = (void *)(((ulong)start) & ~(page_size - 1));
693 len = (len + page_size * 2) & ~(page_size - 1);
695 return mprotect(start, len, PROT_READ | PROT_WRITE);