Blame view
include/os.h
6.33 KB
7a9219c17 sandbox: Add OS d... |
1 |
/* |
d9165153c sandbox: add flag... |
2 3 4 5 6 |
* 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 sandbox: Add OS d... |
7 |
* Copyright (c) 2011 The Chromium OS Authors. |
1a4596601 Add GPL-2.0+ SPDX... |
8 |
* SPDX-License-Identifier: GPL-2.0+ |
7a9219c17 sandbox: Add OS d... |
9 |
*/ |
4f345d567 sandbox: add ifde... |
10 11 |
#ifndef __OS_H__ #define __OS_H__ |
2a54d1599 sandbox: Use uint... |
12 |
#include <linux/types.h> |
70db4212f sandbox: add geto... |
13 |
struct sandbox_state; |
7a9219c17 sandbox: Add OS d... |
14 15 16 17 18 19 20 21 22 23 24 |
/** * 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); /** |
e101550a9 sandbox: Improve ... |
25 26 27 28 29 30 31 32 33 34 |
* Access to the OS read() system call with non-blocking access * * \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_no_block(int fd, void *buf, size_t count); /** |
7a9219c17 sandbox: Add OS d... |
35 36 37 38 39 40 41 42 43 44 |
* 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 sandbox: add lsee... |
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
* 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 sandbox: Add OS d... |
60 61 62 63 64 65 66 |
* Access to the OS open() system call * * \param pathname Pathname of file to open * \param flags Flags, like O_RDONLY, O_RDWR * \return file descriptor, or -1 on error */ int os_open(const char *pathname, int flags); |
d9165153c sandbox: add flag... |
67 68 69 70 71 |
#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 |
7a9219c17 sandbox: Add OS d... |
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
/** * 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); /** * 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 sandbox: mark os_... |
88 |
void os_exit(int exit_code) __attribute__((noreturn)); |
ab06a758b sandbox: put stdi... |
89 90 91 92 93 |
/** * Put tty into raw mode to mimic serial console better */ void os_tty_raw(int fd); |
21899b108 sandbox: Add impr... |
94 95 96 97 98 99 100 101 |
/** * 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 sandbox: Add time... |
102 103 |
/** |
77595c6d9 sandbox: Improve/... |
104 105 106 107 108 109 |
* 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 sandbox: fix the ... |
110 |
void os_free(void *ptr); |
77595c6d9 sandbox: Improve/... |
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
/** * 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 sandbox: Add time... |
133 134 135 136 137 138 139 140 141 142 143 |
* 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 sandbox: Use uint... |
144 |
uint64_t os_get_nsec(void); |
4f345d567 sandbox: add ifde... |
145 |
|
70db4212f sandbox: add geto... |
146 147 148 149 150 151 152 153 154 155 156 |
/** * 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 sandbox: Add a wa... |
157 158 159 160 161 162 163 164 165 166 167 168 169 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 203 |
/* * 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); /** * Get the name of a directory entry type * * @param type Type to cehck * @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 * @return size of file, or -1 if an error ocurred */ ssize_t os_get_filesize(const char *fname); |
91b136c79 sandbox: Allow th... |
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
/** * 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 sandbox: Allow re... |
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
/** * 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); |
4f345d567 sandbox: add ifde... |
239 |
#endif |