688d181b5f8ae602fb34509cbd876fd343aa273a
[linux-2.6.git] / 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_window_size(int fd, int *rows, int *cols);
138 extern int os_new_tty_pgrp(int fd, int pid);
139 extern int os_get_ifname(int fd, char *namebuf);
140 extern int os_set_slip(int fd);
141 extern int os_set_owner(int fd, int pid);
142 extern int os_mode_fd(int fd, int mode);
143
144 extern int os_seek_file(int fd, __u64 offset);
145 extern int os_open_file(char *file, struct openflags flags, int mode);
146 extern int os_read_file(int fd, void *buf, int len);
147 extern int os_write_file(int fd, const void *buf, int count);
148 extern int os_file_size(char *file, unsigned long long *size_out);
149 extern int os_file_modtime(char *file, unsigned long *modtime);
150 extern int os_pipe(int *fd, int stream, int close_on_exec);
151 extern int os_set_fd_async(int fd, int owner);
152 extern int os_clear_fd_async(int fd);
153 extern int os_set_fd_block(int fd, int blocking);
154 extern int os_accept_connection(int fd);
155 extern int os_create_unix_socket(char *file, int len, int close_on_exec);
156 extern int os_shutdown_socket(int fd, int r, int w);
157 extern void os_close_file(int fd);
158 extern int os_rcv_fd(int fd, int *helper_pid_out);
159 extern int create_unix_socket(char *file, int len, int close_on_exec);
160 extern int os_connect_socket(char *name);
161 extern int os_file_type(char *file);
162 extern int os_file_mode(char *file, struct openflags *mode_out);
163 extern int os_lock_file(int fd, int excl);
164 extern void os_flush_stdout(void);
165 extern int os_stat_filesystem(char *path, long *bsize_out,
166                               long long *blocks_out, long long *bfree_out,
167                               long long *bavail_out, long long *files_out,
168                               long long *ffree_out, void *fsid_out,
169                               int fsid_size, long *namelen_out,
170                               long *spare_out);
171 extern int os_change_dir(char *dir);
172 extern int os_fchange_dir(int fd);
173
174 /* start_up.c */
175 extern void os_early_checks(void);
176 extern int can_do_skas(void);
177 extern void os_check_bugs(void);
178 extern void check_host_supports_tls(int *supports_tls, int *tls_min);
179
180 /* Make sure they are clear when running in TT mode. Required by
181  * SEGV_MAYBE_FIXABLE */
182 #ifdef UML_CONFIG_MODE_SKAS
183 #define clear_can_do_skas() do { ptrace_faultinfo = proc_mm = 0; } while (0)
184 #else
185 #define clear_can_do_skas() do {} while (0)
186 #endif
187
188 /* mem.c */
189 extern int create_mem_file(unsigned long long len);
190
191 /* process.c */
192 extern unsigned long os_process_pc(int pid);
193 extern int os_process_parent(int pid);
194 extern void os_stop_process(int pid);
195 extern void os_kill_process(int pid, int reap_child);
196 extern void os_kill_ptraced_process(int pid, int reap_child);
197 #ifdef UML_CONFIG_MODE_TT
198 extern void os_usr1_process(int pid);
199 #endif
200 extern long os_ptrace_ldt(long pid, long addr, long data);
201
202 extern int os_getpid(void);
203 extern int os_getpgrp(void);
204
205 #ifdef UML_CONFIG_MODE_TT
206 extern void init_new_thread_stack(void *sig_stack, void (*usr1_handler)(int));
207 extern void stop(void);
208 #endif
209 extern void init_new_thread_signals(void);
210 extern int run_kernel_thread(int (*fn)(void *), void *arg, void **jmp_ptr);
211
212 extern int os_map_memory(void *virt, int fd, unsigned long long off,
213                          unsigned long len, int r, int w, int x);
214 extern int os_protect_memory(void *addr, unsigned long len,
215                              int r, int w, int x);
216 extern int os_unmap_memory(void *addr, int len);
217 extern int os_drop_memory(void *addr, int length);
218 extern int can_drop_memory(void);
219 extern void os_flush_stdout(void);
220
221 /* tt.c
222  * for tt mode only (will be deleted in future...)
223  */
224 extern void forward_ipi(int fd, int pid);
225 extern void kill_child_dead(int pid);
226 extern int wait_for_stop(int pid, int sig, int cont_type, void *relay);
227 extern int protect_memory(unsigned long addr, unsigned long len,
228                           int r, int w, int x, int must_succeed);
229 extern void forward_pending_sigio(int target);
230 extern int start_fork_tramp(void *arg, unsigned long temp_stack,
231                             int clone_flags, int (*tramp)(void *));
232
233 /* uaccess.c */
234 extern unsigned long __do_user_copy(void *to, const void *from, int n,
235                                     void **fault_addr, void **fault_catcher,
236                                     void (*op)(void *to, const void *from,
237                                                int n), int *faulted_out);
238
239 /* execvp.c */
240 extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
241 /* helper.c */
242 extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv,
243                       unsigned long *stack_out);
244 extern int run_helper_thread(int (*proc)(void *), void *arg,
245                              unsigned int flags, unsigned long *stack_out,
246                              int stack_order);
247 extern int helper_wait(int pid);
248
249
250 /* tls.c */
251 extern int os_set_thread_area(user_desc_t *info, int pid);
252 extern int os_get_thread_area(user_desc_t *info, int pid);
253
254 /* umid.c */
255 extern int umid_file_name(char *name, char *buf, int len);
256 extern int set_umid(char *name);
257 extern char *get_umid(void);
258
259 /* signal.c */
260 extern void set_sigstack(void *sig_stack, int size);
261 extern void remove_sigstack(void);
262 extern void set_handler(int sig, void (*handler)(int), int flags, ...);
263 extern int change_sig(int signal, int on);
264 extern void block_signals(void);
265 extern void unblock_signals(void);
266 extern int get_signals(void);
267 extern int set_signals(int enable);
268
269 /* trap.c */
270 extern void os_fill_handlinfo(struct kern_handlers h);
271 extern void do_longjmp(void *p, int val);
272
273 /* util.c */
274 extern void stack_protections(unsigned long address);
275 extern void task_protections(unsigned long address);
276 extern int raw(int fd);
277 extern void setup_machinename(char *machine_out);
278 extern void setup_hostinfo(char *buf, int len);
279 extern int setjmp_wrapper(void (*proc)(void *, void *), ...);
280 extern void os_dump_core(void);
281
282 /* time.c */
283 #define BILLION (1000 * 1000 * 1000)
284
285 extern void switch_timers(int to_real);
286 extern void idle_sleep(int secs);
287 extern int set_interval(int is_virtual);
288 #ifdef CONFIG_MODE_TT
289 extern void enable_timer(void);
290 #endif
291 extern void disable_timer(void);
292 extern void uml_idle_timer(void);
293 extern unsigned long long os_nsecs(void);
294
295 /* skas/mem.c */
296 extern long run_syscall_stub(struct mm_id * mm_idp,
297                              int syscall, unsigned long *args, long expected,
298                              void **addr, int done);
299 extern long syscall_stub_data(struct mm_id * mm_idp,
300                               unsigned long *data, int data_count,
301                               void **addr, void **stub_addr);
302 extern int map(struct mm_id * mm_idp, unsigned long virt,
303                unsigned long len, int prot, int phys_fd,
304                unsigned long long offset, int done, void **data);
305 extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
306                  int done, void **data);
307 extern int protect(struct mm_id * mm_idp, unsigned long addr,
308                    unsigned long len, unsigned int prot, int done, void **data);
309
310 /* skas/process.c */
311 extern int is_skas_winch(int pid, int fd, void *data);
312 extern int start_userspace(unsigned long stub_stack);
313 extern int copy_context_skas0(unsigned long stack, int pid);
314 extern void userspace(union uml_pt_regs *regs);
315 extern void map_stub_pages(int fd, unsigned long code,
316                            unsigned long data, unsigned long stack);
317 extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
318 extern void switch_threads(jmp_buf *me, jmp_buf *you);
319 extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
320 extern void initial_thread_cb_skas(void (*proc)(void *),
321                                  void *arg);
322 extern void halt_skas(void);
323 extern void reboot_skas(void);
324
325 /* irq.c */
326 extern int os_waiting_for_events(struct irq_fd *active_fds);
327 extern int os_create_pollfd(int fd, int events, void *tmp_pfd, int size_tmpfds);
328 extern void os_free_irq_by_cb(int (*test)(struct irq_fd *, void *), void *arg,
329                 struct irq_fd *active_fds, struct irq_fd ***last_irq_ptr2);
330 extern void os_free_irq_later(struct irq_fd *active_fds,
331                 int irq, void *dev_id);
332 extern int os_get_pollfd(int i);
333 extern void os_set_pollfd(int i, int fd);
334 extern void os_set_ioignore(void);
335 extern void init_irq_signals(int on_sigstack);
336
337 /* sigio.c */
338 extern int add_sigio_fd(int fd);
339 extern int ignore_sigio_fd(int fd);
340 extern void maybe_sigio_broken(int fd, int read);
341
342 /* skas/trap */
343 extern void sig_handler_common_skas(int sig, void *sc_ptr);
344
345 /* sys-x86_64/prctl.c */
346 extern int os_arch_prctl(int pid, int code, unsigned long *addr);
347
348 /* tty.c */
349 int get_pty(void);
350
351 #endif