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