os.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  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. * @fd: File descriptor as returned by os_open()
  19. * @buf: Buffer to place data
  20. * @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. * @fd: File descriptor as returned by os_open()
  28. * @buf: Buffer containing data to write
  29. * @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. * @fd: File descriptor as returned by os_open()
  37. * @offset: File offset (based on whence)
  38. * @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. * @pathname: Pathname of file to open
  50. * @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. * os_close() - access to the OS close() system call
  62. *
  63. * @fd: File descriptor to close
  64. * Return: 0 on success, -1 on error
  65. */
  66. int os_close(int fd);
  67. /**
  68. * os_unlink() - access to the OS unlink() system call
  69. *
  70. * @pathname: Path of file to delete
  71. * Return: 0 for success, other for error
  72. */
  73. int os_unlink(const char *pathname);
  74. /**
  75. * os_exit() - 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. * @exit_code: exit code for U-Boot
  81. */
  82. void os_exit(int exit_code) __attribute__((noreturn));
  83. /**
  84. * os_tty_raw() - put tty into raw mode to mimic serial console better
  85. *
  86. * @fd: File descriptor of stdin (normally 0)
  87. * @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. * os_fs_restore() - 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. * os_malloc() - aquires some memory from the underlying os.
  100. *
  101. * @length: Number of bytes to be allocated
  102. * Return: Pointer to length bytes or NULL if @length is 0 or on error
  103. */
  104. void *os_malloc(size_t length);
  105. /**
  106. * os_free() - free memory previous allocated with os_malloc()
  107. *
  108. * This returns the memory to the OS.
  109. *
  110. * @ptr: Pointer to memory block to free. If this is NULL then this
  111. * function does nothing
  112. */
  113. void os_free(void *ptr);
  114. /**
  115. * os_realloc() - reallocate memory
  116. *
  117. * This follows the semantics of realloc(), so can perform an os_malloc() or
  118. * os_free() depending on @ptr and @length.
  119. *
  120. * Return: Pointer to reallocated memory or NULL if @length is 0
  121. */
  122. void *os_realloc(void *ptr, size_t length);
  123. /**
  124. * os_usleep() - access to the usleep function of the os
  125. *
  126. * @usec: time to sleep in micro seconds
  127. */
  128. void os_usleep(unsigned long usec);
  129. /**
  130. * Gets a monotonic increasing number of nano seconds from the OS
  131. *
  132. * Return: a monotonic increasing time scaled in nano seconds
  133. */
  134. uint64_t os_get_nsec(void);
  135. /**
  136. * Parse arguments and update sandbox state.
  137. *
  138. * @state: sandbox state to update
  139. * @argc: argument count
  140. * @argv: argument vector
  141. * Return:
  142. * * 0 if ok, and program should continue
  143. * * 1 if ok, but program should stop
  144. * * -1 on error: program should terminate
  145. */
  146. int os_parse_args(struct sandbox_state *state, int argc, char *argv[]);
  147. /*
  148. * enum os_dirent_t - type of directory entry
  149. *
  150. * Types of directory entry that we support. See also os_dirent_typename in
  151. * the C file.
  152. */
  153. enum os_dirent_t {
  154. /**
  155. * @OS_FILET_REG: regular file
  156. */
  157. OS_FILET_REG,
  158. /**
  159. * @OS_FILET_LNK: symbolic link
  160. */
  161. OS_FILET_LNK,
  162. /**
  163. * @OS_FILET_DIR: directory
  164. */
  165. OS_FILET_DIR,
  166. /**
  167. * @OS_FILET_UNKNOWN: something else
  168. */
  169. OS_FILET_UNKNOWN,
  170. /**
  171. * @OS_FILET_COUNT: number of directory entry types
  172. */
  173. OS_FILET_COUNT,
  174. };
  175. /**
  176. * struct os_dirent_node - directory node
  177. *
  178. * A directory entry node, containing information about a single dirent
  179. *
  180. */
  181. struct os_dirent_node {
  182. /**
  183. * @next: pointer to next node, or NULL
  184. */
  185. struct os_dirent_node *next;
  186. /**
  187. * @size: size of file in bytes
  188. */
  189. ulong size;
  190. /**
  191. * @type: type of entry
  192. */
  193. enum os_dirent_t type;
  194. /**
  195. * @name: name of entry
  196. */
  197. char name[0];
  198. };
  199. /**
  200. * os_dirent_ls() - get a directory listing
  201. *
  202. * This allocates and returns a linked list containing the directory listing.
  203. *
  204. * @dirname: directory to examine
  205. * @headp: on return pointer to head of linked list, or NULL if none
  206. * Return: 0 if ok, -ve on error
  207. */
  208. int os_dirent_ls(const char *dirname, struct os_dirent_node **headp);
  209. /**
  210. * os_dirent_free() - free directory list
  211. *
  212. * This frees a linked list containing a directory listing.
  213. *
  214. * @node: pointer to head of linked list
  215. */
  216. void os_dirent_free(struct os_dirent_node *node);
  217. /**
  218. * os_dirent_get_typename() - get the name of a directory entry type
  219. *
  220. * @type: type to check
  221. * Return:
  222. * string containing the name of that type,
  223. * or "???" if none/invalid
  224. */
  225. const char *os_dirent_get_typename(enum os_dirent_t type);
  226. /**
  227. * os_get_filesize() - get the size of a file
  228. *
  229. * @fname: filename to check
  230. * @size: size of file is returned if no error
  231. * Return: 0 on success or -1 if an error ocurred
  232. */
  233. int os_get_filesize(const char *fname, loff_t *size);
  234. /**
  235. * os_putc() - write a character to the controlling OS terminal
  236. *
  237. * This bypasses the U-Boot console support and writes directly to the OS
  238. * stdout file descriptor.
  239. *
  240. * @ch: haracter to write
  241. */
  242. void os_putc(int ch);
  243. /**
  244. * os_puts() - write a string to the controlling OS terminal
  245. *
  246. * This bypasses the U-Boot console support and writes directly to the OS
  247. * stdout file descriptor.
  248. *
  249. * @str: string to write (note that \n is not appended)
  250. */
  251. void os_puts(const char *str);
  252. /**
  253. * os_write_ram_buf() - write the sandbox RAM buffer to a existing file
  254. *
  255. * @fname: filename to write memory to (simple binary format)
  256. * Return: 0 if OK, -ve on error
  257. */
  258. int os_write_ram_buf(const char *fname);
  259. /**
  260. * os_read_ram_buf() - read the sandbox RAM buffer from an existing file
  261. *
  262. * @fname: filename containing memory (simple binary format)
  263. * Return: 0 if OK, -ve on error
  264. */
  265. int os_read_ram_buf(const char *fname);
  266. /**
  267. * os_jump_to_image() - jump to a new executable image
  268. *
  269. * This uses exec() to run a new executable image, after putting it in a
  270. * temporary file. The same arguments and environment are passed to this
  271. * new image, with the addition of:
  272. *
  273. * -j <filename> Specifies the filename the image was written to. The
  274. * calling image may want to delete this at some point.
  275. * -m <filename> Specifies the file containing the sandbox memory
  276. * (ram_buf) from this image, so that the new image can
  277. * have access to this. It also means that the original
  278. * memory filename passed to U-Boot will be left intact.
  279. *
  280. * @dest: buffer containing executable image
  281. * @size: size of buffer
  282. * Return: 0 if OK, -ve on error
  283. */
  284. int os_jump_to_image(const void *dest, int size);
  285. /**
  286. * os_find_u_boot() - determine the path to U-Boot proper
  287. *
  288. * This function is intended to be called from within sandbox SPL. It uses
  289. * a few heuristics to find U-Boot proper. Normally it is either in the same
  290. * directory, or the directory above (since u-boot-spl is normally in an
  291. * spl/ subdirectory when built).
  292. *
  293. * @fname: place to put full path to U-Boot
  294. * @maxlen: maximum size of @fname
  295. * @use_img: select the 'u-boot.img' file instead of the 'u-boot' ELF file
  296. * Return: 0 if OK, -NOSPC if the filename is too large, -ENOENT if not found
  297. */
  298. int os_find_u_boot(char *fname, int maxlen, bool use_img);
  299. /**
  300. * os_spl_to_uboot() - Run U-Boot proper
  301. *
  302. * When called from SPL, this runs U-Boot proper. The filename is obtained by
  303. * calling os_find_u_boot().
  304. *
  305. * @fname: full pathname to U-Boot executable
  306. * Return: 0 if OK, -ve on error
  307. */
  308. int os_spl_to_uboot(const char *fname);
  309. /**
  310. * os_localtime() - read the current system time
  311. *
  312. * This reads the current Local Time and places it into the provided
  313. * structure.
  314. *
  315. * @rt: place to put system time
  316. */
  317. void os_localtime(struct rtc_time *rt);
  318. /**
  319. * os_abort() - raise SIGABRT to exit sandbox (e.g. to debugger)
  320. */
  321. void os_abort(void) __attribute__((noreturn));
  322. /**
  323. * os_mprotect_allow() - Remove write-protection on a region of memory
  324. *
  325. * The start and length will be page-aligned before use.
  326. *
  327. * @start: Region start
  328. * @len: Region length in bytes
  329. * Return: 0 if OK, -1 on error from mprotect()
  330. */
  331. int os_mprotect_allow(void *start, size_t len);
  332. /**
  333. * os_write_file() - write a file to the host filesystem
  334. *
  335. * This can be useful when debugging for writing data out of sandbox for
  336. * inspection by external tools.
  337. *
  338. * @name: File path to write to
  339. * @buf: Data to write
  340. * @size: Size of data to write
  341. * Return: 0 if OK, -ve on error
  342. */
  343. int os_write_file(const char *name, const void *buf, int size);
  344. /**
  345. * os_read_file() - Read a file from the host filesystem
  346. *
  347. * This can be useful when reading test data into sandbox for use by test
  348. * routines. The data is allocated using os_malloc() and should be freed by
  349. * the caller.
  350. *
  351. * @name: File path to read from
  352. * @bufp: Returns buffer containing data read
  353. * @sizep: Returns size of data
  354. * Return: 0 if OK, -ve on error
  355. */
  356. int os_read_file(const char *name, void **bufp, int *sizep);
  357. /*
  358. * os_find_text_base() - Find the text section in this running process
  359. *
  360. * This tries to find the address of the text section in this running process.
  361. * It can be useful to map the address of functions to the address listed in
  362. * the u-boot.map file.
  363. *
  364. * Return: address if found, else NULL
  365. */
  366. void *os_find_text_base(void);
  367. /**
  368. * os_relaunch() - restart the sandbox
  369. *
  370. * This functions is used to implement the cold reboot of the sand box.
  371. * @argv\[0] specifies the binary that is started while the calling process
  372. * stops immediately. If the new binary cannot be started, the process is
  373. * terminated and 1 is set as shell return code.
  374. *
  375. * The PID of the process stays the same. All file descriptors that have not
  376. * been opened with O_CLOEXEC stay open including stdin, stdout, stderr.
  377. *
  378. * @argv: NULL terminated list of command line parameters
  379. */
  380. void os_relaunch(char *argv[]);
  381. /**
  382. * os_setup_signal_handlers() - setup signal handlers
  383. *
  384. * Install signal handlers for SIGBUS and SIGSEGV.
  385. *
  386. * Return: 0 for success
  387. */
  388. int os_setup_signal_handlers(void);
  389. /**
  390. * os_signal_action() - handle a signal
  391. *
  392. * @sig: signal
  393. * @pc: program counter
  394. */
  395. void os_signal_action(int sig, unsigned long pc);
  396. /**
  397. * os_get_time_offset() - get time offset
  398. *
  399. * Get the time offset from environment variable UBOOT_SB_TIME_OFFSET.
  400. *
  401. * Return: offset in seconds
  402. */
  403. long os_get_time_offset(void);
  404. /**
  405. * os_set_time_offset() - set time offset
  406. *
  407. * Save the time offset in environment variable UBOOT_SB_TIME_OFFSET.
  408. *
  409. * @offset: offset in seconds
  410. */
  411. void os_set_time_offset(long offset);
  412. #endif