xref: /openbmc/u-boot/arch/sandbox/cpu/os.c (revision 60570df1)
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 static void os_fd_restore(void)
111 {
112 	if (term_setup)
113 		tcsetattr(0, TCSANOW, &orig_term);
114 }
115 
116 /* Put tty into raw mode so <tab> and <ctrl+c> work */
117 void os_tty_raw(int fd, bool allow_sigs)
118 {
119 	struct termios term;
120 
121 	if (term_setup)
122 		return;
123 	term_setup = true;
124 
125 	/* If not a tty, don't complain */
126 	if (tcgetattr(fd, &orig_term))
127 		return;
128 
129 	term = orig_term;
130 	term.c_iflag = IGNBRK | IGNPAR;
131 	term.c_oflag = OPOST | ONLCR;
132 	term.c_cflag = CS8 | CREAD | CLOCAL;
133 	term.c_lflag = allow_sigs ? ISIG : 0;
134 	if (tcsetattr(fd, TCSANOW, &term))
135 		return;
136 
137 	atexit(os_fd_restore);
138 }
139 
140 void *os_malloc(size_t length)
141 {
142 	struct os_mem_hdr *hdr;
143 
144 	hdr = mmap(NULL, length + sizeof(*hdr), PROT_READ | PROT_WRITE,
145 		   MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
146 	if (hdr == MAP_FAILED)
147 		return NULL;
148 	hdr->length = length;
149 
150 	return hdr + 1;
151 }
152 
153 void os_free(void *ptr)
154 {
155 	struct os_mem_hdr *hdr = ptr;
156 
157 	hdr--;
158 	if (ptr)
159 		munmap(hdr, hdr->length + sizeof(*hdr));
160 }
161 
162 void *os_realloc(void *ptr, size_t length)
163 {
164 	struct os_mem_hdr *hdr = ptr;
165 	void *buf = NULL;
166 
167 	hdr--;
168 	if (length != 0) {
169 		buf = os_malloc(length);
170 		if (!buf)
171 			return buf;
172 		if (ptr) {
173 			if (length > hdr->length)
174 				length = hdr->length;
175 			memcpy(buf, ptr, length);
176 		}
177 	}
178 	os_free(ptr);
179 
180 	return buf;
181 }
182 
183 void os_usleep(unsigned long usec)
184 {
185 	usleep(usec);
186 }
187 
188 uint64_t __attribute__((no_instrument_function)) os_get_nsec(void)
189 {
190 #if defined(CLOCK_MONOTONIC) && defined(_POSIX_MONOTONIC_CLOCK)
191 	struct timespec tp;
192 	if (EINVAL == clock_gettime(CLOCK_MONOTONIC, &tp)) {
193 		struct timeval tv;
194 
195 		gettimeofday(&tv, NULL);
196 		tp.tv_sec = tv.tv_sec;
197 		tp.tv_nsec = tv.tv_usec * 1000;
198 	}
199 	return tp.tv_sec * 1000000000ULL + tp.tv_nsec;
200 #else
201 	struct timeval tv;
202 	gettimeofday(&tv, NULL);
203 	return tv.tv_sec * 1000000000ULL + tv.tv_usec * 1000;
204 #endif
205 }
206 
207 static char *short_opts;
208 static struct option *long_opts;
209 
210 int os_parse_args(struct sandbox_state *state, int argc, char *argv[])
211 {
212 	struct sandbox_cmdline_option **sb_opt = __u_boot_sandbox_option_start;
213 	size_t num_options = __u_boot_sandbox_option_count();
214 	size_t i;
215 
216 	int hidden_short_opt;
217 	size_t si;
218 
219 	int c;
220 
221 	if (short_opts || long_opts)
222 		return 1;
223 
224 	state->argc = argc;
225 	state->argv = argv;
226 
227 	/* dynamically construct the arguments to the system getopt_long */
228 	short_opts = os_malloc(sizeof(*short_opts) * num_options * 2 + 1);
229 	long_opts = os_malloc(sizeof(*long_opts) * num_options);
230 	if (!short_opts || !long_opts)
231 		return 1;
232 
233 	/*
234 	 * getopt_long requires "val" to be unique (since that is what the
235 	 * func returns), so generate unique values automatically for flags
236 	 * that don't have a short option.  pick 0x100 as that is above the
237 	 * single byte range (where ASCII/ISO-XXXX-X charsets live).
238 	 */
239 	hidden_short_opt = 0x100;
240 	si = 0;
241 	for (i = 0; i < num_options; ++i) {
242 		long_opts[i].name = sb_opt[i]->flag;
243 		long_opts[i].has_arg = sb_opt[i]->has_arg ?
244 			required_argument : no_argument;
245 		long_opts[i].flag = NULL;
246 
247 		if (sb_opt[i]->flag_short) {
248 			short_opts[si++] = long_opts[i].val = sb_opt[i]->flag_short;
249 			if (long_opts[i].has_arg == required_argument)
250 				short_opts[si++] = ':';
251 		} else
252 			long_opts[i].val = sb_opt[i]->flag_short = hidden_short_opt++;
253 	}
254 	short_opts[si] = '\0';
255 
256 	/* we need to handle output ourselves since u-boot provides printf */
257 	opterr = 0;
258 
259 	/*
260 	 * walk all of the options the user gave us on the command line,
261 	 * figure out what u-boot option structure they belong to (via
262 	 * the unique short val key), and call the appropriate callback.
263 	 */
264 	while ((c = getopt_long(argc, argv, short_opts, long_opts, NULL)) != -1) {
265 		for (i = 0; i < num_options; ++i) {
266 			if (sb_opt[i]->flag_short == c) {
267 				if (sb_opt[i]->callback(state, optarg)) {
268 					state->parse_err = sb_opt[i]->flag;
269 					return 0;
270 				}
271 				break;
272 			}
273 		}
274 		if (i == num_options) {
275 			/*
276 			 * store the faulting flag for later display.  we have to
277 			 * store the flag itself as the getopt parsing itself is
278 			 * tricky: need to handle the following flags (assume all
279 			 * of the below are unknown):
280 			 *   -a        optopt='a' optind=<next>
281 			 *   -abbbb    optopt='a' optind=<this>
282 			 *   -aaaaa    optopt='a' optind=<this>
283 			 *   --a       optopt=0   optind=<this>
284 			 * as you can see, it is impossible to determine the exact
285 			 * faulting flag without doing the parsing ourselves, so
286 			 * we just report the specific flag that failed.
287 			 */
288 			if (optopt) {
289 				static char parse_err[3] = { '-', 0, '\0', };
290 				parse_err[1] = optopt;
291 				state->parse_err = parse_err;
292 			} else
293 				state->parse_err = argv[optind - 1];
294 			break;
295 		}
296 	}
297 
298 	return 0;
299 }
300 
301 void os_dirent_free(struct os_dirent_node *node)
302 {
303 	struct os_dirent_node *next;
304 
305 	while (node) {
306 		next = node->next;
307 		free(node);
308 		node = next;
309 	}
310 }
311 
312 int os_dirent_ls(const char *dirname, struct os_dirent_node **headp)
313 {
314 	struct dirent entry, *result;
315 	struct os_dirent_node *head, *node, *next;
316 	struct stat buf;
317 	DIR *dir;
318 	int ret;
319 	char *fname;
320 	int len;
321 
322 	*headp = NULL;
323 	dir = opendir(dirname);
324 	if (!dir)
325 		return -1;
326 
327 	/* Create a buffer for the maximum filename length */
328 	len = sizeof(entry.d_name) + strlen(dirname) + 2;
329 	fname = malloc(len);
330 	if (!fname) {
331 		ret = -ENOMEM;
332 		goto done;
333 	}
334 
335 	for (node = head = NULL;; node = next) {
336 		ret = readdir_r(dir, &entry, &result);
337 		if (ret || !result)
338 			break;
339 		next = malloc(sizeof(*node) + strlen(entry.d_name) + 1);
340 		if (!next) {
341 			os_dirent_free(head);
342 			ret = -ENOMEM;
343 			goto done;
344 		}
345 		next->next = NULL;
346 		strcpy(next->name, entry.d_name);
347 		switch (entry.d_type) {
348 		case DT_REG:
349 			next->type = OS_FILET_REG;
350 			break;
351 		case DT_DIR:
352 			next->type = OS_FILET_DIR;
353 			break;
354 		case DT_LNK:
355 			next->type = OS_FILET_LNK;
356 			break;
357 		}
358 		next->size = 0;
359 		snprintf(fname, len, "%s/%s", dirname, next->name);
360 		if (!stat(fname, &buf))
361 			next->size = buf.st_size;
362 		if (node)
363 			node->next = next;
364 		if (!head)
365 			head = node;
366 	}
367 	*headp = head;
368 
369 done:
370 	closedir(dir);
371 	free(fname);
372 	return ret;
373 }
374 
375 const char *os_dirent_typename[OS_FILET_COUNT] = {
376 	"   ",
377 	"SYM",
378 	"DIR",
379 	"???",
380 };
381 
382 const char *os_dirent_get_typename(enum os_dirent_t type)
383 {
384 	if (type >= 0 && type < OS_FILET_COUNT)
385 		return os_dirent_typename[type];
386 
387 	return os_dirent_typename[OS_FILET_UNKNOWN];
388 }
389 
390 int os_get_filesize(const char *fname, loff_t *size)
391 {
392 	struct stat buf;
393 	int ret;
394 
395 	ret = stat(fname, &buf);
396 	if (ret)
397 		return ret;
398 	*size = buf.st_size;
399 	return 0;
400 }
401 
402 void os_putc(int ch)
403 {
404 	putchar(ch);
405 }
406 
407 void os_puts(const char *str)
408 {
409 	while (*str)
410 		os_putc(*str++);
411 }
412 
413 int os_write_ram_buf(const char *fname)
414 {
415 	struct sandbox_state *state = state_get_current();
416 	int fd, ret;
417 
418 	fd = open(fname, O_CREAT | O_WRONLY, 0777);
419 	if (fd < 0)
420 		return -ENOENT;
421 	ret = write(fd, state->ram_buf, state->ram_size);
422 	close(fd);
423 	if (ret != state->ram_size)
424 		return -EIO;
425 
426 	return 0;
427 }
428 
429 int os_read_ram_buf(const char *fname)
430 {
431 	struct sandbox_state *state = state_get_current();
432 	int fd, ret;
433 	loff_t size;
434 
435 	ret = os_get_filesize(fname, &size);
436 	if (ret < 0)
437 		return ret;
438 	if (size != state->ram_size)
439 		return -ENOSPC;
440 	fd = open(fname, O_RDONLY);
441 	if (fd < 0)
442 		return -ENOENT;
443 
444 	ret = read(fd, state->ram_buf, state->ram_size);
445 	close(fd);
446 	if (ret != state->ram_size)
447 		return -EIO;
448 
449 	return 0;
450 }
451 
452 static int make_exec(char *fname, const void *data, int size)
453 {
454 	int fd;
455 
456 	strcpy(fname, "/tmp/u-boot.jump.XXXXXX");
457 	fd = mkstemp(fname);
458 	if (fd < 0)
459 		return -ENOENT;
460 	if (write(fd, data, size) < 0)
461 		return -EIO;
462 	close(fd);
463 	if (chmod(fname, 0777))
464 		return -ENOEXEC;
465 
466 	return 0;
467 }
468 
469 static int add_args(char ***argvp, const char *add_args[], int count)
470 {
471 	char **argv;
472 	int argc;
473 
474 	for (argv = *argvp, argc = 0; (*argvp)[argc]; argc++)
475 		;
476 
477 	argv = malloc((argc + count + 1) * sizeof(char *));
478 	if (!argv) {
479 		printf("Out of memory for %d argv\n", count);
480 		return -ENOMEM;
481 	}
482 	memcpy(argv, *argvp, argc * sizeof(char *));
483 	memcpy(argv + argc, add_args, count * sizeof(char *));
484 	argv[argc + count] = NULL;
485 
486 	*argvp = argv;
487 	return 0;
488 }
489 
490 int os_jump_to_image(const void *dest, int size)
491 {
492 	struct sandbox_state *state = state_get_current();
493 	char fname[30], mem_fname[30];
494 	int fd, err;
495 	const char *extra_args[5];
496 	char **argv = state->argv;
497 #ifdef DEBUG
498 	int argc, i;
499 #endif
500 
501 	err = make_exec(fname, dest, size);
502 	if (err)
503 		return err;
504 
505 	strcpy(mem_fname, "/tmp/u-boot.mem.XXXXXX");
506 	fd = mkstemp(mem_fname);
507 	if (fd < 0)
508 		return -ENOENT;
509 	close(fd);
510 	err = os_write_ram_buf(mem_fname);
511 	if (err)
512 		return err;
513 
514 	os_fd_restore();
515 
516 	extra_args[0] = "-j";
517 	extra_args[1] = fname;
518 	extra_args[2] = "-m";
519 	extra_args[3] = mem_fname;
520 	extra_args[4] = "--rm_memory";
521 	err = add_args(&argv, extra_args,
522 		       sizeof(extra_args) / sizeof(extra_args[0]));
523 	if (err)
524 		return err;
525 
526 #ifdef DEBUG
527 	for (i = 0; argv[i]; i++)
528 		printf("%d %s\n", i, argv[i]);
529 #endif
530 
531 	if (state_uninit())
532 		os_exit(2);
533 
534 	err = execv(fname, argv);
535 	free(argv);
536 	if (err)
537 		return err;
538 
539 	return unlink(fname);
540 }
541 
542 void os_localtime(struct rtc_time *rt)
543 {
544 	time_t t = time(NULL);
545 	struct tm *tm;
546 
547 	tm = localtime(&t);
548 	rt->tm_sec = tm->tm_sec;
549 	rt->tm_min = tm->tm_min;
550 	rt->tm_hour = tm->tm_hour;
551 	rt->tm_mday = tm->tm_mday;
552 	rt->tm_mon = tm->tm_mon + 1;
553 	rt->tm_year = tm->tm_year + 1900;
554 	rt->tm_wday = tm->tm_wday;
555 	rt->tm_yday = tm->tm_yday;
556 	rt->tm_isdst = tm->tm_isdst;
557 }
558