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