Cleans up sysenter_init
[akaros.git] / kern / include / trap.h
1 /* See COPYRIGHT for copyright information. */
2
3 #ifndef ROS_KERN_TRAP_H
4 #define ROS_KERN_TRAP_H
5
6 #include <ros/trapframe.h>
7 #include <arch/arch.h>
8 #include <arch/mmu.h>
9 #include <sys/queue.h>
10 /* #include <arch/trap.h> included below */
11
12 /* For kernel contexts, when we save/restore/move them around.  For now, we'll
13  * just use the old trapframe/hw_trap, but in the future we can slim this down a
14  * bit.  Additionally, we might have different types of these in the future, if
15  * we ever do non-cooperative kthread scheduling. */
16 struct kernel_ctx {
17         /* RISCV's current pop_kernel_ctx assumes the hw_tf is the first member */
18         struct hw_trapframe             hw_tf;
19 };
20
21 /* Arch needs to hear about kernel_ctx */
22 #include <arch/trap.h>
23
24 // func ptr for interrupt service routines
25 typedef void (*poly_isr_t)(struct hw_trapframe *hw_tf, void *data);
26 typedef void (*isr_t)(struct hw_trapframe *hw_tf, void *data);
27 typedef struct InterruptHandler {
28         poly_isr_t isr;
29         TV(t) data;
30 } handler_t;
31
32 extern handler_t interrupt_handlers[];
33
34 void idt_init(void);
35 void
36 register_interrupt_handler(handler_t SSOMELOCK (CT(NUM_INTERRUPT_HANDLERS)table)[],
37                            uint8_t int_num,
38                            poly_isr_t handler, TV(t) data);
39 void print_trapframe(struct hw_trapframe *hw_tf);
40 void page_fault_handler(struct hw_trapframe *hw_tf);
41 /* Generic per-core timer interrupt handler.  set_percore_timer() will fire the
42  * timer_interrupt(). */
43 void set_core_timer(uint32_t usec, bool periodic);
44 void timer_interrupt(struct hw_trapframe *hw_tf, void *data);
45
46 extern inline void save_fp_state(struct ancillary_state *silly);
47 extern inline void restore_fp_state(struct ancillary_state *silly);
48 extern inline void init_fp_state(void);
49 /* Set stacktop for the current core to be the stack the kernel will start on
50  * when trapping/interrupting from userspace */
51 void set_stack_top(uintptr_t stacktop);
52 uintptr_t get_stack_top(void);
53
54 /* It's important that this is inline and that ctx is not a stack variable */
55 static inline void save_kernel_ctx(struct kernel_ctx *ctx)
56                    __attribute__((always_inline));
57 void pop_kernel_ctx(struct kernel_ctx *ctx) __attribute__((noreturn));
58
59 /* Sends a non-maskable interrupt, which we have print a trapframe. */
60 void send_nmi(uint32_t os_coreid);
61
62 /* Kernel messages.  This is an in-order 'active message' style messaging
63  * subsystem, where you can instruct other cores (including your own) to execute
64  * a function (with arguments), either immediately or whenever the kernel is
65  * able to abandon its context/stack (permanent swap).
66  *
67  * These are different (for now) than the smp_calls in smp.h, since
68  * they will be executed immediately (for urgent messages), and in the order in
69  * which they are sent.  smp_calls are currently not run in order, and they must
70  * return (possibly passing the work to a workqueue, which is really just a
71  * routine message, so they really need to just return).
72  *
73  * Eventually, smp_call will be replaced by these.
74  *
75  * Also, a big difference is that smp_calls can use the same message (registered
76  * in the interrupt_handlers[] for x86) for every recipient, but the kernel
77  * messages require a unique message.  Also for now, but it might be like that
78  * for a while on x86 (til we have a broadcast). */
79
80 #define KMSG_IMMEDIATE                  1
81 #define KMSG_ROUTINE                    2
82
83 typedef void (*amr_t)(uint32_t srcid, long a0, long a1, long a2);
84
85 struct kernel_message
86 {
87         STAILQ_ENTRY(kernel_message) link;
88         uint32_t srcid;
89         uint32_t dstid;
90         amr_t pc;
91         long arg0;
92         long arg1;
93         long arg2;
94 }__attribute__((aligned(8)));
95
96 STAILQ_HEAD(kernel_msg_list, kernel_message);
97 typedef struct kernel_message kernel_message_t;
98
99 void kernel_msg_init(void);
100 uint32_t send_kernel_message(uint32_t dst, amr_t pc, long arg0, long arg1,
101                              long arg2, int type);
102 void handle_kmsg_ipi(struct hw_trapframe *hw_tf, void *data);
103 void process_routine_kmsg(void);
104 void print_kmsgs(uint32_t coreid);
105
106 /* Kernel context depths.  IRQ depth is how many nested IRQ stacks/contexts we
107  * are working on.  Kernel trap depth is how many nested kernel traps (not
108  * user-space traps) we have.
109  *
110  * Some examples:
111  *              (original context in parens, +(x, y) is the change to IRQ and ktrap
112  *              depth):
113  * - syscall (user): +(0, 0)
114  * - trap (user): +(0, 0)
115  * - irq (user): +(1, 0)
116  * - irq (kernel, handling syscall): +(1, 0)
117  * - trap (kernel, regardless of context): +(0, 1)
118  * - NMI (kernel): it's actually a kernel trap, even though it is
119  *   sent by IPI.  +(0, 1)
120  * - NMI (user): just a trap.  +(0, 0)
121  *
122  * So if the user traps in for a syscall (0, 0), then the kernel takes an IRQ
123  * (1, 0), and then another IRQ (2, 0), and then the kernel page faults (a
124  * trap), we're at (2, 1).
125  *
126  * Or if we're in userspace, then an IRQ arrives, we're in the kernel at (1, 0).
127  * Note that regardless of whether or not we are in userspace or the kernel when
128  * an irq arrives, we still are only at level 1 irq depth.  We don't care if we
129  * have one or 0 kernel contexts under us.  (The reason for this is that I care
130  * if it is *possible* for us to interrupt the kernel, not whether or not it
131  * actually happened). */
132
133 /* uint32_t __ctx_depth is laid out like so:
134  *
135  * +------8------+------8------+------8------+------8------+
136  * |    Flags    |    Unused   | Kernel Trap |  IRQ Depth  |
137  * |             |             |    Depth    |             |
138  * +-------------+-------------+-------------+-------------+
139  *
140  */
141 #define __CTX_IRQ_D_SHIFT                       0
142 #define __CTX_KTRAP_D_SHIFT                     8
143 #define __CTX_FLAG_SHIFT                        24
144 #define __CTX_IRQ_D_MASK                        ((1 << 8) - 1)
145 #define __CTX_KTRAP_D_MASK                      ((1 << 8) - 1)
146 #define __CTX_NESTED_CTX_MASK           ((1 << 16) - 1)
147 #define __CTX_EARLY_RKM                         (1 << __CTX_FLAG_SHIFT)
148
149 /* Basic functions to get or change depths */
150
151 #define irq_depth(pcpui)                                                       \
152         (((pcpui)->__ctx_depth >> __CTX_IRQ_D_SHIFT) & __CTX_IRQ_D_MASK)
153
154 #define ktrap_depth(pcpui)                                                     \
155         (((pcpui)->__ctx_depth >> __CTX_KTRAP_D_SHIFT) & __CTX_KTRAP_D_MASK)
156
157 #define inc_irq_depth(pcpui)                                                   \
158         ((pcpui)->__ctx_depth += 1 << __CTX_IRQ_D_SHIFT)
159
160 #define dec_irq_depth(pcpui)                                                   \
161         ((pcpui)->__ctx_depth -= 1 << __CTX_IRQ_D_SHIFT)
162
163 #define inc_ktrap_depth(pcpui)                                                 \
164         ((pcpui)->__ctx_depth += 1 << __CTX_KTRAP_D_SHIFT)
165
166 #define dec_ktrap_depth(pcpui)                                                 \
167         ((pcpui)->__ctx_depth -= 1 << __CTX_KTRAP_D_SHIFT)
168
169 #define set_rkmsg(pcpui)                                                       \
170         ((pcpui)->__ctx_depth |= __CTX_EARLY_RKM)
171
172 #define clear_rkmsg(pcpui)                                                     \
173         ((pcpui)->__ctx_depth &= ~__CTX_EARLY_RKM)
174
175 /* Functions to query the kernel context depth/state.  I haven't fully decided
176  * on whether or not 'default' context includes RKMs or not.  Will depend on
177  * how we use it.  Check the code below to see what the latest is. */
178
179 #define in_irq_ctx(pcpui)                                                      \
180         (irq_depth(pcpui))
181
182 #define in_early_rkmsg_ctx(pcpui)                                              \
183         ((pcpui)->__ctx_depth & __CTX_EARLY_RKM)
184
185 /* Right now, anything (KTRAP, IRQ, or RKM) makes us not 'default' */
186 #define in_default_ctx(pcpui)                                                  \
187         (!(pcpui)->__ctx_depth)
188
189 /* Can block only if we have no nested contexts (ktraps or irqs, (which are
190  * potentially nested contexts)) */
191 #define can_block(pcpui)                                                       \
192         (!((pcpui)->__ctx_depth & __CTX_NESTED_CTX_MASK))
193
194 /* TRUE if we are allowed to spin, given that the 'lock' was declared as not
195  * grabbable from IRQ context.  Meaning, we can't grab the lock from any nested
196  * context.  (And for most locks, we can never grab them from a kernel trap
197  * handler). 
198  *
199  * Example is a lock that is not declared as irqsave, but we later grab it from
200  * irq context.  This could deadlock the system, even if it doesn't do it this
201  * time.  This function will catch that. */
202 #define can_spinwait_noirq(pcpui)                                              \
203         (!((pcpui)->__ctx_depth & __CTX_NESTED_CTX_MASK))
204
205 /* TRUE if we are allowed to spin, given that the 'lock' was declared as
206  * potentially grabbable by IRQ context (such as with an irqsave lock).  We can
207  * never grab from a ktrap, since there is no way to prevent that.  And we must
208  * have IRQs disabled, since an IRQ handler could attempt to grab the lock. */
209 #define can_spinwait_irq(pcpui)                                                \
210         ((!ktrap_depth(pcpui) && !irq_is_enabled()))
211
212 /* Debugging */
213 void print_kctx_depths(const char *str);
214  
215 #endif /* ROS_KERN_TRAP_H */