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