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