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