blob: db5be46e3e186677c8f16c93f585e82413d7740f [file] [log] [blame]
Jeff Dike329c6e42006-07-14 00:24:03 -07001/*
Jeff Dikeba180fd2007-10-16 01:27:00 -07002 * Copyright (C) 2002 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * Licensed under the GPL
4 */
5
6#ifndef __OS_H__
7#define __OS_H__
8
Jeff Dikeba180fd2007-10-16 01:27:00 -07009#include <stdarg.h>
Jeff Dike63ae2a92006-03-27 01:14:30 -080010#include "irq_user.h"
Jeff Dikeba180fd2007-10-16 01:27:00 -070011#include "longjmp.h"
12#include "mm_id.h"
Paolo 'Blaisorblade' Giarrussodd77aec2006-03-31 02:30:23 -080013#include "sysdep/tls.h"
Jeff Dikeba180fd2007-10-16 01:27:00 -070014#include "../os/include/file.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Jeff Dike24fa6c02007-05-06 14:51:09 -070016#define CATCH_EINTR(expr) while ((errno = 0, ((expr) < 0)) && (errno == EINTR))
17
Jeff Dike329c6e42006-07-14 00:24:03 -070018#define OS_TYPE_FILE 1
19#define OS_TYPE_DIR 2
20#define OS_TYPE_SYMLINK 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#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 */
37struct 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
52struct 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, \
Jeff Dike329c6e42006-07-14 00:24:03 -070064 .t = 0, .a = 0, .e = 0, .cl = 0 })
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66static inline struct openflags of_read(struct openflags flags)
67{
Jeff Dike329c6e42006-07-14 00:24:03 -070068 flags.r = 1;
69 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070}
71
72static inline struct openflags of_write(struct openflags flags)
73{
Jeff Dike329c6e42006-07-14 00:24:03 -070074 flags.w = 1;
75 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076}
77
78static inline struct openflags of_rdwr(struct openflags flags)
79{
Jeff Dike329c6e42006-07-14 00:24:03 -070080 return of_read(of_write(flags));
Linus Torvalds1da177e2005-04-16 15:20:36 -070081}
82
83static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
84{
85 flags.r = r;
86 flags.w = w;
Jeff Dike329c6e42006-07-14 00:24:03 -070087 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088}
89
90static inline struct openflags of_sync(struct openflags flags)
Jeff Dike329c6e42006-07-14 00:24:03 -070091{
92 flags.s = 1;
93 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094}
95
96static inline struct openflags of_create(struct openflags flags)
Jeff Dike329c6e42006-07-14 00:24:03 -070097{
98 flags.c = 1;
99 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100}
Jeff Dike329c6e42006-07-14 00:24:03 -0700101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102static inline struct openflags of_trunc(struct openflags flags)
Jeff Dike329c6e42006-07-14 00:24:03 -0700103{
104 flags.t = 1;
105 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106}
Jeff Dike329c6e42006-07-14 00:24:03 -0700107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108static inline struct openflags of_append(struct openflags flags)
Jeff Dike329c6e42006-07-14 00:24:03 -0700109{
110 flags.a = 1;
111 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112}
Jeff Dike329c6e42006-07-14 00:24:03 -0700113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114static inline struct openflags of_excl(struct openflags flags)
Jeff Dike329c6e42006-07-14 00:24:03 -0700115{
116 flags.e = 1;
117 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118}
119
120static inline struct openflags of_cloexec(struct openflags flags)
Jeff Dike329c6e42006-07-14 00:24:03 -0700121{
122 flags.cl = 1;
123 return flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124}
Jeff Dike329c6e42006-07-14 00:24:03 -0700125
Jeff Dikecf9165a2006-03-27 01:14:36 -0800126/* file.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127extern int os_stat_file(const char *file_name, struct uml_stat *buf);
128extern int os_stat_fd(const int fd, struct uml_stat *buf);
129extern int os_access(const char *file, int mode);
Jeff Dike512b6fb2007-10-16 01:27:11 -0700130extern int os_set_exec_close(int fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132extern int os_get_ifname(int fd, char *namebuf);
133extern int os_set_slip(int fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134extern int os_mode_fd(int fd, int mode);
135
Jeff Dikeba180fd2007-10-16 01:27:00 -0700136extern int os_seek_file(int fd, unsigned long long offset);
WANG Congc9a30722008-02-04 22:30:35 -0800137extern int os_open_file(const char *file, struct openflags flags, int mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138extern int os_read_file(int fd, void *buf, int len);
139extern int os_write_file(int fd, const void *buf, int count);
WANG Congc9a30722008-02-04 22:30:35 -0800140extern int os_file_size(const char *file, unsigned long long *size_out);
141extern int os_file_modtime(const char *file, unsigned long *modtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142extern int os_pipe(int *fd, int stream, int close_on_exec);
Jeff Dikebf8fde72008-02-04 22:31:04 -0800143extern int os_set_fd_async(int fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144extern int os_clear_fd_async(int fd);
145extern int os_set_fd_block(int fd, int blocking);
146extern int os_accept_connection(int fd);
WANG Congc9a30722008-02-04 22:30:35 -0800147extern int os_create_unix_socket(const char *file, int len, int close_on_exec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148extern int os_shutdown_socket(int fd, int r, int w);
149extern void os_close_file(int fd);
150extern int os_rcv_fd(int fd, int *helper_pid_out);
151extern int create_unix_socket(char *file, int len, int close_on_exec);
WANG Congc9a30722008-02-04 22:30:35 -0800152extern int os_connect_socket(const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153extern int os_file_type(char *file);
WANG Congc9a30722008-02-04 22:30:35 -0800154extern int os_file_mode(const char *file, struct openflags *mode_out);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155extern int os_lock_file(int fd, int excl);
Jeff Dikecf9165a2006-03-27 01:14:36 -0800156extern void os_flush_stdout(void);
157extern int os_stat_filesystem(char *path, long *bsize_out,
158 long long *blocks_out, long long *bfree_out,
159 long long *bavail_out, long long *files_out,
160 long long *ffree_out, void *fsid_out,
161 int fsid_size, long *namelen_out,
162 long *spare_out);
163extern int os_change_dir(char *dir);
164extern int os_fchange_dir(int fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Gennady Sharapov60d339f62005-09-03 15:57:47 -0700166/* start_up.c */
167extern void os_early_checks(void);
Karol Swietlicki6b7e9672008-02-04 22:30:50 -0800168extern void can_do_skas(void);
Jeff Dike8e367062006-03-27 01:14:32 -0800169extern void os_check_bugs(void);
Paolo 'Blaisorblade' Giarrusso3feb8852006-03-31 02:30:25 -0800170extern void check_host_supports_tls(int *supports_tls, int *tls_min);
Gennady Sharapov60d339f62005-09-03 15:57:47 -0700171
Jeff Dike0f80bc82005-09-16 19:27:50 -0700172/* mem.c */
Jeff Dikeae173812005-11-07 00:58:57 -0800173extern int create_mem_file(unsigned long long len);
Jeff Dike0f80bc82005-09-16 19:27:50 -0700174
Gennady Sharapov60d339f62005-09-03 15:57:47 -0700175/* process.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176extern unsigned long os_process_pc(int pid);
177extern int os_process_parent(int pid);
178extern void os_stop_process(int pid);
179extern void os_kill_process(int pid, int reap_child);
180extern void os_kill_ptraced_process(int pid, int reap_child);
Paolo 'Blaisorblade' Giarrusso07f4e2c2006-02-24 13:03:55 -0800181extern long os_ptrace_ldt(long pid, long addr, long data);
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183extern int os_getpid(void);
Jeff Dikecd2ee4a2005-05-05 16:15:32 -0700184extern int os_getpgrp(void);
Paolo 'Blaisorblade' Giarrusso07f4e2c2006-02-24 13:03:55 -0800185
Jeff Dikee64bd132006-07-10 04:45:07 -0700186extern void init_new_thread_signals(void);
Jeff Dikefab95c52007-10-16 01:27:05 -0700187extern int run_kernel_thread(int (*fn)(void *), void *arg, jmp_buf **jmp_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189extern int os_map_memory(void *virt, int fd, unsigned long long off,
190 unsigned long len, int r, int w, int x);
Jeff Dike329c6e42006-07-14 00:24:03 -0700191extern int os_protect_memory(void *addr, unsigned long len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 int r, int w, int x);
193extern int os_unmap_memory(void *addr, int len);
Jeff Dike02dea082006-03-31 02:30:08 -0800194extern int os_drop_memory(void *addr, int length);
195extern int can_drop_memory(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196extern void os_flush_stdout(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Gennady Sharapovbb578422005-11-07 00:58:50 -0800198/* uaccess.c */
199extern unsigned long __do_user_copy(void *to, const void *from, int n,
Jeff Dikefab95c52007-10-16 01:27:05 -0700200 void **fault_addr, jmp_buf **fault_catcher,
Gennady Sharapovbb578422005-11-07 00:58:50 -0800201 void (*op)(void *to, const void *from,
202 int n), int *faulted_out);
203
Paolo 'Blaisorblade' Giarrusso5d485452006-11-25 11:09:39 -0800204/* execvp.c */
205extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
Jeff Dikeff5c6ff2005-11-07 00:58:51 -0800206/* helper.c */
Jeff Dikec4399012007-07-15 23:38:56 -0700207extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv);
Jeff Dikeff5c6ff2005-11-07 00:58:51 -0800208extern int run_helper_thread(int (*proc)(void *), void *arg,
Jeff Dikec4399012007-07-15 23:38:56 -0700209 unsigned int flags, unsigned long *stack_out);
Jeff Dike1aa351a2008-02-04 22:31:10 -0800210extern int helper_wait(int pid);
Jeff Dikeff5c6ff2005-11-07 00:58:51 -0800211
Paolo 'Blaisorblade' Giarrussoaa6758d2006-03-31 02:30:22 -0800212
213/* tls.c */
Paolo 'Blaisorblade' Giarrussodd77aec2006-03-31 02:30:23 -0800214extern int os_set_thread_area(user_desc_t *info, int pid);
215extern int os_get_thread_area(user_desc_t *info, int pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Paolo 'Blaisorblade' Giarrussodd77aec2006-03-31 02:30:23 -0800217/* umid.c */
Jeff Dike2264c4752006-01-06 00:18:59 -0800218extern int umid_file_name(char *name, char *buf, int len);
Jeff Dike7eebe8a2006-01-06 00:19:01 -0800219extern int set_umid(char *name);
220extern char *get_umid(void);
Jeff Dike2264c4752006-01-06 00:18:59 -0800221
Gennady Sharapov0805d892006-01-08 01:01:29 -0800222/* signal.c */
Jeff Dike78a26e22007-10-16 01:27:23 -0700223extern void timer_init(void);
Gennady Sharapov0805d892006-01-08 01:01:29 -0800224extern void set_sigstack(void *sig_stack, int size);
225extern void remove_sigstack(void);
226extern void set_handler(int sig, void (*handler)(int), int flags, ...);
227extern int change_sig(int signal, int on);
228extern void block_signals(void);
229extern void unblock_signals(void);
230extern int get_signals(void);
231extern int set_signals(int enable);
232
Gennady Sharapov4fef0c12006-01-18 17:42:41 -0800233/* util.c */
234extern void stack_protections(unsigned long address);
Gennady Sharapov4fef0c12006-01-18 17:42:41 -0800235extern int raw(int fd);
236extern void setup_machinename(char *machine_out);
Jeff Dikeb4ffb6a2007-05-06 14:50:59 -0700237extern void setup_hostinfo(char *buf, int len);
Jeff Dike3e6f2ac2008-02-04 22:30:58 -0800238extern void os_dump_core(void) __attribute__ ((noreturn));
Gennady Sharapov4fef0c12006-01-18 17:42:41 -0800239
Gennady Sharapovcff65c42006-01-18 17:42:42 -0800240/* time.c */
Jeff Dikeb160fb62007-10-16 01:27:26 -0700241extern void idle_sleep(unsigned long long nsecs);
Jeff Dikea2f018b2007-10-16 01:27:22 -0700242extern int set_interval(void);
Jeff Diked2753a6d2007-10-16 01:27:25 -0700243extern int timer_one_shot(int ticks);
Jeff Dike5f734612007-10-16 01:27:27 -0700244extern long long disable_timer(void);
Gennady Sharapovcff65c42006-01-18 17:42:42 -0800245extern void uml_idle_timer(void);
Jeff Dike5f734612007-10-16 01:27:27 -0700246extern long long os_nsecs(void);
Gennady Sharapovcff65c42006-01-18 17:42:42 -0800247
Gennady Sharapovf45d9fc2006-01-18 17:42:45 -0800248/* skas/mem.c */
249extern long run_syscall_stub(struct mm_id * mm_idp,
250 int syscall, unsigned long *args, long expected,
251 void **addr, int done);
252extern long syscall_stub_data(struct mm_id * mm_idp,
253 unsigned long *data, int data_count,
254 void **addr, void **stub_addr);
255extern int map(struct mm_id * mm_idp, unsigned long virt,
Jeff Dike16dd07b2007-05-06 14:51:48 -0700256 unsigned long len, int prot, int phys_fd,
Gennady Sharapovf45d9fc2006-01-18 17:42:45 -0800257 unsigned long long offset, int done, void **data);
Jeff Dike64f60842007-05-06 14:51:45 -0700258extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
Gennady Sharapovf45d9fc2006-01-18 17:42:45 -0800259 int done, void **data);
260extern int protect(struct mm_id * mm_idp, unsigned long addr,
Jeff Dike16dd07b2007-05-06 14:51:48 -0700261 unsigned long len, unsigned int prot, int done, void **data);
Gennady Sharapovf45d9fc2006-01-18 17:42:45 -0800262
Gennady Sharapovabaf6972006-01-18 17:42:46 -0800263/* skas/process.c */
264extern int is_skas_winch(int pid, int fd, void *data);
265extern int start_userspace(unsigned long stub_stack);
266extern int copy_context_skas0(unsigned long stack, int pid);
Jeff Dike77bf4402007-10-16 01:26:58 -0700267extern void userspace(struct uml_pt_regs *regs);
Jeff Dike3e6f2ac2008-02-04 22:30:58 -0800268extern int map_stub_pages(int fd, unsigned long code, unsigned long data,
269 unsigned long stack);
Jeff Dike3c917352006-09-27 01:50:40 -0700270extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
271extern void switch_threads(jmp_buf *me, jmp_buf *you);
272extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
Gennady Sharapovabaf6972006-01-18 17:42:46 -0800273extern void initial_thread_cb_skas(void (*proc)(void *),
274 void *arg);
275extern void halt_skas(void);
276extern void reboot_skas(void);
277
Jeff Dike63ae2a92006-03-27 01:14:30 -0800278/* irq.c */
279extern int os_waiting_for_events(struct irq_fd *active_fds);
Jeff Dike63ae2a92006-03-27 01:14:30 -0800280extern int os_create_pollfd(int fd, int events, void *tmp_pfd, int size_tmpfds);
281extern void os_free_irq_by_cb(int (*test)(struct irq_fd *, void *), void *arg,
282 struct irq_fd *active_fds, struct irq_fd ***last_irq_ptr2);
283extern void os_free_irq_later(struct irq_fd *active_fds,
284 int irq, void *dev_id);
285extern int os_get_pollfd(int i);
286extern void os_set_pollfd(int i, int fd);
287extern void os_set_ioignore(void);
Jeff Dike63ae2a92006-03-27 01:14:30 -0800288
Jeff Dikef206aab2006-03-27 01:14:33 -0800289/* sigio.c */
Jeff Dike19bdf042006-09-25 23:33:04 -0700290extern int add_sigio_fd(int fd);
Jeff Dikef206aab2006-03-27 01:14:33 -0800291extern int ignore_sigio_fd(int fd);
Jeff Dike8e64d96a2006-07-10 04:45:11 -0700292extern void maybe_sigio_broken(int fd, int read);
Jeff Dike5d33e4d2008-05-12 14:01:58 -0700293extern void sigio_broken(int fd, int read);
Jeff Dikef206aab2006-03-27 01:14:33 -0800294
Jeff Dike24fa6c02007-05-06 14:51:09 -0700295/* sys-x86_64/prctl.c */
Jeff Dikef3555592007-02-10 01:44:29 -0800296extern int os_arch_prctl(int pid, int code, unsigned long *addr);
297
Jeff Dike24fa6c02007-05-06 14:51:09 -0700298/* tty.c */
Jeff Dike536788f2008-02-08 04:22:07 -0800299extern int get_pty(void);
300
301/* sys-$ARCH/task_size.c */
Tom Spink40fb16a2008-06-05 22:46:12 -0700302extern unsigned long os_get_top_address(void);
Jeff Dike24fa6c02007-05-06 14:51:09 -0700303
Jeff Dike2264c4752006-01-06 00:18:59 -0800304#endif