f3a5305b8adfcf0fc243692287bd9ec4769c977f
[linux-2.6.git] / arch / x86 / lguest / boot.c
1 /*P:010
2  * A hypervisor allows multiple Operating Systems to run on a single machine.
3  * To quote David Wheeler: "Any problem in computer science can be solved with
4  * another layer of indirection."
5  *
6  * We keep things simple in two ways.  First, we start with a normal Linux
7  * kernel and insert a module (lg.ko) which allows us to run other Linux
8  * kernels the same way we'd run processes.  We call the first kernel the Host,
9  * and the others the Guests.  The program which sets up and configures Guests
10  * (such as the example in Documentation/lguest/lguest.c) is called the
11  * Launcher.
12  *
13  * Secondly, we only run specially modified Guests, not normal kernels: setting
14  * CONFIG_LGUEST_GUEST to "y" compiles this file into the kernel so it knows
15  * how to be a Guest at boot time.  This means that you can use the same kernel
16  * you boot normally (ie. as a Host) as a Guest.
17  *
18  * These Guests know that they cannot do privileged operations, such as disable
19  * interrupts, and that they have to ask the Host to do such things explicitly.
20  * This file consists of all the replacements for such low-level native
21  * hardware operations: these special Guest versions call the Host.
22  *
23  * So how does the kernel know it's a Guest?  We'll see that later, but let's
24  * just say that we end up here where we replace the native functions various
25  * "paravirt" structures with our Guest versions, then boot like normal. :*/
26
27 /*
28  * Copyright (C) 2006, Rusty Russell <rusty@rustcorp.com.au> IBM Corporation.
29  *
30  * This program is free software; you can redistribute it and/or modify
31  * it under the terms of the GNU General Public License as published by
32  * the Free Software Foundation; either version 2 of the License, or
33  * (at your option) any later version.
34  *
35  * This program is distributed in the hope that it will be useful, but
36  * WITHOUT ANY WARRANTY; without even the implied warranty of
37  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
38  * NON INFRINGEMENT.  See the GNU General Public License for more
39  * details.
40  *
41  * You should have received a copy of the GNU General Public License
42  * along with this program; if not, write to the Free Software
43  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
44  */
45 #include <linux/kernel.h>
46 #include <linux/start_kernel.h>
47 #include <linux/string.h>
48 #include <linux/console.h>
49 #include <linux/screen_info.h>
50 #include <linux/irq.h>
51 #include <linux/interrupt.h>
52 #include <linux/clocksource.h>
53 #include <linux/clockchips.h>
54 #include <linux/lguest.h>
55 #include <linux/lguest_launcher.h>
56 #include <linux/virtio_console.h>
57 #include <linux/pm.h>
58 #include <asm/apic.h>
59 #include <asm/lguest.h>
60 #include <asm/paravirt.h>
61 #include <asm/param.h>
62 #include <asm/page.h>
63 #include <asm/pgtable.h>
64 #include <asm/desc.h>
65 #include <asm/setup.h>
66 #include <asm/e820.h>
67 #include <asm/mce.h>
68 #include <asm/io.h>
69 #include <asm/i387.h>
70 #include <asm/reboot.h>         /* for struct machine_ops */
71
72 /*G:010 Welcome to the Guest!
73  *
74  * The Guest in our tale is a simple creature: identical to the Host but
75  * behaving in simplified but equivalent ways.  In particular, the Guest is the
76  * same kernel as the Host (or at least, built from the same source code). :*/
77
78 struct lguest_data lguest_data = {
79         .hcall_status = { [0 ... LHCALL_RING_SIZE-1] = 0xFF },
80         .noirq_start = (u32)lguest_noirq_start,
81         .noirq_end = (u32)lguest_noirq_end,
82         .kernel_address = PAGE_OFFSET,
83         .blocked_interrupts = { 1 }, /* Block timer interrupts */
84         .syscall_vec = SYSCALL_VECTOR,
85 };
86
87 /*G:037 async_hcall() is pretty simple: I'm quite proud of it really.  We have a
88  * ring buffer of stored hypercalls which the Host will run though next time we
89  * do a normal hypercall.  Each entry in the ring has 4 slots for the hypercall
90  * arguments, and a "hcall_status" word which is 0 if the call is ready to go,
91  * and 255 once the Host has finished with it.
92  *
93  * If we come around to a slot which hasn't been finished, then the table is
94  * full and we just make the hypercall directly.  This has the nice side
95  * effect of causing the Host to run all the stored calls in the ring buffer
96  * which empties it for next time! */
97 static void async_hcall(unsigned long call, unsigned long arg1,
98                         unsigned long arg2, unsigned long arg3)
99 {
100         /* Note: This code assumes we're uniprocessor. */
101         static unsigned int next_call;
102         unsigned long flags;
103
104         /* Disable interrupts if not already disabled: we don't want an
105          * interrupt handler making a hypercall while we're already doing
106          * one! */
107         local_irq_save(flags);
108         if (lguest_data.hcall_status[next_call] != 0xFF) {
109                 /* Table full, so do normal hcall which will flush table. */
110                 hcall(call, arg1, arg2, arg3);
111         } else {
112                 lguest_data.hcalls[next_call].arg0 = call;
113                 lguest_data.hcalls[next_call].arg1 = arg1;
114                 lguest_data.hcalls[next_call].arg2 = arg2;
115                 lguest_data.hcalls[next_call].arg3 = arg3;
116                 /* Arguments must all be written before we mark it to go */
117                 wmb();
118                 lguest_data.hcall_status[next_call] = 0;
119                 if (++next_call == LHCALL_RING_SIZE)
120                         next_call = 0;
121         }
122         local_irq_restore(flags);
123 }
124
125 /*G:035 Notice the lazy_hcall() above, rather than hcall().  This is our first
126  * real optimization trick!
127  *
128  * When lazy_mode is set, it means we're allowed to defer all hypercalls and do
129  * them as a batch when lazy_mode is eventually turned off.  Because hypercalls
130  * are reasonably expensive, batching them up makes sense.  For example, a
131  * large munmap might update dozens of page table entries: that code calls
132  * paravirt_enter_lazy_mmu(), does the dozen updates, then calls
133  * lguest_leave_lazy_mode().
134  *
135  * So, when we're in lazy mode, we call async_hcall() to store the call for
136  * future processing: */
137 static void lazy_hcall(unsigned long call,
138                        unsigned long arg1,
139                        unsigned long arg2,
140                        unsigned long arg3)
141 {
142         if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
143                 hcall(call, arg1, arg2, arg3);
144         else
145                 async_hcall(call, arg1, arg2, arg3);
146 }
147
148 /* When lazy mode is turned off reset the per-cpu lazy mode variable and then
149  * issue the do-nothing hypercall to flush any stored calls. */
150 static void lguest_leave_lazy_mode(void)
151 {
152         paravirt_leave_lazy(paravirt_get_lazy_mode());
153         hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0);
154 }
155
156 /*G:033
157  * After that diversion we return to our first native-instruction
158  * replacements: four functions for interrupt control.
159  *
160  * The simplest way of implementing these would be to have "turn interrupts
161  * off" and "turn interrupts on" hypercalls.  Unfortunately, this is too slow:
162  * these are by far the most commonly called functions of those we override.
163  *
164  * So instead we keep an "irq_enabled" field inside our "struct lguest_data",
165  * which the Guest can update with a single instruction.  The Host knows to
166  * check there before it tries to deliver an interrupt.
167  */
168
169 /* save_flags() is expected to return the processor state (ie. "flags").  The
170  * flags word contains all kind of stuff, but in practice Linux only cares
171  * about the interrupt flag.  Our "save_flags()" just returns that. */
172 static unsigned long save_fl(void)
173 {
174         return lguest_data.irq_enabled;
175 }
176 PV_CALLEE_SAVE_REGS_THUNK(save_fl);
177
178 /* restore_flags() just sets the flags back to the value given. */
179 static void restore_fl(unsigned long flags)
180 {
181         lguest_data.irq_enabled = flags;
182 }
183 PV_CALLEE_SAVE_REGS_THUNK(restore_fl);
184
185 /* Interrupts go off... */
186 static void irq_disable(void)
187 {
188         lguest_data.irq_enabled = 0;
189 }
190 PV_CALLEE_SAVE_REGS_THUNK(irq_disable);
191
192 /* Interrupts go on... */
193 static void irq_enable(void)
194 {
195         lguest_data.irq_enabled = X86_EFLAGS_IF;
196 }
197 PV_CALLEE_SAVE_REGS_THUNK(irq_enable);
198
199 /*:*/
200 /*M:003 Note that we don't check for outstanding interrupts when we re-enable
201  * them (or when we unmask an interrupt).  This seems to work for the moment,
202  * since interrupts are rare and we'll just get the interrupt on the next timer
203  * tick, but now we can run with CONFIG_NO_HZ, we should revisit this.  One way
204  * would be to put the "irq_enabled" field in a page by itself, and have the
205  * Host write-protect it when an interrupt comes in when irqs are disabled.
206  * There will then be a page fault as soon as interrupts are re-enabled.
207  *
208  * A better method is to implement soft interrupt disable generally for x86:
209  * instead of disabling interrupts, we set a flag.  If an interrupt does come
210  * in, we then disable them for real.  This is uncommon, so we could simply use
211  * a hypercall for interrupt control and not worry about efficiency. :*/
212
213 /*G:034
214  * The Interrupt Descriptor Table (IDT).
215  *
216  * The IDT tells the processor what to do when an interrupt comes in.  Each
217  * entry in the table is a 64-bit descriptor: this holds the privilege level,
218  * address of the handler, and... well, who cares?  The Guest just asks the
219  * Host to make the change anyway, because the Host controls the real IDT.
220  */
221 static void lguest_write_idt_entry(gate_desc *dt,
222                                    int entrynum, const gate_desc *g)
223 {
224         /* The gate_desc structure is 8 bytes long: we hand it to the Host in
225          * two 32-bit chunks.  The whole 32-bit kernel used to hand descriptors
226          * around like this; typesafety wasn't a big concern in Linux's early
227          * years. */
228         u32 *desc = (u32 *)g;
229         /* Keep the local copy up to date. */
230         native_write_idt_entry(dt, entrynum, g);
231         /* Tell Host about this new entry. */
232         hcall(LHCALL_LOAD_IDT_ENTRY, entrynum, desc[0], desc[1]);
233 }
234
235 /* Changing to a different IDT is very rare: we keep the IDT up-to-date every
236  * time it is written, so we can simply loop through all entries and tell the
237  * Host about them. */
238 static void lguest_load_idt(const struct desc_ptr *desc)
239 {
240         unsigned int i;
241         struct desc_struct *idt = (void *)desc->address;
242
243         for (i = 0; i < (desc->size+1)/8; i++)
244                 hcall(LHCALL_LOAD_IDT_ENTRY, i, idt[i].a, idt[i].b);
245 }
246
247 /*
248  * The Global Descriptor Table.
249  *
250  * The Intel architecture defines another table, called the Global Descriptor
251  * Table (GDT).  You tell the CPU where it is (and its size) using the "lgdt"
252  * instruction, and then several other instructions refer to entries in the
253  * table.  There are three entries which the Switcher needs, so the Host simply
254  * controls the entire thing and the Guest asks it to make changes using the
255  * LOAD_GDT hypercall.
256  *
257  * This is the opposite of the IDT code where we have a LOAD_IDT_ENTRY
258  * hypercall and use that repeatedly to load a new IDT.  I don't think it
259  * really matters, but wouldn't it be nice if they were the same?  Wouldn't
260  * it be even better if you were the one to send the patch to fix it?
261  */
262 static void lguest_load_gdt(const struct desc_ptr *desc)
263 {
264         BUG_ON((desc->size+1)/8 != GDT_ENTRIES);
265         hcall(LHCALL_LOAD_GDT, __pa(desc->address), GDT_ENTRIES, 0);
266 }
267
268 /* For a single GDT entry which changes, we do the lazy thing: alter our GDT,
269  * then tell the Host to reload the entire thing.  This operation is so rare
270  * that this naive implementation is reasonable. */
271 static void lguest_write_gdt_entry(struct desc_struct *dt, int entrynum,
272                                    const void *desc, int type)
273 {
274         native_write_gdt_entry(dt, entrynum, desc, type);
275         hcall(LHCALL_LOAD_GDT, __pa(dt), GDT_ENTRIES, 0);
276 }
277
278 /* OK, I lied.  There are three "thread local storage" GDT entries which change
279  * on every context switch (these three entries are how glibc implements
280  * __thread variables).  So we have a hypercall specifically for this case. */
281 static void lguest_load_tls(struct thread_struct *t, unsigned int cpu)
282 {
283         /* There's one problem which normal hardware doesn't have: the Host
284          * can't handle us removing entries we're currently using.  So we clear
285          * the GS register here: if it's needed it'll be reloaded anyway. */
286         lazy_load_gs(0);
287         lazy_hcall(LHCALL_LOAD_TLS, __pa(&t->tls_array), cpu, 0);
288 }
289
290 /*G:038 That's enough excitement for now, back to ploughing through each of
291  * the different pv_ops structures (we're about 1/3 of the way through).
292  *
293  * This is the Local Descriptor Table, another weird Intel thingy.  Linux only
294  * uses this for some strange applications like Wine.  We don't do anything
295  * here, so they'll get an informative and friendly Segmentation Fault. */
296 static void lguest_set_ldt(const void *addr, unsigned entries)
297 {
298 }
299
300 /* This loads a GDT entry into the "Task Register": that entry points to a
301  * structure called the Task State Segment.  Some comments scattered though the
302  * kernel code indicate that this used for task switching in ages past, along
303  * with blood sacrifice and astrology.
304  *
305  * Now there's nothing interesting in here that we don't get told elsewhere.
306  * But the native version uses the "ltr" instruction, which makes the Host
307  * complain to the Guest about a Segmentation Fault and it'll oops.  So we
308  * override the native version with a do-nothing version. */
309 static void lguest_load_tr_desc(void)
310 {
311 }
312
313 /* The "cpuid" instruction is a way of querying both the CPU identity
314  * (manufacturer, model, etc) and its features.  It was introduced before the
315  * Pentium in 1993 and keeps getting extended by both Intel, AMD and others.
316  * As you might imagine, after a decade and a half this treatment, it is now a
317  * giant ball of hair.  Its entry in the current Intel manual runs to 28 pages.
318  *
319  * This instruction even it has its own Wikipedia entry.  The Wikipedia entry
320  * has been translated into 4 languages.  I am not making this up!
321  *
322  * We could get funky here and identify ourselves as "GenuineLguest", but
323  * instead we just use the real "cpuid" instruction.  Then I pretty much turned
324  * off feature bits until the Guest booted.  (Don't say that: you'll damage
325  * lguest sales!)  Shut up, inner voice!  (Hey, just pointing out that this is
326  * hardly future proof.)  Noone's listening!  They don't like you anyway,
327  * parenthetic weirdo!
328  *
329  * Replacing the cpuid so we can turn features off is great for the kernel, but
330  * anyone (including userspace) can just use the raw "cpuid" instruction and
331  * the Host won't even notice since it isn't privileged.  So we try not to get
332  * too worked up about it. */
333 static void lguest_cpuid(unsigned int *ax, unsigned int *bx,
334                          unsigned int *cx, unsigned int *dx)
335 {
336         int function = *ax;
337
338         native_cpuid(ax, bx, cx, dx);
339         switch (function) {
340         case 1: /* Basic feature request. */
341                 /* We only allow kernel to see SSE3, CMPXCHG16B and SSSE3 */
342                 *cx &= 0x00002201;
343                 /* SSE, SSE2, FXSR, MMX, CMOV, CMPXCHG8B, TSC, FPU. */
344                 *dx &= 0x07808111;
345                 /* The Host can do a nice optimization if it knows that the
346                  * kernel mappings (addresses above 0xC0000000 or whatever
347                  * PAGE_OFFSET is set to) haven't changed.  But Linux calls
348                  * flush_tlb_user() for both user and kernel mappings unless
349                  * the Page Global Enable (PGE) feature bit is set. */
350                 *dx |= 0x00002000;
351                 break;
352         case 0x80000000:
353                 /* Futureproof this a little: if they ask how much extended
354                  * processor information there is, limit it to known fields. */
355                 if (*ax > 0x80000008)
356                         *ax = 0x80000008;
357                 break;
358         }
359 }
360
361 /* Intel has four control registers, imaginatively named cr0, cr2, cr3 and cr4.
362  * I assume there's a cr1, but it hasn't bothered us yet, so we'll not bother
363  * it.  The Host needs to know when the Guest wants to change them, so we have
364  * a whole series of functions like read_cr0() and write_cr0().
365  *
366  * We start with cr0.  cr0 allows you to turn on and off all kinds of basic
367  * features, but Linux only really cares about one: the horrifically-named Task
368  * Switched (TS) bit at bit 3 (ie. 8)
369  *
370  * What does the TS bit do?  Well, it causes the CPU to trap (interrupt 7) if
371  * the floating point unit is used.  Which allows us to restore FPU state
372  * lazily after a task switch, and Linux uses that gratefully, but wouldn't a
373  * name like "FPUTRAP bit" be a little less cryptic?
374  *
375  * We store cr0 locally because the Host never changes it.  The Guest sometimes
376  * wants to read it and we'd prefer not to bother the Host unnecessarily. */
377 static unsigned long current_cr0;
378 static void lguest_write_cr0(unsigned long val)
379 {
380         lazy_hcall(LHCALL_TS, val & X86_CR0_TS, 0, 0);
381         current_cr0 = val;
382 }
383
384 static unsigned long lguest_read_cr0(void)
385 {
386         return current_cr0;
387 }
388
389 /* Intel provided a special instruction to clear the TS bit for people too cool
390  * to use write_cr0() to do it.  This "clts" instruction is faster, because all
391  * the vowels have been optimized out. */
392 static void lguest_clts(void)
393 {
394         lazy_hcall(LHCALL_TS, 0, 0, 0);
395         current_cr0 &= ~X86_CR0_TS;
396 }
397
398 /* cr2 is the virtual address of the last page fault, which the Guest only ever
399  * reads.  The Host kindly writes this into our "struct lguest_data", so we
400  * just read it out of there. */
401 static unsigned long lguest_read_cr2(void)
402 {
403         return lguest_data.cr2;
404 }
405
406 /* See lguest_set_pte() below. */
407 static bool cr3_changed = false;
408
409 /* cr3 is the current toplevel pagetable page: the principle is the same as
410  * cr0.  Keep a local copy, and tell the Host when it changes.  The only
411  * difference is that our local copy is in lguest_data because the Host needs
412  * to set it upon our initial hypercall. */
413 static void lguest_write_cr3(unsigned long cr3)
414 {
415         lguest_data.pgdir = cr3;
416         lazy_hcall(LHCALL_NEW_PGTABLE, cr3, 0, 0);
417         cr3_changed = true;
418 }
419
420 static unsigned long lguest_read_cr3(void)
421 {
422         return lguest_data.pgdir;
423 }
424
425 /* cr4 is used to enable and disable PGE, but we don't care. */
426 static unsigned long lguest_read_cr4(void)
427 {
428         return 0;
429 }
430
431 static void lguest_write_cr4(unsigned long val)
432 {
433 }
434
435 /*
436  * Page Table Handling.
437  *
438  * Now would be a good time to take a rest and grab a coffee or similarly
439  * relaxing stimulant.  The easy parts are behind us, and the trek gradually
440  * winds uphill from here.
441  *
442  * Quick refresher: memory is divided into "pages" of 4096 bytes each.  The CPU
443  * maps virtual addresses to physical addresses using "page tables".  We could
444  * use one huge index of 1 million entries: each address is 4 bytes, so that's
445  * 1024 pages just to hold the page tables.   But since most virtual addresses
446  * are unused, we use a two level index which saves space.  The cr3 register
447  * contains the physical address of the top level "page directory" page, which
448  * contains physical addresses of up to 1024 second-level pages.  Each of these
449  * second level pages contains up to 1024 physical addresses of actual pages,
450  * or Page Table Entries (PTEs).
451  *
452  * Here's a diagram, where arrows indicate physical addresses:
453  *
454  * cr3 ---> +---------+
455  *          |      --------->+---------+
456  *          |         |      | PADDR1  |
457  *        Top-level   |      | PADDR2  |
458  *        (PMD) page  |      |         |
459  *          |         |    Lower-level |
460  *          |         |    (PTE) page  |
461  *          |         |      |         |
462  *            ....               ....
463  *
464  * So to convert a virtual address to a physical address, we look up the top
465  * level, which points us to the second level, which gives us the physical
466  * address of that page.  If the top level entry was not present, or the second
467  * level entry was not present, then the virtual address is invalid (we
468  * say "the page was not mapped").
469  *
470  * Put another way, a 32-bit virtual address is divided up like so:
471  *
472  *  1 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
473  * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
474  *    Index into top     Index into second      Offset within page
475  *  page directory page    pagetable page
476  *
477  * The kernel spends a lot of time changing both the top-level page directory
478  * and lower-level pagetable pages.  The Guest doesn't know physical addresses,
479  * so while it maintains these page tables exactly like normal, it also needs
480  * to keep the Host informed whenever it makes a change: the Host will create
481  * the real page tables based on the Guests'.
482  */
483
484 /* The Guest calls this to set a second-level entry (pte), ie. to map a page
485  * into a process' address space.  We set the entry then tell the Host the
486  * toplevel and address this corresponds to.  The Guest uses one pagetable per
487  * process, so we need to tell the Host which one we're changing (mm->pgd). */
488 static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
489                               pte_t *ptep, pte_t pteval)
490 {
491         *ptep = pteval;
492         lazy_hcall(LHCALL_SET_PTE, __pa(mm->pgd), addr, pteval.pte_low);
493 }
494
495 /* The Guest calls this to set a top-level entry.  Again, we set the entry then
496  * tell the Host which top-level page we changed, and the index of the entry we
497  * changed. */
498 static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
499 {
500         *pmdp = pmdval;
501         lazy_hcall(LHCALL_SET_PMD, __pa(pmdp)&PAGE_MASK,
502                    (__pa(pmdp)&(PAGE_SIZE-1))/4, 0);
503 }
504
505 /* There are a couple of legacy places where the kernel sets a PTE, but we
506  * don't know the top level any more.  This is useless for us, since we don't
507  * know which pagetable is changing or what address, so we just tell the Host
508  * to forget all of them.  Fortunately, this is very rare.
509  *
510  * ... except in early boot when the kernel sets up the initial pagetables,
511  * which makes booting astonishingly slow: 1.83 seconds!  So we don't even tell
512  * the Host anything changed until we've done the first page table switch,
513  * which brings boot back to 0.25 seconds. */
514 static void lguest_set_pte(pte_t *ptep, pte_t pteval)
515 {
516         *ptep = pteval;
517         if (cr3_changed)
518                 lazy_hcall(LHCALL_FLUSH_TLB, 1, 0, 0);
519 }
520
521 /* Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
522  * native page table operations.  On native hardware you can set a new page
523  * table entry whenever you want, but if you want to remove one you have to do
524  * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
525  *
526  * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
527  * called when a valid entry is written, not when it's removed (ie. marked not
528  * present).  Instead, this is where we come when the Guest wants to remove a
529  * page table entry: we tell the Host to set that entry to 0 (ie. the present
530  * bit is zero). */
531 static void lguest_flush_tlb_single(unsigned long addr)
532 {
533         /* Simply set it to zero: if it was not, it will fault back in. */
534         lazy_hcall(LHCALL_SET_PTE, lguest_data.pgdir, addr, 0);
535 }
536
537 /* This is what happens after the Guest has removed a large number of entries.
538  * This tells the Host that any of the page table entries for userspace might
539  * have changed, ie. virtual addresses below PAGE_OFFSET. */
540 static void lguest_flush_tlb_user(void)
541 {
542         lazy_hcall(LHCALL_FLUSH_TLB, 0, 0, 0);
543 }
544
545 /* This is called when the kernel page tables have changed.  That's not very
546  * common (unless the Guest is using highmem, which makes the Guest extremely
547  * slow), so it's worth separating this from the user flushing above. */
548 static void lguest_flush_tlb_kernel(void)
549 {
550         lazy_hcall(LHCALL_FLUSH_TLB, 1, 0, 0);
551 }
552
553 /*
554  * The Unadvanced Programmable Interrupt Controller.
555  *
556  * This is an attempt to implement the simplest possible interrupt controller.
557  * I spent some time looking though routines like set_irq_chip_and_handler,
558  * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
559  * I *think* this is as simple as it gets.
560  *
561  * We can tell the Host what interrupts we want blocked ready for using the
562  * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
563  * simple as setting a bit.  We don't actually "ack" interrupts as such, we
564  * just mask and unmask them.  I wonder if we should be cleverer?
565  */
566 static void disable_lguest_irq(unsigned int irq)
567 {
568         set_bit(irq, lguest_data.blocked_interrupts);
569 }
570
571 static void enable_lguest_irq(unsigned int irq)
572 {
573         clear_bit(irq, lguest_data.blocked_interrupts);
574 }
575
576 /* This structure describes the lguest IRQ controller. */
577 static struct irq_chip lguest_irq_controller = {
578         .name           = "lguest",
579         .mask           = disable_lguest_irq,
580         .mask_ack       = disable_lguest_irq,
581         .unmask         = enable_lguest_irq,
582 };
583
584 /* This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
585  * interrupt (except 128, which is used for system calls), and then tells the
586  * Linux infrastructure that each interrupt is controlled by our level-based
587  * lguest interrupt controller. */
588 static void __init lguest_init_IRQ(void)
589 {
590         unsigned int i;
591
592         for (i = 0; i < LGUEST_IRQS; i++) {
593                 int vector = FIRST_EXTERNAL_VECTOR + i;
594                 /* Some systems map "vectors" to interrupts weirdly.  Lguest has
595                  * a straightforward 1 to 1 mapping, so force that here. */
596                 __get_cpu_var(vector_irq)[vector] = i;
597                 if (vector != SYSCALL_VECTOR) {
598                         set_intr_gate(vector,
599                                       interrupt[vector-FIRST_EXTERNAL_VECTOR]);
600                         set_irq_chip_and_handler_name(i, &lguest_irq_controller,
601                                                       handle_level_irq,
602                                                       "level");
603                 }
604         }
605         /* This call is required to set up for 4k stacks, where we have
606          * separate stacks for hard and soft interrupts. */
607         irq_ctx_init(smp_processor_id());
608 }
609
610 /*
611  * Time.
612  *
613  * It would be far better for everyone if the Guest had its own clock, but
614  * until then the Host gives us the time on every interrupt.
615  */
616 static unsigned long lguest_get_wallclock(void)
617 {
618         return lguest_data.time.tv_sec;
619 }
620
621 /* The TSC is an Intel thing called the Time Stamp Counter.  The Host tells us
622  * what speed it runs at, or 0 if it's unusable as a reliable clock source.
623  * This matches what we want here: if we return 0 from this function, the x86
624  * TSC clock will give up and not register itself. */
625 static unsigned long lguest_tsc_khz(void)
626 {
627         return lguest_data.tsc_khz;
628 }
629
630 /* If we can't use the TSC, the kernel falls back to our lower-priority
631  * "lguest_clock", where we read the time value given to us by the Host. */
632 static cycle_t lguest_clock_read(void)
633 {
634         unsigned long sec, nsec;
635
636         /* Since the time is in two parts (seconds and nanoseconds), we risk
637          * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
638          * and getting 99 and 0.  As Linux tends to come apart under the stress
639          * of time travel, we must be careful: */
640         do {
641                 /* First we read the seconds part. */
642                 sec = lguest_data.time.tv_sec;
643                 /* This read memory barrier tells the compiler and the CPU that
644                  * this can't be reordered: we have to complete the above
645                  * before going on. */
646                 rmb();
647                 /* Now we read the nanoseconds part. */
648                 nsec = lguest_data.time.tv_nsec;
649                 /* Make sure we've done that. */
650                 rmb();
651                 /* Now if the seconds part has changed, try again. */
652         } while (unlikely(lguest_data.time.tv_sec != sec));
653
654         /* Our lguest clock is in real nanoseconds. */
655         return sec*1000000000ULL + nsec;
656 }
657
658 /* This is the fallback clocksource: lower priority than the TSC clocksource. */
659 static struct clocksource lguest_clock = {
660         .name           = "lguest",
661         .rating         = 200,
662         .read           = lguest_clock_read,
663         .mask           = CLOCKSOURCE_MASK(64),
664         .mult           = 1 << 22,
665         .shift          = 22,
666         .flags          = CLOCK_SOURCE_IS_CONTINUOUS,
667 };
668
669 /* We also need a "struct clock_event_device": Linux asks us to set it to go
670  * off some time in the future.  Actually, James Morris figured all this out, I
671  * just applied the patch. */
672 static int lguest_clockevent_set_next_event(unsigned long delta,
673                                            struct clock_event_device *evt)
674 {
675         /* FIXME: I don't think this can ever happen, but James tells me he had
676          * to put this code in.  Maybe we should remove it now.  Anyone? */
677         if (delta < LG_CLOCK_MIN_DELTA) {
678                 if (printk_ratelimit())
679                         printk(KERN_DEBUG "%s: small delta %lu ns\n",
680                                __func__, delta);
681                 return -ETIME;
682         }
683
684         /* Please wake us this far in the future. */
685         hcall(LHCALL_SET_CLOCKEVENT, delta, 0, 0);
686         return 0;
687 }
688
689 static void lguest_clockevent_set_mode(enum clock_event_mode mode,
690                                       struct clock_event_device *evt)
691 {
692         switch (mode) {
693         case CLOCK_EVT_MODE_UNUSED:
694         case CLOCK_EVT_MODE_SHUTDOWN:
695                 /* A 0 argument shuts the clock down. */
696                 hcall(LHCALL_SET_CLOCKEVENT, 0, 0, 0);
697                 break;
698         case CLOCK_EVT_MODE_ONESHOT:
699                 /* This is what we expect. */
700                 break;
701         case CLOCK_EVT_MODE_PERIODIC:
702                 BUG();
703         case CLOCK_EVT_MODE_RESUME:
704                 break;
705         }
706 }
707
708 /* This describes our primitive timer chip. */
709 static struct clock_event_device lguest_clockevent = {
710         .name                   = "lguest",
711         .features               = CLOCK_EVT_FEAT_ONESHOT,
712         .set_next_event         = lguest_clockevent_set_next_event,
713         .set_mode               = lguest_clockevent_set_mode,
714         .rating                 = INT_MAX,
715         .mult                   = 1,
716         .shift                  = 0,
717         .min_delta_ns           = LG_CLOCK_MIN_DELTA,
718         .max_delta_ns           = LG_CLOCK_MAX_DELTA,
719 };
720
721 /* This is the Guest timer interrupt handler (hardware interrupt 0).  We just
722  * call the clockevent infrastructure and it does whatever needs doing. */
723 static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
724 {
725         unsigned long flags;
726
727         /* Don't interrupt us while this is running. */
728         local_irq_save(flags);
729         lguest_clockevent.event_handler(&lguest_clockevent);
730         local_irq_restore(flags);
731 }
732
733 /* At some point in the boot process, we get asked to set up our timing
734  * infrastructure.  The kernel doesn't expect timer interrupts before this, but
735  * we cleverly initialized the "blocked_interrupts" field of "struct
736  * lguest_data" so that timer interrupts were blocked until now. */
737 static void lguest_time_init(void)
738 {
739         /* Set up the timer interrupt (0) to go to our simple timer routine */
740         set_irq_handler(0, lguest_time_irq);
741
742         clocksource_register(&lguest_clock);
743
744         /* We can't set cpumask in the initializer: damn C limitations!  Set it
745          * here and register our timer device. */
746         lguest_clockevent.cpumask = cpumask_of(0);
747         clockevents_register_device(&lguest_clockevent);
748
749         /* Finally, we unblock the timer interrupt. */
750         enable_lguest_irq(0);
751 }
752
753 /*
754  * Miscellaneous bits and pieces.
755  *
756  * Here is an oddball collection of functions which the Guest needs for things
757  * to work.  They're pretty simple.
758  */
759
760 /* The Guest needs to tell the Host what stack it expects traps to use.  For
761  * native hardware, this is part of the Task State Segment mentioned above in
762  * lguest_load_tr_desc(), but to help hypervisors there's this special call.
763  *
764  * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
765  * segment), the privilege level (we're privilege level 1, the Host is 0 and
766  * will not tolerate us trying to use that), the stack pointer, and the number
767  * of pages in the stack. */
768 static void lguest_load_sp0(struct tss_struct *tss,
769                             struct thread_struct *thread)
770 {
771         lazy_hcall(LHCALL_SET_STACK, __KERNEL_DS|0x1, thread->sp0,
772                    THREAD_SIZE/PAGE_SIZE);
773 }
774
775 /* Let's just say, I wouldn't do debugging under a Guest. */
776 static void lguest_set_debugreg(int regno, unsigned long value)
777 {
778         /* FIXME: Implement */
779 }
780
781 /* There are times when the kernel wants to make sure that no memory writes are
782  * caught in the cache (that they've all reached real hardware devices).  This
783  * doesn't matter for the Guest which has virtual hardware.
784  *
785  * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
786  * (clflush) instruction is available and the kernel uses that.  Otherwise, it
787  * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
788  * Unlike clflush, wbinvd can only be run at privilege level 0.  So we can
789  * ignore clflush, but replace wbinvd.
790  */
791 static void lguest_wbinvd(void)
792 {
793 }
794
795 /* If the Guest expects to have an Advanced Programmable Interrupt Controller,
796  * we play dumb by ignoring writes and returning 0 for reads.  So it's no
797  * longer Programmable nor Controlling anything, and I don't think 8 lines of
798  * code qualifies for Advanced.  It will also never interrupt anything.  It
799  * does, however, allow us to get through the Linux boot code. */
800 #ifdef CONFIG_X86_LOCAL_APIC
801 static void lguest_apic_write(u32 reg, u32 v)
802 {
803 }
804
805 static u32 lguest_apic_read(u32 reg)
806 {
807         return 0;
808 }
809
810 static u64 lguest_apic_icr_read(void)
811 {
812         return 0;
813 }
814
815 static void lguest_apic_icr_write(u32 low, u32 id)
816 {
817         /* Warn to see if there's any stray references */
818         WARN_ON(1);
819 }
820
821 static void lguest_apic_wait_icr_idle(void)
822 {
823         return;
824 }
825
826 static u32 lguest_apic_safe_wait_icr_idle(void)
827 {
828         return 0;
829 }
830
831 static void set_lguest_basic_apic_ops(void)
832 {
833         apic->read = lguest_apic_read;
834         apic->write = lguest_apic_write;
835         apic->icr_read = lguest_apic_icr_read;
836         apic->icr_write = lguest_apic_icr_write;
837         apic->wait_icr_idle = lguest_apic_wait_icr_idle;
838         apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
839 };
840 #endif
841
842 /* STOP!  Until an interrupt comes in. */
843 static void lguest_safe_halt(void)
844 {
845         hcall(LHCALL_HALT, 0, 0, 0);
846 }
847
848 /* The SHUTDOWN hypercall takes a string to describe what's happening, and
849  * an argument which says whether this to restart (reboot) the Guest or not.
850  *
851  * Note that the Host always prefers that the Guest speak in physical addresses
852  * rather than virtual addresses, so we use __pa() here. */
853 static void lguest_power_off(void)
854 {
855         hcall(LHCALL_SHUTDOWN, __pa("Power down"), LGUEST_SHUTDOWN_POWEROFF, 0);
856 }
857
858 /*
859  * Panicing.
860  *
861  * Don't.  But if you did, this is what happens.
862  */
863 static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
864 {
865         hcall(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF, 0);
866         /* The hcall won't return, but to keep gcc happy, we're "done". */
867         return NOTIFY_DONE;
868 }
869
870 static struct notifier_block paniced = {
871         .notifier_call = lguest_panic
872 };
873
874 /* Setting up memory is fairly easy. */
875 static __init char *lguest_memory_setup(void)
876 {
877         /* We do this here and not earlier because lockcheck used to barf if we
878          * did it before start_kernel().  I think we fixed that, so it'd be
879          * nice to move it back to lguest_init.  Patch welcome... */
880         atomic_notifier_chain_register(&panic_notifier_list, &paniced);
881
882         /* The Linux bootloader header contains an "e820" memory map: the
883          * Launcher populated the first entry with our memory limit. */
884         e820_add_region(boot_params.e820_map[0].addr,
885                           boot_params.e820_map[0].size,
886                           boot_params.e820_map[0].type);
887
888         /* This string is for the boot messages. */
889         return "LGUEST";
890 }
891
892 /* We will eventually use the virtio console device to produce console output,
893  * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
894  * console output. */
895 static __init int early_put_chars(u32 vtermno, const char *buf, int count)
896 {
897         char scratch[17];
898         unsigned int len = count;
899
900         /* We use a nul-terminated string, so we have to make a copy.  Icky,
901          * huh? */
902         if (len > sizeof(scratch) - 1)
903                 len = sizeof(scratch) - 1;
904         scratch[len] = '\0';
905         memcpy(scratch, buf, len);
906         hcall(LHCALL_NOTIFY, __pa(scratch), 0, 0);
907
908         /* This routine returns the number of bytes actually written. */
909         return len;
910 }
911
912 /* Rebooting also tells the Host we're finished, but the RESTART flag tells the
913  * Launcher to reboot us. */
914 static void lguest_restart(char *reason)
915 {
916         hcall(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART, 0);
917 }
918
919 /*G:050
920  * Patching (Powerfully Placating Performance Pedants)
921  *
922  * We have already seen that pv_ops structures let us replace simple native
923  * instructions with calls to the appropriate back end all throughout the
924  * kernel.  This allows the same kernel to run as a Guest and as a native
925  * kernel, but it's slow because of all the indirect branches.
926  *
927  * Remember that David Wheeler quote about "Any problem in computer science can
928  * be solved with another layer of indirection"?  The rest of that quote is
929  * "... But that usually will create another problem."  This is the first of
930  * those problems.
931  *
932  * Our current solution is to allow the paravirt back end to optionally patch
933  * over the indirect calls to replace them with something more efficient.  We
934  * patch the four most commonly called functions: disable interrupts, enable
935  * interrupts, restore interrupts and save interrupts.  We usually have 6 or 10
936  * bytes to patch into: the Guest versions of these operations are small enough
937  * that we can fit comfortably.
938  *
939  * First we need assembly templates of each of the patchable Guest operations,
940  * and these are in i386_head.S. */
941
942 /*G:060 We construct a table from the assembler templates: */
943 static const struct lguest_insns
944 {
945         const char *start, *end;
946 } lguest_insns[] = {
947         [PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
948         [PARAVIRT_PATCH(pv_irq_ops.irq_enable)] = { lgstart_sti, lgend_sti },
949         [PARAVIRT_PATCH(pv_irq_ops.restore_fl)] = { lgstart_popf, lgend_popf },
950         [PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
951 };
952
953 /* Now our patch routine is fairly simple (based on the native one in
954  * paravirt.c).  If we have a replacement, we copy it in and return how much of
955  * the available space we used. */
956 static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
957                              unsigned long addr, unsigned len)
958 {
959         unsigned int insn_len;
960
961         /* Don't do anything special if we don't have a replacement */
962         if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
963                 return paravirt_patch_default(type, clobber, ibuf, addr, len);
964
965         insn_len = lguest_insns[type].end - lguest_insns[type].start;
966
967         /* Similarly if we can't fit replacement (shouldn't happen, but let's
968          * be thorough). */
969         if (len < insn_len)
970                 return paravirt_patch_default(type, clobber, ibuf, addr, len);
971
972         /* Copy in our instructions. */
973         memcpy(ibuf, lguest_insns[type].start, insn_len);
974         return insn_len;
975 }
976
977 /*G:030 Once we get to lguest_init(), we know we're a Guest.  The various
978  * pv_ops structures in the kernel provide points for (almost) every routine we
979  * have to override to avoid privileged instructions. */
980 __init void lguest_init(void)
981 {
982         /* We're under lguest, paravirt is enabled, and we're running at
983          * privilege level 1, not 0 as normal. */
984         pv_info.name = "lguest";
985         pv_info.paravirt_enabled = 1;
986         pv_info.kernel_rpl = 1;
987
988         /* We set up all the lguest overrides for sensitive operations.  These
989          * are detailed with the operations themselves. */
990
991         /* interrupt-related operations */
992         pv_irq_ops.init_IRQ = lguest_init_IRQ;
993         pv_irq_ops.save_fl = PV_CALLEE_SAVE(save_fl);
994         pv_irq_ops.restore_fl = PV_CALLEE_SAVE(restore_fl);
995         pv_irq_ops.irq_disable = PV_CALLEE_SAVE(irq_disable);
996         pv_irq_ops.irq_enable = PV_CALLEE_SAVE(irq_enable);
997         pv_irq_ops.safe_halt = lguest_safe_halt;
998
999         /* init-time operations */
1000         pv_init_ops.memory_setup = lguest_memory_setup;
1001         pv_init_ops.patch = lguest_patch;
1002
1003         /* Intercepts of various cpu instructions */
1004         pv_cpu_ops.load_gdt = lguest_load_gdt;
1005         pv_cpu_ops.cpuid = lguest_cpuid;
1006         pv_cpu_ops.load_idt = lguest_load_idt;
1007         pv_cpu_ops.iret = lguest_iret;
1008         pv_cpu_ops.load_sp0 = lguest_load_sp0;
1009         pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1010         pv_cpu_ops.set_ldt = lguest_set_ldt;
1011         pv_cpu_ops.load_tls = lguest_load_tls;
1012         pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1013         pv_cpu_ops.clts = lguest_clts;
1014         pv_cpu_ops.read_cr0 = lguest_read_cr0;
1015         pv_cpu_ops.write_cr0 = lguest_write_cr0;
1016         pv_cpu_ops.read_cr4 = lguest_read_cr4;
1017         pv_cpu_ops.write_cr4 = lguest_write_cr4;
1018         pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1019         pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1020         pv_cpu_ops.wbinvd = lguest_wbinvd;
1021         pv_cpu_ops.lazy_mode.enter = paravirt_enter_lazy_cpu;
1022         pv_cpu_ops.lazy_mode.leave = lguest_leave_lazy_mode;
1023
1024         /* pagetable management */
1025         pv_mmu_ops.write_cr3 = lguest_write_cr3;
1026         pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1027         pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1028         pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1029         pv_mmu_ops.set_pte = lguest_set_pte;
1030         pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1031         pv_mmu_ops.set_pmd = lguest_set_pmd;
1032         pv_mmu_ops.read_cr2 = lguest_read_cr2;
1033         pv_mmu_ops.read_cr3 = lguest_read_cr3;
1034         pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
1035         pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mode;
1036
1037 #ifdef CONFIG_X86_LOCAL_APIC
1038         /* apic read/write intercepts */
1039         set_lguest_basic_apic_ops();
1040 #endif
1041
1042         /* time operations */
1043         pv_time_ops.get_wallclock = lguest_get_wallclock;
1044         pv_time_ops.time_init = lguest_time_init;
1045         pv_time_ops.get_tsc_khz = lguest_tsc_khz;
1046
1047         /* Now is a good time to look at the implementations of these functions
1048          * before returning to the rest of lguest_init(). */
1049
1050         /*G:070 Now we've seen all the paravirt_ops, we return to
1051          * lguest_init() where the rest of the fairly chaotic boot setup
1052          * occurs. */
1053
1054         /* The native boot code sets up initial page tables immediately after
1055          * the kernel itself, and sets init_pg_tables_end so they're not
1056          * clobbered.  The Launcher places our initial pagetables somewhere at
1057          * the top of our physical memory, so we don't need extra space: set
1058          * init_pg_tables_end to the end of the kernel. */
1059         init_pg_tables_start = __pa(pg0);
1060         init_pg_tables_end = __pa(pg0);
1061
1062         /* As described in head_32.S, we map the first 128M of memory. */
1063         max_pfn_mapped = (128*1024*1024) >> PAGE_SHIFT;
1064
1065         /* Load the %fs segment register (the per-cpu segment register) with
1066          * the normal data segment to get through booting. */
1067         asm volatile ("mov %0, %%fs" : : "r" (__KERNEL_DS) : "memory");
1068
1069         /* The Host<->Guest Switcher lives at the top of our address space, and
1070          * the Host told us how big it is when we made LGUEST_INIT hypercall:
1071          * it put the answer in lguest_data.reserve_mem  */
1072         reserve_top_address(lguest_data.reserve_mem);
1073
1074         /* If we don't initialize the lock dependency checker now, it crashes
1075          * paravirt_disable_iospace. */
1076         lockdep_init();
1077
1078         /* The IDE code spends about 3 seconds probing for disks: if we reserve
1079          * all the I/O ports up front it can't get them and so doesn't probe.
1080          * Other device drivers are similar (but less severe).  This cuts the
1081          * kernel boot time on my machine from 4.1 seconds to 0.45 seconds. */
1082         paravirt_disable_iospace();
1083
1084         /* This is messy CPU setup stuff which the native boot code does before
1085          * start_kernel, so we have to do, too: */
1086         cpu_detect(&new_cpu_data);
1087         /* head.S usually sets up the first capability word, so do it here. */
1088         new_cpu_data.x86_capability[0] = cpuid_edx(1);
1089
1090         /* Math is always hard! */
1091         new_cpu_data.hard_math = 1;
1092
1093         /* We don't have features.  We have puppies!  Puppies! */
1094 #ifdef CONFIG_X86_MCE
1095         mce_disabled = 1;
1096 #endif
1097 #ifdef CONFIG_ACPI
1098         acpi_disabled = 1;
1099         acpi_ht = 0;
1100 #endif
1101
1102         /* We set the preferred console to "hvc".  This is the "hypervisor
1103          * virtual console" driver written by the PowerPC people, which we also
1104          * adapted for lguest's use. */
1105         add_preferred_console("hvc", 0, NULL);
1106
1107         /* Register our very early console. */
1108         virtio_cons_early_init(early_put_chars);
1109
1110         /* Last of all, we set the power management poweroff hook to point to
1111          * the Guest routine to power off, and the reboot hook to our restart
1112          * routine. */
1113         pm_power_off = lguest_power_off;
1114         machine_ops.restart = lguest_restart;
1115
1116         /* Now we're set up, call i386_start_kernel() in head32.c and we proceed
1117          * to boot as normal.  It never returns. */
1118         i386_start_kernel();
1119 }
1120 /*
1121  * This marks the end of stage II of our journey, The Guest.
1122  *
1123  * It is now time for us to explore the layer of virtual drivers and complete
1124  * our understanding of the Guest in "make Drivers".
1125  */