os.h 10 KB

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