TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / hafnium / third_party / linux / 92d4c21e51fc12736c39c2a161a42f20e2be8a00 / . / arch / um / include / shared / os.h
blob: 2f31d44d892e09c92b2573dcbebb18d089ed3d31 [file] [log] [blame]
David Brazdil0f672f62019-12-10 10:32:29 +0000[diff] [blame]1/* SPDX-License-Identifier: GPL-2.0 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]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)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]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
David Brazdil0f672f62019-12-10 10:32:29 +0000[diff] [blame]39#define OS_SENDMSG_MAX_FDS 8
40
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]41/*
42 * types taken from stat_file() in hostfs_user.c
43 * (if they are wrong here, they are wrong there...).
44 */
45struct uml_stat {
46 int ust_dev; /* device */
47 unsigned long long ust_ino; /* inode */
48 int ust_mode; /* protection */
49 int ust_nlink; /* number of hard links */
50 int ust_uid; /* user ID of owner */
51 int ust_gid; /* group ID of owner */
52 unsigned long long ust_size; /* total size, in bytes */
53 int ust_blksize; /* blocksize for filesystem I/O */
54 unsigned long long ust_blocks; /* number of blocks allocated */
55 unsigned long ust_atime; /* time of last access */
56 unsigned long ust_mtime; /* time of last modification */
57 unsigned long ust_ctime; /* time of last change */
58};
59
60struct openflags {
61 unsigned int r : 1;
62 unsigned int w : 1;
63 unsigned int s : 1; /* O_SYNC */
64 unsigned int c : 1; /* O_CREAT */
65 unsigned int t : 1; /* O_TRUNC */
66 unsigned int a : 1; /* O_APPEND */
67 unsigned int e : 1; /* O_EXCL */
68 unsigned int cl : 1; /* FD_CLOEXEC */
69};
70
71#define OPENFLAGS() ((struct openflags) { .r = 0, .w = 0, .s = 0, .c = 0, \
72 .t = 0, .a = 0, .e = 0, .cl = 0 })
73
74static inline struct openflags of_read(struct openflags flags)
75{
76 flags.r = 1;
77 return flags;
78}
79
80static inline struct openflags of_write(struct openflags flags)
81{
82 flags.w = 1;
83 return flags;
84}
85
86static inline struct openflags of_rdwr(struct openflags flags)
87{
88 return of_read(of_write(flags));
89}
90
91static inline struct openflags of_set_rw(struct openflags flags, int r, int w)
92{
93 flags.r = r;
94 flags.w = w;
95 return flags;
96}
97
98static inline struct openflags of_sync(struct openflags flags)
99{
100 flags.s = 1;
101 return flags;
102}
103
104static inline struct openflags of_create(struct openflags flags)
105{
106 flags.c = 1;
107 return flags;
108}
109
110static inline struct openflags of_trunc(struct openflags flags)
111{
112 flags.t = 1;
113 return flags;
114}
115
116static inline struct openflags of_append(struct openflags flags)
117{
118 flags.a = 1;
119 return flags;
120}
121
122static inline struct openflags of_excl(struct openflags flags)
123{
124 flags.e = 1;
125 return flags;
126}
127
128static inline struct openflags of_cloexec(struct openflags flags)
129{
130 flags.cl = 1;
131 return flags;
132}
133
134/* file.c */
135extern int os_stat_file(const char *file_name, struct uml_stat *buf);
136extern int os_stat_fd(const int fd, struct uml_stat *buf);
137extern int os_access(const char *file, int mode);
138extern int os_set_exec_close(int fd);
139extern int os_ioctl_generic(int fd, unsigned int cmd, unsigned long arg);
140extern int os_get_ifname(int fd, char *namebuf);
141extern int os_set_slip(int fd);
142extern int os_mode_fd(int fd, int mode);
143extern int os_fsync_file(int fd);
144
145extern int os_seek_file(int fd, unsigned long long offset);
146extern int os_open_file(const char *file, struct openflags flags, int mode);
147extern int os_read_file(int fd, void *buf, int len);
148extern int os_write_file(int fd, const void *buf, int count);
149extern int os_sync_file(int fd);
150extern int os_file_size(const char *file, unsigned long long *size_out);
151extern int os_pread_file(int fd, void *buf, int len, unsigned long long offset);
152extern int os_pwrite_file(int fd, const void *buf, int count, unsigned long long offset);
Olivier Deprez157378f2022-04-04 15:47:50 +0200[diff] [blame]153extern int os_file_modtime(const char *file, long long *modtime);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]154extern int os_pipe(int *fd, int stream, int close_on_exec);
155extern int os_set_fd_async(int fd);
156extern int os_clear_fd_async(int fd);
157extern int os_set_fd_block(int fd, int blocking);
158extern int os_accept_connection(int fd);
159extern int os_create_unix_socket(const char *file, int len, int close_on_exec);
160extern int os_shutdown_socket(int fd, int r, int w);
161extern void os_close_file(int fd);
162extern int os_rcv_fd(int fd, int *helper_pid_out);
163extern int create_unix_socket(char *file, int len, int close_on_exec);
164extern int os_connect_socket(const char *name);
165extern int os_file_type(char *file);
166extern int os_file_mode(const char *file, struct openflags *mode_out);
167extern int os_lock_file(int fd, int excl);
168extern void os_flush_stdout(void);
169extern int os_stat_filesystem(char *path, long *bsize_out,
170 long long *blocks_out, long long *bfree_out,
171 long long *bavail_out, long long *files_out,
172 long long *ffree_out, void *fsid_out,
173 int fsid_size, long *namelen_out,
174 long *spare_out);
175extern int os_change_dir(char *dir);
176extern int os_fchange_dir(int fd);
177extern unsigned os_major(unsigned long long dev);
178extern unsigned os_minor(unsigned long long dev);
179extern unsigned long long os_makedev(unsigned major, unsigned minor);
David Brazdil0f672f62019-12-10 10:32:29 +0000[diff] [blame]180extern int os_falloc_punch(int fd, unsigned long long offset, int count);
181extern int os_eventfd(unsigned int initval, int flags);
182extern int os_sendmsg_fds(int fd, const void *buf, unsigned int len,
183 const int *fds, unsigned int fds_num);
Olivier Deprez157378f2022-04-04 15:47:50 +0200[diff] [blame]184int os_poll(unsigned int n, const int *fds);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]185
186/* start_up.c */
187extern void os_early_checks(void);
188extern void os_check_bugs(void);
189extern void check_host_supports_tls(int *supports_tls, int *tls_min);
190
191/* mem.c */
192extern int create_mem_file(unsigned long long len);
193
194/* process.c */
195extern unsigned long os_process_pc(int pid);
196extern int os_process_parent(int pid);
197extern void os_alarm_process(int pid);
198extern void os_stop_process(int pid);
199extern void os_kill_process(int pid, int reap_child);
200extern void os_kill_ptraced_process(int pid, int reap_child);
201
202extern int os_getpid(void);
203extern int os_getpgrp(void);
204
205extern void init_new_thread_signals(void);
206
207extern int os_map_memory(void *virt, int fd, unsigned long long off,
208 unsigned long len, int r, int w, int x);
209extern int os_protect_memory(void *addr, unsigned long len,
210 int r, int w, int x);
211extern int os_unmap_memory(void *addr, int len);
212extern int os_drop_memory(void *addr, int length);
213extern int can_drop_memory(void);
214extern void os_flush_stdout(void);
215extern int os_mincore(void *addr, unsigned long len);
216
217/* execvp.c */
218extern int execvp_noalloc(char *buf, const char *file, char *const argv[]);
219/* helper.c */
220extern int run_helper(void (*pre_exec)(void *), void *pre_data, char **argv);
221extern int run_helper_thread(int (*proc)(void *), void *arg,
222 unsigned int flags, unsigned long *stack_out);
223extern int helper_wait(int pid);
224
225
226/* umid.c */
227extern int umid_file_name(char *name, char *buf, int len);
228extern int set_umid(char *name);
229extern char *get_umid(void);
230
231/* signal.c */
232extern void timer_set_signal_handler(void);
233extern void set_sigstack(void *sig_stack, int size);
234extern void remove_sigstack(void);
235extern void set_handler(int sig);
236extern int change_sig(int signal, int on);
237extern void block_signals(void);
238extern void unblock_signals(void);
239extern int get_signals(void);
240extern int set_signals(int enable);
David Brazdil0f672f62019-12-10 10:32:29 +0000[diff] [blame]241extern int set_signals_trace(int enable);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]242extern int os_is_signal_stack(void);
243extern void deliver_alarm(void);
Olivier Deprez92d4c212022-12-06 15:05:30 +0100[diff] [blame^]244extern void register_pm_wake_signal(void);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]245
246/* util.c */
247extern void stack_protections(unsigned long address);
248extern int raw(int fd);
249extern void setup_machinename(char *machine_out);
250extern void setup_hostinfo(char *buf, int len);
251extern void os_dump_core(void) __attribute__ ((noreturn));
252extern void um_early_printk(const char *s, unsigned int n);
253extern void os_fix_helper_signals(void);
254extern void os_info(const char *fmt, ...)
255 __attribute__ ((format (printf, 1, 2)));
256extern void os_warn(const char *fmt, ...)
257 __attribute__ ((format (printf, 1, 2)));
258
259/* time.c */
260extern void os_idle_sleep(unsigned long long nsecs);
David Brazdil0f672f62019-12-10 10:32:29 +0000[diff] [blame]261extern int os_timer_create(void);
262extern int os_timer_set_interval(unsigned long long nsecs);
263extern int os_timer_one_shot(unsigned long long nsecs);
264extern void os_timer_disable(void);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]265extern void uml_idle_timer(void);
266extern long long os_persistent_clock_emulation(void);
267extern long long os_nsecs(void);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]268
269/* skas/mem.c */
270extern long run_syscall_stub(struct mm_id * mm_idp,
271 int syscall, unsigned long *args, long expected,
272 void **addr, int done);
273extern long syscall_stub_data(struct mm_id * mm_idp,
274 unsigned long *data, int data_count,
275 void **addr, void **stub_addr);
276extern int map(struct mm_id * mm_idp, unsigned long virt,
277 unsigned long len, int prot, int phys_fd,
278 unsigned long long offset, int done, void **data);
279extern int unmap(struct mm_id * mm_idp, unsigned long addr, unsigned long len,
280 int done, void **data);
281extern int protect(struct mm_id * mm_idp, unsigned long addr,
282 unsigned long len, unsigned int prot, int done, void **data);
283
284/* skas/process.c */
285extern int is_skas_winch(int pid, int fd, void *data);
286extern int start_userspace(unsigned long stub_stack);
287extern int copy_context_skas0(unsigned long stack, int pid);
288extern void userspace(struct uml_pt_regs *regs, unsigned long *aux_fp_regs);
289extern int map_stub_pages(int fd, unsigned long code, unsigned long data,
290 unsigned long stack);
291extern void new_thread(void *stack, jmp_buf *buf, void (*handler)(void));
292extern void switch_threads(jmp_buf *me, jmp_buf *you);
293extern int start_idle_thread(void *stack, jmp_buf *switch_buf);
294extern void initial_thread_cb_skas(void (*proc)(void *),
295 void *arg);
296extern void halt_skas(void);
297extern void reboot_skas(void);
298
299/* irq.c */
300extern int os_waiting_for_events_epoll(void);
301extern void *os_epoll_get_data_pointer(int index);
302extern int os_epoll_triggered(int index, int events);
303extern int os_event_mask(int irq_type);
304extern int os_setup_epoll(void);
305extern int os_add_epoll_fd(int events, int fd, void *data);
306extern int os_mod_epoll_fd(int events, int fd, void *data);
307extern int os_del_epoll_fd(int fd);
308extern void os_set_ioignore(void);
309extern void os_close_epoll_fd(void);
310
311/* sigio.c */
312extern int add_sigio_fd(int fd);
313extern int ignore_sigio_fd(int fd);
314extern void maybe_sigio_broken(int fd, int read);
315extern void sigio_broken(int fd, int read);
316
317/* prctl.c */
318extern int os_arch_prctl(int pid, int option, unsigned long *arg2);
319
320/* tty.c */
321extern int get_pty(void);
322
323/* sys-$ARCH/task_size.c */
324extern unsigned long os_get_top_address(void);
325
326long syscall(long number, ...);
327
David Brazdil0f672f62019-12-10 10:32:29 +0000[diff] [blame]328/* irqflags tracing */
329extern void block_signals_trace(void);
330extern void unblock_signals_trace(void);
331extern void um_trace_signals_on(void);
332extern void um_trace_signals_off(void);
333
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000[diff] [blame]334#endif