lguest: Fix translation count about wikipedia's cpuid page
[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/virtual/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 /*
29  * Copyright (C) 2006, Rusty Russell <rusty@rustcorp.com.au> IBM Corporation.
30  *
31  * This program is free software; you can redistribute it and/or modify
32  * it under the terms of the GNU General Public License as published by
33  * the Free Software Foundation; either version 2 of the License, or
34  * (at your option) any later version.
35  *
36  * This program is distributed in the hope that it will be useful, but
37  * WITHOUT ANY WARRANTY; without even the implied warranty of
38  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
39  * NON INFRINGEMENT.  See the GNU General Public License for more
40  * details.
41  *
42  * You should have received a copy of the GNU General Public License
43  * along with this program; if not, write to the Free Software
44  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
45  */
46 #include <linux/kernel.h>
47 #include <linux/start_kernel.h>
48 #include <linux/string.h>
49 #include <linux/console.h>
50 #include <linux/screen_info.h>
51 #include <linux/irq.h>
52 #include <linux/interrupt.h>
53 #include <linux/clocksource.h>
54 #include <linux/clockchips.h>
55 #include <linux/lguest.h>
56 #include <linux/lguest_launcher.h>
57 #include <linux/virtio_console.h>
58 #include <linux/pm.h>
59 #include <asm/apic.h>
60 #include <asm/lguest.h>
61 #include <asm/paravirt.h>
62 #include <asm/param.h>
63 #include <asm/page.h>
64 #include <asm/pgtable.h>
65 #include <asm/desc.h>
66 #include <asm/setup.h>
67 #include <asm/e820.h>
68 #include <asm/mce.h>
69 #include <asm/io.h>
70 #include <asm/i387.h>
71 #include <asm/stackprotector.h>
72 #include <asm/reboot.h>         /* for struct machine_ops */
73
74 /*G:010
75  * Welcome to the Guest!
76  *
77  * The Guest in our tale is a simple creature: identical to the Host but
78  * behaving in simplified but equivalent ways.  In particular, the Guest is the
79  * same kernel as the Host (or at least, built from the same source code).
80 :*/
81
82 struct lguest_data lguest_data = {
83         .hcall_status = { [0 ... LHCALL_RING_SIZE-1] = 0xFF },
84         .noirq_start = (u32)lguest_noirq_start,
85         .noirq_end = (u32)lguest_noirq_end,
86         .kernel_address = PAGE_OFFSET,
87         .blocked_interrupts = { 1 }, /* Block timer interrupts */
88         .syscall_vec = SYSCALL_VECTOR,
89 };
90
91 /*G:037
92  * async_hcall() is pretty simple: I'm quite proud of it really.  We have a
93  * ring buffer of stored hypercalls which the Host will run though next time we
94  * do a normal hypercall.  Each entry in the ring has 5 slots for the hypercall
95  * arguments, and a "hcall_status" word which is 0 if the call is ready to go,
96  * and 255 once the Host has finished with it.
97  *
98  * If we come around to a slot which hasn't been finished, then the table is
99  * full and we just make the hypercall directly.  This has the nice side
100  * effect of causing the Host to run all the stored calls in the ring buffer
101  * which empties it for next time!
102  */
103 static void async_hcall(unsigned long call, unsigned long arg1,
104                         unsigned long arg2, unsigned long arg3,
105                         unsigned long arg4)
106 {
107         /* Note: This code assumes we're uniprocessor. */
108         static unsigned int next_call;
109         unsigned long flags;
110
111         /*
112          * Disable interrupts if not already disabled: we don't want an
113          * interrupt handler making a hypercall while we're already doing
114          * one!
115          */
116         local_irq_save(flags);
117         if (lguest_data.hcall_status[next_call] != 0xFF) {
118                 /* Table full, so do normal hcall which will flush table. */
119                 hcall(call, arg1, arg2, arg3, arg4);
120         } else {
121                 lguest_data.hcalls[next_call].arg0 = call;
122                 lguest_data.hcalls[next_call].arg1 = arg1;
123                 lguest_data.hcalls[next_call].arg2 = arg2;
124                 lguest_data.hcalls[next_call].arg3 = arg3;
125                 lguest_data.hcalls[next_call].arg4 = arg4;
126                 /* Arguments must all be written before we mark it to go */
127                 wmb();
128                 lguest_data.hcall_status[next_call] = 0;
129                 if (++next_call == LHCALL_RING_SIZE)
130                         next_call = 0;
131         }
132         local_irq_restore(flags);
133 }
134
135 /*G:035
136  * Notice the lazy_hcall() above, rather than hcall().  This is our first real
137  * optimization trick!
138  *
139  * When lazy_mode is set, it means we're allowed to defer all hypercalls and do
140  * them as a batch when lazy_mode is eventually turned off.  Because hypercalls
141  * are reasonably expensive, batching them up makes sense.  For example, a
142  * large munmap might update dozens of page table entries: that code calls
143  * paravirt_enter_lazy_mmu(), does the dozen updates, then calls
144  * lguest_leave_lazy_mode().
145  *
146  * So, when we're in lazy mode, we call async_hcall() to store the call for
147  * future processing:
148  */
149 static void lazy_hcall1(unsigned long call, unsigned long arg1)
150 {
151         if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
152                 hcall(call, arg1, 0, 0, 0);
153         else
154                 async_hcall(call, arg1, 0, 0, 0);
155 }
156
157 /* You can imagine what lazy_hcall2, 3 and 4 look like. :*/
158 static void lazy_hcall2(unsigned long call,
159                         unsigned long arg1,
160                         unsigned long arg2)
161 {
162         if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
163                 hcall(call, arg1, arg2, 0, 0);
164         else
165                 async_hcall(call, arg1, arg2, 0, 0);
166 }
167
168 static void lazy_hcall3(unsigned long call,
169                         unsigned long arg1,
170                         unsigned long arg2,
171                         unsigned long arg3)
172 {
173         if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
174                 hcall(call, arg1, arg2, arg3, 0);
175         else
176                 async_hcall(call, arg1, arg2, arg3, 0);
177 }
178
179 #ifdef CONFIG_X86_PAE
180 static void lazy_hcall4(unsigned long call,
181                         unsigned long arg1,
182                         unsigned long arg2,
183                         unsigned long arg3,
184                         unsigned long arg4)
185 {
186         if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
187                 hcall(call, arg1, arg2, arg3, arg4);
188         else
189                 async_hcall(call, arg1, arg2, arg3, arg4);
190 }
191 #endif
192
193 /*G:036
194  * When lazy mode is turned off, we issue the do-nothing hypercall to
195  * flush any stored calls, and call the generic helper to reset the
196  * per-cpu lazy mode variable.
197  */
198 static void lguest_leave_lazy_mmu_mode(void)
199 {
200         hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
201         paravirt_leave_lazy_mmu();
202 }
203
204 /*
205  * We also catch the end of context switch; we enter lazy mode for much of
206  * that too, so again we need to flush here.
207  *
208  * (Technically, this is lazy CPU mode, and normally we're in lazy MMU
209  * mode, but unlike Xen, lguest doesn't care about the difference).
210  */
211 static void lguest_end_context_switch(struct task_struct *next)
212 {
213         hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
214         paravirt_end_context_switch(next);
215 }
216
217 /*G:032
218  * After that diversion we return to our first native-instruction
219  * replacements: four functions for interrupt control.
220  *
221  * The simplest way of implementing these would be to have "turn interrupts
222  * off" and "turn interrupts on" hypercalls.  Unfortunately, this is too slow:
223  * these are by far the most commonly called functions of those we override.
224  *
225  * So instead we keep an "irq_enabled" field inside our "struct lguest_data",
226  * which the Guest can update with a single instruction.  The Host knows to
227  * check there before it tries to deliver an interrupt.
228  */
229
230 /*
231  * save_flags() is expected to return the processor state (ie. "flags").  The
232  * flags word contains all kind of stuff, but in practice Linux only cares
233  * about the interrupt flag.  Our "save_flags()" just returns that.
234  */
235 static unsigned long save_fl(void)
236 {
237         return lguest_data.irq_enabled;
238 }
239
240 /* Interrupts go off... */
241 static void irq_disable(void)
242 {
243         lguest_data.irq_enabled = 0;
244 }
245
246 /*
247  * Let's pause a moment.  Remember how I said these are called so often?
248  * Jeremy Fitzhardinge optimized them so hard early in 2009 that he had to
249  * break some rules.  In particular, these functions are assumed to save their
250  * own registers if they need to: normal C functions assume they can trash the
251  * eax register.  To use normal C functions, we use
252  * PV_CALLEE_SAVE_REGS_THUNK(), which pushes %eax onto the stack, calls the
253  * C function, then restores it.
254  */
255 PV_CALLEE_SAVE_REGS_THUNK(save_fl);
256 PV_CALLEE_SAVE_REGS_THUNK(irq_disable);
257 /*:*/
258
259 /* These are in i386_head.S */
260 extern void lg_irq_enable(void);
261 extern void lg_restore_fl(unsigned long flags);
262
263 /*M:003
264  * We could be more efficient in our checking of outstanding interrupts, rather
265  * than using a branch.  One way would be to put the "irq_enabled" field in a
266  * page by itself, and have the Host write-protect it when an interrupt comes
267  * in when irqs are disabled.  There will then be a page fault as soon as
268  * interrupts are re-enabled.
269  *
270  * A better method is to implement soft interrupt disable generally for x86:
271  * instead of disabling interrupts, we set a flag.  If an interrupt does come
272  * in, we then disable them for real.  This is uncommon, so we could simply use
273  * a hypercall for interrupt control and not worry about efficiency.
274 :*/
275
276 /*G:034
277  * The Interrupt Descriptor Table (IDT).
278  *
279  * The IDT tells the processor what to do when an interrupt comes in.  Each
280  * entry in the table is a 64-bit descriptor: this holds the privilege level,
281  * address of the handler, and... well, who cares?  The Guest just asks the
282  * Host to make the change anyway, because the Host controls the real IDT.
283  */
284 static void lguest_write_idt_entry(gate_desc *dt,
285                                    int entrynum, const gate_desc *g)
286 {
287         /*
288          * The gate_desc structure is 8 bytes long: we hand it to the Host in
289          * two 32-bit chunks.  The whole 32-bit kernel used to hand descriptors
290          * around like this; typesafety wasn't a big concern in Linux's early
291          * years.
292          */
293         u32 *desc = (u32 *)g;
294         /* Keep the local copy up to date. */
295         native_write_idt_entry(dt, entrynum, g);
296         /* Tell Host about this new entry. */
297         hcall(LHCALL_LOAD_IDT_ENTRY, entrynum, desc[0], desc[1], 0);
298 }
299
300 /*
301  * Changing to a different IDT is very rare: we keep the IDT up-to-date every
302  * time it is written, so we can simply loop through all entries and tell the
303  * Host about them.
304  */
305 static void lguest_load_idt(const struct desc_ptr *desc)
306 {
307         unsigned int i;
308         struct desc_struct *idt = (void *)desc->address;
309
310         for (i = 0; i < (desc->size+1)/8; i++)
311                 hcall(LHCALL_LOAD_IDT_ENTRY, i, idt[i].a, idt[i].b, 0);
312 }
313
314 /*
315  * The Global Descriptor Table.
316  *
317  * The Intel architecture defines another table, called the Global Descriptor
318  * Table (GDT).  You tell the CPU where it is (and its size) using the "lgdt"
319  * instruction, and then several other instructions refer to entries in the
320  * table.  There are three entries which the Switcher needs, so the Host simply
321  * controls the entire thing and the Guest asks it to make changes using the
322  * LOAD_GDT hypercall.
323  *
324  * This is the exactly like the IDT code.
325  */
326 static void lguest_load_gdt(const struct desc_ptr *desc)
327 {
328         unsigned int i;
329         struct desc_struct *gdt = (void *)desc->address;
330
331         for (i = 0; i < (desc->size+1)/8; i++)
332                 hcall(LHCALL_LOAD_GDT_ENTRY, i, gdt[i].a, gdt[i].b, 0);
333 }
334
335 /*
336  * For a single GDT entry which changes, we simply change our copy and
337  * then tell the host about it.
338  */
339 static void lguest_write_gdt_entry(struct desc_struct *dt, int entrynum,
340                                    const void *desc, int type)
341 {
342         native_write_gdt_entry(dt, entrynum, desc, type);
343         /* Tell Host about this new entry. */
344         hcall(LHCALL_LOAD_GDT_ENTRY, entrynum,
345               dt[entrynum].a, dt[entrynum].b, 0);
346 }
347
348 /*
349  * There are three "thread local storage" GDT entries which change
350  * on every context switch (these three entries are how glibc implements
351  * __thread variables).  As an optimization, we have a hypercall
352  * specifically for this case.
353  *
354  * Wouldn't it be nicer to have a general LOAD_GDT_ENTRIES hypercall
355  * which took a range of entries?
356  */
357 static void lguest_load_tls(struct thread_struct *t, unsigned int cpu)
358 {
359         /*
360          * There's one problem which normal hardware doesn't have: the Host
361          * can't handle us removing entries we're currently using.  So we clear
362          * the GS register here: if it's needed it'll be reloaded anyway.
363          */
364         lazy_load_gs(0);
365         lazy_hcall2(LHCALL_LOAD_TLS, __pa(&t->tls_array), cpu);
366 }
367
368 /*G:038
369  * That's enough excitement for now, back to ploughing through each of the
370  * different pv_ops structures (we're about 1/3 of the way through).
371  *
372  * This is the Local Descriptor Table, another weird Intel thingy.  Linux only
373  * uses this for some strange applications like Wine.  We don't do anything
374  * here, so they'll get an informative and friendly Segmentation Fault.
375  */
376 static void lguest_set_ldt(const void *addr, unsigned entries)
377 {
378 }
379
380 /*
381  * This loads a GDT entry into the "Task Register": that entry points to a
382  * structure called the Task State Segment.  Some comments scattered though the
383  * kernel code indicate that this used for task switching in ages past, along
384  * with blood sacrifice and astrology.
385  *
386  * Now there's nothing interesting in here that we don't get told elsewhere.
387  * But the native version uses the "ltr" instruction, which makes the Host
388  * complain to the Guest about a Segmentation Fault and it'll oops.  So we
389  * override the native version with a do-nothing version.
390  */
391 static void lguest_load_tr_desc(void)
392 {
393 }
394
395 /*
396  * The "cpuid" instruction is a way of querying both the CPU identity
397  * (manufacturer, model, etc) and its features.  It was introduced before the
398  * Pentium in 1993 and keeps getting extended by both Intel, AMD and others.
399  * As you might imagine, after a decade and a half this treatment, it is now a
400  * giant ball of hair.  Its entry in the current Intel manual runs to 28 pages.
401  *
402  * This instruction even it has its own Wikipedia entry.  The Wikipedia entry
403  * has been translated into 6 languages.  I am not making this up!
404  *
405  * We could get funky here and identify ourselves as "GenuineLguest", but
406  * instead we just use the real "cpuid" instruction.  Then I pretty much turned
407  * off feature bits until the Guest booted.  (Don't say that: you'll damage
408  * lguest sales!)  Shut up, inner voice!  (Hey, just pointing out that this is
409  * hardly future proof.)  No one's listening!  They don't like you anyway,
410  * parenthetic weirdo!
411  *
412  * Replacing the cpuid so we can turn features off is great for the kernel, but
413  * anyone (including userspace) can just use the raw "cpuid" instruction and
414  * the Host won't even notice since it isn't privileged.  So we try not to get
415  * too worked up about it.
416  */
417 static void lguest_cpuid(unsigned int *ax, unsigned int *bx,
418                          unsigned int *cx, unsigned int *dx)
419 {
420         int function = *ax;
421
422         native_cpuid(ax, bx, cx, dx);
423         switch (function) {
424         /*
425          * CPUID 0 gives the highest legal CPUID number (and the ID string).
426          * We futureproof our code a little by sticking to known CPUID values.
427          */
428         case 0:
429                 if (*ax > 5)
430                         *ax = 5;
431                 break;
432
433         /*
434          * CPUID 1 is a basic feature request.
435          *
436          * CX: we only allow kernel to see SSE3, CMPXCHG16B and SSSE3
437          * DX: SSE, SSE2, FXSR, MMX, CMOV, CMPXCHG8B, TSC, FPU and PAE.
438          */
439         case 1:
440                 *cx &= 0x00002201;
441                 *dx &= 0x07808151;
442                 /*
443                  * The Host can do a nice optimization if it knows that the
444                  * kernel mappings (addresses above 0xC0000000 or whatever
445                  * PAGE_OFFSET is set to) haven't changed.  But Linux calls
446                  * flush_tlb_user() for both user and kernel mappings unless
447                  * the Page Global Enable (PGE) feature bit is set.
448                  */
449                 *dx |= 0x00002000;
450                 /*
451                  * We also lie, and say we're family id 5.  6 or greater
452                  * leads to a rdmsr in early_init_intel which we can't handle.
453                  * Family ID is returned as bits 8-12 in ax.
454                  */
455                 *ax &= 0xFFFFF0FF;
456                 *ax |= 0x00000500;
457                 break;
458         /*
459          * 0x80000000 returns the highest Extended Function, so we futureproof
460          * like we do above by limiting it to known fields.
461          */
462         case 0x80000000:
463                 if (*ax > 0x80000008)
464                         *ax = 0x80000008;
465                 break;
466
467         /*
468          * PAE systems can mark pages as non-executable.  Linux calls this the
469          * NX bit.  Intel calls it XD (eXecute Disable), AMD EVP (Enhanced
470          * Virus Protection).  We just switch it off here, since we don't
471          * support it.
472          */
473         case 0x80000001:
474                 *dx &= ~(1 << 20);
475                 break;
476         }
477 }
478
479 /*
480  * Intel has four control registers, imaginatively named cr0, cr2, cr3 and cr4.
481  * I assume there's a cr1, but it hasn't bothered us yet, so we'll not bother
482  * it.  The Host needs to know when the Guest wants to change them, so we have
483  * a whole series of functions like read_cr0() and write_cr0().
484  *
485  * We start with cr0.  cr0 allows you to turn on and off all kinds of basic
486  * features, but Linux only really cares about one: the horrifically-named Task
487  * Switched (TS) bit at bit 3 (ie. 8)
488  *
489  * What does the TS bit do?  Well, it causes the CPU to trap (interrupt 7) if
490  * the floating point unit is used.  Which allows us to restore FPU state
491  * lazily after a task switch, and Linux uses that gratefully, but wouldn't a
492  * name like "FPUTRAP bit" be a little less cryptic?
493  *
494  * We store cr0 locally because the Host never changes it.  The Guest sometimes
495  * wants to read it and we'd prefer not to bother the Host unnecessarily.
496  */
497 static unsigned long current_cr0;
498 static void lguest_write_cr0(unsigned long val)
499 {
500         lazy_hcall1(LHCALL_TS, val & X86_CR0_TS);
501         current_cr0 = val;
502 }
503
504 static unsigned long lguest_read_cr0(void)
505 {
506         return current_cr0;
507 }
508
509 /*
510  * Intel provided a special instruction to clear the TS bit for people too cool
511  * to use write_cr0() to do it.  This "clts" instruction is faster, because all
512  * the vowels have been optimized out.
513  */
514 static void lguest_clts(void)
515 {
516         lazy_hcall1(LHCALL_TS, 0);
517         current_cr0 &= ~X86_CR0_TS;
518 }
519
520 /*
521  * cr2 is the virtual address of the last page fault, which the Guest only ever
522  * reads.  The Host kindly writes this into our "struct lguest_data", so we
523  * just read it out of there.
524  */
525 static unsigned long lguest_read_cr2(void)
526 {
527         return lguest_data.cr2;
528 }
529
530 /* See lguest_set_pte() below. */
531 static bool cr3_changed = false;
532 static unsigned long current_cr3;
533
534 /*
535  * cr3 is the current toplevel pagetable page: the principle is the same as
536  * cr0.  Keep a local copy, and tell the Host when it changes.
537  */
538 static void lguest_write_cr3(unsigned long cr3)
539 {
540         lazy_hcall1(LHCALL_NEW_PGTABLE, cr3);
541         current_cr3 = cr3;
542
543         /* These two page tables are simple, linear, and used during boot */
544         if (cr3 != __pa(swapper_pg_dir) && cr3 != __pa(initial_page_table))
545                 cr3_changed = true;
546 }
547
548 static unsigned long lguest_read_cr3(void)
549 {
550         return current_cr3;
551 }
552
553 /* cr4 is used to enable and disable PGE, but we don't care. */
554 static unsigned long lguest_read_cr4(void)
555 {
556         return 0;
557 }
558
559 static void lguest_write_cr4(unsigned long val)
560 {
561 }
562
563 /*
564  * Page Table Handling.
565  *
566  * Now would be a good time to take a rest and grab a coffee or similarly
567  * relaxing stimulant.  The easy parts are behind us, and the trek gradually
568  * winds uphill from here.
569  *
570  * Quick refresher: memory is divided into "pages" of 4096 bytes each.  The CPU
571  * maps virtual addresses to physical addresses using "page tables".  We could
572  * use one huge index of 1 million entries: each address is 4 bytes, so that's
573  * 1024 pages just to hold the page tables.   But since most virtual addresses
574  * are unused, we use a two level index which saves space.  The cr3 register
575  * contains the physical address of the top level "page directory" page, which
576  * contains physical addresses of up to 1024 second-level pages.  Each of these
577  * second level pages contains up to 1024 physical addresses of actual pages,
578  * or Page Table Entries (PTEs).
579  *
580  * Here's a diagram, where arrows indicate physical addresses:
581  *
582  * cr3 ---> +---------+
583  *          |      --------->+---------+
584  *          |         |      | PADDR1  |
585  *        Mid-level   |      | PADDR2  |
586  *        (PMD) page  |      |         |
587  *          |         |    Lower-level |
588  *          |         |    (PTE) page  |
589  *          |         |      |         |
590  *            ....               ....
591  *
592  * So to convert a virtual address to a physical address, we look up the top
593  * level, which points us to the second level, which gives us the physical
594  * address of that page.  If the top level entry was not present, or the second
595  * level entry was not present, then the virtual address is invalid (we
596  * say "the page was not mapped").
597  *
598  * Put another way, a 32-bit virtual address is divided up like so:
599  *
600  *  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
601  * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
602  *    Index into top     Index into second      Offset within page
603  *  page directory page    pagetable page
604  *
605  * Now, unfortunately, this isn't the whole story: Intel added Physical Address
606  * Extension (PAE) to allow 32 bit systems to use 64GB of memory (ie. 36 bits).
607  * These are held in 64-bit page table entries, so we can now only fit 512
608  * entries in a page, and the neat three-level tree breaks down.
609  *
610  * The result is a four level page table:
611  *
612  * cr3 --> [ 4 Upper  ]
613  *         [   Level  ]
614  *         [  Entries ]
615  *         [(PUD Page)]---> +---------+
616  *                          |      --------->+---------+
617  *                          |         |      | PADDR1  |
618  *                        Mid-level   |      | PADDR2  |
619  *                        (PMD) page  |      |         |
620  *                          |         |    Lower-level |
621  *                          |         |    (PTE) page  |
622  *                          |         |      |         |
623  *                            ....               ....
624  *
625  *
626  * And the virtual address is decoded as:
627  *
628  *         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
629  *      |<-2->|<--- 9 bits ---->|<---- 9 bits --->|<------ 12 bits ------>|
630  * Index into    Index into mid    Index into lower    Offset within page
631  * top entries   directory page     pagetable page
632  *
633  * It's too hard to switch between these two formats at runtime, so Linux only
634  * supports one or the other depending on whether CONFIG_X86_PAE is set.  Many
635  * distributions turn it on, and not just for people with silly amounts of
636  * memory: the larger PTE entries allow room for the NX bit, which lets the
637  * kernel disable execution of pages and increase security.
638  *
639  * This was a problem for lguest, which couldn't run on these distributions;
640  * then Matias Zabaljauregui figured it all out and implemented it, and only a
641  * handful of puppies were crushed in the process!
642  *
643  * Back to our point: the kernel spends a lot of time changing both the
644  * top-level page directory and lower-level pagetable pages.  The Guest doesn't
645  * know physical addresses, so while it maintains these page tables exactly
646  * like normal, it also needs to keep the Host informed whenever it makes a
647  * change: the Host will create the real page tables based on the Guests'.
648  */
649
650 /*
651  * The Guest calls this after it has set a second-level entry (pte), ie. to map
652  * a page into a process' address space.  We tell the Host the toplevel and
653  * address this corresponds to.  The Guest uses one pagetable per process, so
654  * we need to tell the Host which one we're changing (mm->pgd).
655  */
656 static void lguest_pte_update(struct mm_struct *mm, unsigned long addr,
657                                pte_t *ptep)
658 {
659 #ifdef CONFIG_X86_PAE
660         /* PAE needs to hand a 64 bit page table entry, so it uses two args. */
661         lazy_hcall4(LHCALL_SET_PTE, __pa(mm->pgd), addr,
662                     ptep->pte_low, ptep->pte_high);
663 #else
664         lazy_hcall3(LHCALL_SET_PTE, __pa(mm->pgd), addr, ptep->pte_low);
665 #endif
666 }
667
668 /* This is the "set and update" combo-meal-deal version. */
669 static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
670                               pte_t *ptep, pte_t pteval)
671 {
672         native_set_pte(ptep, pteval);
673         lguest_pte_update(mm, addr, ptep);
674 }
675
676 /*
677  * The Guest calls lguest_set_pud to set a top-level entry and lguest_set_pmd
678  * to set a middle-level entry when PAE is activated.
679  *
680  * Again, we set the entry then tell the Host which page we changed,
681  * and the index of the entry we changed.
682  */
683 #ifdef CONFIG_X86_PAE
684 static void lguest_set_pud(pud_t *pudp, pud_t pudval)
685 {
686         native_set_pud(pudp, pudval);
687
688         /* 32 bytes aligned pdpt address and the index. */
689         lazy_hcall2(LHCALL_SET_PGD, __pa(pudp) & 0xFFFFFFE0,
690                    (__pa(pudp) & 0x1F) / sizeof(pud_t));
691 }
692
693 static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
694 {
695         native_set_pmd(pmdp, pmdval);
696         lazy_hcall2(LHCALL_SET_PMD, __pa(pmdp) & PAGE_MASK,
697                    (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
698 }
699 #else
700
701 /* The Guest calls lguest_set_pmd to set a top-level entry when !PAE. */
702 static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
703 {
704         native_set_pmd(pmdp, pmdval);
705         lazy_hcall2(LHCALL_SET_PGD, __pa(pmdp) & PAGE_MASK,
706                    (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
707 }
708 #endif
709
710 /*
711  * There are a couple of legacy places where the kernel sets a PTE, but we
712  * don't know the top level any more.  This is useless for us, since we don't
713  * know which pagetable is changing or what address, so we just tell the Host
714  * to forget all of them.  Fortunately, this is very rare.
715  *
716  * ... except in early boot when the kernel sets up the initial pagetables,
717  * which makes booting astonishingly slow: 48 seconds!  So we don't even tell
718  * the Host anything changed until we've done the first real page table switch,
719  * which brings boot back to 4.3 seconds.
720  */
721 static void lguest_set_pte(pte_t *ptep, pte_t pteval)
722 {
723         native_set_pte(ptep, pteval);
724         if (cr3_changed)
725                 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
726 }
727
728 #ifdef CONFIG_X86_PAE
729 /*
730  * With 64-bit PTE values, we need to be careful setting them: if we set 32
731  * bits at a time, the hardware could see a weird half-set entry.  These
732  * versions ensure we update all 64 bits at once.
733  */
734 static void lguest_set_pte_atomic(pte_t *ptep, pte_t pte)
735 {
736         native_set_pte_atomic(ptep, pte);
737         if (cr3_changed)
738                 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
739 }
740
741 static void lguest_pte_clear(struct mm_struct *mm, unsigned long addr,
742                              pte_t *ptep)
743 {
744         native_pte_clear(mm, addr, ptep);
745         lguest_pte_update(mm, addr, ptep);
746 }
747
748 static void lguest_pmd_clear(pmd_t *pmdp)
749 {
750         lguest_set_pmd(pmdp, __pmd(0));
751 }
752 #endif
753
754 /*
755  * Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
756  * native page table operations.  On native hardware you can set a new page
757  * table entry whenever you want, but if you want to remove one you have to do
758  * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
759  *
760  * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
761  * called when a valid entry is written, not when it's removed (ie. marked not
762  * present).  Instead, this is where we come when the Guest wants to remove a
763  * page table entry: we tell the Host to set that entry to 0 (ie. the present
764  * bit is zero).
765  */
766 static void lguest_flush_tlb_single(unsigned long addr)
767 {
768         /* Simply set it to zero: if it was not, it will fault back in. */
769         lazy_hcall3(LHCALL_SET_PTE, current_cr3, addr, 0);
770 }
771
772 /*
773  * This is what happens after the Guest has removed a large number of entries.
774  * This tells the Host that any of the page table entries for userspace might
775  * have changed, ie. virtual addresses below PAGE_OFFSET.
776  */
777 static void lguest_flush_tlb_user(void)
778 {
779         lazy_hcall1(LHCALL_FLUSH_TLB, 0);
780 }
781
782 /*
783  * This is called when the kernel page tables have changed.  That's not very
784  * common (unless the Guest is using highmem, which makes the Guest extremely
785  * slow), so it's worth separating this from the user flushing above.
786  */
787 static void lguest_flush_tlb_kernel(void)
788 {
789         lazy_hcall1(LHCALL_FLUSH_TLB, 1);
790 }
791
792 /*
793  * The Unadvanced Programmable Interrupt Controller.
794  *
795  * This is an attempt to implement the simplest possible interrupt controller.
796  * I spent some time looking though routines like set_irq_chip_and_handler,
797  * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
798  * I *think* this is as simple as it gets.
799  *
800  * We can tell the Host what interrupts we want blocked ready for using the
801  * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
802  * simple as setting a bit.  We don't actually "ack" interrupts as such, we
803  * just mask and unmask them.  I wonder if we should be cleverer?
804  */
805 static void disable_lguest_irq(struct irq_data *data)
806 {
807         set_bit(data->irq, lguest_data.blocked_interrupts);
808 }
809
810 static void enable_lguest_irq(struct irq_data *data)
811 {
812         clear_bit(data->irq, lguest_data.blocked_interrupts);
813 }
814
815 /* This structure describes the lguest IRQ controller. */
816 static struct irq_chip lguest_irq_controller = {
817         .name           = "lguest",
818         .irq_mask       = disable_lguest_irq,
819         .irq_mask_ack   = disable_lguest_irq,
820         .irq_unmask     = enable_lguest_irq,
821 };
822
823 /*
824  * This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
825  * interrupt (except 128, which is used for system calls), and then tells the
826  * Linux infrastructure that each interrupt is controlled by our level-based
827  * lguest interrupt controller.
828  */
829 static void __init lguest_init_IRQ(void)
830 {
831         unsigned int i;
832
833         for (i = FIRST_EXTERNAL_VECTOR; i < NR_VECTORS; i++) {
834                 /* Some systems map "vectors" to interrupts weirdly.  Not us! */
835                 __this_cpu_write(vector_irq[i], i - FIRST_EXTERNAL_VECTOR);
836                 if (i != SYSCALL_VECTOR)
837                         set_intr_gate(i, interrupt[i - FIRST_EXTERNAL_VECTOR]);
838         }
839
840         /*
841          * This call is required to set up for 4k stacks, where we have
842          * separate stacks for hard and soft interrupts.
843          */
844         irq_ctx_init(smp_processor_id());
845 }
846
847 /*
848  * With CONFIG_SPARSE_IRQ, interrupt descriptors are allocated as-needed, so
849  * rather than set them in lguest_init_IRQ we are called here every time an
850  * lguest device needs an interrupt.
851  *
852  * FIXME: irq_alloc_desc_at() can fail due to lack of memory, we should
853  * pass that up!
854  */
855 void lguest_setup_irq(unsigned int irq)
856 {
857         irq_alloc_desc_at(irq, 0);
858         irq_set_chip_and_handler_name(irq, &lguest_irq_controller,
859                                       handle_level_irq, "level");
860 }
861
862 /*
863  * Time.
864  *
865  * It would be far better for everyone if the Guest had its own clock, but
866  * until then the Host gives us the time on every interrupt.
867  */
868 static unsigned long lguest_get_wallclock(void)
869 {
870         return lguest_data.time.tv_sec;
871 }
872
873 /*
874  * The TSC is an Intel thing called the Time Stamp Counter.  The Host tells us
875  * what speed it runs at, or 0 if it's unusable as a reliable clock source.
876  * This matches what we want here: if we return 0 from this function, the x86
877  * TSC clock will give up and not register itself.
878  */
879 static unsigned long lguest_tsc_khz(void)
880 {
881         return lguest_data.tsc_khz;
882 }
883
884 /*
885  * If we can't use the TSC, the kernel falls back to our lower-priority
886  * "lguest_clock", where we read the time value given to us by the Host.
887  */
888 static cycle_t lguest_clock_read(struct clocksource *cs)
889 {
890         unsigned long sec, nsec;
891
892         /*
893          * Since the time is in two parts (seconds and nanoseconds), we risk
894          * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
895          * and getting 99 and 0.  As Linux tends to come apart under the stress
896          * of time travel, we must be careful:
897          */
898         do {
899                 /* First we read the seconds part. */
900                 sec = lguest_data.time.tv_sec;
901                 /*
902                  * This read memory barrier tells the compiler and the CPU that
903                  * this can't be reordered: we have to complete the above
904                  * before going on.
905                  */
906                 rmb();
907                 /* Now we read the nanoseconds part. */
908                 nsec = lguest_data.time.tv_nsec;
909                 /* Make sure we've done that. */
910                 rmb();
911                 /* Now if the seconds part has changed, try again. */
912         } while (unlikely(lguest_data.time.tv_sec != sec));
913
914         /* Our lguest clock is in real nanoseconds. */
915         return sec*1000000000ULL + nsec;
916 }
917
918 /* This is the fallback clocksource: lower priority than the TSC clocksource. */
919 static struct clocksource lguest_clock = {
920         .name           = "lguest",
921         .rating         = 200,
922         .read           = lguest_clock_read,
923         .mask           = CLOCKSOURCE_MASK(64),
924         .flags          = CLOCK_SOURCE_IS_CONTINUOUS,
925 };
926
927 /*
928  * We also need a "struct clock_event_device": Linux asks us to set it to go
929  * off some time in the future.  Actually, James Morris figured all this out, I
930  * just applied the patch.
931  */
932 static int lguest_clockevent_set_next_event(unsigned long delta,
933                                            struct clock_event_device *evt)
934 {
935         /* FIXME: I don't think this can ever happen, but James tells me he had
936          * to put this code in.  Maybe we should remove it now.  Anyone? */
937         if (delta < LG_CLOCK_MIN_DELTA) {
938                 if (printk_ratelimit())
939                         printk(KERN_DEBUG "%s: small delta %lu ns\n",
940                                __func__, delta);
941                 return -ETIME;
942         }
943
944         /* Please wake us this far in the future. */
945         hcall(LHCALL_SET_CLOCKEVENT, delta, 0, 0, 0);
946         return 0;
947 }
948
949 static void lguest_clockevent_set_mode(enum clock_event_mode mode,
950                                       struct clock_event_device *evt)
951 {
952         switch (mode) {
953         case CLOCK_EVT_MODE_UNUSED:
954         case CLOCK_EVT_MODE_SHUTDOWN:
955                 /* A 0 argument shuts the clock down. */
956                 hcall(LHCALL_SET_CLOCKEVENT, 0, 0, 0, 0);
957                 break;
958         case CLOCK_EVT_MODE_ONESHOT:
959                 /* This is what we expect. */
960                 break;
961         case CLOCK_EVT_MODE_PERIODIC:
962                 BUG();
963         case CLOCK_EVT_MODE_RESUME:
964                 break;
965         }
966 }
967
968 /* This describes our primitive timer chip. */
969 static struct clock_event_device lguest_clockevent = {
970         .name                   = "lguest",
971         .features               = CLOCK_EVT_FEAT_ONESHOT,
972         .set_next_event         = lguest_clockevent_set_next_event,
973         .set_mode               = lguest_clockevent_set_mode,
974         .rating                 = INT_MAX,
975         .mult                   = 1,
976         .shift                  = 0,
977         .min_delta_ns           = LG_CLOCK_MIN_DELTA,
978         .max_delta_ns           = LG_CLOCK_MAX_DELTA,
979 };
980
981 /*
982  * This is the Guest timer interrupt handler (hardware interrupt 0).  We just
983  * call the clockevent infrastructure and it does whatever needs doing.
984  */
985 static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
986 {
987         unsigned long flags;
988
989         /* Don't interrupt us while this is running. */
990         local_irq_save(flags);
991         lguest_clockevent.event_handler(&lguest_clockevent);
992         local_irq_restore(flags);
993 }
994
995 /*
996  * At some point in the boot process, we get asked to set up our timing
997  * infrastructure.  The kernel doesn't expect timer interrupts before this, but
998  * we cleverly initialized the "blocked_interrupts" field of "struct
999  * lguest_data" so that timer interrupts were blocked until now.
1000  */
1001 static void lguest_time_init(void)
1002 {
1003         /* Set up the timer interrupt (0) to go to our simple timer routine */
1004         lguest_setup_irq(0);
1005         irq_set_handler(0, lguest_time_irq);
1006
1007         clocksource_register_hz(&lguest_clock, NSEC_PER_SEC);
1008
1009         /* We can't set cpumask in the initializer: damn C limitations!  Set it
1010          * here and register our timer device. */
1011         lguest_clockevent.cpumask = cpumask_of(0);
1012         clockevents_register_device(&lguest_clockevent);
1013
1014         /* Finally, we unblock the timer interrupt. */
1015         clear_bit(0, lguest_data.blocked_interrupts);
1016 }
1017
1018 /*
1019  * Miscellaneous bits and pieces.
1020  *
1021  * Here is an oddball collection of functions which the Guest needs for things
1022  * to work.  They're pretty simple.
1023  */
1024
1025 /*
1026  * The Guest needs to tell the Host what stack it expects traps to use.  For
1027  * native hardware, this is part of the Task State Segment mentioned above in
1028  * lguest_load_tr_desc(), but to help hypervisors there's this special call.
1029  *
1030  * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
1031  * segment), the privilege level (we're privilege level 1, the Host is 0 and
1032  * will not tolerate us trying to use that), the stack pointer, and the number
1033  * of pages in the stack.
1034  */
1035 static void lguest_load_sp0(struct tss_struct *tss,
1036                             struct thread_struct *thread)
1037 {
1038         lazy_hcall3(LHCALL_SET_STACK, __KERNEL_DS | 0x1, thread->sp0,
1039                    THREAD_SIZE / PAGE_SIZE);
1040 }
1041
1042 /* Let's just say, I wouldn't do debugging under a Guest. */
1043 static void lguest_set_debugreg(int regno, unsigned long value)
1044 {
1045         /* FIXME: Implement */
1046 }
1047
1048 /*
1049  * There are times when the kernel wants to make sure that no memory writes are
1050  * caught in the cache (that they've all reached real hardware devices).  This
1051  * doesn't matter for the Guest which has virtual hardware.
1052  *
1053  * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
1054  * (clflush) instruction is available and the kernel uses that.  Otherwise, it
1055  * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
1056  * Unlike clflush, wbinvd can only be run at privilege level 0.  So we can
1057  * ignore clflush, but replace wbinvd.
1058  */
1059 static void lguest_wbinvd(void)
1060 {
1061 }
1062
1063 /*
1064  * If the Guest expects to have an Advanced Programmable Interrupt Controller,
1065  * we play dumb by ignoring writes and returning 0 for reads.  So it's no
1066  * longer Programmable nor Controlling anything, and I don't think 8 lines of
1067  * code qualifies for Advanced.  It will also never interrupt anything.  It
1068  * does, however, allow us to get through the Linux boot code.
1069  */
1070 #ifdef CONFIG_X86_LOCAL_APIC
1071 static void lguest_apic_write(u32 reg, u32 v)
1072 {
1073 }
1074
1075 static u32 lguest_apic_read(u32 reg)
1076 {
1077         return 0;
1078 }
1079
1080 static u64 lguest_apic_icr_read(void)
1081 {
1082         return 0;
1083 }
1084
1085 static void lguest_apic_icr_write(u32 low, u32 id)
1086 {
1087         /* Warn to see if there's any stray references */
1088         WARN_ON(1);
1089 }
1090
1091 static void lguest_apic_wait_icr_idle(void)
1092 {
1093         return;
1094 }
1095
1096 static u32 lguest_apic_safe_wait_icr_idle(void)
1097 {
1098         return 0;
1099 }
1100
1101 static void set_lguest_basic_apic_ops(void)
1102 {
1103         apic->read = lguest_apic_read;
1104         apic->write = lguest_apic_write;
1105         apic->icr_read = lguest_apic_icr_read;
1106         apic->icr_write = lguest_apic_icr_write;
1107         apic->wait_icr_idle = lguest_apic_wait_icr_idle;
1108         apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
1109 };
1110 #endif
1111
1112 /* STOP!  Until an interrupt comes in. */
1113 static void lguest_safe_halt(void)
1114 {
1115         hcall(LHCALL_HALT, 0, 0, 0, 0);
1116 }
1117
1118 /*
1119  * The SHUTDOWN hypercall takes a string to describe what's happening, and
1120  * an argument which says whether this to restart (reboot) the Guest or not.
1121  *
1122  * Note that the Host always prefers that the Guest speak in physical addresses
1123  * rather than virtual addresses, so we use __pa() here.
1124  */
1125 static void lguest_power_off(void)
1126 {
1127         hcall(LHCALL_SHUTDOWN, __pa("Power down"),
1128               LGUEST_SHUTDOWN_POWEROFF, 0, 0);
1129 }
1130
1131 /*
1132  * Panicing.
1133  *
1134  * Don't.  But if you did, this is what happens.
1135  */
1136 static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
1137 {
1138         hcall(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF, 0, 0);
1139         /* The hcall won't return, but to keep gcc happy, we're "done". */
1140         return NOTIFY_DONE;
1141 }
1142
1143 static struct notifier_block paniced = {
1144         .notifier_call = lguest_panic
1145 };
1146
1147 /* Setting up memory is fairly easy. */
1148 static __init char *lguest_memory_setup(void)
1149 {
1150         /*
1151          * The Linux bootloader header contains an "e820" memory map: the
1152          * Launcher populated the first entry with our memory limit.
1153          */
1154         e820_add_region(boot_params.e820_map[0].addr,
1155                           boot_params.e820_map[0].size,
1156                           boot_params.e820_map[0].type);
1157
1158         /* This string is for the boot messages. */
1159         return "LGUEST";
1160 }
1161
1162 /*
1163  * We will eventually use the virtio console device to produce console output,
1164  * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
1165  * console output.
1166  */
1167 static __init int early_put_chars(u32 vtermno, const char *buf, int count)
1168 {
1169         char scratch[17];
1170         unsigned int len = count;
1171
1172         /* We use a nul-terminated string, so we make a copy.  Icky, huh? */
1173         if (len > sizeof(scratch) - 1)
1174                 len = sizeof(scratch) - 1;
1175         scratch[len] = '\0';
1176         memcpy(scratch, buf, len);
1177         hcall(LHCALL_NOTIFY, __pa(scratch), 0, 0, 0);
1178
1179         /* This routine returns the number of bytes actually written. */
1180         return len;
1181 }
1182
1183 /*
1184  * Rebooting also tells the Host we're finished, but the RESTART flag tells the
1185  * Launcher to reboot us.
1186  */
1187 static void lguest_restart(char *reason)
1188 {
1189         hcall(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART, 0, 0);
1190 }
1191
1192 /*G:050
1193  * Patching (Powerfully Placating Performance Pedants)
1194  *
1195  * We have already seen that pv_ops structures let us replace simple native
1196  * instructions with calls to the appropriate back end all throughout the
1197  * kernel.  This allows the same kernel to run as a Guest and as a native
1198  * kernel, but it's slow because of all the indirect branches.
1199  *
1200  * Remember that David Wheeler quote about "Any problem in computer science can
1201  * be solved with another layer of indirection"?  The rest of that quote is
1202  * "... But that usually will create another problem."  This is the first of
1203  * those problems.
1204  *
1205  * Our current solution is to allow the paravirt back end to optionally patch
1206  * over the indirect calls to replace them with something more efficient.  We
1207  * patch two of the simplest of the most commonly called functions: disable
1208  * interrupts and save interrupts.  We usually have 6 or 10 bytes to patch
1209  * into: the Guest versions of these operations are small enough that we can
1210  * fit comfortably.
1211  *
1212  * First we need assembly templates of each of the patchable Guest operations,
1213  * and these are in i386_head.S.
1214  */
1215
1216 /*G:060 We construct a table from the assembler templates: */
1217 static const struct lguest_insns
1218 {
1219         const char *start, *end;
1220 } lguest_insns[] = {
1221         [PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
1222         [PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
1223 };
1224
1225 /*
1226  * Now our patch routine is fairly simple (based on the native one in
1227  * paravirt.c).  If we have a replacement, we copy it in and return how much of
1228  * the available space we used.
1229  */
1230 static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
1231                              unsigned long addr, unsigned len)
1232 {
1233         unsigned int insn_len;
1234
1235         /* Don't do anything special if we don't have a replacement */
1236         if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
1237                 return paravirt_patch_default(type, clobber, ibuf, addr, len);
1238
1239         insn_len = lguest_insns[type].end - lguest_insns[type].start;
1240
1241         /* Similarly if it can't fit (doesn't happen, but let's be thorough). */
1242         if (len < insn_len)
1243                 return paravirt_patch_default(type, clobber, ibuf, addr, len);
1244
1245         /* Copy in our instructions. */
1246         memcpy(ibuf, lguest_insns[type].start, insn_len);
1247         return insn_len;
1248 }
1249
1250 /*G:029
1251  * Once we get to lguest_init(), we know we're a Guest.  The various
1252  * pv_ops structures in the kernel provide points for (almost) every routine we
1253  * have to override to avoid privileged instructions.
1254  */
1255 __init void lguest_init(void)
1256 {
1257         /* We're under lguest. */
1258         pv_info.name = "lguest";
1259         /* Paravirt is enabled. */
1260         pv_info.paravirt_enabled = 1;
1261         /* We're running at privilege level 1, not 0 as normal. */
1262         pv_info.kernel_rpl = 1;
1263         /* Everyone except Xen runs with this set. */
1264         pv_info.shared_kernel_pmd = 1;
1265
1266         /*
1267          * We set up all the lguest overrides for sensitive operations.  These
1268          * are detailed with the operations themselves.
1269          */
1270
1271         /* Interrupt-related operations */
1272         pv_irq_ops.save_fl = PV_CALLEE_SAVE(save_fl);
1273         pv_irq_ops.restore_fl = __PV_IS_CALLEE_SAVE(lg_restore_fl);
1274         pv_irq_ops.irq_disable = PV_CALLEE_SAVE(irq_disable);
1275         pv_irq_ops.irq_enable = __PV_IS_CALLEE_SAVE(lg_irq_enable);
1276         pv_irq_ops.safe_halt = lguest_safe_halt;
1277
1278         /* Setup operations */
1279         pv_init_ops.patch = lguest_patch;
1280
1281         /* Intercepts of various CPU instructions */
1282         pv_cpu_ops.load_gdt = lguest_load_gdt;
1283         pv_cpu_ops.cpuid = lguest_cpuid;
1284         pv_cpu_ops.load_idt = lguest_load_idt;
1285         pv_cpu_ops.iret = lguest_iret;
1286         pv_cpu_ops.load_sp0 = lguest_load_sp0;
1287         pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1288         pv_cpu_ops.set_ldt = lguest_set_ldt;
1289         pv_cpu_ops.load_tls = lguest_load_tls;
1290         pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1291         pv_cpu_ops.clts = lguest_clts;
1292         pv_cpu_ops.read_cr0 = lguest_read_cr0;
1293         pv_cpu_ops.write_cr0 = lguest_write_cr0;
1294         pv_cpu_ops.read_cr4 = lguest_read_cr4;
1295         pv_cpu_ops.write_cr4 = lguest_write_cr4;
1296         pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1297         pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1298         pv_cpu_ops.wbinvd = lguest_wbinvd;
1299         pv_cpu_ops.start_context_switch = paravirt_start_context_switch;
1300         pv_cpu_ops.end_context_switch = lguest_end_context_switch;
1301
1302         /* Pagetable management */
1303         pv_mmu_ops.write_cr3 = lguest_write_cr3;
1304         pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1305         pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1306         pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1307         pv_mmu_ops.set_pte = lguest_set_pte;
1308         pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1309         pv_mmu_ops.set_pmd = lguest_set_pmd;
1310 #ifdef CONFIG_X86_PAE
1311         pv_mmu_ops.set_pte_atomic = lguest_set_pte_atomic;
1312         pv_mmu_ops.pte_clear = lguest_pte_clear;
1313         pv_mmu_ops.pmd_clear = lguest_pmd_clear;
1314         pv_mmu_ops.set_pud = lguest_set_pud;
1315 #endif
1316         pv_mmu_ops.read_cr2 = lguest_read_cr2;
1317         pv_mmu_ops.read_cr3 = lguest_read_cr3;
1318         pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
1319         pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mmu_mode;
1320         pv_mmu_ops.pte_update = lguest_pte_update;
1321         pv_mmu_ops.pte_update_defer = lguest_pte_update;
1322
1323 #ifdef CONFIG_X86_LOCAL_APIC
1324         /* APIC read/write intercepts */
1325         set_lguest_basic_apic_ops();
1326 #endif
1327
1328         x86_init.resources.memory_setup = lguest_memory_setup;
1329         x86_init.irqs.intr_init = lguest_init_IRQ;
1330         x86_init.timers.timer_init = lguest_time_init;
1331         x86_platform.calibrate_tsc = lguest_tsc_khz;
1332         x86_platform.get_wallclock =  lguest_get_wallclock;
1333
1334         /*
1335          * Now is a good time to look at the implementations of these functions
1336          * before returning to the rest of lguest_init().
1337          */
1338
1339         /*G:070
1340          * Now we've seen all the paravirt_ops, we return to
1341          * lguest_init() where the rest of the fairly chaotic boot setup
1342          * occurs.
1343          */
1344
1345         /*
1346          * The stack protector is a weird thing where gcc places a canary
1347          * value on the stack and then checks it on return.  This file is
1348          * compiled with -fno-stack-protector it, so we got this far without
1349          * problems.  The value of the canary is kept at offset 20 from the
1350          * %gs register, so we need to set that up before calling C functions
1351          * in other files.
1352          */
1353         setup_stack_canary_segment(0);
1354
1355         /*
1356          * We could just call load_stack_canary_segment(), but we might as well
1357          * call switch_to_new_gdt() which loads the whole table and sets up the
1358          * per-cpu segment descriptor register %fs as well.
1359          */
1360         switch_to_new_gdt(0);
1361
1362         /*
1363          * The Host<->Guest Switcher lives at the top of our address space, and
1364          * the Host told us how big it is when we made LGUEST_INIT hypercall:
1365          * it put the answer in lguest_data.reserve_mem
1366          */
1367         reserve_top_address(lguest_data.reserve_mem);
1368
1369         /*
1370          * If we don't initialize the lock dependency checker now, it crashes
1371          * atomic_notifier_chain_register, then paravirt_disable_iospace.
1372          */
1373         lockdep_init();
1374
1375         /* Hook in our special panic hypercall code. */
1376         atomic_notifier_chain_register(&panic_notifier_list, &paniced);
1377
1378         /*
1379          * The IDE code spends about 3 seconds probing for disks: if we reserve
1380          * all the I/O ports up front it can't get them and so doesn't probe.
1381          * Other device drivers are similar (but less severe).  This cuts the
1382          * kernel boot time on my machine from 4.1 seconds to 0.45 seconds.
1383          */
1384         paravirt_disable_iospace();
1385
1386         /*
1387          * This is messy CPU setup stuff which the native boot code does before
1388          * start_kernel, so we have to do, too:
1389          */
1390         cpu_detect(&new_cpu_data);
1391         /* head.S usually sets up the first capability word, so do it here. */
1392         new_cpu_data.x86_capability[0] = cpuid_edx(1);
1393
1394         /* Math is always hard! */
1395         new_cpu_data.hard_math = 1;
1396
1397         /* We don't have features.  We have puppies!  Puppies! */
1398 #ifdef CONFIG_X86_MCE
1399         mce_disabled = 1;
1400 #endif
1401 #ifdef CONFIG_ACPI
1402         acpi_disabled = 1;
1403 #endif
1404
1405         /*
1406          * We set the preferred console to "hvc".  This is the "hypervisor
1407          * virtual console" driver written by the PowerPC people, which we also
1408          * adapted for lguest's use.
1409          */
1410         add_preferred_console("hvc", 0, NULL);
1411
1412         /* Register our very early console. */
1413         virtio_cons_early_init(early_put_chars);
1414
1415         /*
1416          * Last of all, we set the power management poweroff hook to point to
1417          * the Guest routine to power off, and the reboot hook to our restart
1418          * routine.
1419          */
1420         pm_power_off = lguest_power_off;
1421         machine_ops.restart = lguest_restart;
1422
1423         /*
1424          * Now we're set up, call i386_start_kernel() in head32.c and we proceed
1425          * to boot as normal.  It never returns.
1426          */
1427         i386_start_kernel();
1428 }
1429 /*
1430  * This marks the end of stage II of our journey, The Guest.
1431  *
1432  * It is now time for us to explore the layer of virtual drivers and complete
1433  * our understanding of the Guest in "make Drivers".
1434  */