[TCP]: htcp - use measured rtt
[linux-2.6] / drivers / lguest / interrupts_and_traps.c
1 /*P:800 Interrupts (traps) are complicated enough to earn their own file.
2  * There are three classes of interrupts:
3  *
4  * 1) Real hardware interrupts which occur while we're running the Guest,
5  * 2) Interrupts for virtual devices attached to the Guest, and
6  * 3) Traps and faults from the Guest.
7  *
8  * Real hardware interrupts must be delivered to the Host, not the Guest.
9  * Virtual interrupts must be delivered to the Guest, but we make them look
10  * just like real hardware would deliver them.  Traps from the Guest can be set
11  * up to go directly back into the Guest, but sometimes the Host wants to see
12  * them first, so we also have a way of "reflecting" them into the Guest as if
13  * they had been delivered to it directly. :*/
14 #include <linux/uaccess.h>
15 #include "lg.h"
16
17 /* The address of the interrupt handler is split into two bits: */
18 static unsigned long idt_address(u32 lo, u32 hi)
19 {
20         return (lo & 0x0000FFFF) | (hi & 0xFFFF0000);
21 }
22
23 /* The "type" of the interrupt handler is a 4 bit field: we only support a
24  * couple of types. */
25 static int idt_type(u32 lo, u32 hi)
26 {
27         return (hi >> 8) & 0xF;
28 }
29
30 /* An IDT entry can't be used unless the "present" bit is set. */
31 static int idt_present(u32 lo, u32 hi)
32 {
33         return (hi & 0x8000);
34 }
35
36 /* We need a helper to "push" a value onto the Guest's stack, since that's a
37  * big part of what delivering an interrupt does. */
38 static void push_guest_stack(struct lguest *lg, unsigned long *gstack, u32 val)
39 {
40         /* Stack grows upwards: move stack then write value. */
41         *gstack -= 4;
42         lgwrite_u32(lg, *gstack, val);
43 }
44
45 /*H:210 The set_guest_interrupt() routine actually delivers the interrupt or
46  * trap.  The mechanics of delivering traps and interrupts to the Guest are the
47  * same, except some traps have an "error code" which gets pushed onto the
48  * stack as well: the caller tells us if this is one.
49  *
50  * "lo" and "hi" are the two parts of the Interrupt Descriptor Table for this
51  * interrupt or trap.  It's split into two parts for traditional reasons: gcc
52  * on i386 used to be frightened by 64 bit numbers.
53  *
54  * We set up the stack just like the CPU does for a real interrupt, so it's
55  * identical for the Guest (and the standard "iret" instruction will undo
56  * it). */
57 static void set_guest_interrupt(struct lguest *lg, u32 lo, u32 hi, int has_err)
58 {
59         unsigned long gstack;
60         u32 eflags, ss, irq_enable;
61
62         /* There are two cases for interrupts: one where the Guest is already
63          * in the kernel, and a more complex one where the Guest is in
64          * userspace.  We check the privilege level to find out. */
65         if ((lg->regs->ss&0x3) != GUEST_PL) {
66                 /* The Guest told us their kernel stack with the SET_STACK
67                  * hypercall: both the virtual address and the segment */
68                 gstack = guest_pa(lg, lg->esp1);
69                 ss = lg->ss1;
70                 /* We push the old stack segment and pointer onto the new
71                  * stack: when the Guest does an "iret" back from the interrupt
72                  * handler the CPU will notice they're dropping privilege
73                  * levels and expect these here. */
74                 push_guest_stack(lg, &gstack, lg->regs->ss);
75                 push_guest_stack(lg, &gstack, lg->regs->esp);
76         } else {
77                 /* We're staying on the same Guest (kernel) stack. */
78                 gstack = guest_pa(lg, lg->regs->esp);
79                 ss = lg->regs->ss;
80         }
81
82         /* Remember that we never let the Guest actually disable interrupts, so
83          * the "Interrupt Flag" bit is always set.  We copy that bit from the
84          * Guest's "irq_enabled" field into the eflags word: the Guest copies
85          * it back in "lguest_iret". */
86         eflags = lg->regs->eflags;
87         if (get_user(irq_enable, &lg->lguest_data->irq_enabled) == 0
88             && !(irq_enable & X86_EFLAGS_IF))
89                 eflags &= ~X86_EFLAGS_IF;
90
91         /* An interrupt is expected to push three things on the stack: the old
92          * "eflags" word, the old code segment, and the old instruction
93          * pointer. */
94         push_guest_stack(lg, &gstack, eflags);
95         push_guest_stack(lg, &gstack, lg->regs->cs);
96         push_guest_stack(lg, &gstack, lg->regs->eip);
97
98         /* For the six traps which supply an error code, we push that, too. */
99         if (has_err)
100                 push_guest_stack(lg, &gstack, lg->regs->errcode);
101
102         /* Now we've pushed all the old state, we change the stack, the code
103          * segment and the address to execute. */
104         lg->regs->ss = ss;
105         lg->regs->esp = gstack + lg->page_offset;
106         lg->regs->cs = (__KERNEL_CS|GUEST_PL);
107         lg->regs->eip = idt_address(lo, hi);
108
109         /* There are two kinds of interrupt handlers: 0xE is an "interrupt
110          * gate" which expects interrupts to be disabled on entry. */
111         if (idt_type(lo, hi) == 0xE)
112                 if (put_user(0, &lg->lguest_data->irq_enabled))
113                         kill_guest(lg, "Disabling interrupts");
114 }
115
116 /*H:200
117  * Virtual Interrupts.
118  *
119  * maybe_do_interrupt() gets called before every entry to the Guest, to see if
120  * we should divert the Guest to running an interrupt handler. */
121 void maybe_do_interrupt(struct lguest *lg)
122 {
123         unsigned int irq;
124         DECLARE_BITMAP(blk, LGUEST_IRQS);
125         struct desc_struct *idt;
126
127         /* If the Guest hasn't even initialized yet, we can do nothing. */
128         if (!lg->lguest_data)
129                 return;
130
131         /* Take our "irqs_pending" array and remove any interrupts the Guest
132          * wants blocked: the result ends up in "blk". */
133         if (copy_from_user(&blk, lg->lguest_data->blocked_interrupts,
134                            sizeof(blk)))
135                 return;
136
137         bitmap_andnot(blk, lg->irqs_pending, blk, LGUEST_IRQS);
138
139         /* Find the first interrupt. */
140         irq = find_first_bit(blk, LGUEST_IRQS);
141         /* None?  Nothing to do */
142         if (irq >= LGUEST_IRQS)
143                 return;
144
145         /* They may be in the middle of an iret, where they asked us never to
146          * deliver interrupts. */
147         if (lg->regs->eip >= lg->noirq_start && lg->regs->eip < lg->noirq_end)
148                 return;
149
150         /* If they're halted, interrupts restart them. */
151         if (lg->halted) {
152                 /* Re-enable interrupts. */
153                 if (put_user(X86_EFLAGS_IF, &lg->lguest_data->irq_enabled))
154                         kill_guest(lg, "Re-enabling interrupts");
155                 lg->halted = 0;
156         } else {
157                 /* Otherwise we check if they have interrupts disabled. */
158                 u32 irq_enabled;
159                 if (get_user(irq_enabled, &lg->lguest_data->irq_enabled))
160                         irq_enabled = 0;
161                 if (!irq_enabled)
162                         return;
163         }
164
165         /* Look at the IDT entry the Guest gave us for this interrupt.  The
166          * first 32 (FIRST_EXTERNAL_VECTOR) entries are for traps, so we skip
167          * over them. */
168         idt = &lg->idt[FIRST_EXTERNAL_VECTOR+irq];
169         /* If they don't have a handler (yet?), we just ignore it */
170         if (idt_present(idt->a, idt->b)) {
171                 /* OK, mark it no longer pending and deliver it. */
172                 clear_bit(irq, lg->irqs_pending);
173                 /* set_guest_interrupt() takes the interrupt descriptor and a
174                  * flag to say whether this interrupt pushes an error code onto
175                  * the stack as well: virtual interrupts never do. */
176                 set_guest_interrupt(lg, idt->a, idt->b, 0);
177         }
178
179         /* Every time we deliver an interrupt, we update the timestamp in the
180          * Guest's lguest_data struct.  It would be better for the Guest if we
181          * did this more often, but it can actually be quite slow: doing it
182          * here is a compromise which means at least it gets updated every
183          * timer interrupt. */
184         write_timestamp(lg);
185 }
186
187 /*H:220 Now we've got the routines to deliver interrupts, delivering traps
188  * like page fault is easy.  The only trick is that Intel decided that some
189  * traps should have error codes: */
190 static int has_err(unsigned int trap)
191 {
192         return (trap == 8 || (trap >= 10 && trap <= 14) || trap == 17);
193 }
194
195 /* deliver_trap() returns true if it could deliver the trap. */
196 int deliver_trap(struct lguest *lg, unsigned int num)
197 {
198         u32 lo = lg->idt[num].a, hi = lg->idt[num].b;
199
200         /* Early on the Guest hasn't set the IDT entries (or maybe it put a
201          * bogus one in): if we fail here, the Guest will be killed. */
202         if (!idt_present(lo, hi))
203                 return 0;
204         set_guest_interrupt(lg, lo, hi, has_err(num));
205         return 1;
206 }
207
208 /*H:250 Here's the hard part: returning to the Host every time a trap happens
209  * and then calling deliver_trap() and re-entering the Guest is slow.
210  * Particularly because Guest userspace system calls are traps (trap 128).
211  *
212  * So we'd like to set up the IDT to tell the CPU to deliver traps directly
213  * into the Guest.  This is possible, but the complexities cause the size of
214  * this file to double!  However, 150 lines of code is worth writing for taking
215  * system calls down from 1750ns to 270ns.  Plus, if lguest didn't do it, all
216  * the other hypervisors would tease it.
217  *
218  * This routine determines if a trap can be delivered directly. */
219 static int direct_trap(const struct lguest *lg,
220                        const struct desc_struct *trap,
221                        unsigned int num)
222 {
223         /* Hardware interrupts don't go to the Guest at all (except system
224          * call). */
225         if (num >= FIRST_EXTERNAL_VECTOR && num != SYSCALL_VECTOR)
226                 return 0;
227
228         /* The Host needs to see page faults (for shadow paging and to save the
229          * fault address), general protection faults (in/out emulation) and
230          * device not available (TS handling), and of course, the hypercall
231          * trap. */
232         if (num == 14 || num == 13 || num == 7 || num == LGUEST_TRAP_ENTRY)
233                 return 0;
234
235         /* Only trap gates (type 15) can go direct to the Guest.  Interrupt
236          * gates (type 14) disable interrupts as they are entered, which we
237          * never let the Guest do.  Not present entries (type 0x0) also can't
238          * go direct, of course 8) */
239         return idt_type(trap->a, trap->b) == 0xF;
240 }
241 /*:*/
242
243 /*M:005 The Guest has the ability to turn its interrupt gates into trap gates,
244  * if it is careful.  The Host will let trap gates can go directly to the
245  * Guest, but the Guest needs the interrupts atomically disabled for an
246  * interrupt gate.  It can do this by pointing the trap gate at instructions
247  * within noirq_start and noirq_end, where it can safely disable interrupts. */
248
249 /*M:006 The Guests do not use the sysenter (fast system call) instruction,
250  * because it's hardcoded to enter privilege level 0 and so can't go direct.
251  * It's about twice as fast as the older "int 0x80" system call, so it might
252  * still be worthwhile to handle it in the Switcher and lcall down to the
253  * Guest.  The sysenter semantics are hairy tho: search for that keyword in
254  * entry.S :*/
255
256 /*H:260 When we make traps go directly into the Guest, we need to make sure
257  * the kernel stack is valid (ie. mapped in the page tables).  Otherwise, the
258  * CPU trying to deliver the trap will fault while trying to push the interrupt
259  * words on the stack: this is called a double fault, and it forces us to kill
260  * the Guest.
261  *
262  * Which is deeply unfair, because (literally!) it wasn't the Guests' fault. */
263 void pin_stack_pages(struct lguest *lg)
264 {
265         unsigned int i;
266
267         /* Depending on the CONFIG_4KSTACKS option, the Guest can have one or
268          * two pages of stack space. */
269         for (i = 0; i < lg->stack_pages; i++)
270                 /* The stack grows *upwards*, hence the subtraction */
271                 pin_page(lg, lg->esp1 - i * PAGE_SIZE);
272 }
273
274 /* Direct traps also mean that we need to know whenever the Guest wants to use
275  * a different kernel stack, so we can change the IDT entries to use that
276  * stack.  The IDT entries expect a virtual address, so unlike most addresses
277  * the Guest gives us, the "esp" (stack pointer) value here is virtual, not
278  * physical.
279  *
280  * In Linux each process has its own kernel stack, so this happens a lot: we
281  * change stacks on each context switch. */
282 void guest_set_stack(struct lguest *lg, u32 seg, u32 esp, unsigned int pages)
283 {
284         /* You are not allowd have a stack segment with privilege level 0: bad
285          * Guest! */
286         if ((seg & 0x3) != GUEST_PL)
287                 kill_guest(lg, "bad stack segment %i", seg);
288         /* We only expect one or two stack pages. */
289         if (pages > 2)
290                 kill_guest(lg, "bad stack pages %u", pages);
291         /* Save where the stack is, and how many pages */
292         lg->ss1 = seg;
293         lg->esp1 = esp;
294         lg->stack_pages = pages;
295         /* Make sure the new stack pages are mapped */
296         pin_stack_pages(lg);
297 }
298
299 /* All this reference to mapping stacks leads us neatly into the other complex
300  * part of the Host: page table handling. */
301
302 /*H:235 This is the routine which actually checks the Guest's IDT entry and
303  * transfers it into our entry in "struct lguest": */
304 static void set_trap(struct lguest *lg, struct desc_struct *trap,
305                      unsigned int num, u32 lo, u32 hi)
306 {
307         u8 type = idt_type(lo, hi);
308
309         /* We zero-out a not-present entry */
310         if (!idt_present(lo, hi)) {
311                 trap->a = trap->b = 0;
312                 return;
313         }
314
315         /* We only support interrupt and trap gates. */
316         if (type != 0xE && type != 0xF)
317                 kill_guest(lg, "bad IDT type %i", type);
318
319         /* We only copy the handler address, present bit, privilege level and
320          * type.  The privilege level controls where the trap can be triggered
321          * manually with an "int" instruction.  This is usually GUEST_PL,
322          * except for system calls which userspace can use. */
323         trap->a = ((__KERNEL_CS|GUEST_PL)<<16) | (lo&0x0000FFFF);
324         trap->b = (hi&0xFFFFEF00);
325 }
326
327 /*H:230 While we're here, dealing with delivering traps and interrupts to the
328  * Guest, we might as well complete the picture: how the Guest tells us where
329  * it wants them to go.  This would be simple, except making traps fast
330  * requires some tricks.
331  *
332  * We saw the Guest setting Interrupt Descriptor Table (IDT) entries with the
333  * LHCALL_LOAD_IDT_ENTRY hypercall before: that comes here. */
334 void load_guest_idt_entry(struct lguest *lg, unsigned int num, u32 lo, u32 hi)
335 {
336         /* Guest never handles: NMI, doublefault, spurious interrupt or
337          * hypercall.  We ignore when it tries to set them. */
338         if (num == 2 || num == 8 || num == 15 || num == LGUEST_TRAP_ENTRY)
339                 return;
340
341         /* Mark the IDT as changed: next time the Guest runs we'll know we have
342          * to copy this again. */
343         lg->changed |= CHANGED_IDT;
344
345         /* The IDT which we keep in "struct lguest" only contains 32 entries
346          * for the traps and LGUEST_IRQS (32) entries for interrupts.  We
347          * ignore attempts to set handlers for higher interrupt numbers, except
348          * for the system call "interrupt" at 128: we have a special IDT entry
349          * for that. */
350         if (num < ARRAY_SIZE(lg->idt))
351                 set_trap(lg, &lg->idt[num], num, lo, hi);
352         else if (num == SYSCALL_VECTOR)
353                 set_trap(lg, &lg->syscall_idt, num, lo, hi);
354 }
355
356 /* The default entry for each interrupt points into the Switcher routines which
357  * simply return to the Host.  The run_guest() loop will then call
358  * deliver_trap() to bounce it back into the Guest. */
359 static void default_idt_entry(struct desc_struct *idt,
360                               int trap,
361                               const unsigned long handler)
362 {
363         /* A present interrupt gate. */
364         u32 flags = 0x8e00;
365
366         /* Set the privilege level on the entry for the hypercall: this allows
367          * the Guest to use the "int" instruction to trigger it. */
368         if (trap == LGUEST_TRAP_ENTRY)
369                 flags |= (GUEST_PL << 13);
370
371         /* Now pack it into the IDT entry in its weird format. */
372         idt->a = (LGUEST_CS<<16) | (handler&0x0000FFFF);
373         idt->b = (handler&0xFFFF0000) | flags;
374 }
375
376 /* When the Guest first starts, we put default entries into the IDT. */
377 void setup_default_idt_entries(struct lguest_ro_state *state,
378                                const unsigned long *def)
379 {
380         unsigned int i;
381
382         for (i = 0; i < ARRAY_SIZE(state->guest_idt); i++)
383                 default_idt_entry(&state->guest_idt[i], i, def[i]);
384 }
385
386 /*H:240 We don't use the IDT entries in the "struct lguest" directly, instead
387  * we copy them into the IDT which we've set up for Guests on this CPU, just
388  * before we run the Guest.  This routine does that copy. */
389 void copy_traps(const struct lguest *lg, struct desc_struct *idt,
390                 const unsigned long *def)
391 {
392         unsigned int i;
393
394         /* We can simply copy the direct traps, otherwise we use the default
395          * ones in the Switcher: they will return to the Host. */
396         for (i = 0; i < FIRST_EXTERNAL_VECTOR; i++) {
397                 if (direct_trap(lg, &lg->idt[i], i))
398                         idt[i] = lg->idt[i];
399                 else
400                         default_idt_entry(&idt[i], i, def[i]);
401         }
402
403         /* Don't forget the system call trap!  The IDT entries for other
404          * interupts never change, so no need to copy them. */
405         i = SYSCALL_VECTOR;
406         if (direct_trap(lg, &lg->syscall_idt, i))
407                 idt[i] = lg->syscall_idt;
408         else
409                 default_idt_entry(&idt[i], i, def[i]);
410 }
411
412 void guest_set_clockevent(struct lguest *lg, unsigned long delta)
413 {
414         ktime_t expires;
415
416         if (unlikely(delta == 0)) {
417                 /* Clock event device is shutting down. */
418                 hrtimer_cancel(&lg->hrt);
419                 return;
420         }
421
422         expires = ktime_add_ns(ktime_get_real(), delta);
423         hrtimer_start(&lg->hrt, expires, HRTIMER_MODE_ABS);
424 }
425
426 static enum hrtimer_restart clockdev_fn(struct hrtimer *timer)
427 {
428         struct lguest *lg = container_of(timer, struct lguest, hrt);
429
430         set_bit(0, lg->irqs_pending);
431         if (lg->halted)
432                 wake_up_process(lg->tsk);
433         return HRTIMER_NORESTART;
434 }
435
436 void init_clockdev(struct lguest *lg)
437 {
438         hrtimer_init(&lg->hrt, CLOCK_REALTIME, HRTIMER_MODE_ABS);
439         lg->hrt.function = clockdev_fn;
440 }