xref: /minix/minix/include/minix/syslib.h (revision 27852ebe)
1 /* Prototypes for system library functions. */
2 
3 #ifndef _SYSLIB_H
4 #define _SYSLIB_H
5 
6 #include <sys/types.h>
7 #include <sys/sigtypes.h>
8 
9 #include <minix/ipc.h>
10 #include <minix/u64.h>
11 #include <minix/devio.h>
12 
13 #include <minix/safecopies.h>
14 #include <minix/sef.h>
15 #include <machine/mcontext.h>
16 
17 /* Forward declaration */
18 struct rs_pci;
19 struct rusage;
20 struct sockcred;
21 
22 #define SYSTASK SYSTEM
23 
24 /*==========================================================================*
25  * Minix system library. 						    *
26  *==========================================================================*/
27 int _taskcall(endpoint_t who, int syscallnr, message *msgptr);
28 int _kernel_call(int syscallnr, message *msgptr);
29 
30 int sys_abort(int how);
31 int sys_enable_iop(endpoint_t proc_ep);
32 int sys_exec(endpoint_t proc_ep, vir_bytes stack_ptr, vir_bytes progname,
33 	vir_bytes pc, vir_bytes ps_str);
34 int sys_fork(endpoint_t parent, endpoint_t child, endpoint_t *,
35 	u32_t vm, vir_bytes *);
36 int sys_clear(endpoint_t proc_ep);
37 int sys_exit(void);
38 int sys_trace(int req, endpoint_t proc_ep, long addr, long *data_p);
39 
40 int sys_schedule(endpoint_t proc_ep, int priority, int quantum, int cpu,
41 	int niced);
42 int sys_schedctl(unsigned flags, endpoint_t proc_ep, int priority, int
43 	quantum, int cpu);
44 
45 /* Shorthands for sys_runctl() system call. */
46 #define sys_stop(proc_ep) sys_runctl(proc_ep, RC_STOP, 0)
47 #define sys_delay_stop(proc_ep) sys_runctl(proc_ep, RC_STOP, RC_DELAY)
48 #define sys_resume(proc_ep) sys_runctl(proc_ep, RC_RESUME, 0)
49 int sys_runctl(endpoint_t proc_ep, int action, int flags);
50 
51 int sys_update(endpoint_t src_ep, endpoint_t dst_ep, int flags);
52 int sys_statectl(int request, void* address, int length);
53 int sys_privctl(endpoint_t proc_ep, int req, void *p);
54 int sys_privquery_mem(endpoint_t proc_ep, phys_bytes physstart,
55 	phys_bytes physlen);
56 int sys_setgrant(cp_grant_t *grants, int ngrants);
57 
58 int sys_vm_setbuf(phys_bytes base, phys_bytes size, phys_bytes high);
59 int sys_vm_map(endpoint_t proc_ep, int do_map, phys_bytes base,
60 	phys_bytes size, phys_bytes offset);
61 int sys_vmctl(endpoint_t who, int param, u32_t value);
62 int sys_vmctl_get_pdbr(endpoint_t who, u32_t *pdbr);
63 int sys_vmctl_get_memreq(endpoint_t *who, vir_bytes *mem, vir_bytes
64 	*len, int *wrflag, endpoint_t *who_s, vir_bytes *mem_s, endpoint_t *);
65 int sys_vmctl_enable_paging(void * data);
66 
67 int sys_readbios(phys_bytes address, void *buf, size_t size);
68 int sys_settime(int now, clockid_t clk_id, time_t sec, long nsec);
69 int sys_stime(time_t boottime);
70 int sys_vmctl_get_mapping(int index, phys_bytes *addr, phys_bytes *len,
71 	int *flags);
72 int sys_vmctl_reply_mapping(int index, vir_bytes addr);
73 int sys_vmctl_set_addrspace(endpoint_t who, phys_bytes ptroot, void
74 	*ptroot_v);
75 
76 
77 /* Shorthands for sys_sdevio() system call. */
78 #define sys_insb(port, proc_ep, buffer, count) \
79   sys_sdevio(DIO_INPUT_BYTE, port, proc_ep, buffer, count, 0)
80 #define sys_insw(port, proc_ep, buffer, count) \
81   sys_sdevio(DIO_INPUT_WORD, port, proc_ep, buffer, count, 0)
82 #define sys_outsb(port, proc_ep, buffer, count) \
83   sys_sdevio(DIO_OUTPUT_BYTE, port, proc_ep, buffer, count, 0)
84 #define sys_outsw(port, proc_ep, buffer, count) \
85   sys_sdevio(DIO_OUTPUT_WORD, port, proc_ep, buffer, count, 0)
86 #define sys_safe_insb(port, ept, grant, offset, count) \
87   sys_sdevio(DIO_SAFE_INPUT_BYTE, port, ept, (void*)grant, count, offset)
88 #define sys_safe_outsb(port, ept, grant, offset, count) \
89   sys_sdevio(DIO_SAFE_OUTPUT_BYTE, port, ept, (void*)grant, count, offset)
90 #define sys_safe_insw(port, ept, grant, offset, count) \
91   sys_sdevio(DIO_SAFE_INPUT_WORD, port, ept, (void*)grant, count, offset)
92 #define sys_safe_outsw(port, ept, grant, offset, count) \
93   sys_sdevio(DIO_SAFE_OUTPUT_WORD, port, ept, (void*)grant, count, offset)
94 int sys_sdevio(int req, long port, endpoint_t proc_ep, void *buffer, int
95 	count, vir_bytes offset);
96 void *alloc_contig(size_t len, int flags, phys_bytes *phys);
97 int free_contig(void *addr, size_t len);
98 
99 #define AC_ALIGN4K	0x01
100 #define AC_LOWER16M	0x02
101 #define AC_ALIGN64K	0x04
102 #define AC_LOWER1M	0x08
103 
104 /* Clock functionality: get system times, (un)schedule an alarm call, or
105  * retrieve/set a process-virtual timer.
106  */
107 int sys_times(endpoint_t proc_ep, clock_t *user_time, clock_t *sys_time,
108 	clock_t *uptime, time_t *boottime);
109 
110 #define sys_setalarm(exp, abs) sys_setalarm2(exp, abs, NULL, NULL)
111 int sys_setalarm2(clock_t exp_time, int abs_time, clock_t *time_left,
112 	clock_t *uptime);
113 
114 int sys_vtimer(endpoint_t proc_nr, int which, clock_t *newval, clock_t
115 	*oldval);
116 
117 /* Shorthands for sys_irqctl() system call. */
118 #define sys_irqdisable(hook_id) \
119     sys_irqctl(IRQ_DISABLE, 0, 0, hook_id)
120 #define sys_irqenable(hook_id) \
121     sys_irqctl(IRQ_ENABLE, 0, 0, hook_id)
122 #define sys_irqsetpolicy(irq_vec, policy, hook_id) \
123     sys_irqctl(IRQ_SETPOLICY, irq_vec, policy, hook_id)
124 #define sys_irqrmpolicy(hook_id) \
125     sys_irqctl(IRQ_RMPOLICY, 0, 0, hook_id)
126 int sys_irqctl(int request, int irq_vec, int policy, int *irq_hook_id);
127 
128 /* Shorthands for sys_vircopy() and sys_physcopy() system calls. */
129 #define sys_datacopy(p1, v1, p2, v2, len) sys_vircopy(p1, v1, p2, v2, len, 0)
130 #define sys_datacopy_try(p1, v1, p2, v2, len) sys_vircopy(p1, v1, p2, v2, len, CP_FLAG_TRY)
131 int sys_vircopy(endpoint_t src_proc, vir_bytes src_v,
132 	endpoint_t dst_proc, vir_bytes dst_vir, phys_bytes bytes, int flags);
133 
134 #define sys_abscopy(src_phys, dst_phys, bytes) \
135 	sys_physcopy(NONE, src_phys, NONE, dst_phys, bytes, 0)
136 int sys_physcopy(endpoint_t src_proc, vir_bytes src_vir,
137 	endpoint_t dst_proc, vir_bytes dst_vir, phys_bytes bytes, int flags);
138 
139 
140 /* Grant-based copy functions. */
141 int sys_safecopyfrom(endpoint_t source, cp_grant_id_t grant, vir_bytes
142 	grant_offset, vir_bytes my_address, size_t bytes);
143 int sys_safecopyto(endpoint_t dest, cp_grant_id_t grant, vir_bytes
144 	grant_offset, vir_bytes my_address, size_t bytes);
145 int sys_vsafecopy(struct vscp_vec *copyvec, int elements);
146 
147 int sys_safememset(endpoint_t source, cp_grant_id_t grant, vir_bytes
148 	grant_offset, int pattern, size_t bytes);
149 
150 int sys_memset(endpoint_t who, unsigned long pattern,
151 	phys_bytes base, phys_bytes bytes);
152 
153 int sys_vumap(endpoint_t endpt, struct vumap_vir *vvec,
154 	int vcount, size_t offset, int access, struct vumap_phys *pvec,
155 	int *pcount);
156 int sys_umap(endpoint_t proc_ep, int seg, vir_bytes vir_addr, vir_bytes
157 	bytes, phys_bytes *phys_addr);
158 int sys_umap_data_fb(endpoint_t proc_ep, vir_bytes vir_addr, vir_bytes
159 	bytes, phys_bytes *phys_addr);
160 int sys_umap_remote(endpoint_t proc_ep, endpoint_t grantee, int seg,
161 	vir_bytes vir_addr, vir_bytes bytes, phys_bytes *phys_addr);
162 
163 /* Shorthands for sys_diagctl() system call. */
164 #define sys_diagctl_diag(buf,len) \
165 	sys_diagctl(DIAGCTL_CODE_DIAG, buf, len)
166 #define sys_diagctl_stacktrace(ep) \
167 	sys_diagctl(DIAGCTL_CODE_STACKTRACE, NULL, ep)
168 #define sys_diagctl_register()	\
169 	sys_diagctl(DIAGCTL_CODE_REGISTER, NULL, 0)
170 #define sys_diagctl_unregister() \
171 	sys_diagctl(DIAGCTL_CODE_UNREGISTER, NULL, 0)
172 int sys_diagctl(int ctl, char *arg1, int arg2);
173 
174 /* Shorthands for sys_getinfo() system call. */
175 #define sys_getkinfo(dst)	sys_getinfo(GET_KINFO, dst, 0,0,0)
176 #define sys_getloadinfo(dst)	sys_getinfo(GET_LOADINFO, dst, 0,0,0)
177 #define sys_getmachine(dst)	sys_getinfo(GET_MACHINE, dst, 0,0,0)
178 #define sys_getcpuinfo(dst)     sys_getinfo(GET_CPUINFO, dst, 0,0,0)
179 #define sys_getproctab(dst)	sys_getinfo(GET_PROCTAB, dst, 0,0,0)
180 #define sys_getprivtab(dst)	sys_getinfo(GET_PRIVTAB, dst, 0,0,0)
181 #define sys_getproc(dst,nr)	sys_getinfo(GET_PROC, dst, 0,0, nr)
182 #define sys_getrandomness(dst)	sys_getinfo(GET_RANDOMNESS, dst, 0,0,0)
183 #define sys_getrandom_bin(d,b)	sys_getinfo(GET_RANDOMNESS_BIN, d, 0,0,b)
184 #define sys_getimage(dst)	sys_getinfo(GET_IMAGE, dst, 0,0,0)
185 #define sys_getirqhooks(dst)	sys_getinfo(GET_IRQHOOKS, dst, 0,0,0)
186 #define sys_getirqactids(dst)	sys_getinfo(GET_IRQACTIDS, dst, 0,0,0)
187 #define sys_getmonparams(v,vl)	sys_getinfo(GET_MONPARAMS, v,vl, 0,0)
188 #define sys_getschedinfo(v1,v2)	sys_getinfo(GET_SCHEDINFO, v1,0, v2,0)
189 #define sys_getpriv(dst, nr)	sys_getinfo(GET_PRIV, dst, 0,0, nr)
190 #define sys_getidletsc(dst)	sys_getinfo(GET_IDLETSC, dst, 0,0,0)
191 #define sys_getregs(dst,nr)	sys_getinfo(GET_REGS, dst, 0,0, nr)
192 #define sys_getcputicks(dst,nr)	sys_getinfo(GET_CPUTICKS, dst, 0,0, nr)
193 int sys_getinfo(int request, void *val_ptr, int val_len, void *val_ptr2,
194 	int val_len2);
195 int sys_whoami(endpoint_t *ep, char *name, int namelen, int
196 	*priv_flags, int* init_flags);
197 
198 /* Signal control. */
199 int sys_kill(endpoint_t proc_ep, int sig);
200 int sys_sigsend(endpoint_t proc_ep, struct sigmsg *sig_ctxt);
201 int sys_sigreturn(endpoint_t proc_ep, struct sigmsg *sig_ctxt);
202 int sys_getksig(endpoint_t *proc_ep, sigset_t *k_sig_map);
203 int sys_endksig(endpoint_t proc_ep);
204 
205 /* NOTE: two different approaches were used to distinguish the device I/O
206  * types 'byte', 'word', 'long': the latter uses #define and results in a
207  * smaller implementation, but looses the static type checking.
208  */
209 int sys_voutb(pvb_pair_t *pvb_pairs, int nr_ports);
210 int sys_voutw(pvw_pair_t *pvw_pairs, int nr_ports);
211 int sys_voutl(pvl_pair_t *pvl_pairs, int nr_ports);
212 int sys_vinb(pvb_pair_t *pvb_pairs, int nr_ports);
213 int sys_vinw(pvw_pair_t *pvw_pairs, int nr_ports);
214 int sys_vinl(pvl_pair_t *pvl_pairs, int nr_ports);
215 
216 /* Shorthands for sys_out() system call. */
217 #define sys_outb(p,v)	sys_out((p), (u32_t) (v), _DIO_BYTE)
218 #define sys_outw(p,v)	sys_out((p), (u32_t) (v), _DIO_WORD)
219 #define sys_outl(p,v)	sys_out((p), (u32_t) (v), _DIO_LONG)
220 int sys_out(int port, u32_t value, int type);
221 
222 /* Shorthands for sys_in() system call. */
223 #define sys_inb(p,v)	sys_in((p), (v), _DIO_BYTE)
224 #define sys_inw(p,v)	sys_in((p), (v), _DIO_WORD)
225 #define sys_inl(p,v)	sys_in((p), (v), _DIO_LONG)
226 int sys_in(int port, u32_t *value, int type);
227 
228 /* arm pinmux */
229 int sys_padconf(u32_t padconf, u32_t mask, u32_t value);
230 
231 /* pci.c */
232 void pci_init(void);
233 int pci_first_dev(int *devindp, u16_t *vidp, u16_t *didp);
234 int pci_next_dev(int *devindp, u16_t *vidp, u16_t *didp);
235 int pci_find_dev(u8_t bus, u8_t dev, u8_t func, int *devindp);
236 void pci_reserve(int devind);
237 int pci_reserve_ok(int devind);
238 void pci_ids(int devind, u16_t *vidp, u16_t *didp);
239 void pci_rescan_bus(u8_t busnr);
240 u8_t pci_attr_r8(int devind, int port);
241 u16_t pci_attr_r16(int devind, int port);
242 u32_t pci_attr_r32(int devind, int port);
243 void pci_attr_w8(int devind, int port, u8_t value);
244 void pci_attr_w16(int devind, int port, u16_t value);
245 void pci_attr_w32(int devind, int port, u32_t value);
246 char *pci_dev_name(u16_t vid, u16_t did);
247 char *pci_slot_name(int devind);
248 int pci_set_acl(struct rs_pci *rs_pci);
249 int pci_del_acl(endpoint_t proc_ep);
250 int pci_get_bar(int devind, int port, u32_t *base, u32_t *size, int
251 	*ioflag);
252 
253 /* Profiling. */
254 int sys_sprof(int action, int size, int freq, int type, endpoint_t
255 	endpt, vir_bytes ctl_ptr, vir_bytes mem_ptr);
256 
257 /* machine context */
258 int sys_getmcontext(endpoint_t proc, vir_bytes mcp);
259 int sys_setmcontext(endpoint_t proc, vir_bytes mcp);
260 
261 /* input */
262 int tty_input_inject(int type, int code, int val);
263 
264 /* Miscellaneous calls from servers and drivers. */
265 pid_t srv_fork(uid_t reuid, gid_t regid);
266 int srv_kill(pid_t pid, int sig);
267 int getprocnr(pid_t pid, endpoint_t *proc_ep);
268 int mapdriver(const char *label, devmajor_t major, const int *domains,
269 	int nr_domains);
270 pid_t getepinfo(endpoint_t proc_ep, uid_t *uidp, gid_t *gidp);
271 pid_t getnpid(endpoint_t proc_ep);
272 uid_t getnuid(endpoint_t proc_ep);
273 gid_t getngid(endpoint_t proc_ep);
274 int getsockcred(endpoint_t proc_ep, struct sockcred * sockcred, gid_t * groups,
275 	int ngroups);
276 int socketpath(endpoint_t endpt, const char *path, size_t size, int what,
277 	dev_t *dev, ino_t *ino);
278 #define SPATH_CHECK	0	/* check user permissions on socket path */
279 #define SPATH_CREATE	1	/* create socket file at given path */
280 int copyfd(endpoint_t endpt, int fd, int what);
281 #define COPYFD_FROM	0	/* copy file descriptor from remote process */
282 #define COPYFD_TO	1	/* copy file descriptor to remote process */
283 #define COPYFD_CLOSE	2	/* close file descriptor in remote process */
284 #define COPYFD_CLOEXEC	0x8000	/* with COPYFD_TO: set close-on-exec flag */
285 #define COPYFD_FLAGS	0xF000	/* flags mask */
286 int closenb(int fd);
287 
288 /*
289  * These are also the event numbers used in PROC_EVENT messages, but in order
290  * to allow for subscriptions to multiple events, they form a bit mask.
291  */
292 #define PROC_EVENT_EXIT		0x01	/* process has exited */
293 #define PROC_EVENT_SIGNAL	0x02	/* process has caught signal */
294 int proceventmask(unsigned int mask);
295 
296 #endif /* _SYSLIB_H */
297 
298