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