arch/um/include/shared/os.h

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