coverity appeasement - redundant check
[minix.git] / kernel / proto.h
blob28dbba4a622a6c145a8ed05efcb8f02d6d320091
1 /* Function prototypes. */
3 /* FIXME this is a hack how to avoid inclusion conflicts */
4 #ifdef __kernel__
6 #ifndef PROTO_H
7 #define PROTO_H
9 #include <minix/safecopies.h>
10 #include <machine/archtypes.h>
11 #include <a.out.h>
13 /* Struct declarations. */
14 struct proc;
15 struct timer;
17 /* clock.c */
18 clock_t get_uptime(void);
19 void set_timer(struct timer *tp, clock_t t, tmr_func_t f);
20 void reset_timer(struct timer *tp);
21 void ser_dump_proc(void);
23 void cycles_accounting_init(void);
25 * This functions start and stop accounting for process, kernel or idle cycles.
26 * It inherently have to account for some kernel cycles for process too,
27 * therefore it should be called asap after trapping to kernel and as late as
28 * possible before returning to userspace. These function is architecture
29 * dependent
31 void context_stop(struct proc * p);
32 /* this is a wrapper to make calling it from assembly easier */
33 void context_stop_idle(void);
34 int restore_fpu(struct proc *);
35 void save_fpu(struct proc *);
36 void save_local_fpu(struct proc *, int retain);
37 void fpu_sigcontext(struct proc *, struct sigframe *fr, struct
38 sigcontext *sc);
40 /* main.c */
41 #ifndef UNPAGED
42 #define kmain __k_unpaged_kmain
43 #endif
44 void kmain(kinfo_t *cbi);
45 void prepare_shutdown(int how);
46 __dead void minix_shutdown(struct timer *tp);
47 void bsp_finish_booting(void);
49 /* proc.c */
51 int do_ipc(reg_t r1, reg_t r2, reg_t r3);
52 void proc_init(void);
53 int cancel_async(struct proc *src, struct proc *dst);
54 int has_pending_notify(struct proc * caller, int src_p);
55 int has_pending_asend(struct proc * caller, int src_p);
56 void unset_notify_pending(struct proc * caller, int src_p);
57 int mini_notify(const struct proc *src, endpoint_t dst);
58 void enqueue(struct proc *rp);
59 void dequeue(struct proc *rp);
60 void switch_to_user(void);
61 void arch_proc_reset(struct proc *rp);
62 struct proc * arch_finish_switch_to_user(void);
63 struct proc *endpoint_lookup(endpoint_t ep);
64 #if DEBUG_ENABLE_IPC_WARNINGS
65 int isokendpt_f(const char *file, int line, endpoint_t e, int *p, int
66 f);
67 #define isokendpt_d(e, p, f) isokendpt_f(__FILE__, __LINE__, (e), (p), (f))
68 #else
69 int isokendpt_f(endpoint_t e, int *p, int f);
70 #define isokendpt_d(e, p, f) isokendpt_f((e), (p), (f))
71 #endif
72 void proc_no_time(struct proc *p);
73 void reset_proc_accounting(struct proc *p);
74 void flag_account(struct proc *p, int flag);
75 int try_deliver_senda(struct proc *caller_ptr, asynmsg_t *table, size_t
76 size);
78 /* start.c */
79 void cstart();
80 char *env_get(const char *key);
82 /* system.c */
83 int get_priv(register struct proc *rc, int proc_type);
84 void set_sendto_bit(const struct proc *rc, int id);
85 void unset_sendto_bit(const struct proc *rc, int id);
86 void fill_sendto_mask(const struct proc *rc, sys_map_t *map);
87 int send_sig(endpoint_t proc_nr, int sig_nr);
88 void cause_sig(proc_nr_t proc_nr, int sig_nr);
89 void sig_delay_done(struct proc *rp);
90 void kernel_call(message *m_user, struct proc * caller);
91 void system_init(void);
92 void clear_endpoint(struct proc *rc);
93 void clear_ipc_refs(struct proc *rc, int caller_ret);
94 void kernel_call_resume(struct proc *p);
95 int sched_proc(struct proc *rp, int priority, int quantum, int cpu);
97 /* system/do_vtimer.c */
98 void vtimer_check(struct proc *rp);
100 /* interrupt.c */
101 void put_irq_handler(irq_hook_t *hook, int irq, irq_handler_t handler);
102 void rm_irq_handler(const irq_hook_t *hook);
103 void enable_irq(const irq_hook_t *hook);
104 int disable_irq(const irq_hook_t *hook);
106 void interrupts_enable(void);
107 void interrupts_disable(void);
109 /* debug.c */
110 int runqueues_ok(void);
111 #ifndef CONFIG_SMP
112 #define runqueues_ok_local runqueues_ok
113 #else
114 #define runqueues_ok_local() runqueues_ok_cpu(cpuid)
115 int runqueues_ok_cpu(unsigned cpu);
116 #endif
117 char *rtsflagstr(u32_t flags);
118 char *miscflagstr(u32_t flags);
119 char *schedulerstr(struct proc *scheduler);
120 /* prints process information */
121 void print_proc(struct proc *pp);
122 /* prints the given process and recursively all processes it depends on */
123 void print_proc_recursive(struct proc *pp);
124 #if DEBUG_IPC_HOOK
125 void hook_ipc_msgrecv(message *msg, struct proc *src, struct proc *dst);
126 void hook_ipc_msgsend(message *msg, struct proc *src, struct proc *dst);
127 void hook_ipc_msgkcall(message *msg, struct proc *proc);
128 void hook_ipc_msgkresult(message *msg, struct proc *proc);
129 void hook_ipc_clear(struct proc *proc);
130 #endif
132 /* system/do_safemap.c */
133 int map_invoke_vm(struct proc * caller, int req_type, endpoint_t end_d,
134 vir_bytes off_d, endpoint_t end_s, vir_bytes
135 off_s, size_t size, int flag);
137 /* system/do_safecopy.c */
138 int verify_grant(endpoint_t, endpoint_t, cp_grant_id_t, vir_bytes, int,
139 vir_bytes, vir_bytes *, endpoint_t *);
141 /* system/do_sysctl.c */
142 int do_sysctl(struct proc * caller, message *m);
144 #if SPROFILE
145 /* profile.c */
146 void init_profile_clock(u32_t);
147 void stop_profile_clock(void);
148 #endif
150 /* functions defined in architecture-dependent files. */
151 void prot_init();
152 void arch_post_init();
153 void arch_set_secondary_ipc_return(struct proc *, u32_t val);
154 phys_bytes phys_copy(phys_bytes source, phys_bytes dest, phys_bytes
155 count);
156 void phys_copy_fault(void);
157 void phys_copy_fault_in_kernel(void);
158 void memset_fault(void);
159 void memset_fault_in_kernel(void);
160 #define virtual_copy(src, dst, bytes) \
161 virtual_copy_f(NULL, src, dst, bytes, 0)
162 #define virtual_copy_vmcheck(caller, src, dst, bytes) \
163 virtual_copy_f(caller, src, dst, bytes, 1)
164 int virtual_copy_f(struct proc * caller, struct vir_addr *src, struct
165 vir_addr *dst, vir_bytes bytes, int vmcheck);
166 int data_copy(endpoint_t from, vir_bytes from_addr, endpoint_t to,
167 vir_bytes to_addr, size_t bytes);
168 int data_copy_vmcheck(struct proc *, endpoint_t from, vir_bytes
169 from_addr, endpoint_t to, vir_bytes to_addr, size_t bytes);
170 phys_bytes umap_virtual(struct proc* rp, int seg, vir_bytes vir_addr,
171 vir_bytes bytes);
172 phys_bytes seg2phys(u16_t);
173 int vm_memset(endpoint_t who,
174 phys_bytes source, u8_t pattern, phys_bytes count);
175 int intr_init(int);
176 void halt_cpu(void);
177 void arch_init(void);
178 void arch_boot_proc(struct boot_image *b, struct proc *p);
179 void cpu_identify(void);
180 /* arch dependent FPU initialization per CPU */
181 void fpu_init(void);
182 /* returns true if pfu is present and initialized */
183 int is_fpu(void);
184 void ser_putc(char);
185 __dead void arch_shutdown(int);
186 void restore_user_context(struct proc * p);
187 void read_tsc(u32_t *high, u32_t *low);
188 int arch_init_profile_clock(u32_t freq);
189 void arch_stop_profile_clock(void);
190 void arch_ack_profile_clock(void);
191 void do_ser_debug(void);
192 int arch_get_params(char *parm, int max);
193 void memory_init(void);
194 void mem_clear_mapcache(void);
195 void arch_proc_init(struct proc *pr, u32_t, u32_t, char *);
196 int arch_do_vmctl(message *m_ptr, struct proc *p);
197 int vm_contiguous(const struct proc *targetproc, vir_bytes vir_buf,
198 size_t count);
199 void proc_stacktrace(struct proc *proc);
200 int vm_lookup(const struct proc *proc, vir_bytes virtual, phys_bytes
201 *result, u32_t *ptent);
202 size_t vm_lookup_range(const struct proc *proc,
203 vir_bytes vir_addr, phys_bytes *phys_addr, size_t bytes);
204 void delivermsg(struct proc *target);
205 void arch_do_syscall(struct proc *proc);
206 int arch_phys_map(int index, phys_bytes *addr, phys_bytes *len, int
207 *flags);
208 int arch_phys_map_reply(int index, vir_bytes addr);
209 reg_t arch_get_sp(struct proc *p);
210 int arch_enable_paging(struct proc * caller);
211 int vm_check_range(struct proc *caller,
212 struct proc *target, vir_bytes vir_addr, size_t bytes);
214 int copy_msg_from_user(message * user_mbuf, message * dst);
215 int copy_msg_to_user(message * src, message * user_mbuf);
216 void switch_address_space(struct proc * p);
217 void release_address_space(struct proc *pr);
219 void enable_fpu_exception(void);
220 void disable_fpu_exception(void);
221 void release_fpu(struct proc * p);
222 void arch_pause(void);
223 short cpu_load(void);
224 void busy_delay_ms(int ms);
226 /* utility.c */
227 void cpu_print_freq(unsigned cpu);
228 #endif /* __kernel__ */
230 #endif /* PROTO_H */