1 /* 2 * Copyright (c) 2011 The Chromium OS Authors. 3 * SPDX-License-Identifier: GPL-2.0+ 4 */ 5 6 #include <dirent.h> 7 #include <errno.h> 8 #include <fcntl.h> 9 #include <getopt.h> 10 #include <stdio.h> 11 #include <stdint.h> 12 #include <stdlib.h> 13 #include <string.h> 14 #include <termios.h> 15 #include <time.h> 16 #include <unistd.h> 17 #include <sys/mman.h> 18 #include <sys/stat.h> 19 #include <sys/time.h> 20 #include <sys/types.h> 21 #include <linux/types.h> 22 23 #include <asm/getopt.h> 24 #include <asm/sections.h> 25 #include <asm/state.h> 26 #include <os.h> 27 #include <rtc_def.h> 28 29 /* Operating System Interface */ 30 31 struct os_mem_hdr { 32 size_t length; /* number of bytes in the block */ 33 }; 34 35 ssize_t os_read(int fd, void *buf, size_t count) 36 { 37 return read(fd, buf, count); 38 } 39 40 ssize_t os_read_no_block(int fd, void *buf, size_t count) 41 { 42 const int flags = fcntl(fd, F_GETFL, 0); 43 44 fcntl(fd, F_SETFL, flags | O_NONBLOCK); 45 return os_read(fd, buf, count); 46 } 47 48 ssize_t os_write(int fd, const void *buf, size_t count) 49 { 50 return write(fd, buf, count); 51 } 52 53 off_t os_lseek(int fd, off_t offset, int whence) 54 { 55 if (whence == OS_SEEK_SET) 56 whence = SEEK_SET; 57 else if (whence == OS_SEEK_CUR) 58 whence = SEEK_CUR; 59 else if (whence == OS_SEEK_END) 60 whence = SEEK_END; 61 else 62 os_exit(1); 63 return lseek(fd, offset, whence); 64 } 65 66 int os_open(const char *pathname, int os_flags) 67 { 68 int flags; 69 70 switch (os_flags & OS_O_MASK) { 71 case OS_O_RDONLY: 72 default: 73 flags = O_RDONLY; 74 break; 75 76 case OS_O_WRONLY: 77 flags = O_WRONLY; 78 break; 79 80 case OS_O_RDWR: 81 flags = O_RDWR; 82 break; 83 } 84 85 if (os_flags & OS_O_CREAT) 86 flags |= O_CREAT; 87 88 return open(pathname, flags, 0777); 89 } 90 91 int os_close(int fd) 92 { 93 return close(fd); 94 } 95 96 int os_unlink(const char *pathname) 97 { 98 return unlink(pathname); 99 } 100 101 void os_exit(int exit_code) 102 { 103 exit(exit_code); 104 } 105 106 /* Restore tty state when we exit */ 107 static struct termios orig_term; 108 static bool term_setup; 109 110 void os_fd_restore(void) 111 { 112 if (term_setup) { 113 tcsetattr(0, TCSANOW, &orig_term); 114 term_setup = false; 115 } 116 } 117 118 /* Put tty into raw mode so <tab> and <ctrl+c> work */ 119 void os_tty_raw(int fd, bool allow_sigs) 120 { 121 struct termios term; 122 123 if (term_setup) 124 return; 125 126 /* If not a tty, don't complain */ 127 if (tcgetattr(fd, &orig_term)) 128 return; 129 130 term = orig_term; 131 term.c_iflag = IGNBRK | IGNPAR; 132 term.c_oflag = OPOST | ONLCR; 133 term.c_cflag = CS8 | CREAD | CLOCAL; 134 term.c_lflag = allow_sigs ? ISIG : 0; 135 if (tcsetattr(fd, TCSANOW, &term)) 136 return; 137 138 term_setup = true; 139 atexit(os_fd_restore); 140 } 141 142 void *os_malloc(size_t length) 143 { 144 struct os_mem_hdr *hdr; 145 146 hdr = mmap(NULL, length + sizeof(*hdr), PROT_READ | PROT_WRITE, 147 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); 148 if (hdr == MAP_FAILED) 149 return NULL; 150 hdr->length = length; 151 152 return hdr + 1; 153 } 154 155 void os_free(void *ptr) 156 { 157 struct os_mem_hdr *hdr = ptr; 158 159 hdr--; 160 if (ptr) 161 munmap(hdr, hdr->length + sizeof(*hdr)); 162 } 163 164 void *os_realloc(void *ptr, size_t length) 165 { 166 struct os_mem_hdr *hdr = ptr; 167 void *buf = NULL; 168 169 hdr--; 170 if (length != 0) { 171 buf = os_malloc(length); 172 if (!buf) 173 return buf; 174 if (ptr) { 175 if (length > hdr->length) 176 length = hdr->length; 177 memcpy(buf, ptr, length); 178 } 179 } 180 os_free(ptr); 181 182 return buf; 183 } 184 185 void os_usleep(unsigned long usec) 186 { 187 usleep(usec); 188 } 189 190 uint64_t __attribute__((no_instrument_function)) os_get_nsec(void) 191 { 192 #if defined(CLOCK_MONOTONIC) && defined(_POSIX_MONOTONIC_CLOCK) 193 struct timespec tp; 194 if (EINVAL == clock_gettime(CLOCK_MONOTONIC, &tp)) { 195 struct timeval tv; 196 197 gettimeofday(&tv, NULL); 198 tp.tv_sec = tv.tv_sec; 199 tp.tv_nsec = tv.tv_usec * 1000; 200 } 201 return tp.tv_sec * 1000000000ULL + tp.tv_nsec; 202 #else 203 struct timeval tv; 204 gettimeofday(&tv, NULL); 205 return tv.tv_sec * 1000000000ULL + tv.tv_usec * 1000; 206 #endif 207 } 208 209 static char *short_opts; 210 static struct option *long_opts; 211 212 int os_parse_args(struct sandbox_state *state, int argc, char *argv[]) 213 { 214 struct sandbox_cmdline_option **sb_opt = __u_boot_sandbox_option_start; 215 size_t num_options = __u_boot_sandbox_option_count(); 216 size_t i; 217 218 int hidden_short_opt; 219 size_t si; 220 221 int c; 222 223 if (short_opts || long_opts) 224 return 1; 225 226 state->argc = argc; 227 state->argv = argv; 228 229 /* dynamically construct the arguments to the system getopt_long */ 230 short_opts = os_malloc(sizeof(*short_opts) * num_options * 2 + 1); 231 long_opts = os_malloc(sizeof(*long_opts) * num_options); 232 if (!short_opts || !long_opts) 233 return 1; 234 235 /* 236 * getopt_long requires "val" to be unique (since that is what the 237 * func returns), so generate unique values automatically for flags 238 * that don't have a short option. pick 0x100 as that is above the 239 * single byte range (where ASCII/ISO-XXXX-X charsets live). 240 */ 241 hidden_short_opt = 0x100; 242 si = 0; 243 for (i = 0; i < num_options; ++i) { 244 long_opts[i].name = sb_opt[i]->flag; 245 long_opts[i].has_arg = sb_opt[i]->has_arg ? 246 required_argument : no_argument; 247 long_opts[i].flag = NULL; 248 249 if (sb_opt[i]->flag_short) { 250 short_opts[si++] = long_opts[i].val = sb_opt[i]->flag_short; 251 if (long_opts[i].has_arg == required_argument) 252 short_opts[si++] = ':'; 253 } else 254 long_opts[i].val = sb_opt[i]->flag_short = hidden_short_opt++; 255 } 256 short_opts[si] = '\0'; 257 258 /* we need to handle output ourselves since u-boot provides printf */ 259 opterr = 0; 260 261 /* 262 * walk all of the options the user gave us on the command line, 263 * figure out what u-boot option structure they belong to (via 264 * the unique short val key), and call the appropriate callback. 265 */ 266 while ((c = getopt_long(argc, argv, short_opts, long_opts, NULL)) != -1) { 267 for (i = 0; i < num_options; ++i) { 268 if (sb_opt[i]->flag_short == c) { 269 if (sb_opt[i]->callback(state, optarg)) { 270 state->parse_err = sb_opt[i]->flag; 271 return 0; 272 } 273 break; 274 } 275 } 276 if (i == num_options) { 277 /* 278 * store the faulting flag for later display. we have to 279 * store the flag itself as the getopt parsing itself is 280 * tricky: need to handle the following flags (assume all 281 * of the below are unknown): 282 * -a optopt='a' optind=<next> 283 * -abbbb optopt='a' optind=<this> 284 * -aaaaa optopt='a' optind=<this> 285 * --a optopt=0 optind=<this> 286 * as you can see, it is impossible to determine the exact 287 * faulting flag without doing the parsing ourselves, so 288 * we just report the specific flag that failed. 289 */ 290 if (optopt) { 291 static char parse_err[3] = { '-', 0, '\0', }; 292 parse_err[1] = optopt; 293 state->parse_err = parse_err; 294 } else 295 state->parse_err = argv[optind - 1]; 296 break; 297 } 298 } 299 300 return 0; 301 } 302 303 void os_dirent_free(struct os_dirent_node *node) 304 { 305 struct os_dirent_node *next; 306 307 while (node) { 308 next = node->next; 309 free(node); 310 node = next; 311 } 312 } 313 314 int os_dirent_ls(const char *dirname, struct os_dirent_node **headp) 315 { 316 struct dirent *entry; 317 struct os_dirent_node *head, *node, *next; 318 struct stat buf; 319 DIR *dir; 320 int ret; 321 char *fname; 322 int len; 323 int dirlen; 324 325 *headp = NULL; 326 dir = opendir(dirname); 327 if (!dir) 328 return -1; 329 330 /* Create a buffer upfront, with typically sufficient size */ 331 dirlen = strlen(dirname) + 2; 332 len = dirlen + 256; 333 fname = malloc(len); 334 if (!fname) { 335 ret = -ENOMEM; 336 goto done; 337 } 338 339 for (node = head = NULL;; node = next) { 340 errno = 0; 341 entry = readdir(dir); 342 if (!entry) { 343 ret = errno; 344 break; 345 } 346 next = malloc(sizeof(*node) + strlen(entry->d_name) + 1); 347 if (dirlen + strlen(entry->d_name) > len) { 348 len = dirlen + strlen(entry->d_name); 349 fname = realloc(fname, len); 350 } 351 if (!next || !fname) { 352 free(next); 353 os_dirent_free(head); 354 ret = -ENOMEM; 355 goto done; 356 } 357 next->next = NULL; 358 strcpy(next->name, entry->d_name); 359 switch (entry->d_type) { 360 case DT_REG: 361 next->type = OS_FILET_REG; 362 break; 363 case DT_DIR: 364 next->type = OS_FILET_DIR; 365 break; 366 case DT_LNK: 367 next->type = OS_FILET_LNK; 368 break; 369 default: 370 next->type = OS_FILET_UNKNOWN; 371 } 372 next->size = 0; 373 snprintf(fname, len, "%s/%s", dirname, next->name); 374 if (!stat(fname, &buf)) 375 next->size = buf.st_size; 376 if (node) 377 node->next = next; 378 else 379 head = next; 380 } 381 *headp = head; 382 383 done: 384 closedir(dir); 385 free(fname); 386 return ret; 387 } 388 389 const char *os_dirent_typename[OS_FILET_COUNT] = { 390 " ", 391 "SYM", 392 "DIR", 393 "???", 394 }; 395 396 const char *os_dirent_get_typename(enum os_dirent_t type) 397 { 398 if (type >= 0 && type < OS_FILET_COUNT) 399 return os_dirent_typename[type]; 400 401 return os_dirent_typename[OS_FILET_UNKNOWN]; 402 } 403 404 int os_get_filesize(const char *fname, loff_t *size) 405 { 406 struct stat buf; 407 int ret; 408 409 ret = stat(fname, &buf); 410 if (ret) 411 return ret; 412 *size = buf.st_size; 413 return 0; 414 } 415 416 void os_putc(int ch) 417 { 418 putchar(ch); 419 } 420 421 void os_puts(const char *str) 422 { 423 while (*str) 424 os_putc(*str++); 425 } 426 427 int os_write_ram_buf(const char *fname) 428 { 429 struct sandbox_state *state = state_get_current(); 430 int fd, ret; 431 432 fd = open(fname, O_CREAT | O_WRONLY, 0777); 433 if (fd < 0) 434 return -ENOENT; 435 ret = write(fd, state->ram_buf, state->ram_size); 436 close(fd); 437 if (ret != state->ram_size) 438 return -EIO; 439 440 return 0; 441 } 442 443 int os_read_ram_buf(const char *fname) 444 { 445 struct sandbox_state *state = state_get_current(); 446 int fd, ret; 447 loff_t size; 448 449 ret = os_get_filesize(fname, &size); 450 if (ret < 0) 451 return ret; 452 if (size != state->ram_size) 453 return -ENOSPC; 454 fd = open(fname, O_RDONLY); 455 if (fd < 0) 456 return -ENOENT; 457 458 ret = read(fd, state->ram_buf, state->ram_size); 459 close(fd); 460 if (ret != state->ram_size) 461 return -EIO; 462 463 return 0; 464 } 465 466 static int make_exec(char *fname, const void *data, int size) 467 { 468 int fd; 469 470 strcpy(fname, "/tmp/u-boot.jump.XXXXXX"); 471 fd = mkstemp(fname); 472 if (fd < 0) 473 return -ENOENT; 474 if (write(fd, data, size) < 0) 475 return -EIO; 476 close(fd); 477 if (chmod(fname, 0777)) 478 return -ENOEXEC; 479 480 return 0; 481 } 482 483 static int add_args(char ***argvp, const char *add_args[], int count) 484 { 485 char **argv; 486 int argc; 487 488 for (argv = *argvp, argc = 0; (*argvp)[argc]; argc++) 489 ; 490 491 argv = malloc((argc + count + 1) * sizeof(char *)); 492 if (!argv) { 493 printf("Out of memory for %d argv\n", count); 494 return -ENOMEM; 495 } 496 memcpy(argv, *argvp, argc * sizeof(char *)); 497 memcpy(argv + argc, add_args, count * sizeof(char *)); 498 argv[argc + count] = NULL; 499 500 *argvp = argv; 501 return 0; 502 } 503 504 int os_jump_to_image(const void *dest, int size) 505 { 506 struct sandbox_state *state = state_get_current(); 507 char fname[30], mem_fname[30]; 508 int fd, err; 509 const char *extra_args[5]; 510 char **argv = state->argv; 511 #ifdef DEBUG 512 int argc, i; 513 #endif 514 515 err = make_exec(fname, dest, size); 516 if (err) 517 return err; 518 519 strcpy(mem_fname, "/tmp/u-boot.mem.XXXXXX"); 520 fd = mkstemp(mem_fname); 521 if (fd < 0) 522 return -ENOENT; 523 close(fd); 524 err = os_write_ram_buf(mem_fname); 525 if (err) 526 return err; 527 528 os_fd_restore(); 529 530 extra_args[0] = "-j"; 531 extra_args[1] = fname; 532 extra_args[2] = "-m"; 533 extra_args[3] = mem_fname; 534 extra_args[4] = "--rm_memory"; 535 err = add_args(&argv, extra_args, 536 sizeof(extra_args) / sizeof(extra_args[0])); 537 if (err) 538 return err; 539 540 #ifdef DEBUG 541 for (i = 0; argv[i]; i++) 542 printf("%d %s\n", i, argv[i]); 543 #endif 544 545 if (state_uninit()) 546 os_exit(2); 547 548 err = execv(fname, argv); 549 free(argv); 550 if (err) 551 return err; 552 553 return unlink(fname); 554 } 555 556 int os_find_u_boot(char *fname, int maxlen) 557 { 558 struct sandbox_state *state = state_get_current(); 559 const char *progname = state->argv[0]; 560 int len = strlen(progname); 561 char *p; 562 int fd; 563 564 if (len >= maxlen || len < 4) 565 return -ENOSPC; 566 567 /* Look for 'u-boot' in the same directory as 'u-boot-spl' */ 568 strcpy(fname, progname); 569 if (!strcmp(fname + len - 4, "-spl")) { 570 fname[len - 4] = '\0'; 571 fd = os_open(fname, O_RDONLY); 572 if (fd >= 0) { 573 close(fd); 574 return 0; 575 } 576 } 577 578 /* Look for 'u-boot' in the parent directory of spl/ */ 579 p = strstr(fname, "/spl/"); 580 if (p) { 581 strcpy(p, p + 4); 582 fd = os_open(fname, O_RDONLY); 583 if (fd >= 0) { 584 close(fd); 585 return 0; 586 } 587 } 588 589 return -ENOENT; 590 } 591 592 int os_spl_to_uboot(const char *fname) 593 { 594 struct sandbox_state *state = state_get_current(); 595 char *argv[state->argc + 1]; 596 int ret; 597 598 memcpy(argv, state->argv, sizeof(char *) * (state->argc + 1)); 599 argv[0] = (char *)fname; 600 ret = execv(fname, argv); 601 if (ret) 602 return ret; 603 604 return unlink(fname); 605 } 606 607 void os_localtime(struct rtc_time *rt) 608 { 609 time_t t = time(NULL); 610 struct tm *tm; 611 612 tm = localtime(&t); 613 rt->tm_sec = tm->tm_sec; 614 rt->tm_min = tm->tm_min; 615 rt->tm_hour = tm->tm_hour; 616 rt->tm_mday = tm->tm_mday; 617 rt->tm_mon = tm->tm_mon + 1; 618 rt->tm_year = tm->tm_year + 1900; 619 rt->tm_wday = tm->tm_wday; 620 rt->tm_yday = tm->tm_yday; 621 rt->tm_isdst = tm->tm_isdst; 622 } 623