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