sandbox: avoid memory leak in os_dirent_ls
[oweals/u-boot.git] / arch / sandbox / cpu / os.c
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         char *old_fname;
323         int len;
324         int dirlen;
325
326         *headp = NULL;
327         dir = opendir(dirname);
328         if (!dir)
329                 return -1;
330
331         /* Create a buffer upfront, with typically sufficient size */
332         dirlen = strlen(dirname) + 2;
333         len = dirlen + 256;
334         fname = malloc(len);
335         if (!fname) {
336                 ret = -ENOMEM;
337                 goto done;
338         }
339
340         for (node = head = NULL;; node = next) {
341                 errno = 0;
342                 entry = readdir(dir);
343                 if (!entry) {
344                         ret = errno;
345                         break;
346                 }
347                 next = malloc(sizeof(*node) + strlen(entry->d_name) + 1);
348                 if (!next) {
349                         os_dirent_free(head);
350                         ret = -ENOMEM;
351                         goto done;
352                 }
353                 if (dirlen + strlen(entry->d_name) > len) {
354                         len = dirlen + strlen(entry->d_name);
355                         old_fname = fname;
356                         fname = realloc(fname, len);
357                         if (!fname) {
358                                 free(old_fname);
359                                 free(next);
360                                 os_dirent_free(head);
361                                 ret = -ENOMEM;
362                                 goto done;
363                         }
364                 }
365                 next->next = NULL;
366                 strcpy(next->name, entry->d_name);
367                 switch (entry->d_type) {
368                 case DT_REG:
369                         next->type = OS_FILET_REG;
370                         break;
371                 case DT_DIR:
372                         next->type = OS_FILET_DIR;
373                         break;
374                 case DT_LNK:
375                         next->type = OS_FILET_LNK;
376                         break;
377                 default:
378                         next->type = OS_FILET_UNKNOWN;
379                 }
380                 next->size = 0;
381                 snprintf(fname, len, "%s/%s", dirname, next->name);
382                 if (!stat(fname, &buf))
383                         next->size = buf.st_size;
384                 if (node)
385                         node->next = next;
386                 else
387                         head = next;
388         }
389         *headp = head;
390
391 done:
392         closedir(dir);
393         free(fname);
394         return ret;
395 }
396
397 const char *os_dirent_typename[OS_FILET_COUNT] = {
398         "   ",
399         "SYM",
400         "DIR",
401         "???",
402 };
403
404 const char *os_dirent_get_typename(enum os_dirent_t type)
405 {
406         if (type >= OS_FILET_REG && type < OS_FILET_COUNT)
407                 return os_dirent_typename[type];
408
409         return os_dirent_typename[OS_FILET_UNKNOWN];
410 }
411
412 int os_get_filesize(const char *fname, loff_t *size)
413 {
414         struct stat buf;
415         int ret;
416
417         ret = stat(fname, &buf);
418         if (ret)
419                 return ret;
420         *size = buf.st_size;
421         return 0;
422 }
423
424 int os_write_ram_buf(const char *fname)
425 {
426         struct sandbox_state *state = state_get_current();
427         int fd, ret;
428
429         fd = open(fname, O_CREAT | O_WRONLY, 0777);
430         if (fd < 0)
431                 return -ENOENT;
432         ret = write(fd, state->ram_buf, state->ram_size);
433         close(fd);
434         if (ret != state->ram_size)
435                 return -EIO;
436
437         return 0;
438 }
439
440 int os_read_ram_buf(const char *fname)
441 {
442         struct sandbox_state *state = state_get_current();
443         int fd, ret;
444         loff_t size;
445
446         ret = os_get_filesize(fname, &size);
447         if (ret < 0)
448                 return ret;
449         if (size != state->ram_size)
450                 return -ENOSPC;
451         fd = open(fname, O_RDONLY);
452         if (fd < 0)
453                 return -ENOENT;
454
455         ret = read(fd, state->ram_buf, state->ram_size);
456         close(fd);
457         if (ret != state->ram_size)
458                 return -EIO;
459
460         return 0;
461 }
462
463 static int make_exec(char *fname, const void *data, int size)
464 {
465         int fd;
466
467         strcpy(fname, "/tmp/u-boot.jump.XXXXXX");
468         fd = mkstemp(fname);
469         if (fd < 0)
470                 return -ENOENT;
471         if (write(fd, data, size) < 0)
472                 return -EIO;
473         close(fd);
474         if (chmod(fname, 0777))
475                 return -ENOEXEC;
476
477         return 0;
478 }
479
480 static int add_args(char ***argvp, const char *add_args[], int count)
481 {
482         char **argv;
483         int argc;
484
485         for (argv = *argvp, argc = 0; (*argvp)[argc]; argc++)
486                 ;
487
488         argv = malloc((argc + count + 1) * sizeof(char *));
489         if (!argv) {
490                 printf("Out of memory for %d argv\n", count);
491                 return -ENOMEM;
492         }
493         memcpy(argv, *argvp, argc * sizeof(char *));
494         memcpy(argv + argc, add_args, count * sizeof(char *));
495         argv[argc + count] = NULL;
496
497         *argvp = argv;
498         return 0;
499 }
500
501 int os_jump_to_image(const void *dest, int size)
502 {
503         struct sandbox_state *state = state_get_current();
504         char fname[30], mem_fname[30];
505         int fd, err;
506         const char *extra_args[5];
507         char **argv = state->argv;
508 #ifdef DEBUG
509         int argc, i;
510 #endif
511
512         err = make_exec(fname, dest, size);
513         if (err)
514                 return err;
515
516         strcpy(mem_fname, "/tmp/u-boot.mem.XXXXXX");
517         fd = mkstemp(mem_fname);
518         if (fd < 0)
519                 return -ENOENT;
520         close(fd);
521         err = os_write_ram_buf(mem_fname);
522         if (err)
523                 return err;
524
525         os_fd_restore();
526
527         extra_args[0] = "-j";
528         extra_args[1] = fname;
529         extra_args[2] = "-m";
530         extra_args[3] = mem_fname;
531         extra_args[4] = "--rm_memory";
532         err = add_args(&argv, extra_args,
533                        sizeof(extra_args) / sizeof(extra_args[0]));
534         if (err)
535                 return err;
536
537 #ifdef DEBUG
538         for (i = 0; argv[i]; i++)
539                 printf("%d %s\n", i, argv[i]);
540 #endif
541
542         if (state_uninit())
543                 os_exit(2);
544
545         err = execv(fname, argv);
546         free(argv);
547         if (err)
548                 return err;
549
550         return unlink(fname);
551 }
552
553 int os_find_u_boot(char *fname, int maxlen)
554 {
555         struct sandbox_state *state = state_get_current();
556         const char *progname = state->argv[0];
557         int len = strlen(progname);
558         char *p;
559         int fd;
560
561         if (len >= maxlen || len < 4)
562                 return -ENOSPC;
563
564         /* Look for 'u-boot' in the same directory as 'u-boot-spl' */
565         strcpy(fname, progname);
566         if (!strcmp(fname + len - 4, "-spl")) {
567                 fname[len - 4] = '\0';
568                 fd = os_open(fname, O_RDONLY);
569                 if (fd >= 0) {
570                         close(fd);
571                         return 0;
572                 }
573         }
574
575         /* Look for 'u-boot' in the parent directory of spl/ */
576         p = strstr(fname, "/spl/");
577         if (p) {
578                 strcpy(p, p + 4);
579                 fd = os_open(fname, O_RDONLY);
580                 if (fd >= 0) {
581                         close(fd);
582                         return 0;
583                 }
584         }
585
586         return -ENOENT;
587 }
588
589 int os_spl_to_uboot(const char *fname)
590 {
591         struct sandbox_state *state = state_get_current();
592         char *argv[state->argc + 1];
593         int ret;
594
595         memcpy(argv, state->argv, sizeof(char *) * (state->argc + 1));
596         argv[0] = (char *)fname;
597         ret = execv(fname, argv);
598         if (ret)
599                 return ret;
600
601         return unlink(fname);
602 }
603
604 void os_localtime(struct rtc_time *rt)
605 {
606         time_t t = time(NULL);
607         struct tm *tm;
608
609         tm = localtime(&t);
610         rt->tm_sec = tm->tm_sec;
611         rt->tm_min = tm->tm_min;
612         rt->tm_hour = tm->tm_hour;
613         rt->tm_mday = tm->tm_mday;
614         rt->tm_mon = tm->tm_mon + 1;
615         rt->tm_year = tm->tm_year + 1900;
616         rt->tm_wday = tm->tm_wday;
617         rt->tm_yday = tm->tm_yday;
618         rt->tm_isdst = tm->tm_isdst;
619 }