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