1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Operating System Interface
5 * This provides access to useful OS routines for the sandbox architecture.
6 * They are kept in a separate file so we can include system headers.
8 * Copyright (c) 2011 The Chromium OS Authors.
14 #include <linux/types.h>
20 * os_printf() - print directly to OS console
22 * @format: format string
24 int os_printf(const char *format, ...);
27 * Access to the OS read() system call
29 * @fd: File descriptor as returned by os_open()
30 * @buf: Buffer to place data
31 * @count: Number of bytes to read
32 * Return: number of bytes read, or -1 on error
34 ssize_t os_read(int fd, void *buf, size_t count);
37 * Access to the OS write() system call
39 * @fd: File descriptor as returned by os_open()
40 * @buf: Buffer containing data to write
41 * @count: Number of bytes to write
42 * Return: number of bytes written, or -1 on error
44 ssize_t os_write(int fd, const void *buf, size_t count);
47 * Access to the OS lseek() system call
49 * @fd: File descriptor as returned by os_open()
50 * @offset: File offset (based on whence)
51 * @whence: Position offset is relative to (see below)
52 * Return: new file offset
54 off_t os_lseek(int fd, off_t offset, int whence);
56 /* Defines for "whence" in os_lseek() */
62 * os_filesize() - Calculate the size of a file
64 * @fd: File descriptor as returned by os_open()
65 * Return: file size or negative error code
67 int os_filesize(int fd);
70 * Access to the OS open() system call
72 * @pathname: Pathname of file to open
73 * @flags: Flags, like OS_O_RDONLY, OS_O_RDWR
74 * Return: file descriptor, or -1 on error
76 int os_open(const char *pathname, int flags);
81 #define OS_O_MASK 3 /* Mask for read/write flags */
82 #define OS_O_CREAT 0100
83 #define OS_O_TRUNC 01000
86 * os_close() - access to the OS close() system call
88 * @fd: File descriptor to close
89 * Return: 0 on success, -1 on error
94 * os_unlink() - access to the OS unlink() system call
96 * @pathname: Path of file to delete
97 * Return: 0 for success, other for error
99 int os_unlink(const char *pathname);
102 * os_exit() - access to the OS exit() system call
104 * This exits with the supplied return code, which should be 0 to indicate
107 * @exit_code: exit code for U-Boot
109 void os_exit(int exit_code) __attribute__((noreturn));
112 * os_alarm() - access to the OS alarm() system call
114 unsigned int os_alarm(unsigned int seconds);
117 * os_set_alarm_handler() - set handler for SIGALRM
119 * @handler: The handler function. Pass NULL for SIG_DFL.
121 void os_set_alarm_handler(void (*handler)(int));
124 * os_raise_sigalrm() - do raise(SIGALRM)
126 void os_raise_sigalrm(void);
129 * os_tty_raw() - put tty into raw mode to mimic serial console better
131 * @fd: File descriptor of stdin (normally 0)
132 * @allow_sigs: Allow Ctrl-C, Ctrl-Z to generate signals rather than
133 * be handled by U-Boot
135 void os_tty_raw(int fd, bool allow_sigs);
138 * os_fs_restore() - restore the tty to its original mode
140 * Call this to restore the original terminal mode, after it has been changed
141 * by os_tty_raw(). This is an internal function.
143 void os_fd_restore(void);
146 * os_malloc() - aquires some memory from the underlying os.
148 * @length: Number of bytes to be allocated
149 * Return: Pointer to length bytes or NULL if @length is 0 or on error
151 void *os_malloc(size_t length);
154 * os_free() - free memory previous allocated with os_malloc()
156 * This returns the memory to the OS.
158 * @ptr: Pointer to memory block to free. If this is NULL then this
159 * function does nothing
161 void os_free(void *ptr);
164 * os_realloc() - reallocate memory
166 * This follows the semantics of realloc(), so can perform an os_malloc() or
167 * os_free() depending on @ptr and @length.
169 * @ptr: pointer to previously allocated memory of NULL
170 * @length: number of bytes to allocate
171 * Return: pointer to reallocated memory or NULL if @length is 0
173 void *os_realloc(void *ptr, size_t length);
176 * os_usleep() - access to the usleep function of the os
178 * @usec: time to sleep in micro seconds
180 void os_usleep(unsigned long usec);
183 * Gets a monotonic increasing number of nano seconds from the OS
185 * Return: a monotonic increasing time scaled in nano seconds
187 uint64_t os_get_nsec(void);
190 * Parse arguments and update sandbox state.
192 * @state: sandbox state to update
193 * @argc: argument count
194 * @argv: argument vector
196 * * 0 if ok, and program should continue
197 * * 1 if ok, but program should stop
198 * * -1 on error: program should terminate
200 int os_parse_args(struct sandbox_state *state, int argc, char *argv[]);
203 * enum os_dirent_t - type of directory entry
205 * Types of directory entry that we support. See also os_dirent_typename in
210 * @OS_FILET_REG: regular file
214 * @OS_FILET_LNK: symbolic link
218 * @OS_FILET_DIR: directory
222 * @OS_FILET_UNKNOWN: something else
226 * @OS_FILET_COUNT: number of directory entry types
232 * struct os_dirent_node - directory node
234 * A directory entry node, containing information about a single dirent
237 struct os_dirent_node {
239 * @next: pointer to next node, or NULL
241 struct os_dirent_node *next;
243 * @size: size of file in bytes
247 * @type: type of entry
249 enum os_dirent_t type;
251 * @name: name of entry
257 * os_dirent_ls() - get a directory listing
259 * This allocates and returns a linked list containing the directory listing.
261 * @dirname: directory to examine
262 * @headp: on return pointer to head of linked list, or NULL if none
263 * Return: 0 if ok, -ve on error
265 int os_dirent_ls(const char *dirname, struct os_dirent_node **headp);
268 * os_dirent_free() - free directory list
270 * This frees a linked list containing a directory listing.
272 * @node: pointer to head of linked list
274 void os_dirent_free(struct os_dirent_node *node);
277 * os_dirent_get_typename() - get the name of a directory entry type
279 * @type: type to check
281 * string containing the name of that type,
282 * or "???" if none/invalid
284 const char *os_dirent_get_typename(enum os_dirent_t type);
287 * os_get_filesize() - get the size of a file
289 * @fname: filename to check
290 * @size: size of file is returned if no error
291 * Return: 0 on success or -1 if an error ocurred
293 int os_get_filesize(const char *fname, long long *size);
296 * os_putc() - write a character to the controlling OS terminal
298 * This bypasses the U-Boot console support and writes directly to the OS
299 * stdout file descriptor.
301 * @ch: haracter to write
303 void os_putc(int ch);
306 * os_puts() - write a string to the controlling OS terminal
308 * This bypasses the U-Boot console support and writes directly to the OS
309 * stdout file descriptor.
311 * @str: string to write (note that \n is not appended)
313 void os_puts(const char *str);
316 * os_flush() - flush controlling OS terminal
318 * This bypasses the U-Boot console support and flushes directly the OS
319 * stdout file descriptor.
324 * os_write_ram_buf() - write the sandbox RAM buffer to a existing file
326 * @fname: filename to write memory to (simple binary format)
327 * Return: 0 if OK, -ve on error
329 int os_write_ram_buf(const char *fname);
332 * os_read_ram_buf() - read the sandbox RAM buffer from an existing file
334 * @fname: filename containing memory (simple binary format)
335 * Return: 0 if OK, -ve on error
337 int os_read_ram_buf(const char *fname);
340 * os_jump_to_image() - jump to a new executable image
342 * This uses exec() to run a new executable image, after putting it in a
343 * temporary file. The same arguments and environment are passed to this
344 * new image, with the addition of:
346 * -j <filename> Specifies the filename the image was written to. The
347 * calling image may want to delete this at some point.
348 * -m <filename> Specifies the file containing the sandbox memory
349 * (ram_buf) from this image, so that the new image can
350 * have access to this. It also means that the original
351 * memory filename passed to U-Boot will be left intact.
353 * @dest: buffer containing executable image
354 * @size: size of buffer
355 * Return: 0 if OK, -ve on error
357 int os_jump_to_image(const void *dest, int size);
360 * os_find_u_boot() - determine the path to U-Boot proper
362 * This function is intended to be called from within sandbox SPL. It uses
363 * a few heuristics to find U-Boot proper. Normally it is either in the same
364 * directory, or the directory above (since u-boot-spl is normally in an
365 * spl/ subdirectory when built).
367 * @fname: place to put full path to U-Boot
368 * @maxlen: maximum size of @fname
369 * @use_img: select the 'u-boot.img' file instead of the 'u-boot' ELF file
370 * @cur_prefix: prefix of current executable, e.g. "spl" or "tpl"
371 * @next_prefix: prefix of executable to find, e.g. "spl" or ""
372 * Return: 0 if OK, -NOSPC if the filename is too large, -ENOENT if not found
374 int os_find_u_boot(char *fname, int maxlen, bool use_img,
375 const char *cur_prefix, const char *next_prefix);
378 * os_spl_to_uboot() - Run U-Boot proper
380 * When called from SPL, this runs U-Boot proper. The filename is obtained by
381 * calling os_find_u_boot().
383 * @fname: full pathname to U-Boot executable
384 * Return: 0 if OK, -ve on error
386 int os_spl_to_uboot(const char *fname);
389 * os_localtime() - read the current system time
391 * This reads the current Local Time and places it into the provided
394 * @rt: place to put system time
396 void os_localtime(struct rtc_time *rt);
399 * os_abort() - raise SIGABRT to exit sandbox (e.g. to debugger)
401 void os_abort(void) __attribute__((noreturn));
404 * os_mprotect_allow() - Remove write-protection on a region of memory
406 * The start and length will be page-aligned before use.
408 * @start: Region start
409 * @len: Region length in bytes
410 * Return: 0 if OK, -1 on error from mprotect()
412 int os_mprotect_allow(void *start, size_t len);
415 * os_write_file() - write a file to the host filesystem
417 * This can be useful when debugging for writing data out of sandbox for
418 * inspection by external tools.
420 * @name: File path to write to
421 * @buf: Data to write
422 * @size: Size of data to write
423 * Return: 0 if OK, -ve on error
425 int os_write_file(const char *name, const void *buf, int size);
428 * os_read_file() - Read a file from the host filesystem
430 * This can be useful when reading test data into sandbox for use by test
431 * routines. The data is allocated using os_malloc() and should be freed by
434 * @name: File path to read from
435 * @bufp: Returns buffer containing data read
436 * @sizep: Returns size of data
437 * Return: 0 if OK, -ve on error
439 int os_read_file(const char *name, void **bufp, int *sizep);
442 * os_map_file() - Map a file from the host filesystem into memory
444 * This can be useful when to provide a backing store for an emulated device
446 * @pathname: File pathname to map
447 * @os_flags: Flags, like OS_O_RDONLY, OS_O_RDWR
448 * @bufp: Returns buffer containing the file
449 * @sizep: Returns size of data
450 * Return: 0 if OK, -ve on error
452 int os_map_file(const char *pathname, int os_flags, void **bufp, int *sizep);
455 * os_unmap() - Unmap a file previously mapped
457 * @buf: Mapped address
458 * @size: Size in bytes
459 * Return: 0 if OK, -ve on error
461 int os_unmap(void *buf, int size);
464 * os_find_text_base() - Find the text section in this running process
466 * This tries to find the address of the text section in this running process.
467 * It can be useful to map the address of functions to the address listed in
468 * the u-boot.map file.
470 * Return: address if found, else NULL
472 void *os_find_text_base(void);
475 * os_relaunch() - restart the sandbox
477 * This functions is used to implement the cold reboot of the sand box.
478 * @argv\[0] specifies the binary that is started while the calling process
479 * stops immediately. If the new binary cannot be started, the process is
480 * terminated and 1 is set as shell return code.
482 * The PID of the process stays the same. All file descriptors that have not
483 * been opened with O_CLOEXEC stay open including stdin, stdout, stderr.
485 * @argv: NULL terminated list of command line parameters
487 void os_relaunch(char *argv[]);
490 * os_setup_signal_handlers() - setup signal handlers
492 * Install signal handlers for SIGBUS and SIGSEGV.
494 * Return: 0 for success
496 int os_setup_signal_handlers(void);
499 * os_signal_action() - handle a signal
502 * @pc: program counter
504 void os_signal_action(int sig, unsigned long pc);
507 * os_get_time_offset() - get time offset
509 * Get the time offset from environment variable UBOOT_SB_TIME_OFFSET.
511 * Return: offset in seconds
513 long os_get_time_offset(void);
516 * os_set_time_offset() - set time offset
518 * Save the time offset in environment variable UBOOT_SB_TIME_OFFSET.
520 * @offset: offset in seconds
522 void os_set_time_offset(long offset);