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