xref: /openbmc/linux/arch/um/include/shared/os.h (revision f519f0be)
1 /*
2  * Copyright (C) 2015 Anton Ivanov (aivanov@{brocade.com,kot-begemot.co.uk})
3  * Copyright (C) 2015 Thomas Meyer (thomas@m3y3r.de)
4  * Copyright (C) 2002 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
5  * Licensed under the GPL
6  */
7 
8 #ifndef __OS_H__
9 #define __OS_H__
10 
11 #include <stdarg.h>
12 #include <irq_user.h>
13 #include <longjmp.h>
14 #include <mm_id.h>
15 
16 #define CATCH_EINTR(expr) while ((errno = 0, ((expr) < 0)) && (errno == EINTR))
17 
18 #define OS_TYPE_FILE 1
19 #define OS_TYPE_DIR 2
20 #define OS_TYPE_SYMLINK 3
21 #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 #ifdef CONFIG_64BIT
34 #define OS_LIB_PATH	"/usr/lib64/"
35 #else
36 #define OS_LIB_PATH	"/usr/lib/"
37 #endif
38 
39 /*
40  * types taken from stat_file() in hostfs_user.c
41  * (if they are wrong here, they are wrong there...).
42  */
43 struct uml_stat {
44 	int                ust_dev;        /* device */
45 	unsigned long long ust_ino;        /* inode */
46 	int                ust_mode;       /* protection */
47 	int                ust_nlink;      /* number of hard links */
48 	int                ust_uid;        /* user ID of owner */
49 	int                ust_gid;        /* group ID of owner */
50 	unsigned long long ust_size;       /* total size, in bytes */
51 	int                ust_blksize;    /* blocksize for filesystem I/O */
52 	unsigned long long ust_blocks;     /* number of blocks allocated */
53 	unsigned long      ust_atime;      /* time of last access */
54 	unsigned long      ust_mtime;      /* time of last modification */
55 	unsigned long      ust_ctime;      /* time of last change */
56 };
57 
58 struct openflags {
59 	unsigned int r : 1;
60 	unsigned int w : 1;
61 	unsigned int s : 1;	/* O_SYNC */
62 	unsigned int c : 1;	/* O_CREAT */
63 	unsigned int t : 1;	/* O_TRUNC */
64 	unsigned int a : 1;	/* O_APPEND */
65 	unsigned int e : 1;	/* O_EXCL */
66 	unsigned int cl : 1;    /* FD_CLOEXEC */
67 };
68 
69 #define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
70 					  .t = 0, .a = 0, .e = 0, .cl = 0 })
71 
72 static inline struct openflags of_read(struct openflags flags)
73 {
74 	flags.r = 1;
75 	return flags;
76 }
77 
78 static inline struct openflags of_write(struct openflags flags)
79 {
80 	flags.w = 1;
81 	return flags;
82 }
83 
84 static inline struct openflags of_rdwr(struct openflags flags)
85 {
86 	return of_read(of_write(flags));
87 }
88 
89 static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
90 {
91 	flags.r = r;
92 	flags.w = w;
93 	return flags;
94 }
95 
96 static inline struct openflags of_sync(struct openflags flags)
97 {
98 	flags.s = 1;
99 	return flags;
100 }
101 
102 static inline struct openflags of_create(struct openflags flags)
103 {
104 	flags.c = 1;
105 	return flags;
106 }
107 
108 static inline struct openflags of_trunc(struct openflags flags)
109 {
110 	flags.t = 1;
111 	return flags;
112 }
113 
114 static inline struct openflags of_append(struct openflags flags)
115 {
116 	flags.a = 1;
117 	return flags;
118 }
119 
120 static inline struct openflags of_excl(struct openflags flags)
121 {
122 	flags.e = 1;
123 	return flags;
124 }
125 
126 static inline struct openflags of_cloexec(struct openflags flags)
127 {
128 	flags.cl = 1;
129 	return flags;
130 }
131 
132 /* file.c */
133 extern int os_stat_file(const char *file_name, struct uml_stat *buf);
134 extern int os_stat_fd(const int fd, struct uml_stat *buf);
135 extern int os_access(const char *file, int mode);
136 extern int os_set_exec_close(int fd);
137 extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
138 extern int os_get_ifname(int fd, char *namebuf);
139 extern int os_set_slip(int fd);
140 extern int os_mode_fd(int fd, int mode);
141 extern int os_fsync_file(int fd);
142 
143 extern int os_seek_file(int fd, unsigned long long offset);
144 extern int os_open_file(const char *file, struct openflags flags, int mode);
145 extern int os_read_file(int fd, void *buf, int len);
146 extern int os_write_file(int fd, const void *buf, int count);
147 extern int os_sync_file(int fd);
148 extern int os_file_size(const char *file, unsigned long long *size_out);
149 extern int os_pread_file(int fd, void *buf, int len, unsigned long long offset);
150 extern int os_pwrite_file(int fd, const void *buf, int count, unsigned long long offset);
151 extern int os_file_modtime(const char *file, unsigned long *modtime);
152 extern int os_pipe(int *fd, int stream, int close_on_exec);
153 extern int os_set_fd_async(int fd);
154 extern int os_clear_fd_async(int fd);
155 extern int os_set_fd_block(int fd, int blocking);
156 extern int os_accept_connection(int fd);
157 extern int os_create_unix_socket(const char *file, int len, int close_on_exec);
158 extern int os_shutdown_socket(int fd, int r, int w);
159 extern void os_close_file(int fd);
160 extern int os_rcv_fd(int fd, int *helper_pid_out);
161 extern int create_unix_socket(char *file, int len, int close_on_exec);
162 extern int os_connect_socket(const char *name);
163 extern int os_file_type(char *file);
164 extern int os_file_mode(const char *file, struct openflags *mode_out);
165 extern int os_lock_file(int fd, int excl);
166 extern void os_flush_stdout(void);
167 extern int os_stat_filesystem(char *path, long *bsize_out,
168 			      long long *blocks_out, long long *bfree_out,
169 			      long long *bavail_out, long long *files_out,
170 			      long long *ffree_out, void *fsid_out,
171 			      int fsid_size, long *namelen_out,
172 			      long *spare_out);
173 extern int os_change_dir(char *dir);
174 extern int os_fchange_dir(int fd);
175 extern unsigned os_major(unsigned long long dev);
176 extern unsigned os_minor(unsigned long long dev);
177 extern unsigned long long os_makedev(unsigned major, unsigned minor);
178 extern int os_falloc_punch(int fd, unsigned long long offset, int count);
179 
180 /* start_up.c */
181 extern void os_early_checks(void);
182 extern void os_check_bugs(void);
183 extern void check_host_supports_tls(int *supports_tls, int *tls_min);
184 
185 /* mem.c */
186 extern int create_mem_file(unsigned long long len);
187 
188 /* process.c */
189 extern unsigned long os_process_pc(int pid);
190 extern int os_process_parent(int pid);
191 extern void os_alarm_process(int pid);
192 extern void os_stop_process(int pid);
193 extern void os_kill_process(int pid, int reap_child);
194 extern void os_kill_ptraced_process(int pid, int reap_child);
195 
196 extern int os_getpid(void);
197 extern int os_getpgrp(void);
198 
199 extern void init_new_thread_signals(void);
200 
201 extern int os_map_memory(void *virt, int fd, unsigned long long off,
202 			 unsigned long len, int r, int w, int x);
203 extern int os_protect_memory(void *addr, unsigned long len,
204 			     int r, int w, int x);
205 extern int os_unmap_memory(void *addr, int len);
206 extern int os_drop_memory(void *addr, int length);
207 extern int can_drop_memory(void);
208 extern void os_flush_stdout(void);
209 extern int os_mincore(void *addr, unsigned long len);
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 /* umid.c */
221 extern int umid_file_name(char *name, char *buf, int len);
222 extern int set_umid(char *name);
223 extern char *get_umid(void);
224 
225 /* signal.c */
226 extern void timer_set_signal_handler(void);
227 extern void set_sigstack(void *sig_stack, int size);
228 extern void remove_sigstack(void);
229 extern void set_handler(int sig);
230 extern int change_sig(int signal, int on);
231 extern void block_signals(void);
232 extern void unblock_signals(void);
233 extern int get_signals(void);
234 extern int set_signals(int enable);
235 extern int os_is_signal_stack(void);
236 extern void deliver_alarm(void);
237 
238 /* util.c */
239 extern void stack_protections(unsigned long address);
240 extern int raw(int fd);
241 extern void setup_machinename(char *machine_out);
242 extern void setup_hostinfo(char *buf, int len);
243 extern void os_dump_core(void) __attribute__ ((noreturn));
244 extern void um_early_printk(const char *s, unsigned int n);
245 extern void os_fix_helper_signals(void);
246 extern void os_info(const char *fmt, ...)
247 	__attribute__ ((format (printf, 1, 2)));
248 extern void os_warn(const char *fmt, ...)
249 	__attribute__ ((format (printf, 1, 2)));
250 
251 /* time.c */
252 extern void os_idle_sleep(unsigned long long nsecs);
253 extern int os_timer_create(void* timer);
254 extern int os_timer_set_interval(void* timer, void* its);
255 extern int os_timer_one_shot(int ticks);
256 extern long long os_timer_disable(void);
257 extern long os_timer_remain(void* timer);
258 extern void uml_idle_timer(void);
259 extern long long os_persistent_clock_emulation(void);
260 extern long long os_nsecs(void);
261 extern long long os_vnsecs(void);
262 
263 /* skas/mem.c */
264 extern long run_syscall_stub(struct mm_id * mm_idp,
265 			     int syscall, unsigned long *args, long expected,
266 			     void **addr, int done);
267 extern long syscall_stub_data(struct mm_id * mm_idp,
268 			      unsigned long *data, int data_count,
269 			      void **addr, void **stub_addr);
270 extern int map(struct mm_id * mm_idp, unsigned long virt,
271 	       unsigned long len, int prot, int phys_fd,
272 	       unsigned long long offset, int done, void **data);
273 extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
274 		 int done, void **data);
275 extern int protect(struct mm_id * mm_idp, unsigned long addr,
276 		   unsigned long len, unsigned int prot, int done, void **data);
277 
278 /* skas/process.c */
279 extern int is_skas_winch(int pid, int fd, void *data);
280 extern int start_userspace(unsigned long stub_stack);
281 extern int copy_context_skas0(unsigned long stack, int pid);
282 extern void userspace(struct uml_pt_regs *regs, unsigned long *aux_fp_regs);
283 extern int map_stub_pages(int fd, unsigned long code, unsigned long data,
284 			  unsigned long stack);
285 extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
286 extern void switch_threads(jmp_buf *me, jmp_buf *you);
287 extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
288 extern void initial_thread_cb_skas(void (*proc)(void *),
289 				 void *arg);
290 extern void halt_skas(void);
291 extern void reboot_skas(void);
292 
293 /* irq.c */
294 extern int os_waiting_for_events_epoll(void);
295 extern void *os_epoll_get_data_pointer(int index);
296 extern int os_epoll_triggered(int index, int events);
297 extern int os_event_mask(int irq_type);
298 extern int os_setup_epoll(void);
299 extern int os_add_epoll_fd(int events, int fd, void *data);
300 extern int os_mod_epoll_fd(int events, int fd, void *data);
301 extern int os_del_epoll_fd(int fd);
302 extern void os_set_ioignore(void);
303 extern void os_close_epoll_fd(void);
304 
305 /* sigio.c */
306 extern int add_sigio_fd(int fd);
307 extern int ignore_sigio_fd(int fd);
308 extern void maybe_sigio_broken(int fd, int read);
309 extern void sigio_broken(int fd, int read);
310 
311 /* prctl.c */
312 extern int os_arch_prctl(int pid, int option, unsigned long *arg2);
313 
314 /* tty.c */
315 extern int get_pty(void);
316 
317 /* sys-$ARCH/task_size.c */
318 extern unsigned long os_get_top_address(void);
319 
320 long syscall(long number, ...);
321 
322 #endif
323