vmm: refactor userspace's emsr_fakewrite()
[akaros.git] / kern / include / trap.h
1 /* See COPYRIGHT for copyright information. */
2
3 #pragma once
4
5 #define ROS_KERN_TRAP_H
6
7 #include <ros/trapframe.h>
8 #include <arch/arch.h>
9 #include <arch/mmu.h>
10 #include <sys/queue.h>
11 #include <arch/trap.h>
12
13 // func ptr for interrupt service routines
14 typedef void (*isr_t)(struct hw_trapframe *hw_tf, void *data);
15
16 void idt_init(void);
17 int register_irq(int irq, isr_t handler, void *irq_arg, uint32_t tbdf);
18 int route_irqs(int cpu_vec, int coreid);
19 void print_trapframe(struct hw_trapframe *hw_tf);
20 void print_swtrapframe(struct sw_trapframe *sw_tf);
21 void print_vmtrapframe(struct vm_trapframe *vm_tf);
22 void print_user_ctx(struct user_context *ctx);
23 /* Generic per-core timer interrupt handler.  set_percore_timer() will fire the
24  * timer_interrupt(). */
25 void set_core_timer(uint32_t usec, bool periodic);
26 void timer_interrupt(struct hw_trapframe *hw_tf, void *data);
27
28 extern inline void save_fp_state(struct ancillary_state *silly);
29 extern inline void restore_fp_state(struct ancillary_state *silly);
30 extern inline void init_fp_state(void);
31 /* Set stacktop for the current core to be the stack the kernel will start on
32  * when trapping/interrupting from userspace */
33 void set_stack_top(uintptr_t stacktop);
34 uintptr_t get_stack_top(void);
35
36 void send_nmi(uint32_t os_coreid);
37 int reflect_current_context(void);
38 void reflect_unhandled_trap(unsigned int trap_nr, unsigned int err,
39                             unsigned long aux);
40 void __arch_reflect_trap_hwtf(struct hw_trapframe *hw_tf, unsigned int trap_nr,
41                               unsigned int err, unsigned long aux);
42
43 uintptr_t get_user_ctx_pc(struct user_context *ctx);
44 uintptr_t get_user_ctx_fp(struct user_context *ctx);
45 uintptr_t get_user_ctx_sp(struct user_context *ctx);
46
47 /* Partial contexts are those where the full context is split between the parts
48  * in the struct and the parts still loaded in hardware.
49  *
50  * Finalizing a context ensures that the full context is saved in the struct and
51  * nothing remains in hardware.  Finalize does two things: makes sure the
52  * context can be run again on another core and makes sure the core can run
53  * another context.
54  *
55  * arch_finalize_ctx() must be idempotent and have no effect on a full context.
56  * It is up to the architecture to keep track of whether or not a context is
57  * full or partial and handle finalize calls on a context that might not be
58  * partial.  They can do so in the ctx itself, in their own arch-dependent
59  * manner.
60  *
61  * The kernel's guarantee to the arches is that:
62  * - finalize will be called after proc_pop_ctx (i.e. after it runs) at least
63  * once, before that context is used again on another core or before another
64  * context is used on this core.
65  * - the arches can store the partial status and anything else it wants in the
66  * *ctx without fear of it being tampered with.
67  * - user-provided contexts will be passed to proc_secure_ctx, and those
68  * contexts are full/finalized already.  Anything else is a user bug.  The
69  * arches enforce this.
70  * - an arch will never be asked to pop a partial context that was not already
71  * loaded onto the current core.
72  * - contexts will be finalized before handing them back to the user. */
73 extern inline void arch_finalize_ctx(struct user_context *ctx);
74 extern inline bool arch_ctx_is_partial(struct user_context *ctx);
75 void copy_current_ctx_to(struct user_context *to_ctx);
76
77 /* Kernel messages.  This is an in-order 'active message' style messaging
78  * subsystem, where you can instruct other cores (including your own) to execute
79  * a function (with arguments), either immediately or whenever the kernel is
80  * able to abandon its context/stack (permanent swap).
81  *
82  * These are different (for now) than the smp_calls in smp.h, since
83  * they will be executed immediately (for urgent messages), and in the order in
84  * which they are sent.  smp_calls are currently not run in order, and they must
85  * return (possibly passing the work to a workqueue, which is really just a
86  * routine message, so they really need to just return).
87  *
88  * Eventually, smp_call will be replaced by these.
89  *
90  * Also, a big difference is that smp_calls can use the same message (registered
91  * in the interrupt_handlers[] for x86) for every recipient, but the kernel
92  * messages require a unique message.  Also for now, but it might be like that
93  * for a while on x86 (til we have a broadcast). */
94
95 #define KMSG_IMMEDIATE                  1
96 #define KMSG_ROUTINE                    2
97
98 typedef void (*amr_t)(uint32_t srcid, long a0, long a1, long a2);
99
100 struct kernel_message
101 {
102         STAILQ_ENTRY(kernel_message) link;
103         uint32_t srcid;
104         uint32_t dstid;
105         amr_t pc;
106         long arg0;
107         long arg1;
108         long arg2;
109 }__attribute__((aligned(8)));
110
111 STAILQ_HEAD(kernel_msg_list, kernel_message);
112 typedef struct kernel_message kernel_message_t;
113
114 void kernel_msg_init(void);
115 uint32_t send_kernel_message(uint32_t dst, amr_t pc, long arg0, long arg1,
116                              long arg2, int type);
117 void handle_kmsg_ipi(struct hw_trapframe *hw_tf, void *data);
118 bool has_routine_kmsg(void);
119 void process_routine_kmsg(void);
120 void print_kmsgs(uint32_t coreid);
121
122 /* Runs a function with up to two arguments as a routine kernel message.  Kernel
123  * messages can have three arguments, but the deferred function pointer counts
124  * as one.  Note the arguments to the function will be treated as longs. */
125 #define run_as_rkm(f, ...) do {                                                \
126         static_assert(MACRO_NR_ARGS(__VA_ARGS__) <= 2);                        \
127         PASTE(__run_as_rkm_, MACRO_NR_ARGS(__VA_ARGS__))(f, ##__VA_ARGS__);    \
128 } while (0)
129
130 #define __run_as_rkm_0(f) \
131         send_kernel_message(core_id(), __kmsg_trampoline, (long)f, 0xcafebabe, \
132                             0xcafebabe, KMSG_ROUTINE)
133 #define __run_as_rkm_1(f, a1) \
134         send_kernel_message(core_id(), __kmsg_trampoline, (long)f, (long)a1, \
135                             0xcafebabe, KMSG_ROUTINE)
136 #define __run_as_rkm_2(f, a1, a2) \
137         send_kernel_message(core_id(), __kmsg_trampoline, (long)f, (long)a1, \
138                             (long)a2, KMSG_ROUTINE)
139 void __kmsg_trampoline(uint32_t srcid, long a0, long a1, long a2);
140
141 /* Kernel context depths.  IRQ depth is how many nested IRQ stacks/contexts we
142  * are working on.  Kernel trap depth is how many nested kernel traps (not
143  * user-space traps) we have.
144  *
145  * Some examples:
146  *      (original context in parens, +(x, y) is the change to IRQ and ktrap
147  *      depth):
148  * - syscall (user): +(0, 0)
149  * - trap (user): +(0, 0)
150  * - irq (user): +(1, 0)
151  * - irq (kernel, handling syscall): +(1, 0)
152  * - trap (kernel, regardless of context): +(0, 1)
153  * - NMI (kernel): it's actually a kernel trap, even though it is
154  *   sent by IPI.  +(0, 1)
155  * - NMI (user): just a trap.  +(0, 0)
156  *
157  * So if the user traps in for a syscall (0, 0), then the kernel takes an IRQ
158  * (1, 0), and then another IRQ (2, 0), and then the kernel page faults (a
159  * trap), we're at (2, 1).
160  *
161  * Or if we're in userspace, then an IRQ arrives, we're in the kernel at (1, 0).
162  * Note that regardless of whether or not we are in userspace or the kernel when
163  * an irq arrives, we still are only at level 1 irq depth.  We don't care if we
164  * have one or 0 kernel contexts under us.  (The reason for this is that I care
165  * if it is *possible* for us to interrupt the kernel, not whether or not it
166  * actually happened). */
167
168 /* uint32_t __ctx_depth is laid out like so:
169  *
170  * +------8------+------8------+------8------+------8------+
171  * |    Flags    |    Unused   | Kernel Trap |  IRQ Depth  |
172  * |             |             |    Depth    |             |
173  * +-------------+-------------+-------------+-------------+
174  *
175  */
176 #define __CTX_IRQ_D_SHIFT               0
177 #define __CTX_KTRAP_D_SHIFT             8
178 #define __CTX_FLAG_SHIFT                24
179 #define __CTX_IRQ_D_MASK                ((1 << 8) - 1)
180 #define __CTX_KTRAP_D_MASK              ((1 << 8) - 1)
181 #define __CTX_NESTED_CTX_MASK           ((1 << 16) - 1)
182 #define __CTX_CANNOT_BLOCK              (1 << (__CTX_FLAG_SHIFT + 0))
183
184 /* Basic functions to get or change depths */
185
186 #define irq_depth(pcpui)                                                       \
187         (((pcpui)->__ctx_depth >> __CTX_IRQ_D_SHIFT) & __CTX_IRQ_D_MASK)
188
189 #define ktrap_depth(pcpui)                                                     \
190         (((pcpui)->__ctx_depth >> __CTX_KTRAP_D_SHIFT) & __CTX_KTRAP_D_MASK)
191
192 #define inc_irq_depth(pcpui)                                                   \
193         ((pcpui)->__ctx_depth += 1 << __CTX_IRQ_D_SHIFT)
194
195 #define dec_irq_depth(pcpui)                                                   \
196         ((pcpui)->__ctx_depth -= 1 << __CTX_IRQ_D_SHIFT)
197
198 #define inc_ktrap_depth(pcpui)                                                 \
199         ((pcpui)->__ctx_depth += 1 << __CTX_KTRAP_D_SHIFT)
200
201 #define dec_ktrap_depth(pcpui)                                                 \
202         ((pcpui)->__ctx_depth -= 1 << __CTX_KTRAP_D_SHIFT)
203
204 #define set_cannot_block(pcpui)                                                \
205         ((pcpui)->__ctx_depth |= __CTX_CANNOT_BLOCK)
206
207 #define clear_cannot_block(pcpui)                                              \
208         ((pcpui)->__ctx_depth &= ~__CTX_CANNOT_BLOCK)
209
210 /* Functions to query the kernel context depth/state.  I haven't fully decided
211  * on whether or not 'default' context includes RKMs or not.  Will depend on
212  * how we use it.  Check the code below to see what the latest is. */
213
214 #define in_irq_ctx(pcpui)                                                      \
215         (irq_depth(pcpui))
216
217 /* Right now, anything (KTRAP, IRQ, or RKM) makes us not 'default' */
218 #define in_default_ctx(pcpui)                                                  \
219         (!(pcpui)->__ctx_depth)
220
221 /* Can block only if we have no nested contexts (ktraps or irqs, (which are
222  * potentially nested contexts)) and not in an explicit CANNOT_BLOCK. */
223 #define can_block(pcpui)                                                       \
224         (!((pcpui)->__ctx_depth & (__CTX_NESTED_CTX_MASK | __CTX_CANNOT_BLOCK)))
225
226 /* TRUE if we are allowed to spin, given that the 'lock' was declared as not
227  * grabbable from IRQ context.  Meaning, we can't grab the lock from any nested
228  * context.  (And for most locks, we can never grab them from a kernel trap
229  * handler).
230  *
231  * Example is a lock that is not declared as irqsave, but we later grab it from
232  * irq context.  This could deadlock the system, even if it doesn't do it this
233  * time.  This function will catch that. */
234 #define can_spinwait_noirq(pcpui)                                              \
235         (!((pcpui)->__ctx_depth & __CTX_NESTED_CTX_MASK))
236
237 /* TRUE if we are allowed to spin, given that the 'lock' was declared as
238  * potentially grabbable by IRQ context (such as with an irqsave lock).  We can
239  * never grab from a ktrap, since there is no way to prevent that.  And we must
240  * have IRQs disabled, since an IRQ handler could attempt to grab the lock. */
241 #define can_spinwait_irq(pcpui)                                                \
242         ((!ktrap_depth(pcpui) && !irq_is_enabled()))
243
244 /* Debugging */
245 void print_kctx_depths(const char *str);