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 */
40struct 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
55struct 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
69static inline struct openflags of_read(struct openflags flags)
70{
71	flags.r = 1;
72	return flags;
73}
74
75static inline struct openflags of_write(struct openflags flags)
76{
77	flags.w = 1;
78	return flags;
79}
80
81static inline struct openflags of_rdwr(struct openflags flags)
82{
83	return of_read(of_write(flags));
84}
85
86static 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
93static inline struct openflags of_sync(struct openflags flags)
94{
95	flags.s = 1;
96	return flags;
97}
98
99static inline struct openflags of_create(struct openflags flags)
100{
101	flags.c = 1;
102	return flags;
103}
104
105static inline struct openflags of_trunc(struct openflags flags)
106{
107	flags.t = 1;
108	return flags;
109}
110
111static inline struct openflags of_append(struct openflags flags)
112{
113	flags.a = 1;
114	return flags;
115}
116
117static inline struct openflags of_excl(struct openflags flags)
118{
119	flags.e = 1;
120	return flags;
121}
122
123static inline struct openflags of_cloexec(struct openflags flags)
124{
125	flags.cl = 1;
126	return flags;
127}
128
129/* file.c */
130extern int os_stat_file(const char *file_name, struct uml_stat *buf);
131extern int os_stat_fd(const int fd, struct uml_stat *buf);
132extern int os_access(const char *file, int mode);
133extern void os_print_error(int error, const char* str);
134extern int os_get_exec_close(int fd, int *close_on_exec);
135extern int os_set_exec_close(int fd, int close_on_exec);
136extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
137extern int os_window_size(int fd, int *rows, int *cols);
138extern int os_new_tty_pgrp(int fd, int pid);
139extern int os_get_ifname(int fd, char *namebuf);
140extern int os_set_slip(int fd);
141extern int os_set_owner(int fd, int pid);
142extern int os_mode_fd(int fd, int mode);
143
144extern int os_seek_file(int fd, __u64 offset);
145extern int os_open_file(char *file, struct openflags flags, int mode);
146extern int os_read_file(int fd, void *buf, int len);
147extern int os_write_file(int fd, const void *buf, int count);
148extern int os_file_size(char *file, unsigned long long *size_out);
149extern int os_file_modtime(char *file, unsigned long *modtime);
150extern int os_pipe(int *fd, int stream, int close_on_exec);
151extern int os_set_fd_async(int fd, int owner);
152extern int os_clear_fd_async(int fd);
153extern int os_set_fd_block(int fd, int blocking);
154extern int os_accept_connection(int fd);
155extern int os_create_unix_socket(char *file, int len, int close_on_exec);
156extern int os_shutdown_socket(int fd, int r, int w);
157extern void os_close_file(int fd);
158extern int os_rcv_fd(int fd, int *helper_pid_out);
159extern int create_unix_socket(char *file, int len, int close_on_exec);
160extern int os_connect_socket(char *name);
161extern int os_file_type(char *file);
162extern int os_file_mode(char *file, struct openflags *mode_out);
163extern int os_lock_file(int fd, int excl);
164extern void os_flush_stdout(void);
165extern 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);
171extern int os_change_dir(char *dir);
172extern int os_fchange_dir(int fd);
173
174/* start_up.c */
175extern void os_early_checks(void);
176extern int can_do_skas(void);
177extern void os_check_bugs(void);
178extern 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 */
189extern int create_mem_file(unsigned long long len);
190
191/* process.c */
192extern unsigned long os_process_pc(int pid);
193extern int os_process_parent(int pid);
194extern void os_stop_process(int pid);
195extern void os_kill_process(int pid, int reap_child);
196extern void os_kill_ptraced_process(int pid, int reap_child);
197#ifdef UML_CONFIG_MODE_TT
198extern void os_usr1_process(int pid);
199#endif
200extern long os_ptrace_ldt(long pid, long addr, long data);
201
202extern int os_getpid(void);
203extern int os_getpgrp(void);
204
205#ifdef UML_CONFIG_MODE_TT
206extern void init_new_thread_stack(void *sig_stack, void (*usr1_handler)(int));
207extern void stop(void);
208#endif
209extern void init_new_thread_signals(void);
210extern int run_kernel_thread(int (*fn)(void *), void *arg, void **jmp_ptr);
211
212extern int os_map_memory(void *virt, int fd, unsigned long long off,
213			 unsigned long len, int r, int w, int x);
214extern int os_protect_memory(void *addr, unsigned long len,
215			     int r, int w, int x);
216extern int os_unmap_memory(void *addr, int len);
217extern int os_drop_memory(void *addr, int length);
218extern int can_drop_memory(void);
219extern void os_flush_stdout(void);
220
221/* tt.c
222 * for tt mode only (will be deleted in future...)
223 */
224extern void forward_ipi(int fd, int pid);
225extern void kill_child_dead(int pid);
226extern int wait_for_stop(int pid, int sig, int cont_type, void *relay);
227extern int protect_memory(unsigned long addr, unsigned long len,
228			  int r, int w, int x, int must_succeed);
229extern void forward_pending_sigio(int target);
230extern int start_fork_tramp(void *arg, unsigned long temp_stack,
231			    int clone_flags, int (*tramp)(void *));
232
233/* uaccess.c */
234extern 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 */
240extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
241/* helper.c */
242extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv,
243		      unsigned long *stack_out);
244extern int run_helper_thread(int (*proc)(void *), void *arg,
245			     unsigned int flags, unsigned long *stack_out,
246			     int stack_order);
247extern int helper_wait(int pid);
248
249
250/* tls.c */
251extern int os_set_thread_area(user_desc_t *info, int pid);
252extern int os_get_thread_area(user_desc_t *info, int pid);
253
254/* umid.c */
255extern int umid_file_name(char *name, char *buf, int len);
256extern int set_umid(char *name);
257extern char *get_umid(void);
258
259/* signal.c */
260extern void set_sigstack(void *sig_stack, int size);
261extern void remove_sigstack(void);
262extern void set_handler(int sig, void (*handler)(int), int flags, ...);
263extern int change_sig(int signal, int on);
264extern void block_signals(void);
265extern void unblock_signals(void);
266extern int get_signals(void);
267extern int set_signals(int enable);
268
269/* trap.c */
270extern void os_fill_handlinfo(struct kern_handlers h);
271extern void do_longjmp(void *p, int val);
272
273/* util.c */
274extern void stack_protections(unsigned long address);
275extern int raw(int fd);
276extern void setup_machinename(char *machine_out);
277extern void setup_hostinfo(char *buf, int len);
278extern int setjmp_wrapper(void (*proc)(void *, void *), ...);
279extern void os_dump_core(void);
280
281/* time.c */
282#define BILLION (1000 * 1000 * 1000)
283
284extern void switch_timers(int to_real);
285extern void idle_sleep(int secs);
286extern int set_interval(int is_virtual);
287#ifdef CONFIG_MODE_TT
288extern void enable_timer(void);
289#endif
290extern void disable_timer(void);
291extern void uml_idle_timer(void);
292extern unsigned long long os_nsecs(void);
293
294/* skas/mem.c */
295extern long run_syscall_stub(struct mm_id * mm_idp,
296			     int syscall, unsigned long *args, long expected,
297			     void **addr, int done);
298extern long syscall_stub_data(struct mm_id * mm_idp,
299			      unsigned long *data, int data_count,
300			      void **addr, void **stub_addr);
301extern int map(struct mm_id * mm_idp, unsigned long virt,
302	       unsigned long len, int prot, int phys_fd,
303	       unsigned long long offset, int done, void **data);
304extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
305		 int done, void **data);
306extern int protect(struct mm_id * mm_idp, unsigned long addr,
307		   unsigned long len, unsigned int prot, int done, void **data);
308
309/* skas/process.c */
310extern int is_skas_winch(int pid, int fd, void *data);
311extern int start_userspace(unsigned long stub_stack);
312extern int copy_context_skas0(unsigned long stack, int pid);
313extern void userspace(union uml_pt_regs *regs);
314extern void map_stub_pages(int fd, unsigned long code,
315			   unsigned long data, unsigned long stack);
316extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
317extern void switch_threads(jmp_buf *me, jmp_buf *you);
318extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
319extern void initial_thread_cb_skas(void (*proc)(void *),
320				 void *arg);
321extern void halt_skas(void);
322extern void reboot_skas(void);
323
324/* irq.c */
325extern int os_waiting_for_events(struct irq_fd *active_fds);
326extern int os_create_pollfd(int fd, int events, void *tmp_pfd, int size_tmpfds);
327extern void os_free_irq_by_cb(int (*test)(struct irq_fd *, void *), void *arg,
328		struct irq_fd *active_fds, struct irq_fd ***last_irq_ptr2);
329extern void os_free_irq_later(struct irq_fd *active_fds,
330		int irq, void *dev_id);
331extern int os_get_pollfd(int i);
332extern void os_set_pollfd(int i, int fd);
333extern void os_set_ioignore(void);
334extern void init_irq_signals(int on_sigstack);
335
336/* sigio.c */
337extern int add_sigio_fd(int fd);
338extern int ignore_sigio_fd(int fd);
339extern void maybe_sigio_broken(int fd, int read);
340
341/* skas/trap */
342extern void sig_handler_common_skas(int sig, void *sc_ptr);
343
344/* sys-x86_64/prctl.c */
345extern int os_arch_prctl(int pid, int code, unsigned long *addr);
346
347/* tty.c */
348int get_pty(void);
349
350#endif
351