2 * Operating System Interface
4 * This provides access to useful OS routines for the sandbox architecture.
5 * They are kept in a separate file so we can include system headers.
7 * Copyright (c) 2011 The Chromium OS Authors.
8 * SPDX-License-Identifier: GPL-2.0+
14 #include <linux/types.h>
20 * Access to the OS read() system call
22 * \param fd File descriptor as returned by os_open()
23 * \param buf Buffer to place data
24 * \param count Number of bytes to read
25 * \return number of bytes read, or -1 on error
27 ssize_t os_read(int fd, void *buf, size_t count);
30 * Access to the OS read() system call with non-blocking access
32 * \param fd File descriptor as returned by os_open()
33 * \param buf Buffer to place data
34 * \param count Number of bytes to read
35 * \return number of bytes read, or -1 on error
37 ssize_t os_read_no_block(int fd, void *buf, size_t count);
40 * Access to the OS write() system call
42 * \param fd File descriptor as returned by os_open()
43 * \param buf Buffer containing data to write
44 * \param count Number of bytes to write
45 * \return number of bytes written, or -1 on error
47 ssize_t os_write(int fd, const void *buf, size_t count);
50 * Access to the OS lseek() system call
52 * \param fd File descriptor as returned by os_open()
53 * \param offset File offset (based on whence)
54 * \param whence Position offset is relative to (see below)
55 * \return new file offset
57 off_t os_lseek(int fd, off_t offset, int whence);
59 /* Defines for "whence" in os_lseek() */
65 * Access to the OS open() system call
67 * \param pathname Pathname of file to open
68 * \param flags Flags, like OS_O_RDONLY, OS_O_RDWR
69 * \return file descriptor, or -1 on error
71 int os_open(const char *pathname, int flags);
76 #define OS_O_MASK 3 /* Mask for read/write flags */
77 #define OS_O_CREAT 0100
80 * Access to the OS close() system call
82 * \param fd File descriptor to close
83 * \return 0 on success, -1 on error
88 * Access to the OS unlink() system call
90 * \param pathname Path of file to delete
91 * \return 0 for success, other for error
93 int os_unlink(const char *pathname);
96 * Access to the OS exit() system call
98 * This exits with the supplied return code, which should be 0 to indicate
101 * @param exit_code exit code for U-Boot
103 void os_exit(int exit_code) __attribute__((noreturn));
106 * Put tty into raw mode to mimic serial console better
108 * @param fd File descriptor of stdin (normally 0)
109 * @param allow_sigs Allow Ctrl-C, Ctrl-Z to generate signals rather than
110 * be handled by U-Boot
112 void os_tty_raw(int fd, bool allow_sigs);
115 * Acquires some memory from the underlying os.
117 * \param length Number of bytes to be allocated
118 * \return Pointer to length bytes or NULL on error
120 void *os_malloc(size_t length);
123 * Free memory previous allocated with os_malloc()/os_realloc()
125 * This returns the memory to the OS.
127 * \param ptr Pointer to memory block to free
129 void os_free(void *ptr);
132 * Reallocate previously-allocated memory to increase/decrease space
134 * This works in a similar way to the C library realloc() function. If
135 * length is 0, then ptr is freed. Otherwise the space used by ptr is
136 * expanded or reduced depending on whether length is larger or smaller
139 * If ptr is NULL, then this is similar to calling os_malloc().
141 * This function may need to move the memory block to make room for any
142 * extra space, in which case the new pointer is returned.
144 * \param ptr Pointer to memory block to reallocate
145 * \param length New length for memory block
146 * \return pointer to new memory block, or NULL on failure or if length
149 void *os_realloc(void *ptr, size_t length);
152 * Access to the usleep function of the os
154 * \param usec Time to sleep in micro seconds
156 void os_usleep(unsigned long usec);
159 * Gets a monotonic increasing number of nano seconds from the OS
161 * \return A monotonic increasing time scaled in nano seconds
163 uint64_t os_get_nsec(void);
166 * Parse arguments and update sandbox state.
168 * @param state Sandbox state to update
169 * @param argc Argument count
170 * @param argv Argument vector
171 * @return 0 if ok, and program should continue;
172 * 1 if ok, but program should stop;
173 * -1 on error: program should terminate.
175 int os_parse_args(struct sandbox_state *state, int argc, char *argv[]);
178 * Types of directory entry that we support. See also os_dirent_typename in
182 OS_FILET_REG, /* Regular file */
183 OS_FILET_LNK, /* Symbolic link */
184 OS_FILET_DIR, /* Directory */
185 OS_FILET_UNKNOWN, /* Something else */
190 /** A directory entry node, containing information about a single dirent */
191 struct os_dirent_node {
192 struct os_dirent_node *next; /* Pointer to next node, or NULL */
193 ulong size; /* Size of file in bytes */
194 enum os_dirent_t type; /* Type of entry */
195 char name[0]; /* Name of entry */
199 * Get a directionry listing
201 * This allocates and returns a linked list containing the directory listing.
203 * @param dirname Directory to examine
204 * @param headp Returns pointer to head of linked list, or NULL if none
205 * @return 0 if ok, -ve on error
207 int os_dirent_ls(const char *dirname, struct os_dirent_node **headp);
210 * Get the name of a directory entry type
212 * @param type Type to cehck
213 * @return string containing the name of that type, or "???" if none/invalid
215 const char *os_dirent_get_typename(enum os_dirent_t type);
218 * Get the size of a file
220 * @param fname Filename to check
221 * @param size size of file is returned if no error
222 * @return 0 on success or -1 if an error ocurred
224 int os_get_filesize(const char *fname, loff_t *size);
227 * Write a character to the controlling OS terminal
229 * This bypasses the U-Boot console support and writes directly to the OS
230 * stdout file descriptor.
232 * @param ch Character to write
234 void os_putc(int ch);
237 * Write a string to the controlling OS terminal
239 * This bypasses the U-Boot console support and writes directly to the OS
240 * stdout file descriptor.
242 * @param str String to write (note that \n is not appended)
244 void os_puts(const char *str);
247 * Write the sandbox RAM buffer to a existing file
249 * @param fname Filename to write memory to (simple binary format)
250 * @return 0 if OK, -ve on error
252 int os_write_ram_buf(const char *fname);
255 * Read the sandbox RAM buffer from an existing file
257 * @param fname Filename containing memory (simple binary format)
258 * @return 0 if OK, -ve on error
260 int os_read_ram_buf(const char *fname);
263 * Jump to a new executable image
265 * This uses exec() to run a new executable image, after putting it in a
266 * temporary file. The same arguments and environment are passed to this
267 * new image, with the addition of:
269 * -j <filename> Specifies the filename the image was written to. The
270 * calling image may want to delete this at some point.
271 * -m <filename> Specifies the file containing the sandbox memory
272 * (ram_buf) from this image, so that the new image can
273 * have access to this. It also means that the original
274 * memory filename passed to U-Boot will be left intact.
276 * @param dest Buffer containing executable image
277 * @param size Size of buffer
279 int os_jump_to_image(const void *dest, int size);
282 * Read the current system time
284 * This reads the current Local Time and places it into the provided
287 * @param rt Place to put system time
289 void os_localtime(struct rtc_time *rt);