arch/um/include/os.h

   1 /*
   2  * Copyright (C) 2002 Jeff Dike (jdike@karaya.com)
   3  * Licensed under the GPL
   4  */
   5
   6 #ifndef __OS_H__
   7 #define __OS_H__
   8
   9 #include "uml-config.h"
  10 #include "asm/types.h"
  11 #include "../os/include/file.h"
  12 #include "sysdep/ptrace.h"
  13 #include "kern_util.h"
  14 #include "skas/mm_id.h"
  15 #include "irq_user.h"
  16 #include "sysdep/tls.h"
  17 #include "sysdep/archsetjmp.h"
  18
  19 #define CATCH_EINTR(expr) while ((errno = 0, ((expr) < 0)) && (errno == EINTR))
  20
  21 #define OS_TYPE_FILE 1
  22 #define OS_TYPE_DIR 2
  23 #define OS_TYPE_SYMLINK 3
  24 #define OS_TYPE_CHARDEV 4
  25 #define OS_TYPE_BLOCKDEV 5
  26 #define OS_TYPE_FIFO 6
  27 #define OS_TYPE_SOCK 7
  28
  29 /* os_access() flags */
  30 #define OS_ACC_F_OK    0       /* Test for existence.  */
  31 #define OS_ACC_X_OK    1       /* Test for execute permission.  */
  32 #define OS_ACC_W_OK    2       /* Test for write permission.  */
  33 #define OS_ACC_R_OK    4       /* Test for read permission.  */
  34 #define OS_ACC_RW_OK   (OS_ACC_W_OK | OS_ACC_R_OK) /* Test for RW permission */
  35
  36 /*
  37  * types taken from stat_file() in hostfs_user.c
  38  * (if they are wrong here, they are wrong there...).
  39  */
  40 struct uml_stat {
  41         int                ust_dev;        /* device */
  42         unsigned long long ust_ino;        /* inode */
  43         int                ust_mode;       /* protection */
  44         int                ust_nlink;      /* number of hard links */
  45         int                ust_uid;        /* user ID of owner */
  46         int                ust_gid;        /* group ID of owner */
  47         unsigned long long ust_size;       /* total size, in bytes */
  48         int                ust_blksize;    /* blocksize for filesystem I/O */
  49         unsigned long long ust_blocks;     /* number of blocks allocated */
  50         unsigned long      ust_atime;      /* time of last access */
  51         unsigned long      ust_mtime;      /* time of last modification */
  52         unsigned long      ust_ctime;      /* time of last change */
  53 };
  54
  55 struct openflags {
  56         unsigned int r : 1;
  57         unsigned int w : 1;
  58         unsigned int s : 1;     /* O_SYNC */
  59         unsigned int c : 1;     /* O_CREAT */
  60         unsigned int t : 1;     /* O_TRUNC */
  61         unsigned int a : 1;     /* O_APPEND */
  62         unsigned int e : 1;     /* O_EXCL */
  63         unsigned int cl : 1;    /* FD_CLOEXEC */
  64 };
  65
  66 #define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
  67                                           .t = 0, .a = 0, .e = 0, .cl = 0 })
  68
  69 static inline struct openflags of_read(struct openflags flags)
  70 {
  71         flags.r = 1;
  72         return flags;
  73 }
  74
  75 static inline struct openflags of_write(struct openflags flags)
  76 {
  77         flags.w = 1;
  78         return flags;
  79 }
  80
  81 static inline struct openflags of_rdwr(struct openflags flags)
  82 {
  83         return of_read(of_write(flags));
  84 }
  85
  86 static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
  87 {
  88         flags.r = r;
  89         flags.w = w;
  90         return flags;
  91 }
  92
  93 static inline struct openflags of_sync(struct openflags flags)
  94 {
  95         flags.s = 1;
  96         return flags;
  97 }
  98
  99 static inline struct openflags of_create(struct openflags flags)
 100 {
 101         flags.c = 1;
 102         return flags;
 103 }
 104
 105 static inline struct openflags of_trunc(struct openflags flags)
 106 {
 107         flags.t = 1;
 108         return flags;
 109 }
 110
 111 static inline struct openflags of_append(struct openflags flags)
 112 {
 113         flags.a = 1;
 114         return flags;
 115 }
 116
 117 static inline struct openflags of_excl(struct openflags flags)
 118 {
 119         flags.e = 1;
 120         return flags;
 121 }
 122
 123 static inline struct openflags of_cloexec(struct openflags flags)
 124 {
 125         flags.cl = 1;
 126         return flags;
 127 }
 128
 129 /* file.c */
 130 extern int os_stat_file(const char *file_name, struct uml_stat *buf);
 131 extern int os_stat_fd(const int fd, struct uml_stat *buf);
 132 extern int os_access(const char *file, int mode);
 133 extern void os_print_error(int error, const char* str);
 134 extern int os_get_exec_close(int fd, int *close_on_exec);
 135 extern int os_set_exec_close(int fd, int close_on_exec);
 136 extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
 137 extern int os_new_tty_pgrp(int fd, int pid);
 138 extern int os_get_ifname(int fd, char *namebuf);
 139 extern int os_set_slip(int fd);
 140 extern int os_set_owner(int fd, int pid);
 141 extern int os_mode_fd(int fd, int mode);
 142
 143 extern int os_seek_file(int fd, __u64 offset);
 144 extern int os_open_file(char *file, struct openflags flags, int mode);
 145 extern int os_read_file(int fd, void *buf, int len);
 146 extern int os_write_file(int fd, const void *buf, int count);
 147 extern int os_file_size(char *file, unsigned long long *size_out);
 148 extern int os_file_modtime(char *file, unsigned long *modtime);
 149 extern int os_pipe(int *fd, int stream, int close_on_exec);
 150 extern int os_set_fd_async(int fd, int owner);
 151 extern int os_clear_fd_async(int fd);
 152 extern int os_set_fd_block(int fd, int blocking);
 153 extern int os_accept_connection(int fd);
 154 extern int os_create_unix_socket(char *file, int len, int close_on_exec);
 155 extern int os_shutdown_socket(int fd, int r, int w);
 156 extern void os_close_file(int fd);
 157 extern int os_rcv_fd(int fd, int *helper_pid_out);
 158 extern int create_unix_socket(char *file, int len, int close_on_exec);
 159 extern int os_connect_socket(char *name);
 160 extern int os_file_type(char *file);
 161 extern int os_file_mode(char *file, struct openflags *mode_out);
 162 extern int os_lock_file(int fd, int excl);
 163 extern void os_flush_stdout(void);
 164 extern int os_stat_filesystem(char *path, long *bsize_out,
 165                               long long *blocks_out, long long *bfree_out,
 166                               long long *bavail_out, long long *files_out,
 167                               long long *ffree_out, void *fsid_out,
 168                               int fsid_size, long *namelen_out,
 169                               long *spare_out);
 170 extern int os_change_dir(char *dir);
 171 extern int os_fchange_dir(int fd);
 172
 173 /* start_up.c */
 174 extern void os_early_checks(void);
 175 extern int can_do_skas(void);
 176 extern void os_check_bugs(void);
 177 extern void check_host_supports_tls(int *supports_tls, int *tls_min);
 178
 179 /* Make sure they are clear when running in TT mode. Required by
 180  * SEGV_MAYBE_FIXABLE */
 181 #define clear_can_do_skas() do { ptrace_faultinfo = proc_mm = 0; } while (0)
 182
 183 /* mem.c */
 184 extern int create_mem_file(unsigned long long len);
 185
 186 /* process.c */
 187 extern unsigned long os_process_pc(int pid);
 188 extern int os_process_parent(int pid);
 189 extern void os_stop_process(int pid);
 190 extern void os_kill_process(int pid, int reap_child);
 191 extern void os_kill_ptraced_process(int pid, int reap_child);
 192 extern long os_ptrace_ldt(long pid, long addr, long data);
 193
 194 extern int os_getpid(void);
 195 extern int os_getpgrp(void);
 196
 197 extern void init_new_thread_signals(void);
 198 extern int run_kernel_thread(int (*fn)(void *), void *arg, void **jmp_ptr);
 199
 200 extern int os_map_memory(void *virt, int fd, unsigned long long off,
 201                          unsigned long len, int r, int w, int x);
 202 extern int os_protect_memory(void *addr, unsigned long len,
 203                              int r, int w, int x);
 204 extern int os_unmap_memory(void *addr, int len);
 205 extern int os_drop_memory(void *addr, int length);
 206 extern int can_drop_memory(void);
 207 extern void os_flush_stdout(void);
 208
 209 /* uaccess.c */
 210 extern unsigned long __do_user_copy(void *to, const void *from, int n,
 211                                     void **fault_addr, void **fault_catcher,
 212                                     void (*op)(void *to, const void *from,
 213                                                int n), int *faulted_out);
 214
 215 /* execvp.c */
 216 extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
 217 /* helper.c */
 218 extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv);
 219 extern int run_helper_thread(int (*proc)(void *), void *arg,
 220                              unsigned int flags, unsigned long *stack_out);
 221 extern int helper_wait(int pid);
 222
 223
 224 /* tls.c */
 225 extern int os_set_thread_area(user_desc_t *info, int pid);
 226 extern int os_get_thread_area(user_desc_t *info, int pid);
 227
 228 /* umid.c */
 229 extern int umid_file_name(char *name, char *buf, int len);
 230 extern int set_umid(char *name);
 231 extern char *get_umid(void);
 232
 233 /* signal.c */
 234 extern void set_sigstack(void *sig_stack, int size);
 235 extern void remove_sigstack(void);
 236 extern void set_handler(int sig, void (*handler)(int), int flags, ...);
 237 extern int change_sig(int signal, int on);
 238 extern void block_signals(void);
 239 extern void unblock_signals(void);
 240 extern int get_signals(void);
 241 extern int set_signals(int enable);
 242
 243 /* trap.c */
 244 extern void os_fill_handlinfo(struct kern_handlers h);
 245 extern void do_longjmp(void *p, int val);
 246
 247 /* util.c */
 248 extern void stack_protections(unsigned long address);
 249 extern int raw(int fd);
 250 extern void setup_machinename(char *machine_out);
 251 extern void setup_hostinfo(char *buf, int len);
 252 extern int setjmp_wrapper(void (*proc)(void *, void *), ...);
 253 extern void os_dump_core(void);
 254
 255 /* time.c */
 256 #define BILLION (1000 * 1000 * 1000)
 257
 258 extern void switch_timers(int to_real);
 259 extern void idle_sleep(int secs);
 260 extern int set_interval(int is_virtual);
 261 extern void disable_timer(void);
 262 extern void uml_idle_timer(void);
 263 extern unsigned long long os_nsecs(void);
 264
 265 /* skas/mem.c */
 266 extern long run_syscall_stub(struct mm_id * mm_idp,
 267                              int syscall, unsigned long *args, long expected,
 268                              void **addr, int done);
 269 extern long syscall_stub_data(struct mm_id * mm_idp,
 270                               unsigned long *data, int data_count,
 271                               void **addr, void **stub_addr);
 272 extern int map(struct mm_id * mm_idp, unsigned long virt,
 273                unsigned long len, int prot, int phys_fd,
 274                unsigned long long offset, int done, void **data);
 275 extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
 276                  int done, void **data);
 277 extern int protect(struct mm_id * mm_idp, unsigned long addr,
 278                    unsigned long len, unsigned int prot, int done, void **data);
 279
 280 /* skas/process.c */
 281 extern int is_skas_winch(int pid, int fd, void *data);
 282 extern int start_userspace(unsigned long stub_stack);
 283 extern int copy_context_skas0(unsigned long stack, int pid);
 284 extern void save_registers(int pid, union uml_pt_regs *regs);
 285 extern void restore_registers(int pid, union uml_pt_regs *regs);
 286 extern void userspace(union uml_pt_regs *regs);
 287 extern void map_stub_pages(int fd, unsigned long code,
 288                            unsigned long data, unsigned long stack);
 289 extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
 290 extern void switch_threads(jmp_buf *me, jmp_buf *you);
 291 extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
 292 extern void initial_thread_cb_skas(void (*proc)(void *),
 293                                  void *arg);
 294 extern void halt_skas(void);
 295 extern void reboot_skas(void);
 296
 297 /* irq.c */
 298 extern int os_waiting_for_events(struct irq_fd *active_fds);
 299 extern int os_create_pollfd(int fd, int events, void *tmp_pfd, int size_tmpfds);
 300 extern void os_free_irq_by_cb(int (*test)(struct irq_fd *, void *), void *arg,
 301                 struct irq_fd *active_fds, struct irq_fd ***last_irq_ptr2);
 302 extern void os_free_irq_later(struct irq_fd *active_fds,
 303                 int irq, void *dev_id);
 304 extern int os_get_pollfd(int i);
 305 extern void os_set_pollfd(int i, int fd);
 306 extern void os_set_ioignore(void);
 307 extern void init_irq_signals(int on_sigstack);
 308
 309 /* sigio.c */
 310 extern int add_sigio_fd(int fd);
 311 extern int ignore_sigio_fd(int fd);
 312 extern void maybe_sigio_broken(int fd, int read);
 313
 314 /* skas/trap */
 315 extern void sig_handler_common_skas(int sig, void *sc_ptr);
 316
 317 /* sys-x86_64/prctl.c */
 318 extern int os_arch_prctl(int pid, int code, unsigned long *addr);
 319
 320 /* tty.c */
 321 int get_pty(void);
 322
 323 #endif