os.h 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  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()
  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. * Access to the usleep function of the os
  115. *
  116. * \param usec Time to sleep in micro seconds
  117. */
  118. void os_usleep(unsigned long usec);
  119. /**
  120. * Gets a monotonic increasing number of nano seconds from the OS
  121. *
  122. * \return A monotonic increasing time scaled in nano seconds
  123. */
  124. uint64_t os_get_nsec(void);
  125. /**
  126. * Parse arguments and update sandbox state.
  127. *
  128. * @param state Sandbox state to update
  129. * @param argc Argument count
  130. * @param argv Argument vector
  131. * @return 0 if ok, and program should continue;
  132. * 1 if ok, but program should stop;
  133. * -1 on error: program should terminate.
  134. */
  135. int os_parse_args(struct sandbox_state *state, int argc, char *argv[]);
  136. /*
  137. * Types of directory entry that we support. See also os_dirent_typename in
  138. * the C file.
  139. */
  140. enum os_dirent_t {
  141. OS_FILET_REG, /* Regular file */
  142. OS_FILET_LNK, /* Symbolic link */
  143. OS_FILET_DIR, /* Directory */
  144. OS_FILET_UNKNOWN, /* Something else */
  145. OS_FILET_COUNT,
  146. };
  147. /** A directory entry node, containing information about a single dirent */
  148. struct os_dirent_node {
  149. struct os_dirent_node *next; /* Pointer to next node, or NULL */
  150. ulong size; /* Size of file in bytes */
  151. enum os_dirent_t type; /* Type of entry */
  152. char name[0]; /* Name of entry */
  153. };
  154. /**
  155. * Get a directionry listing
  156. *
  157. * This allocates and returns a linked list containing the directory listing.
  158. *
  159. * @param dirname Directory to examine
  160. * @param headp Returns pointer to head of linked list, or NULL if none
  161. * @return 0 if ok, -ve on error
  162. */
  163. int os_dirent_ls(const char *dirname, struct os_dirent_node **headp);
  164. /**
  165. * Free directory list
  166. *
  167. * This frees a linked list containing a directory listing.
  168. *
  169. * @param node Pointer to head of linked list
  170. */
  171. void os_dirent_free(struct os_dirent_node *node);
  172. /**
  173. * Get the name of a directory entry type
  174. *
  175. * @param type Type to check
  176. * @return string containing the name of that type, or "???" if none/invalid
  177. */
  178. const char *os_dirent_get_typename(enum os_dirent_t type);
  179. /**
  180. * Get the size of a file
  181. *
  182. * @param fname Filename to check
  183. * @param size size of file is returned if no error
  184. * @return 0 on success or -1 if an error ocurred
  185. */
  186. int os_get_filesize(const char *fname, loff_t *size);
  187. /**
  188. * Write a character to the controlling OS terminal
  189. *
  190. * This bypasses the U-Boot console support and writes directly to the OS
  191. * stdout file descriptor.
  192. *
  193. * @param ch Character to write
  194. */
  195. void os_putc(int ch);
  196. /**
  197. * Write a string to the controlling OS terminal
  198. *
  199. * This bypasses the U-Boot console support and writes directly to the OS
  200. * stdout file descriptor.
  201. *
  202. * @param str String to write (note that \n is not appended)
  203. */
  204. void os_puts(const char *str);
  205. /**
  206. * Write the sandbox RAM buffer to a existing file
  207. *
  208. * @param fname Filename to write memory to (simple binary format)
  209. * @return 0 if OK, -ve on error
  210. */
  211. int os_write_ram_buf(const char *fname);
  212. /**
  213. * Read the sandbox RAM buffer from an existing file
  214. *
  215. * @param fname Filename containing memory (simple binary format)
  216. * @return 0 if OK, -ve on error
  217. */
  218. int os_read_ram_buf(const char *fname);
  219. /**
  220. * Jump to a new executable image
  221. *
  222. * This uses exec() to run a new executable image, after putting it in a
  223. * temporary file. The same arguments and environment are passed to this
  224. * new image, with the addition of:
  225. *
  226. * -j <filename> Specifies the filename the image was written to. The
  227. * calling image may want to delete this at some point.
  228. * -m <filename> Specifies the file containing the sandbox memory
  229. * (ram_buf) from this image, so that the new image can
  230. * have access to this. It also means that the original
  231. * memory filename passed to U-Boot will be left intact.
  232. *
  233. * @param dest Buffer containing executable image
  234. * @param size Size of buffer
  235. */
  236. int os_jump_to_image(const void *dest, int size);
  237. /**
  238. * os_find_u_boot() - Determine the path to U-Boot proper
  239. *
  240. * This function is intended to be called from within sandbox SPL. It uses
  241. * a few heuristics to find U-Boot proper. Normally it is either in the same
  242. * directory, or the directory above (since u-boot-spl is normally in an
  243. * spl/ subdirectory when built).
  244. *
  245. * @fname: Place to put full path to U-Boot
  246. * @maxlen: Maximum size of @fname
  247. * @return 0 if OK, -NOSPC if the filename is too large, -ENOENT if not found
  248. */
  249. int os_find_u_boot(char *fname, int maxlen);
  250. /**
  251. * os_spl_to_uboot() - Run U-Boot proper
  252. *
  253. * When called from SPL, this runs U-Boot proper. The filename is obtained by
  254. * calling os_find_u_boot().
  255. *
  256. * @fname: Full pathname to U-Boot executable
  257. * @return 0 if OK, -ve on error
  258. */
  259. int os_spl_to_uboot(const char *fname);
  260. /**
  261. * Read the current system time
  262. *
  263. * This reads the current Local Time and places it into the provided
  264. * structure.
  265. *
  266. * @param rt Place to put system time
  267. */
  268. void os_localtime(struct rtc_time *rt);
  269. /**
  270. * os_abort() - Raise SIGABRT to exit sandbox (e.g. to debugger)
  271. */
  272. void os_abort(void);
  273. /**
  274. * os_mprotect_allow() - Remove write-protection on a region of memory
  275. *
  276. * The start and length will be page-aligned before use.
  277. *
  278. * @start: Region start
  279. * @len: Region length in bytes
  280. * @return 0 if OK, -1 on error from mprotect()
  281. */
  282. int os_mprotect_allow(void *start, size_t len);
  283. /**
  284. * os_write_file() - Write a file to the host filesystem
  285. *
  286. * This can be useful when debugging for writing data out of sandbox for
  287. * inspection by external tools.
  288. *
  289. * @name: File path to write to
  290. * @buf: Data to write
  291. * @size: Size of data to write
  292. * @return 0 if OK, -ve on error
  293. */
  294. int os_write_file(const char *name, const void *buf, int size);
  295. /**
  296. * os_read_file() - Read a file from the host filesystem
  297. *
  298. * This can be useful when reading test data into sandbox for use by test
  299. * routines. The data is allocated using os_malloc() and should be freed by
  300. * the caller.
  301. *
  302. * @name: File path to read from
  303. * @bufp: Returns buffer containing data read
  304. * @sizep: Returns size of data
  305. * @return 0 if OK, -ve on error
  306. */
  307. int os_read_file(const char *name, void **bufp, int *sizep);
  308. /*
  309. * os_find_text_base() - Find the text section in this running process
  310. *
  311. * This tries to find the address of the text section in this running process.
  312. * It can be useful to map the address of functions to the address listed in
  313. * the u-boot.map file.
  314. *
  315. * @return address if found, else NULL
  316. */
  317. void *os_find_text_base(void);
  318. #endif