include/minix/syslib.h

   1 /* Prototypes for system library functions. */
   2
   3 #ifndef _SYSLIB_H
   4 #define _SYSLIB_H
   5
   6 #ifndef _TYPES_H
   7 #include <minix/types.h>
   8 #endif
   9
  10 #ifndef _IPC_H
  11 #include <minix/ipc.h>
  12 #endif
  13
  14 #include <minix/u64.h>
  15
  16 #ifndef _DEVIO_H
  17 #include <minix/devio.h>
  18 #endif
  19
  20 #include <minix/safecopies.h>
  21 #include <minix/sef.h>
  22
  23 /* Forward declaration */
  24 struct reg86u;
  25 struct rs_pci;
  26
  27 #define SYSTASK SYSTEM
  28
  29 /*==========================================================================*
  30  * Minix system library.                                                    *
  31  *==========================================================================*/
  32 _PROTOTYPE( int _taskcall, (endpoint_t who, int syscallnr, message *msgptr));
  33 _PROTOTYPE( int _kernel_call, (int syscallnr, message *msgptr));
  34
  35 _PROTOTYPE( int sys_abort, (int how, ...));
  36 _PROTOTYPE( int sys_enable_iop, (endpoint_t proc_ep));
  37 _PROTOTYPE( int sys_exec, (endpoint_t proc_ep, char *ptr,
  38                                 char *aout, vir_bytes initpc));
  39 _PROTOTYPE( int sys_fork, (endpoint_t parent, endpoint_t child, endpoint_t *,
  40         struct mem_map *ptr, u32_t vm, vir_bytes *));
  41 _PROTOTYPE( int sys_newmap, (endpoint_t proc_ep, struct mem_map *ptr));
  42 _PROTOTYPE( int sys_exit, (endpoint_t proc_ep));
  43 _PROTOTYPE( int sys_trace, (int req, endpoint_t proc_ep, long addr, long *data_p));
  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 _PROTOTYPE( int sys_runctl, (endpoint_t proc_ep, int action, int flags));
  50
  51 _PROTOTYPE( int sys_privctl, (endpoint_t proc_ep, int req, void *p));
  52 _PROTOTYPE( int sys_privquery_mem, (endpoint_t proc_ep,
  53         phys_bytes physstart, phys_bytes physlen));
  54 _PROTOTYPE( int sys_setgrant, (cp_grant_t *grants, int ngrants));
  55 _PROTOTYPE( int sys_nice, (endpoint_t proc_ep, int priority));
  56
  57 _PROTOTYPE( int sys_int86, (struct reg86u *reg86p));
  58 _PROTOTYPE( int sys_vm_setbuf, (phys_bytes base, phys_bytes size,
  59                                                         phys_bytes high));
  60 _PROTOTYPE( int sys_vm_map, (endpoint_t proc_ep, int do_map,
  61         phys_bytes base, phys_bytes size, phys_bytes offset));
  62 _PROTOTYPE( int sys_vmctl, (endpoint_t who, int param, u32_t value));
  63 _PROTOTYPE( int sys_vmctl_get_pagefault_i386, (endpoint_t *who, u32_t *cr2, u32_t *err));
  64 _PROTOTYPE( int sys_vmctl_get_cr3_i386, (endpoint_t who, u32_t *cr3)  );
  65 _PROTOTYPE( int sys_vmctl_get_memreq, (endpoint_t *who, vir_bytes *mem,
  66         vir_bytes *len, int *wrflag, endpoint_t *who_s, vir_bytes *mem_s,
  67         endpoint_t *) );
  68 _PROTOTYPE( int sys_vmctl_enable_paging, (struct mem_map *));
  69
  70 _PROTOTYPE( int sys_readbios, (phys_bytes address, void *buf, size_t size));
  71 _PROTOTYPE( int sys_stime, (time_t boottime));
  72 _PROTOTYPE( int sys_sysctl, (int ctl, char *arg1, int arg2));
  73 _PROTOTYPE( int sys_sysctl_stacktrace, (endpoint_t who));
  74 _PROTOTYPE( int sys_vmctl_get_mapping, (int index, phys_bytes *addr,
  75         phys_bytes *len, int *flags));
  76 _PROTOTYPE( int sys_vmctl_reply_mapping, (int index, vir_bytes addr));
  77
  78 /* Shorthands for sys_sdevio() system call. */
  79 #define sys_insb(port, proc_ep, buffer, count) \
  80   sys_sdevio(DIO_INPUT_BYTE, port, proc_ep, buffer, count, 0)
  81 #define sys_insw(port, proc_ep, buffer, count) \
  82   sys_sdevio(DIO_INPUT_WORD, port, proc_ep, buffer, count, 0)
  83 #define sys_outsb(port, proc_ep, buffer, count) \
  84   sys_sdevio(DIO_OUTPUT_BYTE, port, proc_ep, buffer, count, 0)
  85 #define sys_outsw(port, proc_ep, buffer, count) \
  86   sys_sdevio(DIO_OUTPUT_WORD, port, proc_ep, buffer, count, 0)
  87 #define sys_safe_insb(port, ept, grant, offset, count) \
  88   sys_sdevio(DIO_SAFE_INPUT_BYTE, port, ept, (void*)grant, count, offset)
  89 #define sys_safe_outsb(port, ept, grant, offset, count) \
  90   sys_sdevio(DIO_SAFE_OUTPUT_BYTE, port, ept, (void*)grant, count, offset)
  91 #define sys_safe_insw(port, ept, grant, offset, count) \
  92   sys_sdevio(DIO_SAFE_INPUT_WORD, port, ept, (void*)grant, count, offset)
  93 #define sys_safe_outsw(port, ept, grant, offset, count) \
  94   sys_sdevio(DIO_SAFE_OUTPUT_WORD, port, ept, (void*)grant, count, offset)
  95 _PROTOTYPE( int sys_sdevio, (int req, long port, endpoint_t proc_ep,
  96         void *buffer, int count, vir_bytes offset));
  97 _PROTOTYPE(void *alloc_contig, (size_t len, int flags, phys_bytes *phys));
  98 _PROTOTYPE(int free_contig, (void *addr, size_t len));
  99
 100 #define AC_ALIGN4K      0x01
 101 #define AC_LOWER16M     0x02
 102 #define AC_ALIGN64K     0x04
 103 #define AC_LOWER1M      0x08
 104
 105 /* Clock functionality: get system times, (un)schedule an alarm call, or
 106  * retrieve/set a process-virtual timer.
 107  */
 108 _PROTOTYPE( int sys_times, (endpoint_t proc_ep, clock_t *user_time,
 109         clock_t *sys_time, clock_t *uptime, time_t *boottime));
 110 _PROTOTYPE(int sys_setalarm, (clock_t exp_time, int abs_time));
 111 _PROTOTYPE( int sys_vtimer, (endpoint_t proc_nr, int which, clock_t *newval,
 112         clock_t *oldval));
 113
 114 /* Shorthands for sys_irqctl() system call. */
 115 #define sys_irqdisable(hook_id) \
 116     sys_irqctl(IRQ_DISABLE, 0, 0, hook_id)
 117 #define sys_irqenable(hook_id) \
 118     sys_irqctl(IRQ_ENABLE, 0, 0, hook_id)
 119 #define sys_irqsetpolicy(irq_vec, policy, hook_id) \
 120     sys_irqctl(IRQ_SETPOLICY, irq_vec, policy, hook_id)
 121 #define sys_irqrmpolicy(hook_id) \
 122     sys_irqctl(IRQ_RMPOLICY, 0, 0, hook_id)
 123 _PROTOTYPE ( int sys_irqctl, (int request, int irq_vec, int policy,
 124     int *irq_hook_id) );
 125
 126 /* Shorthands for sys_vircopy() and sys_physcopy() system calls. */
 127 #define sys_biosin(bios_vir, dst_vir, bytes) \
 128         sys_vircopy(SELF, BIOS_SEG, bios_vir, SELF, D, dst_vir, bytes)
 129 #define sys_biosout(src_vir, bios_vir, bytes) \
 130         sys_vircopy(SELF, D, src_vir, SELF, BIOS_SEG, bios_vir, bytes)
 131 #define sys_datacopy(src_proc, src_vir, dst_proc, dst_vir, bytes) \
 132         sys_vircopy(src_proc, D, src_vir, dst_proc, D, dst_vir, bytes)
 133 #define sys_textcopy(src_proc, src_vir, dst_proc, dst_vir, bytes) \
 134         sys_vircopy(src_proc, T, src_vir, dst_proc, T, dst_vir, bytes)
 135 #define sys_stackcopy(src_proc, src_vir, dst_proc, dst_vir, bytes) \
 136         sys_vircopy(src_proc, S, src_vir, dst_proc, S, dst_vir, bytes)
 137 _PROTOTYPE(int sys_vircopy, (endpoint_t src_proc, int src_s, vir_bytes src_v,
 138         endpoint_t dst_proc, int dst_seg, vir_bytes dst_vir, phys_bytes bytes));
 139
 140 #define sys_abscopy(src_phys, dst_phys, bytes) \
 141         sys_physcopy(NONE, PHYS_SEG, src_phys, NONE, PHYS_SEG, dst_phys, bytes)
 142 _PROTOTYPE(int sys_physcopy, (endpoint_t src_proc, int src_seg, vir_bytes src_vir,
 143         endpoint_t dst_proc, int dst_seg, vir_bytes dst_vir, phys_bytes bytes));
 144
 145
 146 /* Grant-based copy functions. */
 147 _PROTOTYPE(int sys_safecopyfrom, (endpoint_t source, cp_grant_id_t grant,
 148         vir_bytes grant_offset, vir_bytes my_address, size_t bytes, int my_seg));
 149 _PROTOTYPE(int sys_safecopyto, (endpoint_t dest, cp_grant_id_t grant,
 150         vir_bytes grant_offset, vir_bytes my_address, size_t bytes, int my_seg));
 151 _PROTOTYPE(int sys_vsafecopy, (struct vscp_vec *copyvec, int elements));
 152
 153 _PROTOTYPE(int sys_memset, (unsigned long pattern,
 154                 phys_bytes base, phys_bytes bytes));
 155
 156 /* Grant-based map functions. */
 157 _PROTOTYPE(int sys_safemap, (endpoint_t grantor, cp_grant_id_t grant,
 158         vir_bytes grant_offset, vir_bytes my_address, size_t bytes, int my_seg,
 159         int writable));
 160 _PROTOTYPE(int sys_saferevmap_gid, (cp_grant_id_t grant));
 161 _PROTOTYPE(int sys_saferevmap_addr, (vir_bytes addr));
 162 _PROTOTYPE(int sys_safeunmap, (int my_seg, vir_bytes my_address));
 163
 164 _PROTOTYPE(int sys_umap, (endpoint_t proc_ep, int seg, vir_bytes vir_addr,
 165          vir_bytes bytes, phys_bytes *phys_addr));
 166 _PROTOTYPE(int sys_umap_data_fb, (endpoint_t proc_ep, vir_bytes vir_addr,
 167          vir_bytes bytes, phys_bytes *phys_addr));
 168 _PROTOTYPE(int sys_segctl, (int *index, u16_t *seg, vir_bytes *off,
 169         phys_bytes phys, vir_bytes size));
 170
 171 /* Shorthands for sys_getinfo() system call. */
 172 #define sys_getkmessages(dst)   sys_getinfo(GET_KMESSAGES, dst, 0,0,0)
 173 #define sys_getkinfo(dst)       sys_getinfo(GET_KINFO, dst, 0,0,0)
 174 #define sys_getloadinfo(dst)    sys_getinfo(GET_LOADINFO, dst, 0,0,0)
 175 #define sys_getmachine(dst)     sys_getinfo(GET_MACHINE, dst, 0,0,0)
 176 #define sys_getproctab(dst)     sys_getinfo(GET_PROCTAB, dst, 0,0,0)
 177 #define sys_getprivtab(dst)     sys_getinfo(GET_PRIVTAB, dst, 0,0,0)
 178 #define sys_getproc(dst,nr)     sys_getinfo(GET_PROC, dst, 0,0, nr)
 179 #define sys_getrandomness(dst)  sys_getinfo(GET_RANDOMNESS, dst, 0,0,0)
 180 #define sys_getrandom_bin(d,b)  sys_getinfo(GET_RANDOMNESS_BIN, d, 0,0,b)
 181 #define sys_getimage(dst)       sys_getinfo(GET_IMAGE, dst, 0,0,0)
 182 #define sys_getirqhooks(dst)    sys_getinfo(GET_IRQHOOKS, dst, 0,0,0)
 183 #define sys_getirqactids(dst)   sys_getinfo(GET_IRQACTIDS, dst, 0,0,0)
 184 #define sys_getmonparams(v,vl)  sys_getinfo(GET_MONPARAMS, v,vl, 0,0)
 185 #define sys_getschedinfo(v1,v2) sys_getinfo(GET_SCHEDINFO, v1,0, v2,0)
 186 #define sys_getlocktimings(dst) sys_getinfo(GET_LOCKTIMING, dst, 0,0,0)
 187 #define sys_getpriv(dst, nr)    sys_getinfo(GET_PRIV, dst, 0,0, nr)
 188 #define sys_getidletsc(dst)     sys_getinfo(GET_IDLETSC, dst, 0,0,0)
 189 #define sys_getaoutheader(dst,nr) sys_getinfo(GET_AOUTHEADER, dst, 0,0,nr)
 190 _PROTOTYPE(int sys_getinfo, (int request, void *val_ptr, int val_len,
 191                                  void *val_ptr2, int val_len2)          );
 192 _PROTOTYPE(int sys_whoami, (endpoint_t *ep, char *name, int namelen));
 193
 194 /* Signal control. */
 195 _PROTOTYPE(int sys_kill, (endpoint_t proc_ep, int sig) );
 196 _PROTOTYPE(int sys_sigsend, (endpoint_t proc_ep, struct sigmsg *sig_ctxt) );
 197 _PROTOTYPE(int sys_sigreturn, (endpoint_t proc_ep, struct sigmsg *sig_ctxt) );
 198 _PROTOTYPE(int sys_getksig, (endpoint_t *proc_ep, sigset_t *k_sig_map) );
 199 _PROTOTYPE(int sys_endksig, (endpoint_t proc_ep) );
 200
 201 /* NOTE: two different approaches were used to distinguish the device I/O
 202  * types 'byte', 'word', 'long': the latter uses #define and results in a
 203  * smaller implementation, but looses the static type checking.
 204  */
 205 _PROTOTYPE(int sys_voutb, (pvb_pair_t *pvb_pairs, int nr_ports)         );
 206 _PROTOTYPE(int sys_voutw, (pvw_pair_t *pvw_pairs, int nr_ports)         );
 207 _PROTOTYPE(int sys_voutl, (pvl_pair_t *pvl_pairs, int nr_ports)         );
 208 _PROTOTYPE(int sys_vinb, (pvb_pair_t *pvb_pairs, int nr_ports)          );
 209 _PROTOTYPE(int sys_vinw, (pvw_pair_t *pvw_pairs, int nr_ports)          );
 210 _PROTOTYPE(int sys_vinl, (pvl_pair_t *pvl_pairs, int nr_ports)          );
 211
 212 /* Shorthands for sys_out() system call. */
 213 #define sys_outb(p,v)   sys_out((p), (unsigned long) (v), _DIO_BYTE)
 214 #define sys_outw(p,v)   sys_out((p), (unsigned long) (v), _DIO_WORD)
 215 #define sys_outl(p,v)   sys_out((p), (unsigned long) (v), _DIO_LONG)
 216 _PROTOTYPE(int sys_out, (int port, unsigned long value, int type)       );
 217
 218 /* Shorthands for sys_in() system call. */
 219 #define sys_inb(p,v)    sys_in((p), (v), _DIO_BYTE)
 220 #define sys_inw(p,v)    sys_in((p), (v), _DIO_WORD)
 221 #define sys_inl(p,v)    sys_in((p), (v), _DIO_LONG)
 222 _PROTOTYPE(int sys_in, (int port, unsigned long *value, int type)       );
 223
 224 /* pci.c */
 225 _PROTOTYPE( void pci_init, (void)                                       );
 226 _PROTOTYPE( void pci_init1, (char *name)                                );
 227 _PROTOTYPE( int pci_first_dev, (int *devindp, u16_t *vidp, u16_t *didp) );
 228 _PROTOTYPE( int pci_next_dev, (int *devindp, u16_t *vidp, u16_t *didp)  );
 229 _PROTOTYPE( int pci_find_dev, (U8_t bus, U8_t dev, U8_t func,
 230                                                         int *devindp)   );
 231 _PROTOTYPE( void pci_reserve, (int devind)                              );
 232 _PROTOTYPE( int pci_reserve_ok, (int devind)                            );
 233 _PROTOTYPE( void pci_ids, (int devind, u16_t *vidp, u16_t *didp)        );
 234 _PROTOTYPE( void pci_rescan_bus, (U8_t busnr)                           );
 235 _PROTOTYPE( u8_t pci_attr_r8, (int devind, int port)                    );
 236 _PROTOTYPE( u16_t pci_attr_r16, (int devind, int port)                  );
 237 _PROTOTYPE( u32_t pci_attr_r32, (int devind, int port)                  );
 238 _PROTOTYPE( void pci_attr_w8, (int devind, int port, U8_t value)        );
 239 _PROTOTYPE( void pci_attr_w16, (int devind, int port, U16_t value)      );
 240 _PROTOTYPE( void pci_attr_w32, (int devind, int port, u32_t value)      );
 241 _PROTOTYPE( char *pci_dev_name, (U16_t vid, U16_t did)                  );
 242 _PROTOTYPE( char *pci_slot_name, (int devind)                           );
 243 _PROTOTYPE( int pci_set_acl, (struct rs_pci *rs_pci)                    );
 244 _PROTOTYPE( int pci_del_acl, (endpoint_t proc_ep)                       );
 245
 246 /* Profiling. */
 247 _PROTOTYPE( int sys_sprof, (int action, int size, int freq,
 248                 endpoint_t endpt, void *ctl_ptr, void *mem_ptr)   );
 249 _PROTOTYPE( int sys_cprof, (int action, int size, endpoint_t endpt,
 250                                        void *ctl_ptr, void *mem_ptr)   );
 251 _PROTOTYPE( int sys_profbuf, (void *ctl_ptr, void *mem_ptr)            );
 252
 253 #endif /* _SYSLIB_H */
 254