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