xref: /openbmc/linux/arch/um/include/shared/os.h (revision 5c816641)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2015 Anton Ivanov (aivanov@{brocade.com,kot-begemot.co.uk})
4  * Copyright (C) 2015 Thomas Meyer (thomas@m3y3r.de)
5  * Copyright (C) 2002 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
6  */
7 
8 #ifndef __OS_H__
9 #define __OS_H__
10 
11 #include <irq_user.h>
12 #include <longjmp.h>
13 #include <mm_id.h>
14 
15 #define CATCH_EINTR(expr) while ((errno = 0, ((expr) < 0)) && (errno == EINTR))
16 
17 #define OS_TYPE_FILE 1
18 #define OS_TYPE_DIR 2
19 #define OS_TYPE_SYMLINK 3
20 #define OS_TYPE_CHARDEV 4
21 #define OS_TYPE_BLOCKDEV 5
22 #define OS_TYPE_FIFO 6
23 #define OS_TYPE_SOCK 7
24 
25 /* os_access() flags */
26 #define OS_ACC_F_OK    0       /* Test for existence.  */
27 #define OS_ACC_X_OK    1       /* Test for execute permission.  */
28 #define OS_ACC_W_OK    2       /* Test for write permission.  */
29 #define OS_ACC_R_OK    4       /* Test for read permission.  */
30 #define OS_ACC_RW_OK   (OS_ACC_W_OK | OS_ACC_R_OK) /* Test for RW permission */
31 
32 #ifdef CONFIG_64BIT
33 #define OS_LIB_PATH	"/usr/lib64/"
34 #else
35 #define OS_LIB_PATH	"/usr/lib/"
36 #endif
37 
38 #define OS_SENDMSG_MAX_FDS 8
39 
40 /*
41  * types taken from stat_file() in hostfs_user.c
42  * (if they are wrong here, they are wrong there...).
43  */
44 struct uml_stat {
45 	int                ust_dev;        /* device */
46 	unsigned long long ust_ino;        /* inode */
47 	int                ust_mode;       /* protection */
48 	int                ust_nlink;      /* number of hard links */
49 	int                ust_uid;        /* user ID of owner */
50 	int                ust_gid;        /* group ID of owner */
51 	unsigned long long ust_size;       /* total size, in bytes */
52 	int                ust_blksize;    /* blocksize for filesystem I/O */
53 	unsigned long long ust_blocks;     /* number of blocks allocated */
54 	unsigned long      ust_atime;      /* time of last access */
55 	unsigned long      ust_mtime;      /* time of last modification */
56 	unsigned long      ust_ctime;      /* time of last change */
57 };
58 
59 struct openflags {
60 	unsigned int r : 1;
61 	unsigned int w : 1;
62 	unsigned int s : 1;	/* O_SYNC */
63 	unsigned int c : 1;	/* O_CREAT */
64 	unsigned int t : 1;	/* O_TRUNC */
65 	unsigned int a : 1;	/* O_APPEND */
66 	unsigned int e : 1;	/* O_EXCL */
67 	unsigned int cl : 1;    /* FD_CLOEXEC */
68 };
69 
70 #define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
71 					  .t = 0, .a = 0, .e = 0, .cl = 0 })
72 
73 static inline struct openflags of_read(struct openflags flags)
74 {
75 	flags.r = 1;
76 	return flags;
77 }
78 
79 static inline struct openflags of_write(struct openflags flags)
80 {
81 	flags.w = 1;
82 	return flags;
83 }
84 
85 static inline struct openflags of_rdwr(struct openflags flags)
86 {
87 	return of_read(of_write(flags));
88 }
89 
90 static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
91 {
92 	flags.r = r;
93 	flags.w = w;
94 	return flags;
95 }
96 
97 static inline struct openflags of_sync(struct openflags flags)
98 {
99 	flags.s = 1;
100 	return flags;
101 }
102 
103 static inline struct openflags of_create(struct openflags flags)
104 {
105 	flags.c = 1;
106 	return flags;
107 }
108 
109 static inline struct openflags of_trunc(struct openflags flags)
110 {
111 	flags.t = 1;
112 	return flags;
113 }
114 
115 static inline struct openflags of_append(struct openflags flags)
116 {
117 	flags.a = 1;
118 	return flags;
119 }
120 
121 static inline struct openflags of_excl(struct openflags flags)
122 {
123 	flags.e = 1;
124 	return flags;
125 }
126 
127 static inline struct openflags of_cloexec(struct openflags flags)
128 {
129 	flags.cl = 1;
130 	return flags;
131 }
132 
133 /* file.c */
134 extern int os_stat_file(const char *file_name, struct uml_stat *buf);
135 extern int os_stat_fd(const int fd, struct uml_stat *buf);
136 extern int os_access(const char *file, int mode);
137 extern int os_set_exec_close(int fd);
138 extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
139 extern int os_get_ifname(int fd, char *namebuf);
140 extern int os_set_slip(int fd);
141 extern int os_mode_fd(int fd, int mode);
142 extern int os_fsync_file(int fd);
143 
144 extern int os_seek_file(int fd, unsigned long long offset);
145 extern int os_open_file(const 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_sync_file(int fd);
149 extern int os_file_size(const char *file, unsigned long long *size_out);
150 extern int os_pread_file(int fd, void *buf, int len, unsigned long long offset);
151 extern int os_pwrite_file(int fd, const void *buf, int count, unsigned long long offset);
152 extern int os_file_modtime(const char *file, long long *modtime);
153 extern int os_pipe(int *fd, int stream, int close_on_exec);
154 extern int os_set_fd_async(int fd);
155 extern int os_clear_fd_async(int fd);
156 extern int os_set_fd_block(int fd, int blocking);
157 extern int os_accept_connection(int fd);
158 extern int os_create_unix_socket(const char *file, int len, int close_on_exec);
159 extern int os_shutdown_socket(int fd, int r, int w);
160 extern void os_close_file(int fd);
161 extern int os_rcv_fd(int fd, int *helper_pid_out);
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 unsigned os_major(unsigned long long dev);
168 extern unsigned os_minor(unsigned long long dev);
169 extern unsigned long long os_makedev(unsigned major, unsigned minor);
170 extern int os_falloc_punch(int fd, unsigned long long offset, int count);
171 extern int os_eventfd(unsigned int initval, int flags);
172 extern int os_sendmsg_fds(int fd, const void *buf, unsigned int len,
173 			  const int *fds, unsigned int fds_num);
174 int os_poll(unsigned int n, const int *fds);
175 
176 /* start_up.c */
177 extern void os_early_checks(void);
178 extern void os_check_bugs(void);
179 extern void check_host_supports_tls(int *supports_tls, int *tls_min);
180 extern void get_host_cpu_features(
181 	void (*flags_helper_func)(char *line),
182 	void (*cache_helper_func)(char *line));
183 
184 /* mem.c */
185 extern int create_mem_file(unsigned long long len);
186 
187 /* process.c */
188 extern unsigned long os_process_pc(int pid);
189 extern int os_process_parent(int pid);
190 extern void os_alarm_process(int pid);
191 extern void os_stop_process(int pid);
192 extern void os_kill_process(int pid, int reap_child);
193 extern void os_kill_ptraced_process(int pid, int reap_child);
194 
195 extern int os_getpid(void);
196 extern int os_getpgrp(void);
197 
198 extern void init_new_thread_signals(void);
199 
200 extern int os_map_memory(void *virt, int fd, unsigned long long off,
201 			 unsigned long len, int r, int w, int x);
202 extern int os_protect_memory(void *addr, unsigned long len,
203 			     int r, int w, int x);
204 extern int os_unmap_memory(void *addr, int len);
205 extern int os_drop_memory(void *addr, int length);
206 extern int can_drop_memory(void);
207 extern int os_mincore(void *addr, unsigned long len);
208 
209 /* execvp.c */
210 extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
211 /* helper.c */
212 extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv);
213 extern int run_helper_thread(int (*proc)(void *), void *arg,
214 			     unsigned int flags, unsigned long *stack_out);
215 extern int helper_wait(int pid);
216 
217 
218 /* umid.c */
219 extern int umid_file_name(char *name, char *buf, int len);
220 extern int set_umid(char *name);
221 extern char *get_umid(void);
222 
223 /* signal.c */
224 extern void timer_set_signal_handler(void);
225 extern void set_sigstack(void *sig_stack, int size);
226 extern void set_handler(int sig);
227 extern void send_sigio_to_self(void);
228 extern int change_sig(int signal, int on);
229 extern void block_signals(void);
230 extern void unblock_signals(void);
231 extern int um_set_signals(int enable);
232 extern int um_set_signals_trace(int enable);
233 extern int os_is_signal_stack(void);
234 extern void deliver_alarm(void);
235 extern void register_pm_wake_signal(void);
236 extern void block_signals_hard(void);
237 extern void unblock_signals_hard(void);
238 extern void mark_sigio_pending(void);
239 
240 /* util.c */
241 extern void stack_protections(unsigned long address);
242 extern int raw(int fd);
243 extern void setup_machinename(char *machine_out);
244 extern void setup_hostinfo(char *buf, int len);
245 extern void os_dump_core(void) __attribute__ ((noreturn));
246 extern void um_early_printk(const char *s, unsigned int n);
247 extern void os_fix_helper_signals(void);
248 extern void os_info(const char *fmt, ...)
249 	__attribute__ ((format (printf, 1, 2)));
250 extern void os_warn(const char *fmt, ...)
251 	__attribute__ ((format (printf, 1, 2)));
252 
253 /* time.c */
254 extern void os_idle_sleep(void);
255 extern int os_timer_create(void);
256 extern int os_timer_set_interval(unsigned long long nsecs);
257 extern int os_timer_one_shot(unsigned long long nsecs);
258 extern void os_timer_disable(void);
259 extern long long os_persistent_clock_emulation(void);
260 extern 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 userspace(struct uml_pt_regs *regs, unsigned long *aux_fp_regs);
282 extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
283 extern void switch_threads(jmp_buf *me, jmp_buf *you);
284 extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
285 extern void initial_thread_cb_skas(void (*proc)(void *),
286 				 void *arg);
287 extern void halt_skas(void);
288 extern void reboot_skas(void);
289 
290 /* irq.c */
291 extern int os_waiting_for_events_epoll(void);
292 extern void *os_epoll_get_data_pointer(int index);
293 extern int os_epoll_triggered(int index, int events);
294 extern int os_event_mask(enum um_irq_type irq_type);
295 extern int os_setup_epoll(void);
296 extern int os_add_epoll_fd(int events, int fd, void *data);
297 extern int os_mod_epoll_fd(int events, int fd, void *data);
298 extern int os_del_epoll_fd(int fd);
299 extern void os_set_ioignore(void);
300 extern void os_close_epoll_fd(void);
301 extern void um_irqs_suspend(void);
302 extern void um_irqs_resume(void);
303 
304 /* sigio.c */
305 extern int add_sigio_fd(int fd);
306 extern int ignore_sigio_fd(int fd);
307 extern void maybe_sigio_broken(int fd);
308 extern void sigio_broken(int fd);
309 /*
310  * unlocked versions for IRQ controller code.
311  *
312  * This is safe because it's used at suspend/resume and nothing
313  * else is running.
314  */
315 extern int __add_sigio_fd(int fd);
316 extern int __ignore_sigio_fd(int fd);
317 
318 /* prctl.c */
319 extern int os_arch_prctl(int pid, int option, unsigned long *arg2);
320 
321 /* tty.c */
322 extern int get_pty(void);
323 
324 /* sys-$ARCH/task_size.c */
325 extern unsigned long os_get_top_address(void);
326 
327 long syscall(long number, ...);
328 
329 /* irqflags tracing */
330 extern void block_signals_trace(void);
331 extern void unblock_signals_trace(void);
332 extern void um_trace_signals_on(void);
333 extern void um_trace_signals_off(void);
334 
335 /* time-travel */
336 extern void deliver_time_travel_irqs(void);
337 
338 #endif
339