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