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