os.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Copyright (C) 2015 Anton Ivanov (aivanov@{brocade.com,kot-begemot.co.uk})
  4. * Copyright (C) 2015 Thomas Meyer ([email protected])
  5. * Copyright (C) 2002 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
  6. */
  7. #ifndef __OS_H__
  8. #define __OS_H__
  9. #include <irq_user.h>
  10. #include <longjmp.h>
  11. #include <mm_id.h>
  12. /* This is to get size_t */
  13. #ifndef __UM_HOST__
  14. #include <linux/types.h>
  15. #else
  16. #include <sys/types.h>
  17. #endif
  18. #define CATCH_EINTR(expr) while ((errno = 0, ((expr) < 0)) && (errno == EINTR))
  19. #define OS_TYPE_FILE 1
  20. #define OS_TYPE_DIR 2
  21. #define OS_TYPE_SYMLINK 3
  22. #define OS_TYPE_CHARDEV 4
  23. #define OS_TYPE_BLOCKDEV 5
  24. #define OS_TYPE_FIFO 6
  25. #define OS_TYPE_SOCK 7
  26. /* os_access() flags */
  27. #define OS_ACC_F_OK 0 /* Test for existence. */
  28. #define OS_ACC_X_OK 1 /* Test for execute permission. */
  29. #define OS_ACC_W_OK 2 /* Test for write permission. */
  30. #define OS_ACC_R_OK 4 /* Test for read permission. */
  31. #define OS_ACC_RW_OK (OS_ACC_W_OK | OS_ACC_R_OK) /* Test for RW permission */
  32. #ifdef CONFIG_64BIT
  33. #define OS_LIB_PATH "/usr/lib64/"
  34. #else
  35. #define OS_LIB_PATH "/usr/lib/"
  36. #endif
  37. #define OS_SENDMSG_MAX_FDS 8
  38. /*
  39. * types taken from stat_file() in hostfs_user.c
  40. * (if they are wrong here, they are wrong there...).
  41. */
  42. struct uml_stat {
  43. int ust_dev; /* device */
  44. unsigned long long ust_ino; /* inode */
  45. int ust_mode; /* protection */
  46. int ust_nlink; /* number of hard links */
  47. int ust_uid; /* user ID of owner */
  48. int ust_gid; /* group ID of owner */
  49. unsigned long long ust_size; /* total size, in bytes */
  50. int ust_blksize; /* blocksize for filesystem I/O */
  51. unsigned long long ust_blocks; /* number of blocks allocated */
  52. unsigned long ust_atime; /* time of last access */
  53. unsigned long ust_mtime; /* time of last modification */
  54. unsigned long ust_ctime; /* time of last change */
  55. };
  56. struct openflags {
  57. unsigned int r : 1;
  58. unsigned int w : 1;
  59. unsigned int s : 1; /* O_SYNC */
  60. unsigned int c : 1; /* O_CREAT */
  61. unsigned int t : 1; /* O_TRUNC */
  62. unsigned int a : 1; /* O_APPEND */
  63. unsigned int e : 1; /* O_EXCL */
  64. unsigned int cl : 1; /* FD_CLOEXEC */
  65. };
  66. #define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
  67. .t = 0, .a = 0, .e = 0, .cl = 0 })
  68. static inline struct openflags of_read(struct openflags flags)
  69. {
  70. flags.r = 1;
  71. return flags;
  72. }
  73. static inline struct openflags of_write(struct openflags flags)
  74. {
  75. flags.w = 1;
  76. return flags;
  77. }
  78. static inline struct openflags of_rdwr(struct openflags flags)
  79. {
  80. return of_read(of_write(flags));
  81. }
  82. static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
  83. {
  84. flags.r = r;
  85. flags.w = w;
  86. return flags;
  87. }
  88. static inline struct openflags of_sync(struct openflags flags)
  89. {
  90. flags.s = 1;
  91. return flags;
  92. }
  93. static inline struct openflags of_create(struct openflags flags)
  94. {
  95. flags.c = 1;
  96. return flags;
  97. }
  98. static inline struct openflags of_trunc(struct openflags flags)
  99. {
  100. flags.t = 1;
  101. return flags;
  102. }
  103. static inline struct openflags of_append(struct openflags flags)
  104. {
  105. flags.a = 1;
  106. return flags;
  107. }
  108. static inline struct openflags of_excl(struct openflags flags)
  109. {
  110. flags.e = 1;
  111. return flags;
  112. }
  113. static inline struct openflags of_cloexec(struct openflags flags)
  114. {
  115. flags.cl = 1;
  116. return flags;
  117. }
  118. /* file.c */
  119. extern int os_stat_file(const char *file_name, struct uml_stat *buf);
  120. extern int os_stat_fd(const int fd, struct uml_stat *buf);
  121. extern int os_access(const char *file, int mode);
  122. extern int os_set_exec_close(int fd);
  123. extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
  124. extern int os_get_ifname(int fd, char *namebuf);
  125. extern int os_set_slip(int fd);
  126. extern int os_mode_fd(int fd, int mode);
  127. extern int os_fsync_file(int fd);
  128. extern int os_seek_file(int fd, unsigned long long offset);
  129. extern int os_open_file(const char *file, struct openflags flags, int mode);
  130. extern int os_read_file(int fd, void *buf, int len);
  131. extern int os_write_file(int fd, const void *buf, int count);
  132. extern int os_sync_file(int fd);
  133. extern int os_file_size(const char *file, unsigned long long *size_out);
  134. extern int os_pread_file(int fd, void *buf, int len, unsigned long long offset);
  135. extern int os_pwrite_file(int fd, const void *buf, int count, unsigned long long offset);
  136. extern int os_file_modtime(const char *file, long long *modtime);
  137. extern int os_pipe(int *fd, int stream, int close_on_exec);
  138. extern int os_set_fd_async(int fd);
  139. extern int os_clear_fd_async(int fd);
  140. extern int os_set_fd_block(int fd, int blocking);
  141. extern int os_accept_connection(int fd);
  142. extern int os_create_unix_socket(const char *file, int len, int close_on_exec);
  143. extern int os_shutdown_socket(int fd, int r, int w);
  144. extern void os_close_file(int fd);
  145. extern int os_rcv_fd(int fd, int *helper_pid_out);
  146. extern int os_connect_socket(const char *name);
  147. extern int os_file_type(char *file);
  148. extern int os_file_mode(const char *file, struct openflags *mode_out);
  149. extern int os_lock_file(int fd, int excl);
  150. extern void os_flush_stdout(void);
  151. extern unsigned os_major(unsigned long long dev);
  152. extern unsigned os_minor(unsigned long long dev);
  153. extern unsigned long long os_makedev(unsigned major, unsigned minor);
  154. extern int os_falloc_punch(int fd, unsigned long long offset, int count);
  155. extern int os_falloc_zeroes(int fd, unsigned long long offset, int count);
  156. extern int os_eventfd(unsigned int initval, int flags);
  157. extern int os_sendmsg_fds(int fd, const void *buf, unsigned int len,
  158. const int *fds, unsigned int fds_num);
  159. int os_poll(unsigned int n, const int *fds);
  160. /* start_up.c */
  161. extern void os_early_checks(void);
  162. extern void os_check_bugs(void);
  163. extern void check_host_supports_tls(int *supports_tls, int *tls_min);
  164. extern void get_host_cpu_features(
  165. void (*flags_helper_func)(char *line),
  166. void (*cache_helper_func)(char *line));
  167. /* mem.c */
  168. extern int create_mem_file(unsigned long long len);
  169. /* process.c */
  170. extern unsigned long os_process_pc(int pid);
  171. extern int os_process_parent(int pid);
  172. extern void os_alarm_process(int pid);
  173. extern void os_stop_process(int pid);
  174. extern void os_kill_process(int pid, int reap_child);
  175. extern void os_kill_ptraced_process(int pid, int reap_child);
  176. extern int os_getpid(void);
  177. extern int os_getpgrp(void);
  178. extern void init_new_thread_signals(void);
  179. extern int os_map_memory(void *virt, int fd, unsigned long long off,
  180. unsigned long len, int r, int w, int x);
  181. extern int os_protect_memory(void *addr, unsigned long len,
  182. int r, int w, int x);
  183. extern int os_unmap_memory(void *addr, int len);
  184. extern int os_drop_memory(void *addr, int length);
  185. extern int can_drop_memory(void);
  186. extern int os_mincore(void *addr, unsigned long len);
  187. /* execvp.c */
  188. extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
  189. /* helper.c */
  190. extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv);
  191. extern int run_helper_thread(int (*proc)(void *), void *arg,
  192. unsigned int flags, unsigned long *stack_out);
  193. extern int helper_wait(int pid);
  194. /* umid.c */
  195. extern int umid_file_name(char *name, char *buf, int len);
  196. extern int set_umid(char *name);
  197. extern char *get_umid(void);
  198. /* signal.c */
  199. extern void timer_set_signal_handler(void);
  200. extern void set_sigstack(void *sig_stack, int size);
  201. extern void set_handler(int sig);
  202. extern void send_sigio_to_self(void);
  203. extern int change_sig(int signal, int on);
  204. extern void block_signals(void);
  205. extern void unblock_signals(void);
  206. extern int um_set_signals(int enable);
  207. extern int um_set_signals_trace(int enable);
  208. extern int os_is_signal_stack(void);
  209. extern void deliver_alarm(void);
  210. extern void register_pm_wake_signal(void);
  211. extern void block_signals_hard(void);
  212. extern void unblock_signals_hard(void);
  213. extern void mark_sigio_pending(void);
  214. /* util.c */
  215. extern void stack_protections(unsigned long address);
  216. extern int raw(int fd);
  217. extern void setup_machinename(char *machine_out);
  218. extern void setup_hostinfo(char *buf, int len);
  219. extern ssize_t os_getrandom(void *buf, size_t len, unsigned int flags);
  220. extern void os_dump_core(void) __attribute__ ((noreturn));
  221. extern void um_early_printk(const char *s, unsigned int n);
  222. extern void os_fix_helper_signals(void);
  223. extern void os_info(const char *fmt, ...)
  224. __attribute__ ((format (printf, 1, 2)));
  225. extern void os_warn(const char *fmt, ...)
  226. __attribute__ ((format (printf, 1, 2)));
  227. /* time.c */
  228. extern void os_idle_sleep(void);
  229. extern int os_timer_create(void);
  230. extern int os_timer_set_interval(unsigned long long nsecs);
  231. extern int os_timer_one_shot(unsigned long long nsecs);
  232. extern void os_timer_disable(void);
  233. extern long long os_persistent_clock_emulation(void);
  234. extern long long os_nsecs(void);
  235. /* skas/mem.c */
  236. extern long run_syscall_stub(struct mm_id * mm_idp,
  237. int syscall, unsigned long *args, long expected,
  238. void **addr, int done);
  239. extern long syscall_stub_data(struct mm_id * mm_idp,
  240. unsigned long *data, int data_count,
  241. void **addr, void **stub_addr);
  242. extern int map(struct mm_id * mm_idp, unsigned long virt,
  243. unsigned long len, int prot, int phys_fd,
  244. unsigned long long offset, int done, void **data);
  245. extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
  246. int done, void **data);
  247. extern int protect(struct mm_id * mm_idp, unsigned long addr,
  248. unsigned long len, unsigned int prot, int done, void **data);
  249. /* skas/process.c */
  250. extern int is_skas_winch(int pid, int fd, void *data);
  251. extern int start_userspace(unsigned long stub_stack);
  252. extern int copy_context_skas0(unsigned long stack, int pid);
  253. extern void userspace(struct uml_pt_regs *regs, unsigned long *aux_fp_regs);
  254. extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
  255. extern void switch_threads(jmp_buf *me, jmp_buf *you);
  256. extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
  257. extern void initial_thread_cb_skas(void (*proc)(void *),
  258. void *arg);
  259. extern void halt_skas(void);
  260. extern void reboot_skas(void);
  261. /* irq.c */
  262. extern int os_waiting_for_events_epoll(void);
  263. extern void *os_epoll_get_data_pointer(int index);
  264. extern int os_epoll_triggered(int index, int events);
  265. extern int os_event_mask(enum um_irq_type irq_type);
  266. extern int os_setup_epoll(void);
  267. extern int os_add_epoll_fd(int events, int fd, void *data);
  268. extern int os_mod_epoll_fd(int events, int fd, void *data);
  269. extern int os_del_epoll_fd(int fd);
  270. extern void os_set_ioignore(void);
  271. extern void os_close_epoll_fd(void);
  272. extern void um_irqs_suspend(void);
  273. extern void um_irqs_resume(void);
  274. /* sigio.c */
  275. extern int add_sigio_fd(int fd);
  276. extern int ignore_sigio_fd(int fd);
  277. extern void maybe_sigio_broken(int fd);
  278. extern void sigio_broken(int fd);
  279. /*
  280. * unlocked versions for IRQ controller code.
  281. *
  282. * This is safe because it's used at suspend/resume and nothing
  283. * else is running.
  284. */
  285. extern int __add_sigio_fd(int fd);
  286. extern int __ignore_sigio_fd(int fd);
  287. /* prctl.c */
  288. extern int os_arch_prctl(int pid, int option, unsigned long *arg2);
  289. /* tty.c */
  290. extern int get_pty(void);
  291. /* sys-$ARCH/task_size.c */
  292. extern unsigned long os_get_top_address(void);
  293. long syscall(long number, ...);
  294. /* irqflags tracing */
  295. extern void block_signals_trace(void);
  296. extern void unblock_signals_trace(void);
  297. extern void um_trace_signals_on(void);
  298. extern void um_trace_signals_off(void);
  299. /* time-travel */
  300. extern void deliver_time_travel_irqs(void);
  301. #endif