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