blob: 2bdf628066bd85288bf8143d50175d4f7ea6b398 [file] [log] [blame]
Rusty Russellf938d2c2007-07-26 10:41:02 -07001/*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."
Rusty Russell07ad1572007-07-19 01:49:22 -07005 *
Rusty Russellf938d2c2007-07-26 10:41:02 -07006 * We keep things simple in two ways. First, we start with a normal Linux
7 * kernel and insert a module (lg.ko) which allows us to run other Linux
8 * kernels the same way we'd run processes. We call the first kernel the Host,
9 * and the others the Guests. The program which sets up and configures Guests
10 * (such as the example in Documentation/lguest/lguest.c) is called the
11 * Launcher.
12 *
Rusty Russella6bd8e12008-03-28 11:05:53 -050013 * 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.
Rusty Russellf938d2c2007-07-26 10:41:02 -070017 *
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 *
Rusty Russella6bd8e12008-03-28 11:05:53 -050023 * 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
Rusty Russell2e04ef72009-07-30 16:03:45 -060025 * "paravirt" structures with our Guest versions, then boot like normal.
26:*/
Rusty Russellf938d2c2007-07-26 10:41:02 -070027
28/*
Rusty Russell07ad1572007-07-19 01:49:22 -070029 * 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>
Rusty Russelld7e28ff2007-07-19 01:49:23 -070053#include <linux/clocksource.h>
54#include <linux/clockchips.h>
Rusty Russell07ad1572007-07-19 01:49:22 -070055#include <linux/lguest.h>
56#include <linux/lguest_launcher.h>
Rusty Russell19f15372007-10-22 11:24:21 +100057#include <linux/virtio_console.h>
Jeff Garzik4cfe6c32007-10-25 14:15:09 +100058#include <linux/pm.h>
Ingo Molnar7b6aa332009-02-17 13:58:15 +010059#include <asm/apic.h>
Harvey Harrisoncbc34972008-02-13 13:14:35 -080060#include <asm/lguest.h>
Rusty Russell07ad1572007-07-19 01:49:22 -070061#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>
Jes Sorensen625efab2007-10-22 11:03:28 +100070#include <asm/i387.h>
Rusty Russell2cb78782009-06-03 14:52:24 +093071#include <asm/stackprotector.h>
Balaji Raoec04b132007-12-28 14:26:24 +053072#include <asm/reboot.h> /* for struct machine_ops */
Rusty Russell07ad1572007-07-19 01:49:22 -070073
Rusty Russellb2b47c22007-07-26 10:41:02 -070074/*G:010 Welcome to the Guest!
75 *
76 * The Guest in our tale is a simple creature: identical to the Host but
77 * behaving in simplified but equivalent ways. In particular, the Guest is the
Rusty Russell2e04ef72009-07-30 16:03:45 -060078 * same kernel as the Host (or at least, built from the same source code).
79:*/
Rusty Russellb2b47c22007-07-26 10:41:02 -070080
Rusty Russell07ad1572007-07-19 01:49:22 -070081struct lguest_data lguest_data = {
82 .hcall_status = { [0 ... LHCALL_RING_SIZE-1] = 0xFF },
83 .noirq_start = (u32)lguest_noirq_start,
84 .noirq_end = (u32)lguest_noirq_end,
Rusty Russell47436aa2007-10-22 11:03:36 +100085 .kernel_address = PAGE_OFFSET,
Rusty Russell07ad1572007-07-19 01:49:22 -070086 .blocked_interrupts = { 1 }, /* Block timer interrupts */
Rusty Russellc18acd72007-10-22 11:03:35 +100087 .syscall_vec = SYSCALL_VECTOR,
Rusty Russell07ad1572007-07-19 01:49:22 -070088};
Rusty Russell07ad1572007-07-19 01:49:22 -070089
Rusty Russell2e04ef72009-07-30 16:03:45 -060090/*G:037
91 * async_hcall() is pretty simple: I'm quite proud of it really. We have a
Rusty Russellb2b47c22007-07-26 10:41:02 -070092 * ring buffer of stored hypercalls which the Host will run though next time we
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -060093 * do a normal hypercall. Each entry in the ring has 5 slots for the hypercall
Rusty Russellb2b47c22007-07-26 10:41:02 -070094 * arguments, and a "hcall_status" word which is 0 if the call is ready to go,
95 * and 255 once the Host has finished with it.
96 *
97 * If we come around to a slot which hasn't been finished, then the table is
98 * full and we just make the hypercall directly. This has the nice side
99 * effect of causing the Host to run all the stored calls in the ring buffer
Rusty Russell2e04ef72009-07-30 16:03:45 -0600100 * which empties it for next time!
101 */
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100102static void async_hcall(unsigned long call, unsigned long arg1,
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600103 unsigned long arg2, unsigned long arg3,
104 unsigned long arg4)
Rusty Russell07ad1572007-07-19 01:49:22 -0700105{
106 /* Note: This code assumes we're uniprocessor. */
107 static unsigned int next_call;
108 unsigned long flags;
109
Rusty Russell2e04ef72009-07-30 16:03:45 -0600110 /*
111 * Disable interrupts if not already disabled: we don't want an
Rusty Russellb2b47c22007-07-26 10:41:02 -0700112 * interrupt handler making a hypercall while we're already doing
Rusty Russell2e04ef72009-07-30 16:03:45 -0600113 * one!
114 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700115 local_irq_save(flags);
116 if (lguest_data.hcall_status[next_call] != 0xFF) {
117 /* Table full, so do normal hcall which will flush table. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600118 hcall(call, arg1, arg2, arg3, arg4);
Rusty Russell07ad1572007-07-19 01:49:22 -0700119 } else {
Jes Sorensenb410e7b2007-10-22 11:03:31 +1000120 lguest_data.hcalls[next_call].arg0 = call;
121 lguest_data.hcalls[next_call].arg1 = arg1;
122 lguest_data.hcalls[next_call].arg2 = arg2;
123 lguest_data.hcalls[next_call].arg3 = arg3;
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600124 lguest_data.hcalls[next_call].arg4 = arg4;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700125 /* Arguments must all be written before we mark it to go */
Rusty Russell07ad1572007-07-19 01:49:22 -0700126 wmb();
127 lguest_data.hcall_status[next_call] = 0;
128 if (++next_call == LHCALL_RING_SIZE)
129 next_call = 0;
130 }
131 local_irq_restore(flags);
132}
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100133
Rusty Russell2e04ef72009-07-30 16:03:45 -0600134/*G:035
135 * Notice the lazy_hcall() above, rather than hcall(). This is our first real
136 * optimization trick!
Rusty Russell633872b2007-11-05 21:55:57 +1100137 *
138 * When lazy_mode is set, it means we're allowed to defer all hypercalls and do
139 * them as a batch when lazy_mode is eventually turned off. Because hypercalls
140 * are reasonably expensive, batching them up makes sense. For example, a
141 * large munmap might update dozens of page table entries: that code calls
142 * paravirt_enter_lazy_mmu(), does the dozen updates, then calls
143 * lguest_leave_lazy_mode().
144 *
145 * So, when we're in lazy mode, we call async_hcall() to store the call for
Rusty Russell2e04ef72009-07-30 16:03:45 -0600146 * future processing:
147 */
Rusty Russell091ebf02010-04-14 21:43:54 -0600148static void lazy_hcall1(unsigned long call, unsigned long arg1)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200149{
150 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600151 hcall(call, arg1, 0, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200152 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600153 async_hcall(call, arg1, 0, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200154}
155
Rusty Russella91d74a2009-07-30 16:03:45 -0600156/* You can imagine what lazy_hcall2, 3 and 4 look like. :*/
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200157static void lazy_hcall2(unsigned long call,
Rusty Russell091ebf02010-04-14 21:43:54 -0600158 unsigned long arg1,
159 unsigned long arg2)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200160{
161 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600162 hcall(call, arg1, arg2, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200163 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600164 async_hcall(call, arg1, arg2, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200165}
166
167static void lazy_hcall3(unsigned long call,
Rusty Russell091ebf02010-04-14 21:43:54 -0600168 unsigned long arg1,
169 unsigned long arg2,
170 unsigned long arg3)
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100171{
172 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600173 hcall(call, arg1, arg2, arg3, 0);
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100174 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600175 async_hcall(call, arg1, arg2, arg3, 0);
176}
177
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600178#ifdef CONFIG_X86_PAE
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600179static void lazy_hcall4(unsigned long call,
Rusty Russell091ebf02010-04-14 21:43:54 -0600180 unsigned long arg1,
181 unsigned long arg2,
182 unsigned long arg3,
183 unsigned long arg4)
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600184{
185 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600186 hcall(call, arg1, arg2, arg3, arg4);
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600187 else
188 async_hcall(call, arg1, arg2, arg3, arg4);
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100189}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600190#endif
Rusty Russell633872b2007-11-05 21:55:57 +1100191
Rusty Russella91d74a2009-07-30 16:03:45 -0600192/*G:036
193 * When lazy mode is turned off reset the per-cpu lazy mode variable and then
194 * issue the do-nothing hypercall to flush any stored calls.
195:*/
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800196static void lguest_leave_lazy_mmu_mode(void)
Rusty Russell633872b2007-11-05 21:55:57 +1100197{
Rusty Russell091ebf02010-04-14 21:43:54 -0600198 hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800199 paravirt_leave_lazy_mmu();
200}
201
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800202static void lguest_end_context_switch(struct task_struct *next)
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800203{
Rusty Russell091ebf02010-04-14 21:43:54 -0600204 hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800205 paravirt_end_context_switch(next);
Rusty Russell633872b2007-11-05 21:55:57 +1100206}
Rusty Russell07ad1572007-07-19 01:49:22 -0700207
Rusty Russell61f4bc82009-06-12 22:27:03 -0600208/*G:032
Rusty Russelle1e72962007-10-25 15:02:50 +1000209 * After that diversion we return to our first native-instruction
210 * replacements: four functions for interrupt control.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700211 *
212 * The simplest way of implementing these would be to have "turn interrupts
213 * off" and "turn interrupts on" hypercalls. Unfortunately, this is too slow:
214 * these are by far the most commonly called functions of those we override.
215 *
216 * So instead we keep an "irq_enabled" field inside our "struct lguest_data",
217 * which the Guest can update with a single instruction. The Host knows to
Rusty Russella6bd8e12008-03-28 11:05:53 -0500218 * check there before it tries to deliver an interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700219 */
220
Rusty Russell2e04ef72009-07-30 16:03:45 -0600221/*
222 * save_flags() is expected to return the processor state (ie. "flags"). The
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100223 * flags word contains all kind of stuff, but in practice Linux only cares
Rusty Russell2e04ef72009-07-30 16:03:45 -0600224 * about the interrupt flag. Our "save_flags()" just returns that.
225 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700226static unsigned long save_fl(void)
227{
228 return lguest_data.irq_enabled;
229}
Rusty Russell07ad1572007-07-19 01:49:22 -0700230
Rusty Russellb2b47c22007-07-26 10:41:02 -0700231/* Interrupts go off... */
Rusty Russell07ad1572007-07-19 01:49:22 -0700232static void irq_disable(void)
233{
234 lguest_data.irq_enabled = 0;
235}
Rusty Russell61f4bc82009-06-12 22:27:03 -0600236
Rusty Russell2e04ef72009-07-30 16:03:45 -0600237/*
238 * Let's pause a moment. Remember how I said these are called so often?
Rusty Russell61f4bc82009-06-12 22:27:03 -0600239 * Jeremy Fitzhardinge optimized them so hard early in 2009 that he had to
240 * break some rules. In particular, these functions are assumed to save their
241 * own registers if they need to: normal C functions assume they can trash the
242 * eax register. To use normal C functions, we use
243 * PV_CALLEE_SAVE_REGS_THUNK(), which pushes %eax onto the stack, calls the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600244 * C function, then restores it.
245 */
Rusty Russell61f4bc82009-06-12 22:27:03 -0600246PV_CALLEE_SAVE_REGS_THUNK(save_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -0800247PV_CALLEE_SAVE_REGS_THUNK(irq_disable);
Rusty Russellf56a3842007-07-26 10:41:05 -0700248/*:*/
Rusty Russell61f4bc82009-06-12 22:27:03 -0600249
250/* These are in i386_head.S */
251extern void lg_irq_enable(void);
252extern void lg_restore_fl(unsigned long flags);
253
Rusty Russell2e04ef72009-07-30 16:03:45 -0600254/*M:003
Rusty Russella91d74a2009-07-30 16:03:45 -0600255 * We could be more efficient in our checking of outstanding interrupts, rather
256 * than using a branch. One way would be to put the "irq_enabled" field in a
257 * page by itself, and have the Host write-protect it when an interrupt comes
258 * in when irqs are disabled. There will then be a page fault as soon as
259 * interrupts are re-enabled.
Rusty Russella6bd8e12008-03-28 11:05:53 -0500260 *
261 * A better method is to implement soft interrupt disable generally for x86:
262 * instead of disabling interrupts, we set a flag. If an interrupt does come
263 * in, we then disable them for real. This is uncommon, so we could simply use
Rusty Russell2e04ef72009-07-30 16:03:45 -0600264 * a hypercall for interrupt control and not worry about efficiency.
265:*/
Rusty Russell07ad1572007-07-19 01:49:22 -0700266
Rusty Russellb2b47c22007-07-26 10:41:02 -0700267/*G:034
268 * The Interrupt Descriptor Table (IDT).
269 *
270 * The IDT tells the processor what to do when an interrupt comes in. Each
271 * entry in the table is a 64-bit descriptor: this holds the privilege level,
272 * address of the handler, and... well, who cares? The Guest just asks the
273 * Host to make the change anyway, because the Host controls the real IDT.
274 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100275static void lguest_write_idt_entry(gate_desc *dt,
276 int entrynum, const gate_desc *g)
Rusty Russell07ad1572007-07-19 01:49:22 -0700277{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600278 /*
279 * The gate_desc structure is 8 bytes long: we hand it to the Host in
Rusty Russella6bd8e12008-03-28 11:05:53 -0500280 * two 32-bit chunks. The whole 32-bit kernel used to hand descriptors
281 * around like this; typesafety wasn't a big concern in Linux's early
Rusty Russell2e04ef72009-07-30 16:03:45 -0600282 * years.
283 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100284 u32 *desc = (u32 *)g;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700285 /* Keep the local copy up to date. */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100286 native_write_idt_entry(dt, entrynum, g);
Rusty Russellb2b47c22007-07-26 10:41:02 -0700287 /* Tell Host about this new entry. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600288 hcall(LHCALL_LOAD_IDT_ENTRY, entrynum, desc[0], desc[1], 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700289}
290
Rusty Russell2e04ef72009-07-30 16:03:45 -0600291/*
292 * Changing to a different IDT is very rare: we keep the IDT up-to-date every
Rusty Russellb2b47c22007-07-26 10:41:02 -0700293 * time it is written, so we can simply loop through all entries and tell the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600294 * Host about them.
295 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100296static void lguest_load_idt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700297{
298 unsigned int i;
299 struct desc_struct *idt = (void *)desc->address;
300
301 for (i = 0; i < (desc->size+1)/8; i++)
Rusty Russell091ebf02010-04-14 21:43:54 -0600302 hcall(LHCALL_LOAD_IDT_ENTRY, i, idt[i].a, idt[i].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700303}
304
Rusty Russellb2b47c22007-07-26 10:41:02 -0700305/*
306 * The Global Descriptor Table.
307 *
308 * The Intel architecture defines another table, called the Global Descriptor
309 * Table (GDT). You tell the CPU where it is (and its size) using the "lgdt"
310 * instruction, and then several other instructions refer to entries in the
311 * table. There are three entries which the Switcher needs, so the Host simply
312 * controls the entire thing and the Guest asks it to make changes using the
313 * LOAD_GDT hypercall.
314 *
Rusty Russella489f0b2009-04-19 23:14:00 -0600315 * This is the exactly like the IDT code.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700316 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100317static void lguest_load_gdt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700318{
Rusty Russella489f0b2009-04-19 23:14:00 -0600319 unsigned int i;
320 struct desc_struct *gdt = (void *)desc->address;
321
322 for (i = 0; i < (desc->size+1)/8; i++)
Rusty Russell091ebf02010-04-14 21:43:54 -0600323 hcall(LHCALL_LOAD_GDT_ENTRY, i, gdt[i].a, gdt[i].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700324}
325
Rusty Russell2e04ef72009-07-30 16:03:45 -0600326/*
327 * For a single GDT entry which changes, we do the lazy thing: alter our GDT,
Rusty Russellb2b47c22007-07-26 10:41:02 -0700328 * then tell the Host to reload the entire thing. This operation is so rare
Rusty Russell2e04ef72009-07-30 16:03:45 -0600329 * that this naive implementation is reasonable.
330 */
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100331static void lguest_write_gdt_entry(struct desc_struct *dt, int entrynum,
332 const void *desc, int type)
Rusty Russell07ad1572007-07-19 01:49:22 -0700333{
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100334 native_write_gdt_entry(dt, entrynum, desc, type);
Rusty Russella489f0b2009-04-19 23:14:00 -0600335 /* Tell Host about this new entry. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600336 hcall(LHCALL_LOAD_GDT_ENTRY, entrynum,
337 dt[entrynum].a, dt[entrynum].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700338}
339
Rusty Russell2e04ef72009-07-30 16:03:45 -0600340/*
341 * OK, I lied. There are three "thread local storage" GDT entries which change
Rusty Russellb2b47c22007-07-26 10:41:02 -0700342 * on every context switch (these three entries are how glibc implements
Rusty Russell2e04ef72009-07-30 16:03:45 -0600343 * __thread variables). So we have a hypercall specifically for this case.
344 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700345static void lguest_load_tls(struct thread_struct *t, unsigned int cpu)
346{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600347 /*
348 * There's one problem which normal hardware doesn't have: the Host
Rusty Russell0d027c02007-08-09 20:57:13 +1000349 * can't handle us removing entries we're currently using. So we clear
Rusty Russell2e04ef72009-07-30 16:03:45 -0600350 * the GS register here: if it's needed it'll be reloaded anyway.
351 */
Tejun Heoccbeed32009-02-09 22:17:40 +0900352 lazy_load_gs(0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200353 lazy_hcall2(LHCALL_LOAD_TLS, __pa(&t->tls_array), cpu);
Rusty Russell07ad1572007-07-19 01:49:22 -0700354}
355
Rusty Russell2e04ef72009-07-30 16:03:45 -0600356/*G:038
357 * That's enough excitement for now, back to ploughing through each of the
358 * different pv_ops structures (we're about 1/3 of the way through).
Rusty Russellb2b47c22007-07-26 10:41:02 -0700359 *
360 * This is the Local Descriptor Table, another weird Intel thingy. Linux only
361 * uses this for some strange applications like Wine. We don't do anything
Rusty Russell2e04ef72009-07-30 16:03:45 -0600362 * here, so they'll get an informative and friendly Segmentation Fault.
363 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700364static void lguest_set_ldt(const void *addr, unsigned entries)
365{
366}
367
Rusty Russell2e04ef72009-07-30 16:03:45 -0600368/*
369 * This loads a GDT entry into the "Task Register": that entry points to a
Rusty Russellb2b47c22007-07-26 10:41:02 -0700370 * structure called the Task State Segment. Some comments scattered though the
371 * kernel code indicate that this used for task switching in ages past, along
372 * with blood sacrifice and astrology.
373 *
374 * Now there's nothing interesting in here that we don't get told elsewhere.
375 * But the native version uses the "ltr" instruction, which makes the Host
376 * complain to the Guest about a Segmentation Fault and it'll oops. So we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600377 * override the native version with a do-nothing version.
378 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700379static void lguest_load_tr_desc(void)
380{
381}
382
Rusty Russell2e04ef72009-07-30 16:03:45 -0600383/*
384 * The "cpuid" instruction is a way of querying both the CPU identity
Rusty Russellb2b47c22007-07-26 10:41:02 -0700385 * (manufacturer, model, etc) and its features. It was introduced before the
Rusty Russella6bd8e12008-03-28 11:05:53 -0500386 * Pentium in 1993 and keeps getting extended by both Intel, AMD and others.
387 * As you might imagine, after a decade and a half this treatment, it is now a
388 * giant ball of hair. Its entry in the current Intel manual runs to 28 pages.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700389 *
390 * This instruction even it has its own Wikipedia entry. The Wikipedia entry
Rusty Russell2e04ef72009-07-30 16:03:45 -0600391 * has been translated into 5 languages. I am not making this up!
Rusty Russellb2b47c22007-07-26 10:41:02 -0700392 *
393 * We could get funky here and identify ourselves as "GenuineLguest", but
394 * instead we just use the real "cpuid" instruction. Then I pretty much turned
395 * off feature bits until the Guest booted. (Don't say that: you'll damage
396 * lguest sales!) Shut up, inner voice! (Hey, just pointing out that this is
397 * hardly future proof.) Noone's listening! They don't like you anyway,
398 * parenthetic weirdo!
399 *
400 * Replacing the cpuid so we can turn features off is great for the kernel, but
401 * anyone (including userspace) can just use the raw "cpuid" instruction and
402 * the Host won't even notice since it isn't privileged. So we try not to get
Rusty Russell2e04ef72009-07-30 16:03:45 -0600403 * too worked up about it.
404 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100405static void lguest_cpuid(unsigned int *ax, unsigned int *bx,
406 unsigned int *cx, unsigned int *dx)
Rusty Russell07ad1572007-07-19 01:49:22 -0700407{
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100408 int function = *ax;
Rusty Russell07ad1572007-07-19 01:49:22 -0700409
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100410 native_cpuid(ax, bx, cx, dx);
Rusty Russell07ad1572007-07-19 01:49:22 -0700411 switch (function) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600412 /*
413 * CPUID 0 gives the highest legal CPUID number (and the ID string).
414 * We futureproof our code a little by sticking to known CPUID values.
415 */
416 case 0:
Rusty Russell7a504922009-07-17 21:47:44 -0600417 if (*ax > 5)
418 *ax = 5;
419 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600420
421 /*
422 * CPUID 1 is a basic feature request.
423 *
424 * CX: we only allow kernel to see SSE3, CMPXCHG16B and SSSE3
425 * DX: SSE, SSE2, FXSR, MMX, CMOV, CMPXCHG8B, TSC, FPU and PAE.
426 */
427 case 1:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100428 *cx &= 0x00002201;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600429 *dx &= 0x07808151;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600430 /*
431 * The Host can do a nice optimization if it knows that the
Rusty Russellb2b47c22007-07-26 10:41:02 -0700432 * kernel mappings (addresses above 0xC0000000 or whatever
433 * PAGE_OFFSET is set to) haven't changed. But Linux calls
434 * flush_tlb_user() for both user and kernel mappings unless
Rusty Russell2e04ef72009-07-30 16:03:45 -0600435 * the Page Global Enable (PGE) feature bit is set.
436 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100437 *dx |= 0x00002000;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600438 /*
439 * We also lie, and say we're family id 5. 6 or greater
Rusty Russellcbd88c82009-03-09 10:06:22 -0600440 * leads to a rdmsr in early_init_intel which we can't handle.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600441 * Family ID is returned as bits 8-12 in ax.
442 */
Rusty Russellcbd88c82009-03-09 10:06:22 -0600443 *ax &= 0xFFFFF0FF;
444 *ax |= 0x00000500;
Rusty Russell07ad1572007-07-19 01:49:22 -0700445 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600446 /*
447 * 0x80000000 returns the highest Extended Function, so we futureproof
448 * like we do above by limiting it to known fields.
449 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700450 case 0x80000000:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100451 if (*ax > 0x80000008)
452 *ax = 0x80000008;
Rusty Russell07ad1572007-07-19 01:49:22 -0700453 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600454
455 /*
456 * PAE systems can mark pages as non-executable. Linux calls this the
457 * NX bit. Intel calls it XD (eXecute Disable), AMD EVP (Enhanced
458 * Virus Protection). We just switch turn if off here, since we don't
459 * support it.
460 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600461 case 0x80000001:
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600462 *dx &= ~(1 << 20);
463 break;
Rusty Russell07ad1572007-07-19 01:49:22 -0700464 }
465}
466
Rusty Russell2e04ef72009-07-30 16:03:45 -0600467/*
468 * Intel has four control registers, imaginatively named cr0, cr2, cr3 and cr4.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700469 * I assume there's a cr1, but it hasn't bothered us yet, so we'll not bother
470 * it. The Host needs to know when the Guest wants to change them, so we have
471 * a whole series of functions like read_cr0() and write_cr0().
472 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000473 * We start with cr0. cr0 allows you to turn on and off all kinds of basic
Rusty Russellb2b47c22007-07-26 10:41:02 -0700474 * features, but Linux only really cares about one: the horrifically-named Task
475 * Switched (TS) bit at bit 3 (ie. 8)
476 *
477 * What does the TS bit do? Well, it causes the CPU to trap (interrupt 7) if
478 * the floating point unit is used. Which allows us to restore FPU state
479 * lazily after a task switch, and Linux uses that gratefully, but wouldn't a
480 * name like "FPUTRAP bit" be a little less cryptic?
481 *
Rusty Russellad5173f2008-10-31 11:24:27 -0500482 * We store cr0 locally because the Host never changes it. The Guest sometimes
Rusty Russell2e04ef72009-07-30 16:03:45 -0600483 * wants to read it and we'd prefer not to bother the Host unnecessarily.
484 */
Rusty Russellad5173f2008-10-31 11:24:27 -0500485static unsigned long current_cr0;
Rusty Russell07ad1572007-07-19 01:49:22 -0700486static void lguest_write_cr0(unsigned long val)
487{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200488 lazy_hcall1(LHCALL_TS, val & X86_CR0_TS);
Rusty Russell07ad1572007-07-19 01:49:22 -0700489 current_cr0 = val;
490}
491
492static unsigned long lguest_read_cr0(void)
493{
494 return current_cr0;
495}
496
Rusty Russell2e04ef72009-07-30 16:03:45 -0600497/*
498 * Intel provided a special instruction to clear the TS bit for people too cool
Rusty Russellb2b47c22007-07-26 10:41:02 -0700499 * to use write_cr0() to do it. This "clts" instruction is faster, because all
Rusty Russell2e04ef72009-07-30 16:03:45 -0600500 * the vowels have been optimized out.
501 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700502static void lguest_clts(void)
503{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200504 lazy_hcall1(LHCALL_TS, 0);
Rusty Russell25c47bb2007-10-25 14:09:53 +1000505 current_cr0 &= ~X86_CR0_TS;
Rusty Russell07ad1572007-07-19 01:49:22 -0700506}
507
Rusty Russell2e04ef72009-07-30 16:03:45 -0600508/*
509 * cr2 is the virtual address of the last page fault, which the Guest only ever
Rusty Russellb2b47c22007-07-26 10:41:02 -0700510 * reads. The Host kindly writes this into our "struct lguest_data", so we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600511 * just read it out of there.
512 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700513static unsigned long lguest_read_cr2(void)
514{
515 return lguest_data.cr2;
516}
517
Rusty Russellad5173f2008-10-31 11:24:27 -0500518/* See lguest_set_pte() below. */
519static bool cr3_changed = false;
520
Rusty Russell2e04ef72009-07-30 16:03:45 -0600521/*
522 * cr3 is the current toplevel pagetable page: the principle is the same as
Rusty Russellad5173f2008-10-31 11:24:27 -0500523 * cr0. Keep a local copy, and tell the Host when it changes. The only
524 * difference is that our local copy is in lguest_data because the Host needs
Rusty Russell2e04ef72009-07-30 16:03:45 -0600525 * to set it upon our initial hypercall.
526 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700527static void lguest_write_cr3(unsigned long cr3)
528{
Rusty Russellad5173f2008-10-31 11:24:27 -0500529 lguest_data.pgdir = cr3;
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200530 lazy_hcall1(LHCALL_NEW_PGTABLE, cr3);
Rusty Russellad5173f2008-10-31 11:24:27 -0500531 cr3_changed = true;
Rusty Russell07ad1572007-07-19 01:49:22 -0700532}
533
534static unsigned long lguest_read_cr3(void)
535{
Rusty Russellad5173f2008-10-31 11:24:27 -0500536 return lguest_data.pgdir;
Rusty Russell07ad1572007-07-19 01:49:22 -0700537}
538
Rusty Russelle1e72962007-10-25 15:02:50 +1000539/* cr4 is used to enable and disable PGE, but we don't care. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700540static unsigned long lguest_read_cr4(void)
541{
542 return 0;
543}
544
545static void lguest_write_cr4(unsigned long val)
546{
547}
548
Rusty Russellb2b47c22007-07-26 10:41:02 -0700549/*
550 * Page Table Handling.
551 *
552 * Now would be a good time to take a rest and grab a coffee or similarly
553 * relaxing stimulant. The easy parts are behind us, and the trek gradually
554 * winds uphill from here.
555 *
556 * Quick refresher: memory is divided into "pages" of 4096 bytes each. The CPU
557 * maps virtual addresses to physical addresses using "page tables". We could
558 * use one huge index of 1 million entries: each address is 4 bytes, so that's
559 * 1024 pages just to hold the page tables. But since most virtual addresses
Rusty Russelle1e72962007-10-25 15:02:50 +1000560 * are unused, we use a two level index which saves space. The cr3 register
Rusty Russellb2b47c22007-07-26 10:41:02 -0700561 * contains the physical address of the top level "page directory" page, which
562 * contains physical addresses of up to 1024 second-level pages. Each of these
563 * second level pages contains up to 1024 physical addresses of actual pages,
564 * or Page Table Entries (PTEs).
565 *
566 * Here's a diagram, where arrows indicate physical addresses:
567 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000568 * cr3 ---> +---------+
Rusty Russellb2b47c22007-07-26 10:41:02 -0700569 * | --------->+---------+
570 * | | | PADDR1 |
Rusty Russella91d74a2009-07-30 16:03:45 -0600571 * Mid-level | | PADDR2 |
Rusty Russellb2b47c22007-07-26 10:41:02 -0700572 * (PMD) page | | |
573 * | | Lower-level |
574 * | | (PTE) page |
575 * | | | |
576 * .... ....
577 *
578 * So to convert a virtual address to a physical address, we look up the top
579 * level, which points us to the second level, which gives us the physical
580 * address of that page. If the top level entry was not present, or the second
581 * level entry was not present, then the virtual address is invalid (we
582 * say "the page was not mapped").
583 *
584 * Put another way, a 32-bit virtual address is divided up like so:
585 *
586 * 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
587 * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
588 * Index into top Index into second Offset within page
589 * page directory page pagetable page
590 *
Rusty Russella91d74a2009-07-30 16:03:45 -0600591 * Now, unfortunately, this isn't the whole story: Intel added Physical Address
592 * Extension (PAE) to allow 32 bit systems to use 64GB of memory (ie. 36 bits).
593 * These are held in 64-bit page table entries, so we can now only fit 512
594 * entries in a page, and the neat three-level tree breaks down.
595 *
596 * The result is a four level page table:
597 *
598 * cr3 --> [ 4 Upper ]
599 * [ Level ]
600 * [ Entries ]
601 * [(PUD Page)]---> +---------+
602 * | --------->+---------+
603 * | | | PADDR1 |
604 * Mid-level | | PADDR2 |
605 * (PMD) page | | |
606 * | | Lower-level |
607 * | | (PTE) page |
608 * | | | |
609 * .... ....
610 *
611 *
612 * And the virtual address is decoded as:
613 *
614 * 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
615 * |<-2->|<--- 9 bits ---->|<---- 9 bits --->|<------ 12 bits ------>|
616 * Index into Index into mid Index into lower Offset within page
617 * top entries directory page pagetable page
618 *
619 * It's too hard to switch between these two formats at runtime, so Linux only
620 * supports one or the other depending on whether CONFIG_X86_PAE is set. Many
621 * distributions turn it on, and not just for people with silly amounts of
622 * memory: the larger PTE entries allow room for the NX bit, which lets the
623 * kernel disable execution of pages and increase security.
624 *
625 * This was a problem for lguest, which couldn't run on these distributions;
626 * then Matias Zabaljauregui figured it all out and implemented it, and only a
627 * handful of puppies were crushed in the process!
628 *
629 * Back to our point: the kernel spends a lot of time changing both the
630 * top-level page directory and lower-level pagetable pages. The Guest doesn't
631 * know physical addresses, so while it maintains these page tables exactly
632 * like normal, it also needs to keep the Host informed whenever it makes a
633 * change: the Host will create the real page tables based on the Guests'.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700634 */
635
Rusty Russell2e04ef72009-07-30 16:03:45 -0600636/*
Rusty Russella91d74a2009-07-30 16:03:45 -0600637 * The Guest calls this after it has set a second-level entry (pte), ie. to map
638 * a page into a process' address space. Wetell the Host the toplevel and
639 * address this corresponds to. The Guest uses one pagetable per process, so
640 * we need to tell the Host which one we're changing (mm->pgd).
Rusty Russell2e04ef72009-07-30 16:03:45 -0600641 */
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600642static void lguest_pte_update(struct mm_struct *mm, unsigned long addr,
643 pte_t *ptep)
644{
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600645#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600646 /* PAE needs to hand a 64 bit page table entry, so it uses two args. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600647 lazy_hcall4(LHCALL_SET_PTE, __pa(mm->pgd), addr,
648 ptep->pte_low, ptep->pte_high);
649#else
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200650 lazy_hcall3(LHCALL_SET_PTE, __pa(mm->pgd), addr, ptep->pte_low);
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600651#endif
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600652}
653
Rusty Russella91d74a2009-07-30 16:03:45 -0600654/* This is the "set and update" combo-meal-deal version. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700655static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
656 pte_t *ptep, pte_t pteval)
657{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600658 native_set_pte(ptep, pteval);
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600659 lguest_pte_update(mm, addr, ptep);
Rusty Russell07ad1572007-07-19 01:49:22 -0700660}
661
Rusty Russell2e04ef72009-07-30 16:03:45 -0600662/*
663 * The Guest calls lguest_set_pud to set a top-level entry and lguest_set_pmd
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600664 * to set a middle-level entry when PAE is activated.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600665 *
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600666 * Again, we set the entry then tell the Host which page we changed,
Rusty Russell2e04ef72009-07-30 16:03:45 -0600667 * and the index of the entry we changed.
668 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600669#ifdef CONFIG_X86_PAE
670static void lguest_set_pud(pud_t *pudp, pud_t pudval)
671{
672 native_set_pud(pudp, pudval);
673
674 /* 32 bytes aligned pdpt address and the index. */
675 lazy_hcall2(LHCALL_SET_PGD, __pa(pudp) & 0xFFFFFFE0,
676 (__pa(pudp) & 0x1F) / sizeof(pud_t));
677}
678
679static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
680{
681 native_set_pmd(pmdp, pmdval);
682 lazy_hcall2(LHCALL_SET_PMD, __pa(pmdp) & PAGE_MASK,
683 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
684}
685#else
686
Rusty Russell2e04ef72009-07-30 16:03:45 -0600687/* The Guest calls lguest_set_pmd to set a top-level entry when !PAE. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700688static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
689{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600690 native_set_pmd(pmdp, pmdval);
Matias Zabaljaureguiebe0ba82009-05-30 15:48:08 -0300691 lazy_hcall2(LHCALL_SET_PGD, __pa(pmdp) & PAGE_MASK,
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600692 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
Rusty Russell07ad1572007-07-19 01:49:22 -0700693}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600694#endif
Rusty Russell07ad1572007-07-19 01:49:22 -0700695
Rusty Russell2e04ef72009-07-30 16:03:45 -0600696/*
697 * There are a couple of legacy places where the kernel sets a PTE, but we
Rusty Russellb2b47c22007-07-26 10:41:02 -0700698 * don't know the top level any more. This is useless for us, since we don't
699 * know which pagetable is changing or what address, so we just tell the Host
700 * to forget all of them. Fortunately, this is very rare.
701 *
702 * ... except in early boot when the kernel sets up the initial pagetables,
Rusty Russellad5173f2008-10-31 11:24:27 -0500703 * which makes booting astonishingly slow: 1.83 seconds! So we don't even tell
704 * the Host anything changed until we've done the first page table switch,
Rusty Russell2e04ef72009-07-30 16:03:45 -0600705 * which brings boot back to 0.25 seconds.
706 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700707static void lguest_set_pte(pte_t *ptep, pte_t pteval)
708{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600709 native_set_pte(ptep, pteval);
Rusty Russellad5173f2008-10-31 11:24:27 -0500710 if (cr3_changed)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200711 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700712}
713
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600714#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600715/*
716 * With 64-bit PTE values, we need to be careful setting them: if we set 32
717 * bits at a time, the hardware could see a weird half-set entry. These
718 * versions ensure we update all 64 bits at once.
719 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600720static void lguest_set_pte_atomic(pte_t *ptep, pte_t pte)
721{
722 native_set_pte_atomic(ptep, pte);
723 if (cr3_changed)
724 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
725}
726
Rusty Russella91d74a2009-07-30 16:03:45 -0600727static void lguest_pte_clear(struct mm_struct *mm, unsigned long addr,
728 pte_t *ptep)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600729{
730 native_pte_clear(mm, addr, ptep);
731 lguest_pte_update(mm, addr, ptep);
732}
733
Rusty Russella91d74a2009-07-30 16:03:45 -0600734static void lguest_pmd_clear(pmd_t *pmdp)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600735{
736 lguest_set_pmd(pmdp, __pmd(0));
737}
738#endif
739
Rusty Russell2e04ef72009-07-30 16:03:45 -0600740/*
741 * Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
Rusty Russellb2b47c22007-07-26 10:41:02 -0700742 * native page table operations. On native hardware you can set a new page
743 * table entry whenever you want, but if you want to remove one you have to do
744 * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
745 *
746 * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
747 * called when a valid entry is written, not when it's removed (ie. marked not
748 * present). Instead, this is where we come when the Guest wants to remove a
749 * page table entry: we tell the Host to set that entry to 0 (ie. the present
Rusty Russell2e04ef72009-07-30 16:03:45 -0600750 * bit is zero).
751 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700752static void lguest_flush_tlb_single(unsigned long addr)
753{
Rusty Russellb2b47c22007-07-26 10:41:02 -0700754 /* Simply set it to zero: if it was not, it will fault back in. */
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200755 lazy_hcall3(LHCALL_SET_PTE, lguest_data.pgdir, addr, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700756}
757
Rusty Russell2e04ef72009-07-30 16:03:45 -0600758/*
759 * This is what happens after the Guest has removed a large number of entries.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700760 * This tells the Host that any of the page table entries for userspace might
Rusty Russell2e04ef72009-07-30 16:03:45 -0600761 * have changed, ie. virtual addresses below PAGE_OFFSET.
762 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700763static void lguest_flush_tlb_user(void)
764{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200765 lazy_hcall1(LHCALL_FLUSH_TLB, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700766}
767
Rusty Russell2e04ef72009-07-30 16:03:45 -0600768/*
769 * This is called when the kernel page tables have changed. That's not very
Rusty Russellb2b47c22007-07-26 10:41:02 -0700770 * common (unless the Guest is using highmem, which makes the Guest extremely
Rusty Russell2e04ef72009-07-30 16:03:45 -0600771 * slow), so it's worth separating this from the user flushing above.
772 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700773static void lguest_flush_tlb_kernel(void)
774{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200775 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700776}
777
Rusty Russellb2b47c22007-07-26 10:41:02 -0700778/*
779 * The Unadvanced Programmable Interrupt Controller.
780 *
781 * This is an attempt to implement the simplest possible interrupt controller.
782 * I spent some time looking though routines like set_irq_chip_and_handler,
783 * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
784 * I *think* this is as simple as it gets.
785 *
786 * We can tell the Host what interrupts we want blocked ready for using the
787 * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
788 * simple as setting a bit. We don't actually "ack" interrupts as such, we
789 * just mask and unmask them. I wonder if we should be cleverer?
790 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700791static void disable_lguest_irq(unsigned int irq)
792{
793 set_bit(irq, lguest_data.blocked_interrupts);
794}
795
796static void enable_lguest_irq(unsigned int irq)
797{
798 clear_bit(irq, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -0700799}
800
Rusty Russellb2b47c22007-07-26 10:41:02 -0700801/* This structure describes the lguest IRQ controller. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700802static struct irq_chip lguest_irq_controller = {
803 .name = "lguest",
804 .mask = disable_lguest_irq,
805 .mask_ack = disable_lguest_irq,
806 .unmask = enable_lguest_irq,
807};
808
Rusty Russell2e04ef72009-07-30 16:03:45 -0600809/*
810 * This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
Rusty Russellb2b47c22007-07-26 10:41:02 -0700811 * interrupt (except 128, which is used for system calls), and then tells the
812 * Linux infrastructure that each interrupt is controlled by our level-based
Rusty Russell2e04ef72009-07-30 16:03:45 -0600813 * lguest interrupt controller.
814 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700815static void __init lguest_init_IRQ(void)
816{
817 unsigned int i;
818
Rusty Russell10283752009-06-12 22:26:59 -0600819 for (i = FIRST_EXTERNAL_VECTOR; i < NR_VECTORS; i++) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600820 /* Some systems map "vectors" to interrupts weirdly. Not us! */
Rusty Russell10283752009-06-12 22:26:59 -0600821 __get_cpu_var(vector_irq)[i] = i - FIRST_EXTERNAL_VECTOR;
822 if (i != SYSCALL_VECTOR)
823 set_intr_gate(i, interrupt[i - FIRST_EXTERNAL_VECTOR]);
Rusty Russell07ad1572007-07-19 01:49:22 -0700824 }
Rusty Russell2e04ef72009-07-30 16:03:45 -0600825
826 /*
827 * This call is required to set up for 4k stacks, where we have
828 * separate stacks for hard and soft interrupts.
829 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700830 irq_ctx_init(smp_processor_id());
831}
832
Rusty Russella91d74a2009-07-30 16:03:45 -0600833/*
834 * With CONFIG_SPARSE_IRQ, interrupt descriptors are allocated as-needed, so
835 * rather than set them in lguest_init_IRQ we are called here every time an
836 * lguest device needs an interrupt.
837 *
838 * FIXME: irq_to_desc_alloc_node() can fail due to lack of memory, we should
839 * pass that up!
840 */
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600841void lguest_setup_irq(unsigned int irq)
842{
Yinghai Lu85ac16d2009-04-27 18:00:38 -0700843 irq_to_desc_alloc_node(irq, 0);
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600844 set_irq_chip_and_handler_name(irq, &lguest_irq_controller,
845 handle_level_irq, "level");
846}
847
Rusty Russellb2b47c22007-07-26 10:41:02 -0700848/*
849 * Time.
850 *
851 * It would be far better for everyone if the Guest had its own clock, but
Rusty Russell6c8dca52007-07-27 13:42:52 +1000852 * until then the Host gives us the time on every interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700853 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700854static unsigned long lguest_get_wallclock(void)
855{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000856 return lguest_data.time.tv_sec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700857}
858
Rusty Russell2e04ef72009-07-30 16:03:45 -0600859/*
860 * The TSC is an Intel thing called the Time Stamp Counter. The Host tells us
Rusty Russella6bd8e12008-03-28 11:05:53 -0500861 * what speed it runs at, or 0 if it's unusable as a reliable clock source.
862 * This matches what we want here: if we return 0 from this function, the x86
Rusty Russell2e04ef72009-07-30 16:03:45 -0600863 * TSC clock will give up and not register itself.
864 */
Alok Katariae93ef942008-07-01 11:43:36 -0700865static unsigned long lguest_tsc_khz(void)
Rusty Russell3fabc552008-03-11 09:35:56 -0500866{
867 return lguest_data.tsc_khz;
868}
869
Rusty Russell2e04ef72009-07-30 16:03:45 -0600870/*
871 * If we can't use the TSC, the kernel falls back to our lower-priority
872 * "lguest_clock", where we read the time value given to us by the Host.
873 */
Magnus Damm8e196082009-04-21 12:24:00 -0700874static cycle_t lguest_clock_read(struct clocksource *cs)
Rusty Russell07ad1572007-07-19 01:49:22 -0700875{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000876 unsigned long sec, nsec;
877
Rusty Russell2e04ef72009-07-30 16:03:45 -0600878 /*
879 * Since the time is in two parts (seconds and nanoseconds), we risk
Rusty Russell3fabc552008-03-11 09:35:56 -0500880 * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
881 * and getting 99 and 0. As Linux tends to come apart under the stress
Rusty Russell2e04ef72009-07-30 16:03:45 -0600882 * of time travel, we must be careful:
883 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000884 do {
885 /* First we read the seconds part. */
886 sec = lguest_data.time.tv_sec;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600887 /*
888 * This read memory barrier tells the compiler and the CPU that
Rusty Russell6c8dca52007-07-27 13:42:52 +1000889 * this can't be reordered: we have to complete the above
Rusty Russell2e04ef72009-07-30 16:03:45 -0600890 * before going on.
891 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000892 rmb();
893 /* Now we read the nanoseconds part. */
894 nsec = lguest_data.time.tv_nsec;
895 /* Make sure we've done that. */
896 rmb();
897 /* Now if the seconds part has changed, try again. */
898 } while (unlikely(lguest_data.time.tv_sec != sec));
899
Rusty Russell3fabc552008-03-11 09:35:56 -0500900 /* Our lguest clock is in real nanoseconds. */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000901 return sec*1000000000ULL + nsec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700902}
903
Rusty Russell3fabc552008-03-11 09:35:56 -0500904/* This is the fallback clocksource: lower priority than the TSC clocksource. */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700905static struct clocksource lguest_clock = {
906 .name = "lguest",
Rusty Russell3fabc552008-03-11 09:35:56 -0500907 .rating = 200,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700908 .read = lguest_clock_read,
Rusty Russell6c8dca52007-07-27 13:42:52 +1000909 .mask = CLOCKSOURCE_MASK(64),
Rusty Russell37250092007-08-09 20:52:35 +1000910 .mult = 1 << 22,
911 .shift = 22,
Tony Breeds05aa0262007-10-22 10:56:25 +1000912 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700913};
914
Rusty Russell2e04ef72009-07-30 16:03:45 -0600915/*
916 * We also need a "struct clock_event_device": Linux asks us to set it to go
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700917 * off some time in the future. Actually, James Morris figured all this out, I
Rusty Russell2e04ef72009-07-30 16:03:45 -0600918 * just applied the patch.
919 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700920static int lguest_clockevent_set_next_event(unsigned long delta,
921 struct clock_event_device *evt)
922{
Rusty Russella6bd8e12008-03-28 11:05:53 -0500923 /* FIXME: I don't think this can ever happen, but James tells me he had
924 * to put this code in. Maybe we should remove it now. Anyone? */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700925 if (delta < LG_CLOCK_MIN_DELTA) {
926 if (printk_ratelimit())
927 printk(KERN_DEBUG "%s: small delta %lu ns\n",
Harvey Harrison77bf90e2008-03-03 11:37:23 -0800928 __func__, delta);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700929 return -ETIME;
930 }
Rusty Russella6bd8e12008-03-28 11:05:53 -0500931
932 /* Please wake us this far in the future. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600933 hcall(LHCALL_SET_CLOCKEVENT, delta, 0, 0, 0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700934 return 0;
935}
936
937static void lguest_clockevent_set_mode(enum clock_event_mode mode,
938 struct clock_event_device *evt)
939{
940 switch (mode) {
941 case CLOCK_EVT_MODE_UNUSED:
942 case CLOCK_EVT_MODE_SHUTDOWN:
943 /* A 0 argument shuts the clock down. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600944 hcall(LHCALL_SET_CLOCKEVENT, 0, 0, 0, 0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700945 break;
946 case CLOCK_EVT_MODE_ONESHOT:
947 /* This is what we expect. */
948 break;
949 case CLOCK_EVT_MODE_PERIODIC:
950 BUG();
Thomas Gleixner18de5bc2007-07-21 04:37:34 -0700951 case CLOCK_EVT_MODE_RESUME:
952 break;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700953 }
954}
955
956/* This describes our primitive timer chip. */
957static struct clock_event_device lguest_clockevent = {
958 .name = "lguest",
959 .features = CLOCK_EVT_FEAT_ONESHOT,
960 .set_next_event = lguest_clockevent_set_next_event,
961 .set_mode = lguest_clockevent_set_mode,
962 .rating = INT_MAX,
963 .mult = 1,
964 .shift = 0,
965 .min_delta_ns = LG_CLOCK_MIN_DELTA,
966 .max_delta_ns = LG_CLOCK_MAX_DELTA,
967};
968
Rusty Russell2e04ef72009-07-30 16:03:45 -0600969/*
970 * This is the Guest timer interrupt handler (hardware interrupt 0). We just
971 * call the clockevent infrastructure and it does whatever needs doing.
972 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700973static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
974{
975 unsigned long flags;
976
977 /* Don't interrupt us while this is running. */
978 local_irq_save(flags);
979 lguest_clockevent.event_handler(&lguest_clockevent);
980 local_irq_restore(flags);
981}
982
Rusty Russell2e04ef72009-07-30 16:03:45 -0600983/*
984 * At some point in the boot process, we get asked to set up our timing
Rusty Russellb2b47c22007-07-26 10:41:02 -0700985 * infrastructure. The kernel doesn't expect timer interrupts before this, but
986 * we cleverly initialized the "blocked_interrupts" field of "struct
Rusty Russell2e04ef72009-07-30 16:03:45 -0600987 * lguest_data" so that timer interrupts were blocked until now.
988 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700989static void lguest_time_init(void)
990{
Rusty Russellb2b47c22007-07-26 10:41:02 -0700991 /* Set up the timer interrupt (0) to go to our simple timer routine */
Rusty Russell07ad1572007-07-19 01:49:22 -0700992 set_irq_handler(0, lguest_time_irq);
Rusty Russell07ad1572007-07-19 01:49:22 -0700993
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700994 clocksource_register(&lguest_clock);
995
Rusty Russellb2b47c22007-07-26 10:41:02 -0700996 /* We can't set cpumask in the initializer: damn C limitations! Set it
997 * here and register our timer device. */
Rusty Russell320ab2b2008-12-13 21:20:26 +1030998 lguest_clockevent.cpumask = cpumask_of(0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700999 clockevents_register_device(&lguest_clockevent);
1000
Rusty Russellb2b47c22007-07-26 10:41:02 -07001001 /* Finally, we unblock the timer interrupt. */
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001002 enable_lguest_irq(0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001003}
1004
Rusty Russellb2b47c22007-07-26 10:41:02 -07001005/*
1006 * Miscellaneous bits and pieces.
1007 *
1008 * Here is an oddball collection of functions which the Guest needs for things
1009 * to work. They're pretty simple.
1010 */
1011
Rusty Russell2e04ef72009-07-30 16:03:45 -06001012/*
1013 * The Guest needs to tell the Host what stack it expects traps to use. For
Rusty Russellb2b47c22007-07-26 10:41:02 -07001014 * native hardware, this is part of the Task State Segment mentioned above in
1015 * lguest_load_tr_desc(), but to help hypervisors there's this special call.
1016 *
1017 * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
1018 * segment), the privilege level (we're privilege level 1, the Host is 0 and
1019 * will not tolerate us trying to use that), the stack pointer, and the number
Rusty Russell2e04ef72009-07-30 16:03:45 -06001020 * of pages in the stack.
1021 */
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001022static void lguest_load_sp0(struct tss_struct *tss,
Rusty Russella6bd8e12008-03-28 11:05:53 -05001023 struct thread_struct *thread)
Rusty Russell07ad1572007-07-19 01:49:22 -07001024{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001025 lazy_hcall3(LHCALL_SET_STACK, __KERNEL_DS | 0x1, thread->sp0,
1026 THREAD_SIZE / PAGE_SIZE);
Rusty Russell07ad1572007-07-19 01:49:22 -07001027}
1028
Rusty Russellb2b47c22007-07-26 10:41:02 -07001029/* Let's just say, I wouldn't do debugging under a Guest. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001030static void lguest_set_debugreg(int regno, unsigned long value)
1031{
1032 /* FIXME: Implement */
1033}
1034
Rusty Russell2e04ef72009-07-30 16:03:45 -06001035/*
1036 * There are times when the kernel wants to make sure that no memory writes are
Rusty Russellb2b47c22007-07-26 10:41:02 -07001037 * caught in the cache (that they've all reached real hardware devices). This
1038 * doesn't matter for the Guest which has virtual hardware.
1039 *
1040 * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
1041 * (clflush) instruction is available and the kernel uses that. Otherwise, it
1042 * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
1043 * Unlike clflush, wbinvd can only be run at privilege level 0. So we can
1044 * ignore clflush, but replace wbinvd.
1045 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001046static void lguest_wbinvd(void)
1047{
1048}
1049
Rusty Russell2e04ef72009-07-30 16:03:45 -06001050/*
1051 * If the Guest expects to have an Advanced Programmable Interrupt Controller,
Rusty Russellb2b47c22007-07-26 10:41:02 -07001052 * we play dumb by ignoring writes and returning 0 for reads. So it's no
1053 * longer Programmable nor Controlling anything, and I don't think 8 lines of
1054 * code qualifies for Advanced. It will also never interrupt anything. It
Rusty Russell2e04ef72009-07-30 16:03:45 -06001055 * does, however, allow us to get through the Linux boot code.
1056 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001057#ifdef CONFIG_X86_LOCAL_APIC
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001058static void lguest_apic_write(u32 reg, u32 v)
Rusty Russell07ad1572007-07-19 01:49:22 -07001059{
1060}
1061
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001062static u32 lguest_apic_read(u32 reg)
Rusty Russell07ad1572007-07-19 01:49:22 -07001063{
1064 return 0;
1065}
Suresh Siddha511d9d32008-07-14 09:49:14 -07001066
1067static u64 lguest_apic_icr_read(void)
1068{
1069 return 0;
1070}
1071
1072static void lguest_apic_icr_write(u32 low, u32 id)
1073{
1074 /* Warn to see if there's any stray references */
1075 WARN_ON(1);
1076}
1077
1078static void lguest_apic_wait_icr_idle(void)
1079{
1080 return;
1081}
1082
1083static u32 lguest_apic_safe_wait_icr_idle(void)
1084{
1085 return 0;
1086}
1087
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001088static void set_lguest_basic_apic_ops(void)
1089{
1090 apic->read = lguest_apic_read;
1091 apic->write = lguest_apic_write;
1092 apic->icr_read = lguest_apic_icr_read;
1093 apic->icr_write = lguest_apic_icr_write;
1094 apic->wait_icr_idle = lguest_apic_wait_icr_idle;
1095 apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
Suresh Siddha511d9d32008-07-14 09:49:14 -07001096};
Rusty Russell07ad1572007-07-19 01:49:22 -07001097#endif
1098
Rusty Russellb2b47c22007-07-26 10:41:02 -07001099/* STOP! Until an interrupt comes in. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001100static void lguest_safe_halt(void)
1101{
Rusty Russell091ebf02010-04-14 21:43:54 -06001102 hcall(LHCALL_HALT, 0, 0, 0, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001103}
1104
Rusty Russell2e04ef72009-07-30 16:03:45 -06001105/*
1106 * The SHUTDOWN hypercall takes a string to describe what's happening, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001107 * an argument which says whether this to restart (reboot) the Guest or not.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001108 *
1109 * Note that the Host always prefers that the Guest speak in physical addresses
Rusty Russell2e04ef72009-07-30 16:03:45 -06001110 * rather than virtual addresses, so we use __pa() here.
1111 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001112static void lguest_power_off(void)
1113{
Rusty Russell091ebf02010-04-14 21:43:54 -06001114 hcall(LHCALL_SHUTDOWN, __pa("Power down"),
1115 LGUEST_SHUTDOWN_POWEROFF, 0, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001116}
1117
Rusty Russellb2b47c22007-07-26 10:41:02 -07001118/*
1119 * Panicing.
1120 *
1121 * Don't. But if you did, this is what happens.
1122 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001123static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
1124{
Rusty Russell091ebf02010-04-14 21:43:54 -06001125 hcall(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF, 0, 0);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001126 /* The hcall won't return, but to keep gcc happy, we're "done". */
Rusty Russell07ad1572007-07-19 01:49:22 -07001127 return NOTIFY_DONE;
1128}
1129
1130static struct notifier_block paniced = {
1131 .notifier_call = lguest_panic
1132};
1133
Rusty Russellb2b47c22007-07-26 10:41:02 -07001134/* Setting up memory is fairly easy. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001135static __init char *lguest_memory_setup(void)
1136{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001137 /*
1138 *The Linux bootloader header contains an "e820" memory map: the
1139 * Launcher populated the first entry with our memory limit.
1140 */
Yinghai Lud0be6bd2008-06-15 18:58:51 -07001141 e820_add_region(boot_params.e820_map[0].addr,
H. Peter Anvin30c82642007-10-15 17:13:22 -07001142 boot_params.e820_map[0].size,
1143 boot_params.e820_map[0].type);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001144
1145 /* This string is for the boot messages. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001146 return "LGUEST";
1147}
1148
Rusty Russell2e04ef72009-07-30 16:03:45 -06001149/*
1150 * We will eventually use the virtio console device to produce console output,
Rusty Russelle1e72962007-10-25 15:02:50 +10001151 * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
Rusty Russell2e04ef72009-07-30 16:03:45 -06001152 * console output.
1153 */
Rusty Russell19f15372007-10-22 11:24:21 +10001154static __init int early_put_chars(u32 vtermno, const char *buf, int count)
1155{
1156 char scratch[17];
1157 unsigned int len = count;
1158
Rusty Russell2e04ef72009-07-30 16:03:45 -06001159 /* We use a nul-terminated string, so we make a copy. Icky, huh? */
Rusty Russell19f15372007-10-22 11:24:21 +10001160 if (len > sizeof(scratch) - 1)
1161 len = sizeof(scratch) - 1;
1162 scratch[len] = '\0';
1163 memcpy(scratch, buf, len);
Rusty Russell091ebf02010-04-14 21:43:54 -06001164 hcall(LHCALL_NOTIFY, __pa(scratch), 0, 0, 0);
Rusty Russell19f15372007-10-22 11:24:21 +10001165
1166 /* This routine returns the number of bytes actually written. */
1167 return len;
1168}
1169
Rusty Russell2e04ef72009-07-30 16:03:45 -06001170/*
1171 * Rebooting also tells the Host we're finished, but the RESTART flag tells the
1172 * Launcher to reboot us.
1173 */
Rusty Russella6bd8e12008-03-28 11:05:53 -05001174static void lguest_restart(char *reason)
1175{
Rusty Russell091ebf02010-04-14 21:43:54 -06001176 hcall(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART, 0, 0);
Rusty Russella6bd8e12008-03-28 11:05:53 -05001177}
1178
Rusty Russellb2b47c22007-07-26 10:41:02 -07001179/*G:050
1180 * Patching (Powerfully Placating Performance Pedants)
1181 *
Rusty Russella6bd8e12008-03-28 11:05:53 -05001182 * We have already seen that pv_ops structures let us replace simple native
1183 * instructions with calls to the appropriate back end all throughout the
1184 * kernel. This allows the same kernel to run as a Guest and as a native
Rusty Russellb2b47c22007-07-26 10:41:02 -07001185 * kernel, but it's slow because of all the indirect branches.
1186 *
1187 * Remember that David Wheeler quote about "Any problem in computer science can
1188 * be solved with another layer of indirection"? The rest of that quote is
1189 * "... But that usually will create another problem." This is the first of
1190 * those problems.
1191 *
1192 * Our current solution is to allow the paravirt back end to optionally patch
1193 * over the indirect calls to replace them with something more efficient. We
Rusty Russella32a8812009-06-12 22:27:02 -06001194 * patch two of the simplest of the most commonly called functions: disable
1195 * interrupts and save interrupts. We usually have 6 or 10 bytes to patch
1196 * into: the Guest versions of these operations are small enough that we can
1197 * fit comfortably.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001198 *
1199 * First we need assembly templates of each of the patchable Guest operations,
Rusty Russell2e04ef72009-07-30 16:03:45 -06001200 * and these are in i386_head.S.
1201 */
Rusty Russellb2b47c22007-07-26 10:41:02 -07001202
1203/*G:060 We construct a table from the assembler templates: */
Rusty Russell07ad1572007-07-19 01:49:22 -07001204static const struct lguest_insns
1205{
1206 const char *start, *end;
1207} lguest_insns[] = {
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001208 [PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001209 [PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
Rusty Russell07ad1572007-07-19 01:49:22 -07001210};
Rusty Russellb2b47c22007-07-26 10:41:02 -07001211
Rusty Russell2e04ef72009-07-30 16:03:45 -06001212/*
1213 * Now our patch routine is fairly simple (based on the native one in
Rusty Russellb2b47c22007-07-26 10:41:02 -07001214 * paravirt.c). If we have a replacement, we copy it in and return how much of
Rusty Russell2e04ef72009-07-30 16:03:45 -06001215 * the available space we used.
1216 */
Andi Kleenab144f52007-08-10 22:31:03 +02001217static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
1218 unsigned long addr, unsigned len)
Rusty Russell07ad1572007-07-19 01:49:22 -07001219{
1220 unsigned int insn_len;
1221
Rusty Russellb2b47c22007-07-26 10:41:02 -07001222 /* Don't do anything special if we don't have a replacement */
Rusty Russell07ad1572007-07-19 01:49:22 -07001223 if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
Andi Kleenab144f52007-08-10 22:31:03 +02001224 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001225
1226 insn_len = lguest_insns[type].end - lguest_insns[type].start;
1227
Rusty Russell2e04ef72009-07-30 16:03:45 -06001228 /* Similarly if it can't fit (doesn't happen, but let's be thorough). */
Rusty Russell07ad1572007-07-19 01:49:22 -07001229 if (len < insn_len)
Andi Kleenab144f52007-08-10 22:31:03 +02001230 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001231
Rusty Russellb2b47c22007-07-26 10:41:02 -07001232 /* Copy in our instructions. */
Andi Kleenab144f52007-08-10 22:31:03 +02001233 memcpy(ibuf, lguest_insns[type].start, insn_len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001234 return insn_len;
1235}
1236
Rusty Russell2e04ef72009-07-30 16:03:45 -06001237/*G:029
1238 * Once we get to lguest_init(), we know we're a Guest. The various
Rusty Russella6bd8e12008-03-28 11:05:53 -05001239 * pv_ops structures in the kernel provide points for (almost) every routine we
Rusty Russell2e04ef72009-07-30 16:03:45 -06001240 * have to override to avoid privileged instructions.
1241 */
Rusty Russell814a0e52007-10-22 11:29:44 +10001242__init void lguest_init(void)
Rusty Russell07ad1572007-07-19 01:49:22 -07001243{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001244 /* We're under lguest. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001245 pv_info.name = "lguest";
Rusty Russell2e04ef72009-07-30 16:03:45 -06001246 /* Paravirt is enabled. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001247 pv_info.paravirt_enabled = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001248 /* We're running at privilege level 1, not 0 as normal. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001249 pv_info.kernel_rpl = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001250 /* Everyone except Xen runs with this set. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001251 pv_info.shared_kernel_pmd = 1;
Rusty Russell07ad1572007-07-19 01:49:22 -07001252
Rusty Russell2e04ef72009-07-30 16:03:45 -06001253 /*
1254 * We set up all the lguest overrides for sensitive operations. These
1255 * are detailed with the operations themselves.
1256 */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001257
Rusty Russell2e04ef72009-07-30 16:03:45 -06001258 /* Interrupt-related operations */
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001259 pv_irq_ops.save_fl = PV_CALLEE_SAVE(save_fl);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001260 pv_irq_ops.restore_fl = __PV_IS_CALLEE_SAVE(lg_restore_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001261 pv_irq_ops.irq_disable = PV_CALLEE_SAVE(irq_disable);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001262 pv_irq_ops.irq_enable = __PV_IS_CALLEE_SAVE(lg_irq_enable);
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001263 pv_irq_ops.safe_halt = lguest_safe_halt;
1264
Rusty Russell2e04ef72009-07-30 16:03:45 -06001265 /* Setup operations */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001266 pv_init_ops.patch = lguest_patch;
1267
Rusty Russell2e04ef72009-07-30 16:03:45 -06001268 /* Intercepts of various CPU instructions */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001269 pv_cpu_ops.load_gdt = lguest_load_gdt;
1270 pv_cpu_ops.cpuid = lguest_cpuid;
1271 pv_cpu_ops.load_idt = lguest_load_idt;
1272 pv_cpu_ops.iret = lguest_iret;
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001273 pv_cpu_ops.load_sp0 = lguest_load_sp0;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001274 pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1275 pv_cpu_ops.set_ldt = lguest_set_ldt;
1276 pv_cpu_ops.load_tls = lguest_load_tls;
1277 pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1278 pv_cpu_ops.clts = lguest_clts;
1279 pv_cpu_ops.read_cr0 = lguest_read_cr0;
1280 pv_cpu_ops.write_cr0 = lguest_write_cr0;
1281 pv_cpu_ops.read_cr4 = lguest_read_cr4;
1282 pv_cpu_ops.write_cr4 = lguest_write_cr4;
1283 pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1284 pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1285 pv_cpu_ops.wbinvd = lguest_wbinvd;
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -08001286 pv_cpu_ops.start_context_switch = paravirt_start_context_switch;
1287 pv_cpu_ops.end_context_switch = lguest_end_context_switch;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001288
Rusty Russell2e04ef72009-07-30 16:03:45 -06001289 /* Pagetable management */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001290 pv_mmu_ops.write_cr3 = lguest_write_cr3;
1291 pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1292 pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1293 pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1294 pv_mmu_ops.set_pte = lguest_set_pte;
1295 pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1296 pv_mmu_ops.set_pmd = lguest_set_pmd;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001297#ifdef CONFIG_X86_PAE
1298 pv_mmu_ops.set_pte_atomic = lguest_set_pte_atomic;
1299 pv_mmu_ops.pte_clear = lguest_pte_clear;
1300 pv_mmu_ops.pmd_clear = lguest_pmd_clear;
1301 pv_mmu_ops.set_pud = lguest_set_pud;
1302#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001303 pv_mmu_ops.read_cr2 = lguest_read_cr2;
1304 pv_mmu_ops.read_cr3 = lguest_read_cr3;
Jeremy Fitzhardinge8965c1c2007-10-16 11:51:29 -07001305 pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -08001306 pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mmu_mode;
Rusty Russellb7ff99e2009-03-30 21:55:23 -06001307 pv_mmu_ops.pte_update = lguest_pte_update;
1308 pv_mmu_ops.pte_update_defer = lguest_pte_update;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001309
Rusty Russell07ad1572007-07-19 01:49:22 -07001310#ifdef CONFIG_X86_LOCAL_APIC
Rusty Russell2e04ef72009-07-30 16:03:45 -06001311 /* APIC read/write intercepts */
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001312 set_lguest_basic_apic_ops();
Rusty Russell07ad1572007-07-19 01:49:22 -07001313#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001314
Thomas Gleixner6b18ae32009-08-20 10:19:54 +02001315 x86_init.resources.memory_setup = lguest_memory_setup;
Thomas Gleixner66bcaf02009-08-20 09:59:09 +02001316 x86_init.irqs.intr_init = lguest_init_IRQ;
Thomas Gleixner845b3942009-08-19 15:37:03 +02001317 x86_init.timers.timer_init = lguest_time_init;
Thomas Gleixner2d826402009-08-20 17:06:25 +02001318 x86_platform.calibrate_tsc = lguest_tsc_khz;
Feng Tang7bd867d2009-09-10 10:48:56 +08001319 x86_platform.get_wallclock = lguest_get_wallclock;
Thomas Gleixner6b18ae32009-08-20 10:19:54 +02001320
Rusty Russell2e04ef72009-07-30 16:03:45 -06001321 /*
1322 * Now is a good time to look at the implementations of these functions
1323 * before returning to the rest of lguest_init().
1324 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001325
Rusty Russell2e04ef72009-07-30 16:03:45 -06001326 /*G:070
1327 * Now we've seen all the paravirt_ops, we return to
Rusty Russellb2b47c22007-07-26 10:41:02 -07001328 * lguest_init() where the rest of the fairly chaotic boot setup
Rusty Russell2e04ef72009-07-30 16:03:45 -06001329 * occurs.
1330 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001331
Rusty Russell2e04ef72009-07-30 16:03:45 -06001332 /*
1333 * The stack protector is a weird thing where gcc places a canary
Rusty Russell2cb78782009-06-03 14:52:24 +09301334 * value on the stack and then checks it on return. This file is
1335 * compiled with -fno-stack-protector it, so we got this far without
1336 * problems. The value of the canary is kept at offset 20 from the
1337 * %gs register, so we need to set that up before calling C functions
Rusty Russell2e04ef72009-07-30 16:03:45 -06001338 * in other files.
1339 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301340 setup_stack_canary_segment(0);
Rusty Russell2e04ef72009-07-30 16:03:45 -06001341
1342 /*
1343 * We could just call load_stack_canary_segment(), but we might as well
1344 * call switch_to_new_gdt() which loads the whole table and sets up the
1345 * per-cpu segment descriptor register %fs as well.
1346 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301347 switch_to_new_gdt(0);
1348
Rusty Russella91d74a2009-07-30 16:03:45 -06001349 /* We actually boot with all memory mapped, but let's say 128MB. */
Rusty Russell5d006d82008-07-29 09:58:29 -05001350 max_pfn_mapped = (128*1024*1024) >> PAGE_SHIFT;
1351
Rusty Russell2e04ef72009-07-30 16:03:45 -06001352 /*
1353 * The Host<->Guest Switcher lives at the top of our address space, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001354 * the Host told us how big it is when we made LGUEST_INIT hypercall:
Rusty Russell2e04ef72009-07-30 16:03:45 -06001355 * it put the answer in lguest_data.reserve_mem
1356 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001357 reserve_top_address(lguest_data.reserve_mem);
1358
Rusty Russell2e04ef72009-07-30 16:03:45 -06001359 /*
1360 * If we don't initialize the lock dependency checker now, it crashes
Rusty Russellcdae0ad2009-09-23 22:26:42 -06001361 * atomic_notifier_chain_register, then paravirt_disable_iospace.
Rusty Russell2e04ef72009-07-30 16:03:45 -06001362 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001363 lockdep_init();
1364
Rusty Russellcdae0ad2009-09-23 22:26:42 -06001365 /* Hook in our special panic hypercall code. */
1366 atomic_notifier_chain_register(&panic_notifier_list, &paniced);
1367
Rusty Russell2e04ef72009-07-30 16:03:45 -06001368 /*
1369 * The IDE code spends about 3 seconds probing for disks: if we reserve
Rusty Russellb2b47c22007-07-26 10:41:02 -07001370 * all the I/O ports up front it can't get them and so doesn't probe.
1371 * Other device drivers are similar (but less severe). This cuts the
Rusty Russell2e04ef72009-07-30 16:03:45 -06001372 * kernel boot time on my machine from 4.1 seconds to 0.45 seconds.
1373 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001374 paravirt_disable_iospace();
1375
Rusty Russell2e04ef72009-07-30 16:03:45 -06001376 /*
1377 * This is messy CPU setup stuff which the native boot code does before
1378 * start_kernel, so we have to do, too:
1379 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001380 cpu_detect(&new_cpu_data);
1381 /* head.S usually sets up the first capability word, so do it here. */
1382 new_cpu_data.x86_capability[0] = cpuid_edx(1);
1383
1384 /* Math is always hard! */
1385 new_cpu_data.hard_math = 1;
1386
Rusty Russella6bd8e12008-03-28 11:05:53 -05001387 /* We don't have features. We have puppies! Puppies! */
Rusty Russell07ad1572007-07-19 01:49:22 -07001388#ifdef CONFIG_X86_MCE
1389 mce_disabled = 1;
1390#endif
Rusty Russell07ad1572007-07-19 01:49:22 -07001391#ifdef CONFIG_ACPI
1392 acpi_disabled = 1;
1393 acpi_ht = 0;
1394#endif
1395
Rusty Russell2e04ef72009-07-30 16:03:45 -06001396 /*
1397 * We set the preferred console to "hvc". This is the "hypervisor
Rusty Russellb2b47c22007-07-26 10:41:02 -07001398 * virtual console" driver written by the PowerPC people, which we also
Rusty Russell2e04ef72009-07-30 16:03:45 -06001399 * adapted for lguest's use.
1400 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001401 add_preferred_console("hvc", 0, NULL);
1402
Rusty Russell19f15372007-10-22 11:24:21 +10001403 /* Register our very early console. */
1404 virtio_cons_early_init(early_put_chars);
1405
Rusty Russell2e04ef72009-07-30 16:03:45 -06001406 /*
1407 * Last of all, we set the power management poweroff hook to point to
Rusty Russella6bd8e12008-03-28 11:05:53 -05001408 * the Guest routine to power off, and the reboot hook to our restart
Rusty Russell2e04ef72009-07-30 16:03:45 -06001409 * routine.
1410 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001411 pm_power_off = lguest_power_off;
Balaji Raoec04b132007-12-28 14:26:24 +05301412 machine_ops.restart = lguest_restart;
Rusty Russella6bd8e12008-03-28 11:05:53 -05001413
Rusty Russell2e04ef72009-07-30 16:03:45 -06001414 /*
1415 * Now we're set up, call i386_start_kernel() in head32.c and we proceed
1416 * to boot as normal. It never returns.
1417 */
Yinghai Luf0d43102008-05-29 12:56:36 -07001418 i386_start_kernel();
Rusty Russell07ad1572007-07-19 01:49:22 -07001419}
Rusty Russellb2b47c22007-07-26 10:41:02 -07001420/*
1421 * This marks the end of stage II of our journey, The Guest.
1422 *
Rusty Russelle1e72962007-10-25 15:02:50 +10001423 * It is now time for us to explore the layer of virtual drivers and complete
1424 * our understanding of the Guest in "make Drivers".
Rusty Russellb2b47c22007-07-26 10:41:02 -07001425 */