arch/um/include/shared/os.h

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