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
  16 #define OS_TYPE_FILE 1
  17 #define OS_TYPE_DIR 2
  18 #define OS_TYPE_SYMLINK 3
  19 #define OS_TYPE_CHARDEV 4
  20 #define OS_TYPE_BLOCKDEV 5
  21 #define OS_TYPE_FIFO 6
  22 #define OS_TYPE_SOCK 7
  23
  24 /* os_access() flags */
  25 #define OS_ACC_F_OK    0       /* Test for existence.  */
  26 #define OS_ACC_X_OK    1       /* Test for execute permission.  */
  27 #define OS_ACC_W_OK    2       /* Test for write permission.  */
  28 #define OS_ACC_R_OK    4       /* Test for read permission.  */
  29 #define OS_ACC_RW_OK   (OS_ACC_W_OK | OS_ACC_R_OK) /* Test for RW permission */
  30
  31 /*
  32  * types taken from stat_file() in hostfs_user.c
  33  * (if they are wrong here, they are wrong there...).
  34  */
  35 struct uml_stat {
  36         int                ust_dev;        /* device */
  37         unsigned long long ust_ino;        /* inode */
  38         int                ust_mode;       /* protection */
  39         int                ust_nlink;      /* number of hard links */
  40         int                ust_uid;        /* user ID of owner */
  41         int                ust_gid;        /* group ID of owner */
  42         unsigned long long ust_size;       /* total size, in bytes */
  43         int                ust_blksize;    /* blocksize for filesystem I/O */
  44         unsigned long long ust_blocks;     /* number of blocks allocated */
  45         unsigned long      ust_atime;      /* time of last access */
  46         unsigned long      ust_mtime;      /* time of last modification */
  47         unsigned long      ust_ctime;      /* time of last change */
  48 };
  49
  50 struct openflags {
  51         unsigned int r : 1;
  52         unsigned int w : 1;
  53         unsigned int s : 1;     /* O_SYNC */
  54         unsigned int c : 1;     /* O_CREAT */
  55         unsigned int t : 1;     /* O_TRUNC */
  56         unsigned int a : 1;     /* O_APPEND */
  57         unsigned int e : 1;     /* O_EXCL */
  58         unsigned int cl : 1;    /* FD_CLOEXEC */
  59 };
  60
  61 #define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
  62                                           .t = 0, .a = 0, .e = 0, .cl = 0 })
  63
  64 static inline struct openflags of_read(struct openflags flags)
  65 {
  66         flags.r = 1;
  67         return(flags);
  68 }
  69
  70 static inline struct openflags of_write(struct openflags flags)
  71 {
  72         flags.w = 1;
  73         return(flags);
  74 }
  75
  76 static inline struct openflags of_rdwr(struct openflags flags)
  77 {
  78         return(of_read(of_write(flags)));
  79 }
  80
  81 static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
  82 {
  83         flags.r = r;
  84         flags.w = w;
  85         return(flags);
  86 }
  87
  88 static inline struct openflags of_sync(struct openflags flags)
  89 {
  90         flags.s = 1;
  91         return(flags);
  92 }
  93
  94 static inline struct openflags of_create(struct openflags flags)
  95 {
  96         flags.c = 1;
  97         return(flags);
  98 }
  99
 100 static inline struct openflags of_trunc(struct openflags flags)
 101 {
 102         flags.t = 1;
 103         return(flags);
 104 }
 105
 106 static inline struct openflags of_append(struct openflags flags)
 107 {
 108         flags.a = 1;
 109         return(flags);
 110 }
 111
 112 static inline struct openflags of_excl(struct openflags flags)
 113 {
 114         flags.e = 1;
 115         return(flags);
 116 }
 117
 118 static inline struct openflags of_cloexec(struct openflags flags)
 119 {
 120         flags.cl = 1;
 121         return(flags);
 122 }
 123
 124 extern int os_stat_file(const char *file_name, struct uml_stat *buf);
 125 extern int os_stat_fd(const int fd, struct uml_stat *buf);
 126 extern int os_access(const char *file, int mode);
 127 extern void os_print_error(int error, const char* str);
 128 extern int os_get_exec_close(int fd, int *close_on_exec);
 129 extern int os_set_exec_close(int fd, int close_on_exec);
 130 extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
 131 extern int os_window_size(int fd, int *rows, int *cols);
 132 extern int os_new_tty_pgrp(int fd, int pid);
 133 extern int os_get_ifname(int fd, char *namebuf);
 134 extern int os_set_slip(int fd);
 135 extern int os_set_owner(int fd, int pid);
 136 extern int os_sigio_async(int master, int slave);
 137 extern int os_mode_fd(int fd, int mode);
 138
 139 extern int os_seek_file(int fd, __u64 offset);
 140 extern int os_open_file(char *file, struct openflags flags, int mode);
 141 extern int os_read_file(int fd, void *buf, int len);
 142 extern int os_write_file(int fd, const void *buf, int count);
 143 extern int os_file_size(char *file, unsigned long long *size_out);
 144 extern int os_file_modtime(char *file, unsigned long *modtime);
 145 extern int os_pipe(int *fd, int stream, int close_on_exec);
 146 extern int os_set_fd_async(int fd, int owner);
 147 extern int os_clear_fd_async(int fd);
 148 extern int os_set_fd_block(int fd, int blocking);
 149 extern int os_accept_connection(int fd);
 150 extern int os_create_unix_socket(char *file, int len, int close_on_exec);
 151 extern int os_shutdown_socket(int fd, int r, int w);
 152 extern void os_close_file(int fd);
 153 extern int os_rcv_fd(int fd, int *helper_pid_out);
 154 extern int create_unix_socket(char *file, int len, int close_on_exec);
 155 extern int os_connect_socket(char *name);
 156 extern int os_file_type(char *file);
 157 extern int os_file_mode(char *file, struct openflags *mode_out);
 158 extern int os_lock_file(int fd, int excl);
 159
 160 /* start_up.c */
 161 extern void os_early_checks(void);
 162 extern int can_do_skas(void);
 163
 164 /* Make sure they are clear when running in TT mode. Required by
 165  * SEGV_MAYBE_FIXABLE */
 166 #ifdef UML_CONFIG_MODE_SKAS
 167 #define clear_can_do_skas() do { ptrace_faultinfo = proc_mm = 0; } while (0)
 168 #else
 169 #define clear_can_do_skas() do {} while (0)
 170 #endif
 171
 172 /* mem.c */
 173 extern int create_mem_file(unsigned long long len);
 174
 175 /* process.c */
 176 extern unsigned long os_process_pc(int pid);
 177 extern int os_process_parent(int pid);
 178 extern void os_stop_process(int pid);
 179 extern void os_kill_process(int pid, int reap_child);
 180 extern void os_kill_ptraced_process(int pid, int reap_child);
 181 extern void os_usr1_process(int pid);
 182 extern int os_getpid(void);
 183 extern int os_getpgrp(void);
 184 extern void init_new_thread_stack(void *sig_stack, void (*usr1_handler)(int));
 185 extern void init_new_thread_signals(int altstack);
 186 extern int run_kernel_thread(int (*fn)(void *), void *arg, void **jmp_ptr);
 187
 188 extern int os_map_memory(void *virt, int fd, unsigned long long off,
 189                          unsigned long len, int r, int w, int x);
 190 extern int os_protect_memory(void *addr, unsigned long len,
 191                              int r, int w, int x);
 192 extern int os_unmap_memory(void *addr, int len);
 193 extern void os_flush_stdout(void);
 194
 195 /* tt.c
 196  * for tt mode only (will be deleted in future...)
 197  */
 198 extern void stop(void);
 199 extern int wait_for_stop(int pid, int sig, int cont_type, void *relay);
 200 extern int protect_memory(unsigned long addr, unsigned long len,
 201                           int r, int w, int x, int must_succeed);
 202 extern void forward_pending_sigio(int target);
 203 extern int start_fork_tramp(void *arg, unsigned long temp_stack,
 204                             int clone_flags, int (*tramp)(void *));
 205
 206 /* uaccess.c */
 207 extern unsigned long __do_user_copy(void *to, const void *from, int n,
 208                                     void **fault_addr, void **fault_catcher,
 209                                     void (*op)(void *to, const void *from,
 210                                                int n), int *faulted_out);
 211
 212 /* helper.c */
 213 extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv,
 214                       unsigned long *stack_out);
 215 extern int run_helper_thread(int (*proc)(void *), void *arg,
 216                              unsigned int flags, unsigned long *stack_out,
 217                              int stack_order);
 218 extern int helper_wait(int pid);
 219
 220 /* umid.c */
 221
 222 extern int umid_file_name(char *name, char *buf, int len);
 223 extern int set_umid(char *name);
 224 extern char *get_umid(void);
 225
 226 /* signal.c */
 227 extern void set_sigstack(void *sig_stack, int size);
 228 extern void remove_sigstack(void);
 229 extern void set_handler(int sig, void (*handler)(int), int flags, ...);
 230 extern int change_sig(int signal, int on);
 231 extern void block_signals(void);
 232 extern void unblock_signals(void);
 233 extern int get_signals(void);
 234 extern int set_signals(int enable);
 235 extern void os_usr1_signal(int on);
 236
 237 /* trap.c */
 238 extern void os_fill_handlinfo(struct kern_handlers h);
 239 extern void do_longjmp(void *p, int val);
 240
 241 /* util.c */
 242 extern void stack_protections(unsigned long address);
 243 extern void task_protections(unsigned long address);
 244 extern int raw(int fd);
 245 extern void setup_machinename(char *machine_out);
 246 extern void setup_hostinfo(void);
 247 extern int setjmp_wrapper(void (*proc)(void *, void *), ...);
 248
 249 /* time.c */
 250 #define BILLION (1000 * 1000 * 1000)
 251
 252 extern void switch_timers(int to_real);
 253 extern void idle_sleep(int secs);
 254 extern void enable_timer(void);
 255 extern void disable_timer(void);
 256 extern void user_time_init(void);
 257 extern void uml_idle_timer(void);
 258 extern unsigned long long os_nsecs(void);
 259
 260 /* skas/mem.c */
 261 extern long run_syscall_stub(struct mm_id * mm_idp,
 262                              int syscall, unsigned long *args, long expected,
 263                              void **addr, int done);
 264 extern long syscall_stub_data(struct mm_id * mm_idp,
 265                               unsigned long *data, int data_count,
 266                               void **addr, void **stub_addr);
 267 extern int map(struct mm_id * mm_idp, unsigned long virt,
 268                unsigned long len, int r, int w, int x, int phys_fd,
 269                unsigned long long offset, int done, void **data);
 270 extern int unmap(struct mm_id * mm_idp, void *addr, unsigned long len,
 271                  int done, void **data);
 272 extern int protect(struct mm_id * mm_idp, unsigned long addr,
 273                    unsigned long len, int r, int w, int x, int done,
 274                    void **data);
 275
 276 /* skas/process.c */
 277 extern int is_skas_winch(int pid, int fd, void *data);
 278 extern int start_userspace(unsigned long stub_stack);
 279 extern int copy_context_skas0(unsigned long stack, int pid);
 280 extern void userspace(union uml_pt_regs *regs);
 281 extern void map_stub_pages(int fd, unsigned long code,
 282                            unsigned long data, unsigned long stack);
 283 extern void new_thread(void *stack, void **switch_buf_ptr,
 284                          void **fork_buf_ptr, void (*handler)(int));
 285 extern void thread_wait(void *sw, void *fb);
 286 extern void switch_threads(void *me, void *next);
 287 extern int start_idle_thread(void *stack, void *switch_buf_ptr,
 288                              void **fork_buf_ptr);
 289 extern void initial_thread_cb_skas(void (*proc)(void *),
 290                                  void *arg);
 291 extern void halt_skas(void);
 292 extern void reboot_skas(void);
 293
 294 #endif