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