arch/sandbox/cpu/os.c

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