Blame view
include/os.h
10.1 KB
83d290c56
|
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
7a9219c17
|
2 |
/* |
d9165153c
|
3 4 5 6 7 |
* Operating System Interface * * This provides access to useful OS routines for the sandbox architecture. * They are kept in a separate file so we can include system headers. * |
7a9219c17
|
8 |
* Copyright (c) 2011 The Chromium OS Authors. |
7a9219c17
|
9 |
*/ |
4f345d567
|
10 11 |
#ifndef __OS_H__ #define __OS_H__ |
2a54d1599
|
12 |
#include <linux/types.h> |
94eefdee2
|
13 |
struct rtc_time; |
70db4212f
|
14 |
struct sandbox_state; |
7a9219c17
|
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
/** * Access to the OS read() system call * * \param fd File descriptor as returned by os_open() * \param buf Buffer to place data * \param count Number of bytes to read * \return number of bytes read, or -1 on error */ ssize_t os_read(int fd, void *buf, size_t count); /** * Access to the OS write() system call * * \param fd File descriptor as returned by os_open() * \param buf Buffer containing data to write * \param count Number of bytes to write * \return number of bytes written, or -1 on error */ ssize_t os_write(int fd, const void *buf, size_t count); /** |
e2dcefcb4
|
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
* Access to the OS lseek() system call * * \param fd File descriptor as returned by os_open() * \param offset File offset (based on whence) * \param whence Position offset is relative to (see below) * \return new file offset */ off_t os_lseek(int fd, off_t offset, int whence); /* Defines for "whence" in os_lseek() */ #define OS_SEEK_SET 0 #define OS_SEEK_CUR 1 #define OS_SEEK_END 2 /** |
7a9219c17
|
51 52 53 |
* Access to the OS open() system call * * \param pathname Pathname of file to open |
887bd4164
|
54 |
* \param flags Flags, like OS_O_RDONLY, OS_O_RDWR |
7a9219c17
|
55 56 57 |
* \return file descriptor, or -1 on error */ int os_open(const char *pathname, int flags); |
d9165153c
|
58 59 60 61 62 |
#define OS_O_RDONLY 0 #define OS_O_WRONLY 1 #define OS_O_RDWR 2 #define OS_O_MASK 3 /* Mask for read/write flags */ #define OS_O_CREAT 0100 |
50b288aca
|
63 |
#define OS_O_TRUNC 01000 |
d9165153c
|
64 |
|
7a9219c17
|
65 66 67 68 69 70 71 72 73 |
/** * Access to the OS close() system call * * \param fd File descriptor to close * \return 0 on success, -1 on error */ int os_close(int fd); /** |
cfd13e8dd
|
74 75 76 77 78 79 80 81 |
* Access to the OS unlink() system call * * \param pathname Path of file to delete * \return 0 for success, other for error */ int os_unlink(const char *pathname); /** |
7a9219c17
|
82 83 84 85 86 87 88 |
* Access to the OS exit() system call * * This exits with the supplied return code, which should be 0 to indicate * success. * * @param exit_code exit code for U-Boot */ |
9d72e67b7
|
89 |
void os_exit(int exit_code) __attribute__((noreturn)); |
ab06a758b
|
90 91 92 |
/** * Put tty into raw mode to mimic serial console better |
ffb87905c
|
93 94 95 96 |
* * @param fd File descriptor of stdin (normally 0) * @param allow_sigs Allow Ctrl-C, Ctrl-Z to generate signals rather than * be handled by U-Boot |
ab06a758b
|
97 |
*/ |
ffb87905c
|
98 |
void os_tty_raw(int fd, bool allow_sigs); |
21899b108
|
99 100 |
/** |
8939df092
|
101 102 103 104 105 106 107 108 |
* Restore the tty to its original mode * * Call this to restore the original terminal mode, after it has been changed * by os_tty_raw(). This is an internal function. */ void os_fd_restore(void); /** |
21899b108
|
109 110 111 112 113 114 |
* Acquires some memory from the underlying os. * * \param length Number of bytes to be allocated * \return Pointer to length bytes or NULL on error */ void *os_malloc(size_t length); |
d99a6874f
|
115 116 |
/** |
77595c6d9
|
117 118 119 120 121 122 |
* Free memory previous allocated with os_malloc()/os_realloc() * * This returns the memory to the OS. * * \param ptr Pointer to memory block to free */ |
347d06dec
|
123 |
void os_free(void *ptr); |
77595c6d9
|
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
/** * Reallocate previously-allocated memory to increase/decrease space * * This works in a similar way to the C library realloc() function. If * length is 0, then ptr is freed. Otherwise the space used by ptr is * expanded or reduced depending on whether length is larger or smaller * than before. * * If ptr is NULL, then this is similar to calling os_malloc(). * * This function may need to move the memory block to make room for any * extra space, in which case the new pointer is returned. * * \param ptr Pointer to memory block to reallocate * \param length New length for memory block * \return pointer to new memory block, or NULL on failure or if length * is 0. */ void *os_realloc(void *ptr, size_t length); /** |
d99a6874f
|
146 147 148 149 150 151 152 153 154 155 156 |
* Access to the usleep function of the os * * \param usec Time to sleep in micro seconds */ void os_usleep(unsigned long usec); /** * Gets a monotonic increasing number of nano seconds from the OS * * \return A monotonic increasing time scaled in nano seconds */ |
2a54d1599
|
157 |
uint64_t os_get_nsec(void); |
4f345d567
|
158 |
|
70db4212f
|
159 160 161 162 163 164 165 166 167 168 169 |
/** * Parse arguments and update sandbox state. * * @param state Sandbox state to update * @param argc Argument count * @param argv Argument vector * @return 0 if ok, and program should continue; * 1 if ok, but program should stop; * -1 on error: program should terminate. */ int os_parse_args(struct sandbox_state *state, int argc, char *argv[]); |
62584db19
|
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
/* * Types of directory entry that we support. See also os_dirent_typename in * the C file. */ enum os_dirent_t { OS_FILET_REG, /* Regular file */ OS_FILET_LNK, /* Symbolic link */ OS_FILET_DIR, /* Directory */ OS_FILET_UNKNOWN, /* Something else */ OS_FILET_COUNT, }; /** A directory entry node, containing information about a single dirent */ struct os_dirent_node { struct os_dirent_node *next; /* Pointer to next node, or NULL */ ulong size; /* Size of file in bytes */ enum os_dirent_t type; /* Type of entry */ char name[0]; /* Name of entry */ }; /** * Get a directionry listing * * This allocates and returns a linked list containing the directory listing. * * @param dirname Directory to examine * @param headp Returns pointer to head of linked list, or NULL if none * @return 0 if ok, -ve on error */ int os_dirent_ls(const char *dirname, struct os_dirent_node **headp); /** |
86167089b
|
203 204 205 206 207 208 209 210 211 |
* Free directory list * * This frees a linked list containing a directory listing. * * @param node Pointer to head of linked list */ void os_dirent_free(struct os_dirent_node *node); /** |
62584db19
|
212 213 |
* Get the name of a directory entry type * |
86167089b
|
214 |
* @param type Type to check |
62584db19
|
215 216 217 218 219 220 221 222 |
* @return string containing the name of that type, or "???" if none/invalid */ const char *os_dirent_get_typename(enum os_dirent_t type); /** * Get the size of a file * * @param fname Filename to check |
96b1046d1
|
223 224 |
* @param size size of file is returned if no error * @return 0 on success or -1 if an error ocurred |
62584db19
|
225 |
*/ |
96b1046d1
|
226 |
int os_get_filesize(const char *fname, loff_t *size); |
62584db19
|
227 |
|
91b136c79
|
228 |
/** |
0b189b6ce
|
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
* Write a character to the controlling OS terminal * * This bypasses the U-Boot console support and writes directly to the OS * stdout file descriptor. * * @param ch Character to write */ void os_putc(int ch); /** * Write a string to the controlling OS terminal * * This bypasses the U-Boot console support and writes directly to the OS * stdout file descriptor. * * @param str String to write (note that is not appended) */ void os_puts(const char *str); /** |
5c2859cdc
|
250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
* Write the sandbox RAM buffer to a existing file * * @param fname Filename to write memory to (simple binary format) * @return 0 if OK, -ve on error */ int os_write_ram_buf(const char *fname); /** * Read the sandbox RAM buffer from an existing file * * @param fname Filename containing memory (simple binary format) * @return 0 if OK, -ve on error */ int os_read_ram_buf(const char *fname); |
47f5fcfb4
|
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
/** * Jump to a new executable image * * This uses exec() to run a new executable image, after putting it in a * temporary file. The same arguments and environment are passed to this * new image, with the addition of: * * -j <filename> Specifies the filename the image was written to. The * calling image may want to delete this at some point. * -m <filename> Specifies the file containing the sandbox memory * (ram_buf) from this image, so that the new image can * have access to this. It also means that the original * memory filename passed to U-Boot will be left intact. * * @param dest Buffer containing executable image * @param size Size of buffer */ int os_jump_to_image(const void *dest, int size); |
94eefdee2
|
282 |
/** |
d4e33f5a7
|
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
* os_find_u_boot() - Determine the path to U-Boot proper * * This function is intended to be called from within sandbox SPL. It uses * a few heuristics to find U-Boot proper. Normally it is either in the same * directory, or the directory above (since u-boot-spl is normally in an * spl/ subdirectory when built). * * @fname: Place to put full path to U-Boot * @maxlen: Maximum size of @fname * @return 0 if OK, -NOSPC if the filename is too large, -ENOENT if not found */ int os_find_u_boot(char *fname, int maxlen); /** * os_spl_to_uboot() - Run U-Boot proper * * When called from SPL, this runs U-Boot proper. The filename is obtained by * calling os_find_u_boot(). * * @fname: Full pathname to U-Boot executable * @return 0 if OK, -ve on error */ int os_spl_to_uboot(const char *fname); /** |
94eefdee2
|
308 309 310 311 312 313 314 315 |
* Read the current system time * * This reads the current Local Time and places it into the provided * structure. * * @param rt Place to put system time */ void os_localtime(struct rtc_time *rt); |
30eef21fa
|
316 |
/** |
fe938fb0d
|
317 318 319 |
* os_abort() - Raise SIGABRT to exit sandbox (e.g. to debugger) */ void os_abort(void); |
9f8037ea9
|
320 321 322 323 324 325 326 327 328 329 330 |
/** * os_mprotect_allow() - Remove write-protection on a region of memory * * The start and length will be page-aligned before use. * * @start: Region start * @len: Region length in bytes * @return 0 if OK, -1 on error from mprotect() */ int os_mprotect_allow(void *start, size_t len); |
056a5cea3
|
331 332 333 334 335 336 337 338 339 340 341 342 |
/** * os_write_file() - Write a file to the host filesystem * * This can be useful when debugging for writing data out of sandbox for * inspection by external tools. * * @name: File path to write to * @buf: Data to write * @size: Size of data to write * @return 0 if OK, -ve on error */ int os_write_file(const char *name, const void *buf, int size); |
566bf3a86
|
343 344 345 346 347 348 349 350 351 352 353 354 355 |
/** * os_read_file() - Read a file from the host filesystem * * This can be useful when reading test data into sandbox for use by test * routines. The data is allocated using os_malloc() and should be freed by * the caller. * * @name: File path to read from * @bufp: Returns buffer containing data read * @sizep: Returns size of data * @return 0 if OK, -ve on error */ int os_read_file(const char *name, void **bufp, int *sizep); |
001d1885f
|
356 357 358 359 360 361 362 363 364 365 |
/* * os_find_text_base() - Find the text section in this running process * * This tries to find the address of the text section in this running process. * It can be useful to map the address of functions to the address listed in * the u-boot.map file. * * @return address if found, else NULL */ void *os_find_text_base(void); |
4f345d567
|
366 |
#endif |