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_write(int fd, const void *buf, size_t count)
43 return write(fd, buf, count);
46 off_t os_lseek(int fd, off_t offset, int whence)
48 if (whence == OS_SEEK_SET)
50 else if (whence == OS_SEEK_CUR)
52 else if (whence == OS_SEEK_END)
56 return lseek(fd, offset, whence);
59 int os_open(const char *pathname, int os_flags)
63 switch (os_flags & OS_O_MASK) {
78 if (os_flags & OS_O_CREAT)
80 if (os_flags & OS_O_TRUNC)
83 return open(pathname, flags, 0777);
91 int os_unlink(const char *pathname)
93 return unlink(pathname);
96 void os_exit(int exit_code)
101 int os_write_file(const char *fname, const void *buf, int size)
105 fd = os_open(fname, OS_O_WRONLY | OS_O_CREAT | OS_O_TRUNC);
107 printf("Cannot open file '%s'\n", fname);
110 if (os_write(fd, buf, size) != size) {
111 printf("Cannot write to file '%s'\n", fname);
120 int os_read_file(const char *fname, void **bufp, int *sizep)
126 fd = os_open(fname, OS_O_RDONLY);
128 printf("Cannot open file '%s'\n", fname);
131 size = os_lseek(fd, 0, OS_SEEK_END);
133 printf("Cannot seek to end of file '%s'\n", fname);
136 if (os_lseek(fd, 0, OS_SEEK_SET) < 0) {
137 printf("Cannot seek to start of file '%s'\n", fname);
140 *bufp = os_malloc(size);
142 printf("Not enough memory to read file '%s'\n", fname);
146 if (os_read(fd, *bufp, size) != size) {
147 printf("Cannot read from file '%s'\n", fname);
159 /* Restore tty state when we exit */
160 static struct termios orig_term;
161 static bool term_setup;
162 static bool term_nonblock;
164 void os_fd_restore(void)
169 tcsetattr(0, TCSANOW, &orig_term);
171 flags = fcntl(0, F_GETFL, 0);
172 fcntl(0, F_SETFL, flags & ~O_NONBLOCK);
178 /* Put tty into raw mode so <tab> and <ctrl+c> work */
179 void os_tty_raw(int fd, bool allow_sigs)
187 /* If not a tty, don't complain */
188 if (tcgetattr(fd, &orig_term))
192 term.c_iflag = IGNBRK | IGNPAR;
193 term.c_oflag = OPOST | ONLCR;
194 term.c_cflag = CS8 | CREAD | CLOCAL;
195 term.c_lflag = allow_sigs ? ISIG : 0;
196 if (tcsetattr(fd, TCSANOW, &term))
199 flags = fcntl(fd, F_GETFL, 0);
200 if (!(flags & O_NONBLOCK)) {
201 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK))
203 term_nonblock = true;
207 atexit(os_fd_restore);
210 void *os_malloc(size_t length)
212 struct os_mem_hdr *hdr;
213 int page_size = getpagesize();
216 * Use an address that is hopefully available to us so that pointers
217 * to this memory are fairly obvious. If we end up with a different
218 * address, that's fine too.
220 hdr = mmap((void *)0x10000000, length + page_size,
221 PROT_READ | PROT_WRITE | PROT_EXEC,
222 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
223 if (hdr == MAP_FAILED)
225 hdr->length = length;
227 return (void *)hdr + page_size;
230 void os_free(void *ptr)
232 struct os_mem_hdr *hdr = ptr;
236 munmap(hdr, hdr->length + sizeof(*hdr));
239 void *os_realloc(void *ptr, size_t length)
241 struct os_mem_hdr *hdr = ptr;
246 buf = os_malloc(length);
250 if (length > hdr->length)
251 length = hdr->length;
252 memcpy(buf, ptr, length);
260 void os_usleep(unsigned long usec)
265 uint64_t __attribute__((no_instrument_function)) os_get_nsec(void)
267 #if defined(CLOCK_MONOTONIC) && defined(_POSIX_MONOTONIC_CLOCK)
269 if (EINVAL == clock_gettime(CLOCK_MONOTONIC, &tp)) {
272 gettimeofday(&tv, NULL);
273 tp.tv_sec = tv.tv_sec;
274 tp.tv_nsec = tv.tv_usec * 1000;
276 return tp.tv_sec * 1000000000ULL + tp.tv_nsec;
279 gettimeofday(&tv, NULL);
280 return tv.tv_sec * 1000000000ULL + tv.tv_usec * 1000;
284 static char *short_opts;
285 static struct option *long_opts;
287 int os_parse_args(struct sandbox_state *state, int argc, char *argv[])
289 struct sandbox_cmdline_option **sb_opt = __u_boot_sandbox_option_start;
290 size_t num_options = __u_boot_sandbox_option_count();
293 int hidden_short_opt;
298 if (short_opts || long_opts)
304 /* dynamically construct the arguments to the system getopt_long */
305 short_opts = os_malloc(sizeof(*short_opts) * num_options * 2 + 1);
306 long_opts = os_malloc(sizeof(*long_opts) * num_options);
307 if (!short_opts || !long_opts)
311 * getopt_long requires "val" to be unique (since that is what the
312 * func returns), so generate unique values automatically for flags
313 * that don't have a short option. pick 0x100 as that is above the
314 * single byte range (where ASCII/ISO-XXXX-X charsets live).
316 hidden_short_opt = 0x100;
318 for (i = 0; i < num_options; ++i) {
319 long_opts[i].name = sb_opt[i]->flag;
320 long_opts[i].has_arg = sb_opt[i]->has_arg ?
321 required_argument : no_argument;
322 long_opts[i].flag = NULL;
324 if (sb_opt[i]->flag_short) {
325 short_opts[si++] = long_opts[i].val = sb_opt[i]->flag_short;
326 if (long_opts[i].has_arg == required_argument)
327 short_opts[si++] = ':';
329 long_opts[i].val = sb_opt[i]->flag_short = hidden_short_opt++;
331 short_opts[si] = '\0';
333 /* we need to handle output ourselves since u-boot provides printf */
337 * walk all of the options the user gave us on the command line,
338 * figure out what u-boot option structure they belong to (via
339 * the unique short val key), and call the appropriate callback.
341 while ((c = getopt_long(argc, argv, short_opts, long_opts, NULL)) != -1) {
342 for (i = 0; i < num_options; ++i) {
343 if (sb_opt[i]->flag_short == c) {
344 if (sb_opt[i]->callback(state, optarg)) {
345 state->parse_err = sb_opt[i]->flag;
351 if (i == num_options) {
353 * store the faulting flag for later display. we have to
354 * store the flag itself as the getopt parsing itself is
355 * tricky: need to handle the following flags (assume all
356 * of the below are unknown):
357 * -a optopt='a' optind=<next>
358 * -abbbb optopt='a' optind=<this>
359 * -aaaaa optopt='a' optind=<this>
360 * --a optopt=0 optind=<this>
361 * as you can see, it is impossible to determine the exact
362 * faulting flag without doing the parsing ourselves, so
363 * we just report the specific flag that failed.
366 static char parse_err[3] = { '-', 0, '\0', };
367 parse_err[1] = optopt;
368 state->parse_err = parse_err;
370 state->parse_err = argv[optind - 1];
378 void os_dirent_free(struct os_dirent_node *node)
380 struct os_dirent_node *next;
389 int os_dirent_ls(const char *dirname, struct os_dirent_node **headp)
391 struct dirent *entry;
392 struct os_dirent_node *head, *node, *next;
402 dir = opendir(dirname);
406 /* Create a buffer upfront, with typically sufficient size */
407 dirlen = strlen(dirname) + 2;
409 fname = os_malloc(len);
415 for (node = head = NULL;; node = next) {
417 entry = readdir(dir);
422 next = os_malloc(sizeof(*node) + strlen(entry->d_name) + 1);
424 os_dirent_free(head);
428 if (dirlen + strlen(entry->d_name) > len) {
429 len = dirlen + strlen(entry->d_name);
431 fname = os_realloc(fname, len);
435 os_dirent_free(head);
441 strcpy(next->name, entry->d_name);
442 switch (entry->d_type) {
444 next->type = OS_FILET_REG;
447 next->type = OS_FILET_DIR;
450 next->type = OS_FILET_LNK;
453 next->type = OS_FILET_UNKNOWN;
456 snprintf(fname, len, "%s/%s", dirname, next->name);
457 if (!stat(fname, &buf))
458 next->size = buf.st_size;
472 const char *os_dirent_typename[OS_FILET_COUNT] = {
479 const char *os_dirent_get_typename(enum os_dirent_t type)
481 if (type >= OS_FILET_REG && type < OS_FILET_COUNT)
482 return os_dirent_typename[type];
484 return os_dirent_typename[OS_FILET_UNKNOWN];
487 int os_get_filesize(const char *fname, loff_t *size)
492 ret = stat(fname, &buf);
504 void os_puts(const char *str)
510 int os_write_ram_buf(const char *fname)
512 struct sandbox_state *state = state_get_current();
515 fd = open(fname, O_CREAT | O_WRONLY, 0777);
518 ret = write(fd, state->ram_buf, state->ram_size);
520 if (ret != state->ram_size)
526 int os_read_ram_buf(const char *fname)
528 struct sandbox_state *state = state_get_current();
532 ret = os_get_filesize(fname, &size);
535 if (size != state->ram_size)
537 fd = open(fname, O_RDONLY);
541 ret = read(fd, state->ram_buf, state->ram_size);
543 if (ret != state->ram_size)
549 static int make_exec(char *fname, const void *data, int size)
553 strcpy(fname, "/tmp/u-boot.jump.XXXXXX");
557 if (write(fd, data, size) < 0)
560 if (chmod(fname, 0777))
567 * add_args() - Allocate a new argv with the given args
569 * This is used to create a new argv array with all the old arguments and some
570 * new ones that are passed in
572 * @argvp: Returns newly allocated args list
573 * @add_args: Arguments to add, each a string
574 * @count: Number of arguments in @add_args
575 * @return 0 if OK, -ENOMEM if out of memory
577 static int add_args(char ***argvp, char *add_args[], int count)
582 for (argc = 0; (*argvp)[argc]; argc++)
585 argv = os_malloc((argc + count + 1) * sizeof(char *));
587 printf("Out of memory for %d argv\n", count);
590 for (ap = *argvp, argc = 0; *ap; ap++) {
593 /* Drop args that we don't want to propagate */
594 if (*arg == '-' && strlen(arg) == 2) {
601 } else if (!strcmp(arg, "--rm_memory")) {
608 memcpy(argv + argc, add_args, count * sizeof(char *));
609 argv[argc + count] = NULL;
616 * os_jump_to_file() - Jump to a new program
618 * This saves the memory buffer, sets up arguments to the new process, then
621 * @fname: Filename to exec
622 * @return does not return on success, any return value is an error
624 static int os_jump_to_file(const char *fname)
626 struct sandbox_state *state = state_get_current();
630 char **argv = state->argv;
636 strcpy(mem_fname, "/tmp/u-boot.mem.XXXXXX");
637 fd = mkstemp(mem_fname);
641 err = os_write_ram_buf(mem_fname);
647 extra_args[0] = "-j";
648 extra_args[1] = (char *)fname;
649 extra_args[2] = "-m";
650 extra_args[3] = mem_fname;
652 if (state->ram_buf_rm)
653 extra_args[argc++] = "--rm_memory";
654 err = add_args(&argv, extra_args, argc);
657 argv[0] = (char *)fname;
660 for (i = 0; argv[i]; i++)
661 printf("%d %s\n", i, argv[i]);
667 err = execv(fname, argv);
672 return unlink(fname);
675 int os_jump_to_image(const void *dest, int size)
680 err = make_exec(fname, dest, size);
684 return os_jump_to_file(fname);
687 int os_find_u_boot(char *fname, int maxlen)
689 struct sandbox_state *state = state_get_current();
690 const char *progname = state->argv[0];
691 int len = strlen(progname);
696 if (len >= maxlen || len < 4)
699 strcpy(fname, progname);
700 suffix = fname + len - 4;
702 /* If we are TPL, boot to SPL */
703 if (!strcmp(suffix, "-tpl")) {
704 fname[len - 3] = 's';
705 fd = os_open(fname, O_RDONLY);
711 /* Look for 'u-boot-tpl' in the tpl/ directory */
712 p = strstr(fname, "/tpl/");
715 fd = os_open(fname, O_RDONLY);
724 /* Look for 'u-boot' in the same directory as 'u-boot-spl' */
725 if (!strcmp(suffix, "-spl")) {
726 fname[len - 4] = '\0';
727 fd = os_open(fname, O_RDONLY);
734 /* Look for 'u-boot' in the parent directory of spl/ */
735 p = strstr(fname, "/spl/");
738 fd = os_open(fname, O_RDONLY);
748 int os_spl_to_uboot(const char *fname)
750 struct sandbox_state *state = state_get_current();
751 char *argv[state->argc + 1];
754 memcpy(argv, state->argv, sizeof(char *) * (state->argc + 1));
755 argv[0] = (char *)fname;
756 ret = execv(fname, argv);
760 return unlink(fname);
763 void os_localtime(struct rtc_time *rt)
765 time_t t = time(NULL);
769 rt->tm_sec = tm->tm_sec;
770 rt->tm_min = tm->tm_min;
771 rt->tm_hour = tm->tm_hour;
772 rt->tm_mday = tm->tm_mday;
773 rt->tm_mon = tm->tm_mon + 1;
774 rt->tm_year = tm->tm_year + 1900;
775 rt->tm_wday = tm->tm_wday;
776 rt->tm_yday = tm->tm_yday;
777 rt->tm_isdst = tm->tm_isdst;
785 int os_mprotect_allow(void *start, size_t len)
787 int page_size = getpagesize();
789 /* Move start to the start of a page, len to the end */
790 start = (void *)(((ulong)start) & ~(page_size - 1));
791 len = (len + page_size * 2) & ~(page_size - 1);
793 return mprotect(start, len, PROT_READ | PROT_WRITE);