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