• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 tools/lguest/lguest.c) is called the Launcher.
11  *
12  * Secondly, we only run specially modified Guests, not normal kernels: setting
13  * CONFIG_LGUEST_GUEST to "y" compiles this file into the kernel so it knows
14  * how to be a Guest at boot time.  This means that you can use the same kernel
15  * you boot normally (ie. as a Host) as a Guest.
16  *
17  * These Guests know that they cannot do privileged operations, such as disable
18  * interrupts, and that they have to ask the Host to do such things explicitly.
19  * This file consists of all the replacements for such low-level native
20  * hardware operations: these special Guest versions call the Host.
21  *
22  * So how does the kernel know it's a Guest?  We'll see that later, but let's
23  * just say that we end up here where we replace the native functions various
24  * "paravirt" structures with our Guest versions, then boot like normal.
25 :*/
26 
27 /*
28  * Copyright (C) 2006, Rusty Russell <rusty@rustcorp.com.au> IBM Corporation.
29  *
30  * This program is free software; you can redistribute it and/or modify
31  * it under the terms of the GNU General Public License as published by
32  * the Free Software Foundation; either version 2 of the License, or
33  * (at your option) any later version.
34  *
35  * This program is distributed in the hope that it will be useful, but
36  * WITHOUT ANY WARRANTY; without even the implied warranty of
37  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
38  * NON INFRINGEMENT.  See the GNU General Public License for more
39  * details.
40  *
41  * You should have received a copy of the GNU General Public License
42  * along with this program; if not, write to the Free Software
43  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
44  */
45 #include <linux/kernel.h>
46 #include <linux/start_kernel.h>
47 #include <linux/string.h>
48 #include <linux/console.h>
49 #include <linux/screen_info.h>
50 #include <linux/irq.h>
51 #include <linux/interrupt.h>
52 #include <linux/clocksource.h>
53 #include <linux/clockchips.h>
54 #include <linux/lguest.h>
55 #include <linux/lguest_launcher.h>
56 #include <linux/virtio_console.h>
57 #include <linux/pm.h>
58 #include <linux/export.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  */
async_hcall(unsigned long call,unsigned long arg1,unsigned long arg2,unsigned long arg3,unsigned long arg4)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  */
lazy_hcall1(unsigned long call,unsigned long arg1)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. :*/
lazy_hcall2(unsigned long call,unsigned long arg1,unsigned long arg2)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 
lazy_hcall3(unsigned long call,unsigned long arg1,unsigned long arg2,unsigned long arg3)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
lazy_hcall4(unsigned long call,unsigned long arg1,unsigned long arg2,unsigned long arg3,unsigned long arg4)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  */
lguest_leave_lazy_mmu_mode(void)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  */
lguest_end_context_switch(struct task_struct * next)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  */
lguest_save_fl(void)236 asmlinkage __visible unsigned long lguest_save_fl(void)
237 {
238 	return lguest_data.irq_enabled;
239 }
240 
241 /* Interrupts go off... */
lguest_irq_disable(void)242 asmlinkage __visible void lguest_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(lguest_save_fl);
257 PV_CALLEE_SAVE_REGS_THUNK(lguest_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  */
lguest_write_idt_entry(gate_desc * dt,int entrynum,const gate_desc * g)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  */
lguest_load_idt(const struct desc_ptr * desc)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  */
lguest_load_gdt(const struct desc_ptr * desc)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  */
lguest_write_gdt_entry(struct desc_struct * dt,int entrynum,const void * desc,int type)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  */
lguest_load_tls(struct thread_struct * t,unsigned int cpu)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  */
lguest_set_ldt(const void * addr,unsigned entries)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  */
lguest_load_tr_desc(void)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  */
lguest_cpuid(unsigned int * ax,unsigned int * bx,unsigned int * cx,unsigned int * dx)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;
lguest_write_cr0(unsigned long val)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 
lguest_read_cr0(void)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  */
lguest_clts(void)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  */
lguest_read_cr2(void)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  */
lguest_write_cr3(unsigned long cr3)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_symbol(swapper_pg_dir) &&
555 	    cr3 != __pa_symbol(initial_page_table))
556 		cr3_changed = true;
557 }
558 
lguest_read_cr3(void)559 static unsigned long lguest_read_cr3(void)
560 {
561 	return current_cr3;
562 }
563 
564 /* cr4 is used to enable and disable PGE, but we don't care. */
lguest_read_cr4(void)565 static unsigned long lguest_read_cr4(void)
566 {
567 	return 0;
568 }
569 
lguest_write_cr4(unsigned long val)570 static void lguest_write_cr4(unsigned long val)
571 {
572 }
573 
574 /*
575  * Page Table Handling.
576  *
577  * Now would be a good time to take a rest and grab a coffee or similarly
578  * relaxing stimulant.  The easy parts are behind us, and the trek gradually
579  * winds uphill from here.
580  *
581  * Quick refresher: memory is divided into "pages" of 4096 bytes each.  The CPU
582  * maps virtual addresses to physical addresses using "page tables".  We could
583  * use one huge index of 1 million entries: each address is 4 bytes, so that's
584  * 1024 pages just to hold the page tables.   But since most virtual addresses
585  * are unused, we use a two level index which saves space.  The cr3 register
586  * contains the physical address of the top level "page directory" page, which
587  * contains physical addresses of up to 1024 second-level pages.  Each of these
588  * second level pages contains up to 1024 physical addresses of actual pages,
589  * or Page Table Entries (PTEs).
590  *
591  * Here's a diagram, where arrows indicate physical addresses:
592  *
593  * cr3 ---> +---------+
594  *	    |  	   --------->+---------+
595  *	    |	      |	     | PADDR1  |
596  *	  Mid-level   |	     | PADDR2  |
597  *	  (PMD) page  |	     | 	       |
598  *	    |	      |	   Lower-level |
599  *	    |	      |	   (PTE) page  |
600  *	    |	      |	     |	       |
601  *	      ....    	     	 ....
602  *
603  * So to convert a virtual address to a physical address, we look up the top
604  * level, which points us to the second level, which gives us the physical
605  * address of that page.  If the top level entry was not present, or the second
606  * level entry was not present, then the virtual address is invalid (we
607  * say "the page was not mapped").
608  *
609  * Put another way, a 32-bit virtual address is divided up like so:
610  *
611  *  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
612  * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
613  *    Index into top     Index into second      Offset within page
614  *  page directory page    pagetable page
615  *
616  * Now, unfortunately, this isn't the whole story: Intel added Physical Address
617  * Extension (PAE) to allow 32 bit systems to use 64GB of memory (ie. 36 bits).
618  * These are held in 64-bit page table entries, so we can now only fit 512
619  * entries in a page, and the neat three-level tree breaks down.
620  *
621  * The result is a four level page table:
622  *
623  * cr3 --> [ 4 Upper  ]
624  *	   [   Level  ]
625  *	   [  Entries ]
626  *	   [(PUD Page)]---> +---------+
627  *	 		    |  	   --------->+---------+
628  *	 		    |	      |	     | PADDR1  |
629  *	 		  Mid-level   |	     | PADDR2  |
630  *	 		  (PMD) page  |	     | 	       |
631  *	 		    |	      |	   Lower-level |
632  *	 		    |	      |	   (PTE) page  |
633  *	 		    |	      |	     |	       |
634  *	 		      ....    	     	 ....
635  *
636  *
637  * And the virtual address is decoded as:
638  *
639  *         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
640  *      |<-2->|<--- 9 bits ---->|<---- 9 bits --->|<------ 12 bits ------>|
641  * Index into    Index into mid    Index into lower    Offset within page
642  * top entries   directory page     pagetable page
643  *
644  * It's too hard to switch between these two formats at runtime, so Linux only
645  * supports one or the other depending on whether CONFIG_X86_PAE is set.  Many
646  * distributions turn it on, and not just for people with silly amounts of
647  * memory: the larger PTE entries allow room for the NX bit, which lets the
648  * kernel disable execution of pages and increase security.
649  *
650  * This was a problem for lguest, which couldn't run on these distributions;
651  * then Matias Zabaljauregui figured it all out and implemented it, and only a
652  * handful of puppies were crushed in the process!
653  *
654  * Back to our point: the kernel spends a lot of time changing both the
655  * top-level page directory and lower-level pagetable pages.  The Guest doesn't
656  * know physical addresses, so while it maintains these page tables exactly
657  * like normal, it also needs to keep the Host informed whenever it makes a
658  * change: the Host will create the real page tables based on the Guests'.
659  */
660 
661 /*
662  * The Guest calls this after it has set a second-level entry (pte), ie. to map
663  * a page into a process' address space.  We tell the Host the toplevel and
664  * address this corresponds to.  The Guest uses one pagetable per process, so
665  * we need to tell the Host which one we're changing (mm->pgd).
666  */
lguest_pte_update(struct mm_struct * mm,unsigned long addr,pte_t * ptep)667 static void lguest_pte_update(struct mm_struct *mm, unsigned long addr,
668 			       pte_t *ptep)
669 {
670 #ifdef CONFIG_X86_PAE
671 	/* PAE needs to hand a 64 bit page table entry, so it uses two args. */
672 	lazy_hcall4(LHCALL_SET_PTE, __pa(mm->pgd), addr,
673 		    ptep->pte_low, ptep->pte_high);
674 #else
675 	lazy_hcall3(LHCALL_SET_PTE, __pa(mm->pgd), addr, ptep->pte_low);
676 #endif
677 }
678 
679 /* This is the "set and update" combo-meal-deal version. */
lguest_set_pte_at(struct mm_struct * mm,unsigned long addr,pte_t * ptep,pte_t pteval)680 static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
681 			      pte_t *ptep, pte_t pteval)
682 {
683 	native_set_pte(ptep, pteval);
684 	lguest_pte_update(mm, addr, ptep);
685 }
686 
687 /*
688  * The Guest calls lguest_set_pud to set a top-level entry and lguest_set_pmd
689  * to set a middle-level entry when PAE is activated.
690  *
691  * Again, we set the entry then tell the Host which page we changed,
692  * and the index of the entry we changed.
693  */
694 #ifdef CONFIG_X86_PAE
lguest_set_pud(pud_t * pudp,pud_t pudval)695 static void lguest_set_pud(pud_t *pudp, pud_t pudval)
696 {
697 	native_set_pud(pudp, pudval);
698 
699 	/* 32 bytes aligned pdpt address and the index. */
700 	lazy_hcall2(LHCALL_SET_PGD, __pa(pudp) & 0xFFFFFFE0,
701 		   (__pa(pudp) & 0x1F) / sizeof(pud_t));
702 }
703 
lguest_set_pmd(pmd_t * pmdp,pmd_t pmdval)704 static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
705 {
706 	native_set_pmd(pmdp, pmdval);
707 	lazy_hcall2(LHCALL_SET_PMD, __pa(pmdp) & PAGE_MASK,
708 		   (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
709 }
710 #else
711 
712 /* The Guest calls lguest_set_pmd to set a top-level entry when !PAE. */
lguest_set_pmd(pmd_t * pmdp,pmd_t pmdval)713 static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
714 {
715 	native_set_pmd(pmdp, pmdval);
716 	lazy_hcall2(LHCALL_SET_PGD, __pa(pmdp) & PAGE_MASK,
717 		   (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
718 }
719 #endif
720 
721 /*
722  * There are a couple of legacy places where the kernel sets a PTE, but we
723  * don't know the top level any more.  This is useless for us, since we don't
724  * know which pagetable is changing or what address, so we just tell the Host
725  * to forget all of them.  Fortunately, this is very rare.
726  *
727  * ... except in early boot when the kernel sets up the initial pagetables,
728  * which makes booting astonishingly slow: 48 seconds!  So we don't even tell
729  * the Host anything changed until we've done the first real page table switch,
730  * which brings boot back to 4.3 seconds.
731  */
lguest_set_pte(pte_t * ptep,pte_t pteval)732 static void lguest_set_pte(pte_t *ptep, pte_t pteval)
733 {
734 	native_set_pte(ptep, pteval);
735 	if (cr3_changed)
736 		lazy_hcall1(LHCALL_FLUSH_TLB, 1);
737 }
738 
739 #ifdef CONFIG_X86_PAE
740 /*
741  * With 64-bit PTE values, we need to be careful setting them: if we set 32
742  * bits at a time, the hardware could see a weird half-set entry.  These
743  * versions ensure we update all 64 bits at once.
744  */
lguest_set_pte_atomic(pte_t * ptep,pte_t pte)745 static void lguest_set_pte_atomic(pte_t *ptep, pte_t pte)
746 {
747 	native_set_pte_atomic(ptep, pte);
748 	if (cr3_changed)
749 		lazy_hcall1(LHCALL_FLUSH_TLB, 1);
750 }
751 
lguest_pte_clear(struct mm_struct * mm,unsigned long addr,pte_t * ptep)752 static void lguest_pte_clear(struct mm_struct *mm, unsigned long addr,
753 			     pte_t *ptep)
754 {
755 	native_pte_clear(mm, addr, ptep);
756 	lguest_pte_update(mm, addr, ptep);
757 }
758 
lguest_pmd_clear(pmd_t * pmdp)759 static void lguest_pmd_clear(pmd_t *pmdp)
760 {
761 	lguest_set_pmd(pmdp, __pmd(0));
762 }
763 #endif
764 
765 /*
766  * Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
767  * native page table operations.  On native hardware you can set a new page
768  * table entry whenever you want, but if you want to remove one you have to do
769  * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
770  *
771  * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
772  * called when a valid entry is written, not when it's removed (ie. marked not
773  * present).  Instead, this is where we come when the Guest wants to remove a
774  * page table entry: we tell the Host to set that entry to 0 (ie. the present
775  * bit is zero).
776  */
lguest_flush_tlb_single(unsigned long addr)777 static void lguest_flush_tlb_single(unsigned long addr)
778 {
779 	/* Simply set it to zero: if it was not, it will fault back in. */
780 	lazy_hcall3(LHCALL_SET_PTE, current_cr3, addr, 0);
781 }
782 
783 /*
784  * This is what happens after the Guest has removed a large number of entries.
785  * This tells the Host that any of the page table entries for userspace might
786  * have changed, ie. virtual addresses below PAGE_OFFSET.
787  */
lguest_flush_tlb_user(void)788 static void lguest_flush_tlb_user(void)
789 {
790 	lazy_hcall1(LHCALL_FLUSH_TLB, 0);
791 }
792 
793 /*
794  * This is called when the kernel page tables have changed.  That's not very
795  * common (unless the Guest is using highmem, which makes the Guest extremely
796  * slow), so it's worth separating this from the user flushing above.
797  */
lguest_flush_tlb_kernel(void)798 static void lguest_flush_tlb_kernel(void)
799 {
800 	lazy_hcall1(LHCALL_FLUSH_TLB, 1);
801 }
802 
803 /*
804  * The Unadvanced Programmable Interrupt Controller.
805  *
806  * This is an attempt to implement the simplest possible interrupt controller.
807  * I spent some time looking though routines like set_irq_chip_and_handler,
808  * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
809  * I *think* this is as simple as it gets.
810  *
811  * We can tell the Host what interrupts we want blocked ready for using the
812  * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
813  * simple as setting a bit.  We don't actually "ack" interrupts as such, we
814  * just mask and unmask them.  I wonder if we should be cleverer?
815  */
disable_lguest_irq(struct irq_data * data)816 static void disable_lguest_irq(struct irq_data *data)
817 {
818 	set_bit(data->irq, lguest_data.blocked_interrupts);
819 }
820 
enable_lguest_irq(struct irq_data * data)821 static void enable_lguest_irq(struct irq_data *data)
822 {
823 	clear_bit(data->irq, lguest_data.blocked_interrupts);
824 }
825 
826 /* This structure describes the lguest IRQ controller. */
827 static struct irq_chip lguest_irq_controller = {
828 	.name		= "lguest",
829 	.irq_mask	= disable_lguest_irq,
830 	.irq_mask_ack	= disable_lguest_irq,
831 	.irq_unmask	= enable_lguest_irq,
832 };
833 
834 /*
835  * This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
836  * interrupt (except 128, which is used for system calls), and then tells the
837  * Linux infrastructure that each interrupt is controlled by our level-based
838  * lguest interrupt controller.
839  */
lguest_init_IRQ(void)840 static void __init lguest_init_IRQ(void)
841 {
842 	unsigned int i;
843 
844 	for (i = FIRST_EXTERNAL_VECTOR; i < NR_VECTORS; i++) {
845 		/* Some systems map "vectors" to interrupts weirdly.  Not us! */
846 		__this_cpu_write(vector_irq[i], i - FIRST_EXTERNAL_VECTOR);
847 		if (i != SYSCALL_VECTOR)
848 			set_intr_gate(i, interrupt[i - FIRST_EXTERNAL_VECTOR]);
849 	}
850 
851 	/*
852 	 * This call is required to set up for 4k stacks, where we have
853 	 * separate stacks for hard and soft interrupts.
854 	 */
855 	irq_ctx_init(smp_processor_id());
856 }
857 
858 /*
859  * Interrupt descriptors are allocated as-needed, but low-numbered ones are
860  * reserved by the generic x86 code.  So we ignore irq_alloc_desc_at if it
861  * tells us the irq is already used: other errors (ie. ENOMEM) we take
862  * seriously.
863  */
lguest_setup_irq(unsigned int irq)864 int lguest_setup_irq(unsigned int irq)
865 {
866 	int err;
867 
868 	/* Returns -ve error or vector number. */
869 	err = irq_alloc_desc_at(irq, 0);
870 	if (err < 0 && err != -EEXIST)
871 		return err;
872 
873 	irq_set_chip_and_handler_name(irq, &lguest_irq_controller,
874 				      handle_level_irq, "level");
875 	return 0;
876 }
877 
878 /*
879  * Time.
880  *
881  * It would be far better for everyone if the Guest had its own clock, but
882  * until then the Host gives us the time on every interrupt.
883  */
lguest_get_wallclock(struct timespec * now)884 static void lguest_get_wallclock(struct timespec *now)
885 {
886 	*now = lguest_data.time;
887 }
888 
889 /*
890  * The TSC is an Intel thing called the Time Stamp Counter.  The Host tells us
891  * what speed it runs at, or 0 if it's unusable as a reliable clock source.
892  * This matches what we want here: if we return 0 from this function, the x86
893  * TSC clock will give up and not register itself.
894  */
lguest_tsc_khz(void)895 static unsigned long lguest_tsc_khz(void)
896 {
897 	return lguest_data.tsc_khz;
898 }
899 
900 /*
901  * If we can't use the TSC, the kernel falls back to our lower-priority
902  * "lguest_clock", where we read the time value given to us by the Host.
903  */
lguest_clock_read(struct clocksource * cs)904 static cycle_t lguest_clock_read(struct clocksource *cs)
905 {
906 	unsigned long sec, nsec;
907 
908 	/*
909 	 * Since the time is in two parts (seconds and nanoseconds), we risk
910 	 * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
911 	 * and getting 99 and 0.  As Linux tends to come apart under the stress
912 	 * of time travel, we must be careful:
913 	 */
914 	do {
915 		/* First we read the seconds part. */
916 		sec = lguest_data.time.tv_sec;
917 		/*
918 		 * This read memory barrier tells the compiler and the CPU that
919 		 * this can't be reordered: we have to complete the above
920 		 * before going on.
921 		 */
922 		rmb();
923 		/* Now we read the nanoseconds part. */
924 		nsec = lguest_data.time.tv_nsec;
925 		/* Make sure we've done that. */
926 		rmb();
927 		/* Now if the seconds part has changed, try again. */
928 	} while (unlikely(lguest_data.time.tv_sec != sec));
929 
930 	/* Our lguest clock is in real nanoseconds. */
931 	return sec*1000000000ULL + nsec;
932 }
933 
934 /* This is the fallback clocksource: lower priority than the TSC clocksource. */
935 static struct clocksource lguest_clock = {
936 	.name		= "lguest",
937 	.rating		= 200,
938 	.read		= lguest_clock_read,
939 	.mask		= CLOCKSOURCE_MASK(64),
940 	.flags		= CLOCK_SOURCE_IS_CONTINUOUS,
941 };
942 
943 /*
944  * We also need a "struct clock_event_device": Linux asks us to set it to go
945  * off some time in the future.  Actually, James Morris figured all this out, I
946  * just applied the patch.
947  */
lguest_clockevent_set_next_event(unsigned long delta,struct clock_event_device * evt)948 static int lguest_clockevent_set_next_event(unsigned long delta,
949                                            struct clock_event_device *evt)
950 {
951 	/* FIXME: I don't think this can ever happen, but James tells me he had
952 	 * to put this code in.  Maybe we should remove it now.  Anyone? */
953 	if (delta < LG_CLOCK_MIN_DELTA) {
954 		if (printk_ratelimit())
955 			printk(KERN_DEBUG "%s: small delta %lu ns\n",
956 			       __func__, delta);
957 		return -ETIME;
958 	}
959 
960 	/* Please wake us this far in the future. */
961 	hcall(LHCALL_SET_CLOCKEVENT, delta, 0, 0, 0);
962 	return 0;
963 }
964 
lguest_clockevent_set_mode(enum clock_event_mode mode,struct clock_event_device * evt)965 static void lguest_clockevent_set_mode(enum clock_event_mode mode,
966                                       struct clock_event_device *evt)
967 {
968 	switch (mode) {
969 	case CLOCK_EVT_MODE_UNUSED:
970 	case CLOCK_EVT_MODE_SHUTDOWN:
971 		/* A 0 argument shuts the clock down. */
972 		hcall(LHCALL_SET_CLOCKEVENT, 0, 0, 0, 0);
973 		break;
974 	case CLOCK_EVT_MODE_ONESHOT:
975 		/* This is what we expect. */
976 		break;
977 	case CLOCK_EVT_MODE_PERIODIC:
978 		BUG();
979 	case CLOCK_EVT_MODE_RESUME:
980 		break;
981 	}
982 }
983 
984 /* This describes our primitive timer chip. */
985 static struct clock_event_device lguest_clockevent = {
986 	.name                   = "lguest",
987 	.features               = CLOCK_EVT_FEAT_ONESHOT,
988 	.set_next_event         = lguest_clockevent_set_next_event,
989 	.set_mode               = lguest_clockevent_set_mode,
990 	.rating                 = INT_MAX,
991 	.mult                   = 1,
992 	.shift                  = 0,
993 	.min_delta_ns           = LG_CLOCK_MIN_DELTA,
994 	.max_delta_ns           = LG_CLOCK_MAX_DELTA,
995 };
996 
997 /*
998  * This is the Guest timer interrupt handler (hardware interrupt 0).  We just
999  * call the clockevent infrastructure and it does whatever needs doing.
1000  */
lguest_time_irq(unsigned int irq,struct irq_desc * desc)1001 static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
1002 {
1003 	unsigned long flags;
1004 
1005 	/* Don't interrupt us while this is running. */
1006 	local_irq_save(flags);
1007 	lguest_clockevent.event_handler(&lguest_clockevent);
1008 	local_irq_restore(flags);
1009 }
1010 
1011 /*
1012  * At some point in the boot process, we get asked to set up our timing
1013  * infrastructure.  The kernel doesn't expect timer interrupts before this, but
1014  * we cleverly initialized the "blocked_interrupts" field of "struct
1015  * lguest_data" so that timer interrupts were blocked until now.
1016  */
lguest_time_init(void)1017 static void lguest_time_init(void)
1018 {
1019 	/* Set up the timer interrupt (0) to go to our simple timer routine */
1020 	lguest_setup_irq(0);
1021 	irq_set_handler(0, lguest_time_irq);
1022 
1023 	clocksource_register_hz(&lguest_clock, NSEC_PER_SEC);
1024 
1025 	/* We can't set cpumask in the initializer: damn C limitations!  Set it
1026 	 * here and register our timer device. */
1027 	lguest_clockevent.cpumask = cpumask_of(0);
1028 	clockevents_register_device(&lguest_clockevent);
1029 
1030 	/* Finally, we unblock the timer interrupt. */
1031 	clear_bit(0, lguest_data.blocked_interrupts);
1032 }
1033 
1034 /*
1035  * Miscellaneous bits and pieces.
1036  *
1037  * Here is an oddball collection of functions which the Guest needs for things
1038  * to work.  They're pretty simple.
1039  */
1040 
1041 /*
1042  * The Guest needs to tell the Host what stack it expects traps to use.  For
1043  * native hardware, this is part of the Task State Segment mentioned above in
1044  * lguest_load_tr_desc(), but to help hypervisors there's this special call.
1045  *
1046  * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
1047  * segment), the privilege level (we're privilege level 1, the Host is 0 and
1048  * will not tolerate us trying to use that), the stack pointer, and the number
1049  * of pages in the stack.
1050  */
lguest_load_sp0(struct tss_struct * tss,struct thread_struct * thread)1051 static void lguest_load_sp0(struct tss_struct *tss,
1052 			    struct thread_struct *thread)
1053 {
1054 	lazy_hcall3(LHCALL_SET_STACK, __KERNEL_DS | 0x1, thread->sp0,
1055 		   THREAD_SIZE / PAGE_SIZE);
1056 }
1057 
1058 /* Let's just say, I wouldn't do debugging under a Guest. */
lguest_get_debugreg(int regno)1059 static unsigned long lguest_get_debugreg(int regno)
1060 {
1061 	/* FIXME: Implement */
1062 	return 0;
1063 }
1064 
lguest_set_debugreg(int regno,unsigned long value)1065 static void lguest_set_debugreg(int regno, unsigned long value)
1066 {
1067 	/* FIXME: Implement */
1068 }
1069 
1070 /*
1071  * There are times when the kernel wants to make sure that no memory writes are
1072  * caught in the cache (that they've all reached real hardware devices).  This
1073  * doesn't matter for the Guest which has virtual hardware.
1074  *
1075  * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
1076  * (clflush) instruction is available and the kernel uses that.  Otherwise, it
1077  * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
1078  * Unlike clflush, wbinvd can only be run at privilege level 0.  So we can
1079  * ignore clflush, but replace wbinvd.
1080  */
lguest_wbinvd(void)1081 static void lguest_wbinvd(void)
1082 {
1083 }
1084 
1085 /*
1086  * If the Guest expects to have an Advanced Programmable Interrupt Controller,
1087  * we play dumb by ignoring writes and returning 0 for reads.  So it's no
1088  * longer Programmable nor Controlling anything, and I don't think 8 lines of
1089  * code qualifies for Advanced.  It will also never interrupt anything.  It
1090  * does, however, allow us to get through the Linux boot code.
1091  */
1092 #ifdef CONFIG_X86_LOCAL_APIC
lguest_apic_write(u32 reg,u32 v)1093 static void lguest_apic_write(u32 reg, u32 v)
1094 {
1095 }
1096 
lguest_apic_read(u32 reg)1097 static u32 lguest_apic_read(u32 reg)
1098 {
1099 	return 0;
1100 }
1101 
lguest_apic_icr_read(void)1102 static u64 lguest_apic_icr_read(void)
1103 {
1104 	return 0;
1105 }
1106 
lguest_apic_icr_write(u32 low,u32 id)1107 static void lguest_apic_icr_write(u32 low, u32 id)
1108 {
1109 	/* Warn to see if there's any stray references */
1110 	WARN_ON(1);
1111 }
1112 
lguest_apic_wait_icr_idle(void)1113 static void lguest_apic_wait_icr_idle(void)
1114 {
1115 	return;
1116 }
1117 
lguest_apic_safe_wait_icr_idle(void)1118 static u32 lguest_apic_safe_wait_icr_idle(void)
1119 {
1120 	return 0;
1121 }
1122 
set_lguest_basic_apic_ops(void)1123 static void set_lguest_basic_apic_ops(void)
1124 {
1125 	apic->read = lguest_apic_read;
1126 	apic->write = lguest_apic_write;
1127 	apic->icr_read = lguest_apic_icr_read;
1128 	apic->icr_write = lguest_apic_icr_write;
1129 	apic->wait_icr_idle = lguest_apic_wait_icr_idle;
1130 	apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
1131 };
1132 #endif
1133 
1134 /* STOP!  Until an interrupt comes in. */
lguest_safe_halt(void)1135 static void lguest_safe_halt(void)
1136 {
1137 	hcall(LHCALL_HALT, 0, 0, 0, 0);
1138 }
1139 
1140 /*
1141  * The SHUTDOWN hypercall takes a string to describe what's happening, and
1142  * an argument which says whether this to restart (reboot) the Guest or not.
1143  *
1144  * Note that the Host always prefers that the Guest speak in physical addresses
1145  * rather than virtual addresses, so we use __pa() here.
1146  */
lguest_power_off(void)1147 static void lguest_power_off(void)
1148 {
1149 	hcall(LHCALL_SHUTDOWN, __pa("Power down"),
1150 	      LGUEST_SHUTDOWN_POWEROFF, 0, 0);
1151 }
1152 
1153 /*
1154  * Panicing.
1155  *
1156  * Don't.  But if you did, this is what happens.
1157  */
lguest_panic(struct notifier_block * nb,unsigned long l,void * p)1158 static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
1159 {
1160 	hcall(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF, 0, 0);
1161 	/* The hcall won't return, but to keep gcc happy, we're "done". */
1162 	return NOTIFY_DONE;
1163 }
1164 
1165 static struct notifier_block paniced = {
1166 	.notifier_call = lguest_panic
1167 };
1168 
1169 /* Setting up memory is fairly easy. */
lguest_memory_setup(void)1170 static __init char *lguest_memory_setup(void)
1171 {
1172 	/*
1173 	 * The Linux bootloader header contains an "e820" memory map: the
1174 	 * Launcher populated the first entry with our memory limit.
1175 	 */
1176 	e820_add_region(boot_params.e820_map[0].addr,
1177 			  boot_params.e820_map[0].size,
1178 			  boot_params.e820_map[0].type);
1179 
1180 	/* This string is for the boot messages. */
1181 	return "LGUEST";
1182 }
1183 
1184 /*
1185  * We will eventually use the virtio console device to produce console output,
1186  * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
1187  * console output.
1188  */
early_put_chars(u32 vtermno,const char * buf,int count)1189 static __init int early_put_chars(u32 vtermno, const char *buf, int count)
1190 {
1191 	char scratch[17];
1192 	unsigned int len = count;
1193 
1194 	/* We use a nul-terminated string, so we make a copy.  Icky, huh? */
1195 	if (len > sizeof(scratch) - 1)
1196 		len = sizeof(scratch) - 1;
1197 	scratch[len] = '\0';
1198 	memcpy(scratch, buf, len);
1199 	hcall(LHCALL_NOTIFY, __pa(scratch), 0, 0, 0);
1200 
1201 	/* This routine returns the number of bytes actually written. */
1202 	return len;
1203 }
1204 
1205 /*
1206  * Rebooting also tells the Host we're finished, but the RESTART flag tells the
1207  * Launcher to reboot us.
1208  */
lguest_restart(char * reason)1209 static void lguest_restart(char *reason)
1210 {
1211 	hcall(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART, 0, 0);
1212 }
1213 
1214 /*G:050
1215  * Patching (Powerfully Placating Performance Pedants)
1216  *
1217  * We have already seen that pv_ops structures let us replace simple native
1218  * instructions with calls to the appropriate back end all throughout the
1219  * kernel.  This allows the same kernel to run as a Guest and as a native
1220  * kernel, but it's slow because of all the indirect branches.
1221  *
1222  * Remember that David Wheeler quote about "Any problem in computer science can
1223  * be solved with another layer of indirection"?  The rest of that quote is
1224  * "... But that usually will create another problem."  This is the first of
1225  * those problems.
1226  *
1227  * Our current solution is to allow the paravirt back end to optionally patch
1228  * over the indirect calls to replace them with something more efficient.  We
1229  * patch two of the simplest of the most commonly called functions: disable
1230  * interrupts and save interrupts.  We usually have 6 or 10 bytes to patch
1231  * into: the Guest versions of these operations are small enough that we can
1232  * fit comfortably.
1233  *
1234  * First we need assembly templates of each of the patchable Guest operations,
1235  * and these are in i386_head.S.
1236  */
1237 
1238 /*G:060 We construct a table from the assembler templates: */
1239 static const struct lguest_insns
1240 {
1241 	const char *start, *end;
1242 } lguest_insns[] = {
1243 	[PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
1244 	[PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
1245 };
1246 
1247 /*
1248  * Now our patch routine is fairly simple (based on the native one in
1249  * paravirt.c).  If we have a replacement, we copy it in and return how much of
1250  * the available space we used.
1251  */
lguest_patch(u8 type,u16 clobber,void * ibuf,unsigned long addr,unsigned len)1252 static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
1253 			     unsigned long addr, unsigned len)
1254 {
1255 	unsigned int insn_len;
1256 
1257 	/* Don't do anything special if we don't have a replacement */
1258 	if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
1259 		return paravirt_patch_default(type, clobber, ibuf, addr, len);
1260 
1261 	insn_len = lguest_insns[type].end - lguest_insns[type].start;
1262 
1263 	/* Similarly if it can't fit (doesn't happen, but let's be thorough). */
1264 	if (len < insn_len)
1265 		return paravirt_patch_default(type, clobber, ibuf, addr, len);
1266 
1267 	/* Copy in our instructions. */
1268 	memcpy(ibuf, lguest_insns[type].start, insn_len);
1269 	return insn_len;
1270 }
1271 
1272 /*G:029
1273  * Once we get to lguest_init(), we know we're a Guest.  The various
1274  * pv_ops structures in the kernel provide points for (almost) every routine we
1275  * have to override to avoid privileged instructions.
1276  */
lguest_init(void)1277 __init void lguest_init(void)
1278 {
1279 	/* We're under lguest. */
1280 	pv_info.name = "lguest";
1281 	/* Paravirt is enabled. */
1282 	pv_info.paravirt_enabled = 1;
1283 	/* We're running at privilege level 1, not 0 as normal. */
1284 	pv_info.kernel_rpl = 1;
1285 	/* Everyone except Xen runs with this set. */
1286 	pv_info.shared_kernel_pmd = 1;
1287 
1288 	/*
1289 	 * We set up all the lguest overrides for sensitive operations.  These
1290 	 * are detailed with the operations themselves.
1291 	 */
1292 
1293 	/* Interrupt-related operations */
1294 	pv_irq_ops.save_fl = PV_CALLEE_SAVE(lguest_save_fl);
1295 	pv_irq_ops.restore_fl = __PV_IS_CALLEE_SAVE(lg_restore_fl);
1296 	pv_irq_ops.irq_disable = PV_CALLEE_SAVE(lguest_irq_disable);
1297 	pv_irq_ops.irq_enable = __PV_IS_CALLEE_SAVE(lg_irq_enable);
1298 	pv_irq_ops.safe_halt = lguest_safe_halt;
1299 
1300 	/* Setup operations */
1301 	pv_init_ops.patch = lguest_patch;
1302 
1303 	/* Intercepts of various CPU instructions */
1304 	pv_cpu_ops.load_gdt = lguest_load_gdt;
1305 	pv_cpu_ops.cpuid = lguest_cpuid;
1306 	pv_cpu_ops.load_idt = lguest_load_idt;
1307 	pv_cpu_ops.iret = lguest_iret;
1308 	pv_cpu_ops.load_sp0 = lguest_load_sp0;
1309 	pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1310 	pv_cpu_ops.set_ldt = lguest_set_ldt;
1311 	pv_cpu_ops.load_tls = lguest_load_tls;
1312 	pv_cpu_ops.get_debugreg = lguest_get_debugreg;
1313 	pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1314 	pv_cpu_ops.clts = lguest_clts;
1315 	pv_cpu_ops.read_cr0 = lguest_read_cr0;
1316 	pv_cpu_ops.write_cr0 = lguest_write_cr0;
1317 	pv_cpu_ops.read_cr4 = lguest_read_cr4;
1318 	pv_cpu_ops.write_cr4 = lguest_write_cr4;
1319 	pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1320 	pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1321 	pv_cpu_ops.wbinvd = lguest_wbinvd;
1322 	pv_cpu_ops.start_context_switch = paravirt_start_context_switch;
1323 	pv_cpu_ops.end_context_switch = lguest_end_context_switch;
1324 
1325 	/* Pagetable management */
1326 	pv_mmu_ops.write_cr3 = lguest_write_cr3;
1327 	pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1328 	pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1329 	pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1330 	pv_mmu_ops.set_pte = lguest_set_pte;
1331 	pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1332 	pv_mmu_ops.set_pmd = lguest_set_pmd;
1333 #ifdef CONFIG_X86_PAE
1334 	pv_mmu_ops.set_pte_atomic = lguest_set_pte_atomic;
1335 	pv_mmu_ops.pte_clear = lguest_pte_clear;
1336 	pv_mmu_ops.pmd_clear = lguest_pmd_clear;
1337 	pv_mmu_ops.set_pud = lguest_set_pud;
1338 #endif
1339 	pv_mmu_ops.read_cr2 = lguest_read_cr2;
1340 	pv_mmu_ops.read_cr3 = lguest_read_cr3;
1341 	pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
1342 	pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mmu_mode;
1343 	pv_mmu_ops.lazy_mode.flush = paravirt_flush_lazy_mmu;
1344 	pv_mmu_ops.pte_update = lguest_pte_update;
1345 	pv_mmu_ops.pte_update_defer = lguest_pte_update;
1346 
1347 #ifdef CONFIG_X86_LOCAL_APIC
1348 	/* APIC read/write intercepts */
1349 	set_lguest_basic_apic_ops();
1350 #endif
1351 
1352 	x86_init.resources.memory_setup = lguest_memory_setup;
1353 	x86_init.irqs.intr_init = lguest_init_IRQ;
1354 	x86_init.timers.timer_init = lguest_time_init;
1355 	x86_platform.calibrate_tsc = lguest_tsc_khz;
1356 	x86_platform.get_wallclock =  lguest_get_wallclock;
1357 
1358 	/*
1359 	 * Now is a good time to look at the implementations of these functions
1360 	 * before returning to the rest of lguest_init().
1361 	 */
1362 
1363 	/*G:070
1364 	 * Now we've seen all the paravirt_ops, we return to
1365 	 * lguest_init() where the rest of the fairly chaotic boot setup
1366 	 * occurs.
1367 	 */
1368 
1369 	/*
1370 	 * The stack protector is a weird thing where gcc places a canary
1371 	 * value on the stack and then checks it on return.  This file is
1372 	 * compiled with -fno-stack-protector it, so we got this far without
1373 	 * problems.  The value of the canary is kept at offset 20 from the
1374 	 * %gs register, so we need to set that up before calling C functions
1375 	 * in other files.
1376 	 */
1377 	setup_stack_canary_segment(0);
1378 
1379 	/*
1380 	 * We could just call load_stack_canary_segment(), but we might as well
1381 	 * call switch_to_new_gdt() which loads the whole table and sets up the
1382 	 * per-cpu segment descriptor register %fs as well.
1383 	 */
1384 	switch_to_new_gdt(0);
1385 
1386 	/*
1387 	 * The Host<->Guest Switcher lives at the top of our address space, and
1388 	 * the Host told us how big it is when we made LGUEST_INIT hypercall:
1389 	 * it put the answer in lguest_data.reserve_mem
1390 	 */
1391 	reserve_top_address(lguest_data.reserve_mem);
1392 
1393 	/*
1394 	 * If we don't initialize the lock dependency checker now, it crashes
1395 	 * atomic_notifier_chain_register, then paravirt_disable_iospace.
1396 	 */
1397 	lockdep_init();
1398 
1399 	/* Hook in our special panic hypercall code. */
1400 	atomic_notifier_chain_register(&panic_notifier_list, &paniced);
1401 
1402 	/*
1403 	 * The IDE code spends about 3 seconds probing for disks: if we reserve
1404 	 * all the I/O ports up front it can't get them and so doesn't probe.
1405 	 * Other device drivers are similar (but less severe).  This cuts the
1406 	 * kernel boot time on my machine from 4.1 seconds to 0.45 seconds.
1407 	 */
1408 	paravirt_disable_iospace();
1409 
1410 	/*
1411 	 * This is messy CPU setup stuff which the native boot code does before
1412 	 * start_kernel, so we have to do, too:
1413 	 */
1414 	cpu_detect(&new_cpu_data);
1415 	/* head.S usually sets up the first capability word, so do it here. */
1416 	new_cpu_data.x86_capability[0] = cpuid_edx(1);
1417 
1418 	/* Math is always hard! */
1419 	set_cpu_cap(&new_cpu_data, X86_FEATURE_FPU);
1420 
1421 	/* We don't have features.  We have puppies!  Puppies! */
1422 #ifdef CONFIG_X86_MCE
1423 	mca_cfg.disabled = true;
1424 #endif
1425 #ifdef CONFIG_ACPI
1426 	acpi_disabled = 1;
1427 #endif
1428 
1429 	/*
1430 	 * We set the preferred console to "hvc".  This is the "hypervisor
1431 	 * virtual console" driver written by the PowerPC people, which we also
1432 	 * adapted for lguest's use.
1433 	 */
1434 	add_preferred_console("hvc", 0, NULL);
1435 
1436 	/* Register our very early console. */
1437 	virtio_cons_early_init(early_put_chars);
1438 
1439 	/*
1440 	 * Last of all, we set the power management poweroff hook to point to
1441 	 * the Guest routine to power off, and the reboot hook to our restart
1442 	 * routine.
1443 	 */
1444 	pm_power_off = lguest_power_off;
1445 	machine_ops.restart = lguest_restart;
1446 
1447 	/*
1448 	 * Now we're set up, call i386_start_kernel() in head32.c and we proceed
1449 	 * to boot as normal.  It never returns.
1450 	 */
1451 	i386_start_kernel();
1452 }
1453 /*
1454  * This marks the end of stage II of our journey, The Guest.
1455  *
1456  * It is now time for us to explore the layer of virtual drivers and complete
1457  * our understanding of the Guest in "make Drivers".
1458  */
1459