os.h

  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/* This is to get size_t */
 15#ifndef __UM_HOST__
 16#include <linux/types.h>
 17#else
 18#include <sys/types.h>
 19#endif
 20
 21#define CATCH_EINTR(expr) while ((errno = 0, ((expr) < 0)) && (errno == EINTR))
 22
 23#define OS_TYPE_FILE 1
 24#define OS_TYPE_DIR 2
 25#define OS_TYPE_SYMLINK 3
 26#define OS_TYPE_CHARDEV 4
 27#define OS_TYPE_BLOCKDEV 5
 28#define OS_TYPE_FIFO 6
 29#define OS_TYPE_SOCK 7
 30
 31/* os_access() flags */
 32#define OS_ACC_F_OK    0       /* Test for existence.  */
 33#define OS_ACC_X_OK    1       /* Test for execute permission.  */
 34#define OS_ACC_W_OK    2       /* Test for write permission.  */
 35#define OS_ACC_R_OK    4       /* Test for read permission.  */
 36#define OS_ACC_RW_OK   (OS_ACC_W_OK | OS_ACC_R_OK) /* Test for RW permission */
 37
 38#ifdef CONFIG_64BIT
 39#define OS_LIB_PATH	"/usr/lib64/"
 40#else
 41#define OS_LIB_PATH	"/usr/lib/"
 42#endif
 43
 44#define OS_SENDMSG_MAX_FDS 8
 45
 46/*
 47 * types taken from stat_file() in hostfs_user.c
 48 * (if they are wrong here, they are wrong there...).
 49 */
 50struct uml_stat {
 51	int                ust_dev;        /* device */
 52	unsigned long long ust_ino;        /* inode */
 53	int                ust_mode;       /* protection */
 54	int                ust_nlink;      /* number of hard links */
 55	int                ust_uid;        /* user ID of owner */
 56	int                ust_gid;        /* group ID of owner */
 57	unsigned long long ust_size;       /* total size, in bytes */
 58	int                ust_blksize;    /* blocksize for filesystem I/O */
 59	unsigned long long ust_blocks;     /* number of blocks allocated */
 60	unsigned long      ust_atime;      /* time of last access */
 61	unsigned long      ust_mtime;      /* time of last modification */
 62	unsigned long      ust_ctime;      /* time of last change */
 63};
 64
 65struct openflags {
 66	unsigned int r : 1;
 67	unsigned int w : 1;
 68	unsigned int s : 1;	/* O_SYNC */
 69	unsigned int c : 1;	/* O_CREAT */
 70	unsigned int t : 1;	/* O_TRUNC */
 71	unsigned int a : 1;	/* O_APPEND */
 72	unsigned int e : 1;	/* O_EXCL */
 73	unsigned int cl : 1;    /* FD_CLOEXEC */
 74};
 75
 76#define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
 77					  .t = 0, .a = 0, .e = 0, .cl = 0 })
 78
 79static inline struct openflags of_read(struct openflags flags)
 80{
 81	flags.r = 1;
 82	return flags;
 83}
 84
 85static inline struct openflags of_write(struct openflags flags)
 86{
 87	flags.w = 1;
 88	return flags;
 89}
 90
 91static inline struct openflags of_rdwr(struct openflags flags)
 92{
 93	return of_read(of_write(flags));
 94}
 95
 96static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
 97{
 98	flags.r = r;
 99	flags.w = w;
100	return flags;
101}
102
103static inline struct openflags of_sync(struct openflags flags)
104{
105	flags.s = 1;
106	return flags;
107}
108
109static inline struct openflags of_create(struct openflags flags)
110{
111	flags.c = 1;
112	return flags;
113}
114
115static inline struct openflags of_trunc(struct openflags flags)
116{
117	flags.t = 1;
118	return flags;
119}
120
121static inline struct openflags of_append(struct openflags flags)
122{
123	flags.a = 1;
124	return flags;
125}
126
127static inline struct openflags of_excl(struct openflags flags)
128{
129	flags.e = 1;
130	return flags;
131}
132
133static inline struct openflags of_cloexec(struct openflags flags)
134{
135	flags.cl = 1;
136	return flags;
137}
138
139/* file.c */
140extern int os_stat_file(const char *file_name, struct uml_stat *buf);
141extern int os_stat_fd(const int fd, struct uml_stat *buf);
142extern int os_access(const char *file, int mode);
143extern int os_set_exec_close(int fd);
144extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
145extern int os_get_ifname(int fd, char *namebuf);
146extern int os_mode_fd(int fd, int mode);
147
148extern int os_seek_file(int fd, unsigned long long offset);
149extern int os_open_file(const char *file, struct openflags flags, int mode);
150extern int os_read_file(int fd, void *buf, int len);
151extern int os_write_file(int fd, const void *buf, int count);
152extern int os_sync_file(int fd);
153extern int os_file_size(const char *file, unsigned long long *size_out);
154extern int os_pread_file(int fd, void *buf, int len, unsigned long long offset);
155extern int os_pwrite_file(int fd, const void *buf, int count, unsigned long long offset);
156extern int os_file_modtime(const char *file, long long *modtime);
157extern int os_pipe(int *fd, int stream, int close_on_exec);
158extern int os_set_fd_async(int fd);
159extern int os_clear_fd_async(int fd);
160extern int os_set_fd_block(int fd, int blocking);
161extern int os_accept_connection(int fd);
162extern int os_create_unix_socket(const char *file, int len, int close_on_exec);
163extern int os_shutdown_socket(int fd, int r, int w);
164extern int os_dup_file(int fd);
165extern void os_close_file(int fd);
166ssize_t os_rcv_fd_msg(int fd, int *fds, unsigned int n_fds,
167		      void *data, size_t data_len);
168extern int os_connect_socket(const char *name);
169extern int os_file_type(char *file);
170extern int os_file_mode(const char *file, struct openflags *mode_out);
171extern int os_lock_file(int fd, int excl);
172extern void os_flush_stdout(void);
173extern unsigned os_major(unsigned long long dev);
174extern unsigned os_minor(unsigned long long dev);
175extern unsigned long long os_makedev(unsigned major, unsigned minor);
176extern int os_falloc_punch(int fd, unsigned long long offset, int count);
177extern int os_falloc_zeroes(int fd, unsigned long long offset, int count);
178extern int os_eventfd(unsigned int initval, int flags);
179extern int os_sendmsg_fds(int fd, const void *buf, unsigned int len,
180			  const int *fds, unsigned int fds_num);
181int os_poll(unsigned int n, const int *fds);
182void *os_mmap_rw_shared(int fd, size_t size);
183void *os_mremap_rw_shared(void *old_addr, size_t old_size, size_t new_size);
184
185/* start_up.c */
186extern void os_early_checks(void);
187extern void os_check_bugs(void);
188extern void check_host_supports_tls(int *supports_tls, int *tls_min);
189extern void get_host_cpu_features(
190	void (*flags_helper_func)(char *line),
191	void (*cache_helper_func)(char *line));
192
193/* mem.c */
194extern int create_mem_file(unsigned long long len);
195
196/* tlb.c */
197extern void report_enomem(void);
198
199/* process.c */
200pid_t os_reap_child(void);
201extern void os_alarm_process(int pid);
202extern void os_kill_process(int pid, int reap_child);
203extern void os_kill_ptraced_process(int pid, int reap_child);
204
205extern int os_getpid(void);
206
207extern void init_new_thread_signals(void);
208
209extern int os_map_memory(void *virt, int fd, unsigned long long off,
210			 unsigned long len, int r, int w, int x);
211extern int os_protect_memory(void *addr, unsigned long len,
212			     int r, int w, int x);
213extern int os_unmap_memory(void *addr, int len);
214extern int os_drop_memory(void *addr, int length);
215extern int can_drop_memory(void);
216
217void os_set_pdeathsig(void);
218
219int os_futex_wait(void *uaddr, unsigned int val);
220int os_futex_wake(void *uaddr);
221
222/* execvp.c */
223extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
224/* helper.c */
225extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv);
226extern int run_helper_thread(int (*proc)(void *), void *arg,
227			     unsigned int flags, unsigned long *stack_out);
228extern int helper_wait(int pid);
229
230struct os_helper_thread;
231int os_run_helper_thread(struct os_helper_thread **td_out,
232			 void *(*routine)(void *), void *arg);
233void os_kill_helper_thread(struct os_helper_thread *td);
234void os_fix_helper_thread_signals(void);
235
236/* umid.c */
237extern int umid_file_name(char *name, char *buf, int len);
238extern int set_umid(char *name);
239extern char *get_umid(void);
240
241/* signal.c */
242extern void timer_set_signal_handler(void);
243extern void set_sigstack(void *sig_stack, int size);
244extern void set_handler(int sig);
245extern void send_sigio_to_self(void);
246extern int change_sig(int signal, int on);
247extern void block_signals(void);
248extern void unblock_signals(void);
249extern int um_get_signals(void);
250extern int um_set_signals(int enable);
251extern int um_set_signals_trace(int enable);
252extern void deliver_alarm(void);
253extern void register_pm_wake_signal(void);
254extern void block_signals_hard(void);
255extern void unblock_signals_hard(void);
256extern void mark_sigio_pending(void);
257
258/* util.c */
259extern void stack_protections(unsigned long address);
260extern int raw(int fd);
261extern void setup_machinename(char *machine_out);
262extern void setup_hostinfo(char *buf, int len);
263extern ssize_t os_getrandom(void *buf, size_t len, unsigned int flags);
264extern void os_dump_core(void) __attribute__ ((noreturn));
265extern void um_early_printk(const char *s, unsigned int n);
266extern void os_fix_helper_signals(void);
267extern void os_info(const char *fmt, ...)
268	__attribute__ ((format (printf, 1, 2)));
269extern void os_warn(const char *fmt, ...)
270	__attribute__ ((format (printf, 1, 2)));
271
272/* time.c */
273void os_idle_prepare(void);
274extern void os_idle_sleep(void);
275extern int os_timer_create(void);
276extern int os_timer_set_interval(int cpu, unsigned long long nsecs);
277extern int os_timer_one_shot(int cpu, unsigned long long nsecs);
278extern void os_timer_disable(int cpu);
279extern long long os_persistent_clock_emulation(void);
280extern long long os_nsecs(void);
281
282/* skas/mem.c */
283int syscall_stub_flush(struct mm_id *mm_idp);
284struct stub_syscall *syscall_stub_alloc(struct mm_id *mm_idp);
285void syscall_stub_dump_error(struct mm_id *mm_idp);
286
287int map(struct mm_id *mm_idp, unsigned long virt,
288	unsigned long len, int prot, int phys_fd,
289	unsigned long long offset);
290int unmap(struct mm_id *mm_idp, unsigned long addr, unsigned long len);
291
292/* skas/process.c */
293extern int is_skas_winch(int pid, int fd, void *data);
294extern int start_userspace(struct mm_id *mm_id);
295extern void userspace(struct uml_pt_regs *regs);
296extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
297extern void switch_threads(jmp_buf *me, jmp_buf *you);
298extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
299extern void initial_thread_cb_skas(void (*proc)(void *),
300				 void *arg);
301extern void halt_skas(void);
302extern void reboot_skas(void);
303
304/* irq.c */
305extern int os_waiting_for_events_epoll(void);
306extern void *os_epoll_get_data_pointer(int index);
307extern int os_epoll_triggered(int index, int events);
308extern int os_event_mask(enum um_irq_type irq_type);
309extern int os_setup_epoll(void);
310extern int os_add_epoll_fd(int events, int fd, void *data);
311extern int os_mod_epoll_fd(int events, int fd, void *data);
312extern int os_del_epoll_fd(int fd);
313extern void os_set_ioignore(void);
314extern void os_close_epoll_fd(void);
315extern void um_irqs_suspend(void);
316extern void um_irqs_resume(void);
317
318/* sigio.c */
319extern int add_sigio_fd(int fd);
320extern int ignore_sigio_fd(int fd);
321extern void maybe_sigio_broken(int fd);
322extern void sigio_broken(void);
323/*
324 * unlocked versions for IRQ controller code.
325 *
326 * This is safe because it's used at suspend/resume and nothing
327 * else is running.
328 */
329extern int __add_sigio_fd(int fd);
330extern int __ignore_sigio_fd(int fd);
331
332/* tty.c */
333extern int get_pty(void);
334
335long syscall(long number, ...);
336
337/* irqflags tracing */
338extern void block_signals_trace(void);
339extern void unblock_signals_trace(void);
340extern void um_trace_signals_on(void);
341extern void um_trace_signals_off(void);
342
343/* time-travel */
344extern void deliver_time_travel_irqs(void);
345
346/* smp.c */
347#if IS_ENABLED(CONFIG_SMP)
348void os_init_smp(void);
349int os_start_cpu_thread(int cpu);
350void os_start_secondary(void *arg, jmp_buf *switch_buf);
351int os_send_ipi(int cpu, int vector);
352void os_local_ipi_enable(void);
353void os_local_ipi_disable(void);
354#else /* !CONFIG_SMP */
355static inline void os_local_ipi_enable(void) { }
356static inline void os_local_ipi_disable(void) { }
357#endif /* CONFIG_SMP */
358
359#endif