blob: d677fa9ca6506c4851f933ab5f3af6871cf79160 [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. */
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600118 kvm_hypercall4(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 */
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200148static void lazy_hcall1(unsigned long call,
149 unsigned long arg1)
150{
151 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
152 kvm_hypercall1(call, arg1);
153 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600154 async_hcall(call, arg1, 0, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200155}
156
Rusty Russella91d74a2009-07-30 16:03:45 -0600157/* You can imagine what lazy_hcall2, 3 and 4 look like. :*/
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200158static void lazy_hcall2(unsigned long call,
159 unsigned long arg1,
160 unsigned long arg2)
161{
162 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
163 kvm_hypercall2(call, arg1, arg2);
164 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600165 async_hcall(call, arg1, arg2, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200166}
167
168static void lazy_hcall3(unsigned long call,
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100169 unsigned long arg1,
170 unsigned long arg2,
171 unsigned long arg3)
172{
173 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200174 kvm_hypercall3(call, arg1, arg2, arg3);
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100175 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600176 async_hcall(call, arg1, arg2, arg3, 0);
177}
178
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600179#ifdef CONFIG_X86_PAE
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600180static void lazy_hcall4(unsigned long call,
181 unsigned long arg1,
182 unsigned long arg2,
183 unsigned long arg3,
184 unsigned long arg4)
185{
186 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
187 kvm_hypercall4(call, arg1, arg2, arg3, arg4);
188 else
189 async_hcall(call, arg1, arg2, arg3, arg4);
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100190}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600191#endif
Rusty Russell633872b2007-11-05 21:55:57 +1100192
Rusty Russella91d74a2009-07-30 16:03:45 -0600193/*G:036
194 * When lazy mode is turned off reset the per-cpu lazy mode variable and then
195 * issue the do-nothing hypercall to flush any stored calls.
196:*/
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800197static void lguest_leave_lazy_mmu_mode(void)
Rusty Russell633872b2007-11-05 21:55:57 +1100198{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200199 kvm_hypercall0(LHCALL_FLUSH_ASYNC);
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800200 paravirt_leave_lazy_mmu();
201}
202
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800203static void lguest_end_context_switch(struct task_struct *next)
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800204{
Rusty Russell633872b2007-11-05 21:55:57 +1100205 kvm_hypercall0(LHCALL_FLUSH_ASYNC);
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800206 paravirt_end_context_switch(next);
Rusty Russell633872b2007-11-05 21:55:57 +1100207}
Rusty Russell07ad1572007-07-19 01:49:22 -0700208
Rusty Russell61f4bc82009-06-12 22:27:03 -0600209/*G:032
Rusty Russelle1e72962007-10-25 15:02:50 +1000210 * After that diversion we return to our first native-instruction
211 * replacements: four functions for interrupt control.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700212 *
213 * The simplest way of implementing these would be to have "turn interrupts
214 * off" and "turn interrupts on" hypercalls. Unfortunately, this is too slow:
215 * these are by far the most commonly called functions of those we override.
216 *
217 * So instead we keep an "irq_enabled" field inside our "struct lguest_data",
218 * which the Guest can update with a single instruction. The Host knows to
Rusty Russella6bd8e12008-03-28 11:05:53 -0500219 * check there before it tries to deliver an interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700220 */
221
Rusty Russell2e04ef72009-07-30 16:03:45 -0600222/*
223 * save_flags() is expected to return the processor state (ie. "flags"). The
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100224 * flags word contains all kind of stuff, but in practice Linux only cares
Rusty Russell2e04ef72009-07-30 16:03:45 -0600225 * about the interrupt flag. Our "save_flags()" just returns that.
226 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700227static unsigned long save_fl(void)
228{
229 return lguest_data.irq_enabled;
230}
Rusty Russell07ad1572007-07-19 01:49:22 -0700231
Rusty Russellb2b47c22007-07-26 10:41:02 -0700232/* Interrupts go off... */
Rusty Russell07ad1572007-07-19 01:49:22 -0700233static void irq_disable(void)
234{
235 lguest_data.irq_enabled = 0;
236}
Rusty Russell61f4bc82009-06-12 22:27:03 -0600237
Rusty Russell2e04ef72009-07-30 16:03:45 -0600238/*
239 * Let's pause a moment. Remember how I said these are called so often?
Rusty Russell61f4bc82009-06-12 22:27:03 -0600240 * Jeremy Fitzhardinge optimized them so hard early in 2009 that he had to
241 * break some rules. In particular, these functions are assumed to save their
242 * own registers if they need to: normal C functions assume they can trash the
243 * eax register. To use normal C functions, we use
244 * PV_CALLEE_SAVE_REGS_THUNK(), which pushes %eax onto the stack, calls the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600245 * C function, then restores it.
246 */
Rusty Russell61f4bc82009-06-12 22:27:03 -0600247PV_CALLEE_SAVE_REGS_THUNK(save_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -0800248PV_CALLEE_SAVE_REGS_THUNK(irq_disable);
Rusty Russellf56a3842007-07-26 10:41:05 -0700249/*:*/
Rusty Russell61f4bc82009-06-12 22:27:03 -0600250
251/* These are in i386_head.S */
252extern void lg_irq_enable(void);
253extern void lg_restore_fl(unsigned long flags);
254
Rusty Russell2e04ef72009-07-30 16:03:45 -0600255/*M:003
Rusty Russella91d74a2009-07-30 16:03:45 -0600256 * We could be more efficient in our checking of outstanding interrupts, rather
257 * than using a branch. One way would be to put the "irq_enabled" field in a
258 * page by itself, and have the Host write-protect it when an interrupt comes
259 * in when irqs are disabled. There will then be a page fault as soon as
260 * interrupts are re-enabled.
Rusty Russella6bd8e12008-03-28 11:05:53 -0500261 *
262 * A better method is to implement soft interrupt disable generally for x86:
263 * instead of disabling interrupts, we set a flag. If an interrupt does come
264 * in, we then disable them for real. This is uncommon, so we could simply use
Rusty Russell2e04ef72009-07-30 16:03:45 -0600265 * a hypercall for interrupt control and not worry about efficiency.
266:*/
Rusty Russell07ad1572007-07-19 01:49:22 -0700267
Rusty Russellb2b47c22007-07-26 10:41:02 -0700268/*G:034
269 * The Interrupt Descriptor Table (IDT).
270 *
271 * The IDT tells the processor what to do when an interrupt comes in. Each
272 * entry in the table is a 64-bit descriptor: this holds the privilege level,
273 * address of the handler, and... well, who cares? The Guest just asks the
274 * Host to make the change anyway, because the Host controls the real IDT.
275 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100276static void lguest_write_idt_entry(gate_desc *dt,
277 int entrynum, const gate_desc *g)
Rusty Russell07ad1572007-07-19 01:49:22 -0700278{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600279 /*
280 * The gate_desc structure is 8 bytes long: we hand it to the Host in
Rusty Russella6bd8e12008-03-28 11:05:53 -0500281 * two 32-bit chunks. The whole 32-bit kernel used to hand descriptors
282 * around like this; typesafety wasn't a big concern in Linux's early
Rusty Russell2e04ef72009-07-30 16:03:45 -0600283 * years.
284 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100285 u32 *desc = (u32 *)g;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700286 /* Keep the local copy up to date. */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100287 native_write_idt_entry(dt, entrynum, g);
Rusty Russellb2b47c22007-07-26 10:41:02 -0700288 /* Tell Host about this new entry. */
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200289 kvm_hypercall3(LHCALL_LOAD_IDT_ENTRY, entrynum, desc[0], desc[1]);
Rusty Russell07ad1572007-07-19 01:49:22 -0700290}
291
Rusty Russell2e04ef72009-07-30 16:03:45 -0600292/*
293 * Changing to a different IDT is very rare: we keep the IDT up-to-date every
Rusty Russellb2b47c22007-07-26 10:41:02 -0700294 * time it is written, so we can simply loop through all entries and tell the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600295 * Host about them.
296 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100297static void lguest_load_idt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700298{
299 unsigned int i;
300 struct desc_struct *idt = (void *)desc->address;
301
302 for (i = 0; i < (desc->size+1)/8; i++)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200303 kvm_hypercall3(LHCALL_LOAD_IDT_ENTRY, i, idt[i].a, idt[i].b);
Rusty Russell07ad1572007-07-19 01:49:22 -0700304}
305
Rusty Russellb2b47c22007-07-26 10:41:02 -0700306/*
307 * The Global Descriptor Table.
308 *
309 * The Intel architecture defines another table, called the Global Descriptor
310 * Table (GDT). You tell the CPU where it is (and its size) using the "lgdt"
311 * instruction, and then several other instructions refer to entries in the
312 * table. There are three entries which the Switcher needs, so the Host simply
313 * controls the entire thing and the Guest asks it to make changes using the
314 * LOAD_GDT hypercall.
315 *
Rusty Russella489f0b2009-04-19 23:14:00 -0600316 * This is the exactly like the IDT code.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700317 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100318static void lguest_load_gdt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700319{
Rusty Russella489f0b2009-04-19 23:14:00 -0600320 unsigned int i;
321 struct desc_struct *gdt = (void *)desc->address;
322
323 for (i = 0; i < (desc->size+1)/8; i++)
324 kvm_hypercall3(LHCALL_LOAD_GDT_ENTRY, i, gdt[i].a, gdt[i].b);
Rusty Russell07ad1572007-07-19 01:49:22 -0700325}
326
Rusty Russell2e04ef72009-07-30 16:03:45 -0600327/*
328 * For a single GDT entry which changes, we do the lazy thing: alter our GDT,
Rusty Russellb2b47c22007-07-26 10:41:02 -0700329 * then tell the Host to reload the entire thing. This operation is so rare
Rusty Russell2e04ef72009-07-30 16:03:45 -0600330 * that this naive implementation is reasonable.
331 */
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100332static void lguest_write_gdt_entry(struct desc_struct *dt, int entrynum,
333 const void *desc, int type)
Rusty Russell07ad1572007-07-19 01:49:22 -0700334{
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100335 native_write_gdt_entry(dt, entrynum, desc, type);
Rusty Russella489f0b2009-04-19 23:14:00 -0600336 /* Tell Host about this new entry. */
337 kvm_hypercall3(LHCALL_LOAD_GDT_ENTRY, entrynum,
338 dt[entrynum].a, dt[entrynum].b);
Rusty Russell07ad1572007-07-19 01:49:22 -0700339}
340
Rusty Russell2e04ef72009-07-30 16:03:45 -0600341/*
342 * OK, I lied. There are three "thread local storage" GDT entries which change
Rusty Russellb2b47c22007-07-26 10:41:02 -0700343 * on every context switch (these three entries are how glibc implements
Rusty Russell2e04ef72009-07-30 16:03:45 -0600344 * __thread variables). So we have a hypercall specifically for this case.
345 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700346static void lguest_load_tls(struct thread_struct *t, unsigned int cpu)
347{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600348 /*
349 * There's one problem which normal hardware doesn't have: the Host
Rusty Russell0d027c02007-08-09 20:57:13 +1000350 * can't handle us removing entries we're currently using. So we clear
Rusty Russell2e04ef72009-07-30 16:03:45 -0600351 * the GS register here: if it's needed it'll be reloaded anyway.
352 */
Tejun Heoccbeed32009-02-09 22:17:40 +0900353 lazy_load_gs(0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200354 lazy_hcall2(LHCALL_LOAD_TLS, __pa(&t->tls_array), cpu);
Rusty Russell07ad1572007-07-19 01:49:22 -0700355}
356
Rusty Russell2e04ef72009-07-30 16:03:45 -0600357/*G:038
358 * That's enough excitement for now, back to ploughing through each of the
359 * different pv_ops structures (we're about 1/3 of the way through).
Rusty Russellb2b47c22007-07-26 10:41:02 -0700360 *
361 * This is the Local Descriptor Table, another weird Intel thingy. Linux only
362 * uses this for some strange applications like Wine. We don't do anything
Rusty Russell2e04ef72009-07-30 16:03:45 -0600363 * here, so they'll get an informative and friendly Segmentation Fault.
364 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700365static void lguest_set_ldt(const void *addr, unsigned entries)
366{
367}
368
Rusty Russell2e04ef72009-07-30 16:03:45 -0600369/*
370 * This loads a GDT entry into the "Task Register": that entry points to a
Rusty Russellb2b47c22007-07-26 10:41:02 -0700371 * structure called the Task State Segment. Some comments scattered though the
372 * kernel code indicate that this used for task switching in ages past, along
373 * with blood sacrifice and astrology.
374 *
375 * Now there's nothing interesting in here that we don't get told elsewhere.
376 * But the native version uses the "ltr" instruction, which makes the Host
377 * complain to the Guest about a Segmentation Fault and it'll oops. So we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600378 * override the native version with a do-nothing version.
379 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700380static void lguest_load_tr_desc(void)
381{
382}
383
Rusty Russell2e04ef72009-07-30 16:03:45 -0600384/*
385 * The "cpuid" instruction is a way of querying both the CPU identity
Rusty Russellb2b47c22007-07-26 10:41:02 -0700386 * (manufacturer, model, etc) and its features. It was introduced before the
Rusty Russella6bd8e12008-03-28 11:05:53 -0500387 * Pentium in 1993 and keeps getting extended by both Intel, AMD and others.
388 * As you might imagine, after a decade and a half this treatment, it is now a
389 * giant ball of hair. Its entry in the current Intel manual runs to 28 pages.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700390 *
391 * This instruction even it has its own Wikipedia entry. The Wikipedia entry
Rusty Russell2e04ef72009-07-30 16:03:45 -0600392 * has been translated into 5 languages. I am not making this up!
Rusty Russellb2b47c22007-07-26 10:41:02 -0700393 *
394 * We could get funky here and identify ourselves as "GenuineLguest", but
395 * instead we just use the real "cpuid" instruction. Then I pretty much turned
396 * off feature bits until the Guest booted. (Don't say that: you'll damage
397 * lguest sales!) Shut up, inner voice! (Hey, just pointing out that this is
398 * hardly future proof.) Noone's listening! They don't like you anyway,
399 * parenthetic weirdo!
400 *
401 * Replacing the cpuid so we can turn features off is great for the kernel, but
402 * anyone (including userspace) can just use the raw "cpuid" instruction and
403 * the Host won't even notice since it isn't privileged. So we try not to get
Rusty Russell2e04ef72009-07-30 16:03:45 -0600404 * too worked up about it.
405 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100406static void lguest_cpuid(unsigned int *ax, unsigned int *bx,
407 unsigned int *cx, unsigned int *dx)
Rusty Russell07ad1572007-07-19 01:49:22 -0700408{
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100409 int function = *ax;
Rusty Russell07ad1572007-07-19 01:49:22 -0700410
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100411 native_cpuid(ax, bx, cx, dx);
Rusty Russell07ad1572007-07-19 01:49:22 -0700412 switch (function) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600413 /*
414 * CPUID 0 gives the highest legal CPUID number (and the ID string).
415 * We futureproof our code a little by sticking to known CPUID values.
416 */
417 case 0:
Rusty Russell7a504922009-07-17 21:47:44 -0600418 if (*ax > 5)
419 *ax = 5;
420 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600421
422 /*
423 * CPUID 1 is a basic feature request.
424 *
425 * CX: we only allow kernel to see SSE3, CMPXCHG16B and SSSE3
426 * DX: SSE, SSE2, FXSR, MMX, CMOV, CMPXCHG8B, TSC, FPU and PAE.
427 */
428 case 1:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100429 *cx &= 0x00002201;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600430 *dx &= 0x07808151;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600431 /*
432 * The Host can do a nice optimization if it knows that the
Rusty Russellb2b47c22007-07-26 10:41:02 -0700433 * kernel mappings (addresses above 0xC0000000 or whatever
434 * PAGE_OFFSET is set to) haven't changed. But Linux calls
435 * flush_tlb_user() for both user and kernel mappings unless
Rusty Russell2e04ef72009-07-30 16:03:45 -0600436 * the Page Global Enable (PGE) feature bit is set.
437 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100438 *dx |= 0x00002000;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600439 /*
440 * We also lie, and say we're family id 5. 6 or greater
Rusty Russellcbd88c82009-03-09 10:06:22 -0600441 * leads to a rdmsr in early_init_intel which we can't handle.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600442 * Family ID is returned as bits 8-12 in ax.
443 */
Rusty Russellcbd88c82009-03-09 10:06:22 -0600444 *ax &= 0xFFFFF0FF;
445 *ax |= 0x00000500;
Rusty Russell07ad1572007-07-19 01:49:22 -0700446 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600447 /*
448 * 0x80000000 returns the highest Extended Function, so we futureproof
449 * like we do above by limiting it to known fields.
450 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700451 case 0x80000000:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100452 if (*ax > 0x80000008)
453 *ax = 0x80000008;
Rusty Russell07ad1572007-07-19 01:49:22 -0700454 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600455
456 /*
457 * PAE systems can mark pages as non-executable. Linux calls this the
458 * NX bit. Intel calls it XD (eXecute Disable), AMD EVP (Enhanced
459 * Virus Protection). We just switch turn if off here, since we don't
460 * support it.
461 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600462 case 0x80000001:
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600463 *dx &= ~(1 << 20);
464 break;
Rusty Russell07ad1572007-07-19 01:49:22 -0700465 }
466}
467
Rusty Russell2e04ef72009-07-30 16:03:45 -0600468/*
469 * Intel has four control registers, imaginatively named cr0, cr2, cr3 and cr4.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700470 * I assume there's a cr1, but it hasn't bothered us yet, so we'll not bother
471 * it. The Host needs to know when the Guest wants to change them, so we have
472 * a whole series of functions like read_cr0() and write_cr0().
473 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000474 * We start with cr0. cr0 allows you to turn on and off all kinds of basic
Rusty Russellb2b47c22007-07-26 10:41:02 -0700475 * features, but Linux only really cares about one: the horrifically-named Task
476 * Switched (TS) bit at bit 3 (ie. 8)
477 *
478 * What does the TS bit do? Well, it causes the CPU to trap (interrupt 7) if
479 * the floating point unit is used. Which allows us to restore FPU state
480 * lazily after a task switch, and Linux uses that gratefully, but wouldn't a
481 * name like "FPUTRAP bit" be a little less cryptic?
482 *
Rusty Russellad5173f2008-10-31 11:24:27 -0500483 * We store cr0 locally because the Host never changes it. The Guest sometimes
Rusty Russell2e04ef72009-07-30 16:03:45 -0600484 * wants to read it and we'd prefer not to bother the Host unnecessarily.
485 */
Rusty Russellad5173f2008-10-31 11:24:27 -0500486static unsigned long current_cr0;
Rusty Russell07ad1572007-07-19 01:49:22 -0700487static void lguest_write_cr0(unsigned long val)
488{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200489 lazy_hcall1(LHCALL_TS, val & X86_CR0_TS);
Rusty Russell07ad1572007-07-19 01:49:22 -0700490 current_cr0 = val;
491}
492
493static unsigned long lguest_read_cr0(void)
494{
495 return current_cr0;
496}
497
Rusty Russell2e04ef72009-07-30 16:03:45 -0600498/*
499 * Intel provided a special instruction to clear the TS bit for people too cool
Rusty Russellb2b47c22007-07-26 10:41:02 -0700500 * to use write_cr0() to do it. This "clts" instruction is faster, because all
Rusty Russell2e04ef72009-07-30 16:03:45 -0600501 * the vowels have been optimized out.
502 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700503static void lguest_clts(void)
504{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200505 lazy_hcall1(LHCALL_TS, 0);
Rusty Russell25c47bb2007-10-25 14:09:53 +1000506 current_cr0 &= ~X86_CR0_TS;
Rusty Russell07ad1572007-07-19 01:49:22 -0700507}
508
Rusty Russell2e04ef72009-07-30 16:03:45 -0600509/*
510 * cr2 is the virtual address of the last page fault, which the Guest only ever
Rusty Russellb2b47c22007-07-26 10:41:02 -0700511 * reads. The Host kindly writes this into our "struct lguest_data", so we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600512 * just read it out of there.
513 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700514static unsigned long lguest_read_cr2(void)
515{
516 return lguest_data.cr2;
517}
518
Rusty Russellad5173f2008-10-31 11:24:27 -0500519/* See lguest_set_pte() below. */
520static bool cr3_changed = false;
521
Rusty Russell2e04ef72009-07-30 16:03:45 -0600522/*
523 * cr3 is the current toplevel pagetable page: the principle is the same as
Rusty Russellad5173f2008-10-31 11:24:27 -0500524 * cr0. Keep a local copy, and tell the Host when it changes. The only
525 * difference is that our local copy is in lguest_data because the Host needs
Rusty Russell2e04ef72009-07-30 16:03:45 -0600526 * to set it upon our initial hypercall.
527 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700528static void lguest_write_cr3(unsigned long cr3)
529{
Rusty Russellad5173f2008-10-31 11:24:27 -0500530 lguest_data.pgdir = cr3;
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200531 lazy_hcall1(LHCALL_NEW_PGTABLE, cr3);
Rusty Russellad5173f2008-10-31 11:24:27 -0500532 cr3_changed = true;
Rusty Russell07ad1572007-07-19 01:49:22 -0700533}
534
535static unsigned long lguest_read_cr3(void)
536{
Rusty Russellad5173f2008-10-31 11:24:27 -0500537 return lguest_data.pgdir;
Rusty Russell07ad1572007-07-19 01:49:22 -0700538}
539
Rusty Russelle1e72962007-10-25 15:02:50 +1000540/* cr4 is used to enable and disable PGE, but we don't care. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700541static unsigned long lguest_read_cr4(void)
542{
543 return 0;
544}
545
546static void lguest_write_cr4(unsigned long val)
547{
548}
549
Rusty Russellb2b47c22007-07-26 10:41:02 -0700550/*
551 * Page Table Handling.
552 *
553 * Now would be a good time to take a rest and grab a coffee or similarly
554 * relaxing stimulant. The easy parts are behind us, and the trek gradually
555 * winds uphill from here.
556 *
557 * Quick refresher: memory is divided into "pages" of 4096 bytes each. The CPU
558 * maps virtual addresses to physical addresses using "page tables". We could
559 * use one huge index of 1 million entries: each address is 4 bytes, so that's
560 * 1024 pages just to hold the page tables. But since most virtual addresses
Rusty Russelle1e72962007-10-25 15:02:50 +1000561 * are unused, we use a two level index which saves space. The cr3 register
Rusty Russellb2b47c22007-07-26 10:41:02 -0700562 * contains the physical address of the top level "page directory" page, which
563 * contains physical addresses of up to 1024 second-level pages. Each of these
564 * second level pages contains up to 1024 physical addresses of actual pages,
565 * or Page Table Entries (PTEs).
566 *
567 * Here's a diagram, where arrows indicate physical addresses:
568 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000569 * cr3 ---> +---------+
Rusty Russellb2b47c22007-07-26 10:41:02 -0700570 * | --------->+---------+
571 * | | | PADDR1 |
Rusty Russella91d74a2009-07-30 16:03:45 -0600572 * Mid-level | | PADDR2 |
Rusty Russellb2b47c22007-07-26 10:41:02 -0700573 * (PMD) page | | |
574 * | | Lower-level |
575 * | | (PTE) page |
576 * | | | |
577 * .... ....
578 *
579 * So to convert a virtual address to a physical address, we look up the top
580 * level, which points us to the second level, which gives us the physical
581 * address of that page. If the top level entry was not present, or the second
582 * level entry was not present, then the virtual address is invalid (we
583 * say "the page was not mapped").
584 *
585 * Put another way, a 32-bit virtual address is divided up like so:
586 *
587 * 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
588 * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
589 * Index into top Index into second Offset within page
590 * page directory page pagetable page
591 *
Rusty Russella91d74a2009-07-30 16:03:45 -0600592 * Now, unfortunately, this isn't the whole story: Intel added Physical Address
593 * Extension (PAE) to allow 32 bit systems to use 64GB of memory (ie. 36 bits).
594 * These are held in 64-bit page table entries, so we can now only fit 512
595 * entries in a page, and the neat three-level tree breaks down.
596 *
597 * The result is a four level page table:
598 *
599 * cr3 --> [ 4 Upper ]
600 * [ Level ]
601 * [ Entries ]
602 * [(PUD Page)]---> +---------+
603 * | --------->+---------+
604 * | | | PADDR1 |
605 * Mid-level | | PADDR2 |
606 * (PMD) page | | |
607 * | | Lower-level |
608 * | | (PTE) page |
609 * | | | |
610 * .... ....
611 *
612 *
613 * And the virtual address is decoded as:
614 *
615 * 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
616 * |<-2->|<--- 9 bits ---->|<---- 9 bits --->|<------ 12 bits ------>|
617 * Index into Index into mid Index into lower Offset within page
618 * top entries directory page pagetable page
619 *
620 * It's too hard to switch between these two formats at runtime, so Linux only
621 * supports one or the other depending on whether CONFIG_X86_PAE is set. Many
622 * distributions turn it on, and not just for people with silly amounts of
623 * memory: the larger PTE entries allow room for the NX bit, which lets the
624 * kernel disable execution of pages and increase security.
625 *
626 * This was a problem for lguest, which couldn't run on these distributions;
627 * then Matias Zabaljauregui figured it all out and implemented it, and only a
628 * handful of puppies were crushed in the process!
629 *
630 * Back to our point: the kernel spends a lot of time changing both the
631 * top-level page directory and lower-level pagetable pages. The Guest doesn't
632 * know physical addresses, so while it maintains these page tables exactly
633 * like normal, it also needs to keep the Host informed whenever it makes a
634 * change: the Host will create the real page tables based on the Guests'.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700635 */
636
Rusty Russell2e04ef72009-07-30 16:03:45 -0600637/*
Rusty Russella91d74a2009-07-30 16:03:45 -0600638 * The Guest calls this after it has set a second-level entry (pte), ie. to map
639 * a page into a process' address space. Wetell the Host the toplevel and
640 * address this corresponds to. The Guest uses one pagetable per process, so
641 * we need to tell the Host which one we're changing (mm->pgd).
Rusty Russell2e04ef72009-07-30 16:03:45 -0600642 */
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600643static void lguest_pte_update(struct mm_struct *mm, unsigned long addr,
644 pte_t *ptep)
645{
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600646#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600647 /* PAE needs to hand a 64 bit page table entry, so it uses two args. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600648 lazy_hcall4(LHCALL_SET_PTE, __pa(mm->pgd), addr,
649 ptep->pte_low, ptep->pte_high);
650#else
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200651 lazy_hcall3(LHCALL_SET_PTE, __pa(mm->pgd), addr, ptep->pte_low);
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600652#endif
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600653}
654
Rusty Russella91d74a2009-07-30 16:03:45 -0600655/* This is the "set and update" combo-meal-deal version. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700656static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
657 pte_t *ptep, pte_t pteval)
658{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600659 native_set_pte(ptep, pteval);
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600660 lguest_pte_update(mm, addr, ptep);
Rusty Russell07ad1572007-07-19 01:49:22 -0700661}
662
Rusty Russell2e04ef72009-07-30 16:03:45 -0600663/*
664 * The Guest calls lguest_set_pud to set a top-level entry and lguest_set_pmd
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600665 * to set a middle-level entry when PAE is activated.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600666 *
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600667 * Again, we set the entry then tell the Host which page we changed,
Rusty Russell2e04ef72009-07-30 16:03:45 -0600668 * and the index of the entry we changed.
669 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600670#ifdef CONFIG_X86_PAE
671static void lguest_set_pud(pud_t *pudp, pud_t pudval)
672{
673 native_set_pud(pudp, pudval);
674
675 /* 32 bytes aligned pdpt address and the index. */
676 lazy_hcall2(LHCALL_SET_PGD, __pa(pudp) & 0xFFFFFFE0,
677 (__pa(pudp) & 0x1F) / sizeof(pud_t));
678}
679
680static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
681{
682 native_set_pmd(pmdp, pmdval);
683 lazy_hcall2(LHCALL_SET_PMD, __pa(pmdp) & PAGE_MASK,
684 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
685}
686#else
687
Rusty Russell2e04ef72009-07-30 16:03:45 -0600688/* The Guest calls lguest_set_pmd to set a top-level entry when !PAE. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700689static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
690{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600691 native_set_pmd(pmdp, pmdval);
Matias Zabaljaureguiebe0ba82009-05-30 15:48:08 -0300692 lazy_hcall2(LHCALL_SET_PGD, __pa(pmdp) & PAGE_MASK,
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600693 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
Rusty Russell07ad1572007-07-19 01:49:22 -0700694}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600695#endif
Rusty Russell07ad1572007-07-19 01:49:22 -0700696
Rusty Russell2e04ef72009-07-30 16:03:45 -0600697/*
698 * There are a couple of legacy places where the kernel sets a PTE, but we
Rusty Russellb2b47c22007-07-26 10:41:02 -0700699 * don't know the top level any more. This is useless for us, since we don't
700 * know which pagetable is changing or what address, so we just tell the Host
701 * to forget all of them. Fortunately, this is very rare.
702 *
703 * ... except in early boot when the kernel sets up the initial pagetables,
Rusty Russellad5173f2008-10-31 11:24:27 -0500704 * which makes booting astonishingly slow: 1.83 seconds! So we don't even tell
705 * the Host anything changed until we've done the first page table switch,
Rusty Russell2e04ef72009-07-30 16:03:45 -0600706 * which brings boot back to 0.25 seconds.
707 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700708static void lguest_set_pte(pte_t *ptep, pte_t pteval)
709{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600710 native_set_pte(ptep, pteval);
Rusty Russellad5173f2008-10-31 11:24:27 -0500711 if (cr3_changed)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200712 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700713}
714
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600715#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600716/*
717 * With 64-bit PTE values, we need to be careful setting them: if we set 32
718 * bits at a time, the hardware could see a weird half-set entry. These
719 * versions ensure we update all 64 bits at once.
720 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600721static void lguest_set_pte_atomic(pte_t *ptep, pte_t pte)
722{
723 native_set_pte_atomic(ptep, pte);
724 if (cr3_changed)
725 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
726}
727
Rusty Russella91d74a2009-07-30 16:03:45 -0600728static void lguest_pte_clear(struct mm_struct *mm, unsigned long addr,
729 pte_t *ptep)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600730{
731 native_pte_clear(mm, addr, ptep);
732 lguest_pte_update(mm, addr, ptep);
733}
734
Rusty Russella91d74a2009-07-30 16:03:45 -0600735static void lguest_pmd_clear(pmd_t *pmdp)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600736{
737 lguest_set_pmd(pmdp, __pmd(0));
738}
739#endif
740
Rusty Russell2e04ef72009-07-30 16:03:45 -0600741/*
742 * Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
Rusty Russellb2b47c22007-07-26 10:41:02 -0700743 * native page table operations. On native hardware you can set a new page
744 * table entry whenever you want, but if you want to remove one you have to do
745 * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
746 *
747 * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
748 * called when a valid entry is written, not when it's removed (ie. marked not
749 * present). Instead, this is where we come when the Guest wants to remove a
750 * page table entry: we tell the Host to set that entry to 0 (ie. the present
Rusty Russell2e04ef72009-07-30 16:03:45 -0600751 * bit is zero).
752 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700753static void lguest_flush_tlb_single(unsigned long addr)
754{
Rusty Russellb2b47c22007-07-26 10:41:02 -0700755 /* Simply set it to zero: if it was not, it will fault back in. */
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200756 lazy_hcall3(LHCALL_SET_PTE, lguest_data.pgdir, addr, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700757}
758
Rusty Russell2e04ef72009-07-30 16:03:45 -0600759/*
760 * This is what happens after the Guest has removed a large number of entries.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700761 * This tells the Host that any of the page table entries for userspace might
Rusty Russell2e04ef72009-07-30 16:03:45 -0600762 * have changed, ie. virtual addresses below PAGE_OFFSET.
763 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700764static void lguest_flush_tlb_user(void)
765{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200766 lazy_hcall1(LHCALL_FLUSH_TLB, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700767}
768
Rusty Russell2e04ef72009-07-30 16:03:45 -0600769/*
770 * This is called when the kernel page tables have changed. That's not very
Rusty Russellb2b47c22007-07-26 10:41:02 -0700771 * common (unless the Guest is using highmem, which makes the Guest extremely
Rusty Russell2e04ef72009-07-30 16:03:45 -0600772 * slow), so it's worth separating this from the user flushing above.
773 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700774static void lguest_flush_tlb_kernel(void)
775{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200776 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700777}
778
Rusty Russellb2b47c22007-07-26 10:41:02 -0700779/*
780 * The Unadvanced Programmable Interrupt Controller.
781 *
782 * This is an attempt to implement the simplest possible interrupt controller.
783 * I spent some time looking though routines like set_irq_chip_and_handler,
784 * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
785 * I *think* this is as simple as it gets.
786 *
787 * We can tell the Host what interrupts we want blocked ready for using the
788 * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
789 * simple as setting a bit. We don't actually "ack" interrupts as such, we
790 * just mask and unmask them. I wonder if we should be cleverer?
791 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700792static void disable_lguest_irq(unsigned int irq)
793{
794 set_bit(irq, lguest_data.blocked_interrupts);
795}
796
797static void enable_lguest_irq(unsigned int irq)
798{
799 clear_bit(irq, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -0700800}
801
Rusty Russellb2b47c22007-07-26 10:41:02 -0700802/* This structure describes the lguest IRQ controller. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700803static struct irq_chip lguest_irq_controller = {
804 .name = "lguest",
805 .mask = disable_lguest_irq,
806 .mask_ack = disable_lguest_irq,
807 .unmask = enable_lguest_irq,
808};
809
Rusty Russell2e04ef72009-07-30 16:03:45 -0600810/*
811 * This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
Rusty Russellb2b47c22007-07-26 10:41:02 -0700812 * interrupt (except 128, which is used for system calls), and then tells the
813 * Linux infrastructure that each interrupt is controlled by our level-based
Rusty Russell2e04ef72009-07-30 16:03:45 -0600814 * lguest interrupt controller.
815 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700816static void __init lguest_init_IRQ(void)
817{
818 unsigned int i;
819
Rusty Russell10283752009-06-12 22:26:59 -0600820 for (i = FIRST_EXTERNAL_VECTOR; i < NR_VECTORS; i++) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600821 /* Some systems map "vectors" to interrupts weirdly. Not us! */
Rusty Russell10283752009-06-12 22:26:59 -0600822 __get_cpu_var(vector_irq)[i] = i - FIRST_EXTERNAL_VECTOR;
823 if (i != SYSCALL_VECTOR)
824 set_intr_gate(i, interrupt[i - FIRST_EXTERNAL_VECTOR]);
Rusty Russell07ad1572007-07-19 01:49:22 -0700825 }
Rusty Russell2e04ef72009-07-30 16:03:45 -0600826
827 /*
828 * This call is required to set up for 4k stacks, where we have
829 * separate stacks for hard and soft interrupts.
830 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700831 irq_ctx_init(smp_processor_id());
832}
833
Rusty Russella91d74a2009-07-30 16:03:45 -0600834/*
835 * With CONFIG_SPARSE_IRQ, interrupt descriptors are allocated as-needed, so
836 * rather than set them in lguest_init_IRQ we are called here every time an
837 * lguest device needs an interrupt.
838 *
839 * FIXME: irq_to_desc_alloc_node() can fail due to lack of memory, we should
840 * pass that up!
841 */
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600842void lguest_setup_irq(unsigned int irq)
843{
Yinghai Lu85ac16d2009-04-27 18:00:38 -0700844 irq_to_desc_alloc_node(irq, 0);
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600845 set_irq_chip_and_handler_name(irq, &lguest_irq_controller,
846 handle_level_irq, "level");
847}
848
Rusty Russellb2b47c22007-07-26 10:41:02 -0700849/*
850 * Time.
851 *
852 * It would be far better for everyone if the Guest had its own clock, but
Rusty Russell6c8dca52007-07-27 13:42:52 +1000853 * until then the Host gives us the time on every interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700854 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700855static unsigned long lguest_get_wallclock(void)
856{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000857 return lguest_data.time.tv_sec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700858}
859
Rusty Russell2e04ef72009-07-30 16:03:45 -0600860/*
861 * The TSC is an Intel thing called the Time Stamp Counter. The Host tells us
Rusty Russella6bd8e12008-03-28 11:05:53 -0500862 * what speed it runs at, or 0 if it's unusable as a reliable clock source.
863 * This matches what we want here: if we return 0 from this function, the x86
Rusty Russell2e04ef72009-07-30 16:03:45 -0600864 * TSC clock will give up and not register itself.
865 */
Alok Katariae93ef942008-07-01 11:43:36 -0700866static unsigned long lguest_tsc_khz(void)
Rusty Russell3fabc552008-03-11 09:35:56 -0500867{
868 return lguest_data.tsc_khz;
869}
870
Rusty Russell2e04ef72009-07-30 16:03:45 -0600871/*
872 * If we can't use the TSC, the kernel falls back to our lower-priority
873 * "lguest_clock", where we read the time value given to us by the Host.
874 */
Magnus Damm8e196082009-04-21 12:24:00 -0700875static cycle_t lguest_clock_read(struct clocksource *cs)
Rusty Russell07ad1572007-07-19 01:49:22 -0700876{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000877 unsigned long sec, nsec;
878
Rusty Russell2e04ef72009-07-30 16:03:45 -0600879 /*
880 * Since the time is in two parts (seconds and nanoseconds), we risk
Rusty Russell3fabc552008-03-11 09:35:56 -0500881 * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
882 * and getting 99 and 0. As Linux tends to come apart under the stress
Rusty Russell2e04ef72009-07-30 16:03:45 -0600883 * of time travel, we must be careful:
884 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000885 do {
886 /* First we read the seconds part. */
887 sec = lguest_data.time.tv_sec;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600888 /*
889 * This read memory barrier tells the compiler and the CPU that
Rusty Russell6c8dca52007-07-27 13:42:52 +1000890 * this can't be reordered: we have to complete the above
Rusty Russell2e04ef72009-07-30 16:03:45 -0600891 * before going on.
892 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000893 rmb();
894 /* Now we read the nanoseconds part. */
895 nsec = lguest_data.time.tv_nsec;
896 /* Make sure we've done that. */
897 rmb();
898 /* Now if the seconds part has changed, try again. */
899 } while (unlikely(lguest_data.time.tv_sec != sec));
900
Rusty Russell3fabc552008-03-11 09:35:56 -0500901 /* Our lguest clock is in real nanoseconds. */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000902 return sec*1000000000ULL + nsec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700903}
904
Rusty Russell3fabc552008-03-11 09:35:56 -0500905/* This is the fallback clocksource: lower priority than the TSC clocksource. */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700906static struct clocksource lguest_clock = {
907 .name = "lguest",
Rusty Russell3fabc552008-03-11 09:35:56 -0500908 .rating = 200,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700909 .read = lguest_clock_read,
Rusty Russell6c8dca52007-07-27 13:42:52 +1000910 .mask = CLOCKSOURCE_MASK(64),
Rusty Russell37250092007-08-09 20:52:35 +1000911 .mult = 1 << 22,
912 .shift = 22,
Tony Breeds05aa0262007-10-22 10:56:25 +1000913 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700914};
915
Rusty Russell2e04ef72009-07-30 16:03:45 -0600916/*
917 * We also need a "struct clock_event_device": Linux asks us to set it to go
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700918 * off some time in the future. Actually, James Morris figured all this out, I
Rusty Russell2e04ef72009-07-30 16:03:45 -0600919 * just applied the patch.
920 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700921static int lguest_clockevent_set_next_event(unsigned long delta,
922 struct clock_event_device *evt)
923{
Rusty Russella6bd8e12008-03-28 11:05:53 -0500924 /* FIXME: I don't think this can ever happen, but James tells me he had
925 * to put this code in. Maybe we should remove it now. Anyone? */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700926 if (delta < LG_CLOCK_MIN_DELTA) {
927 if (printk_ratelimit())
928 printk(KERN_DEBUG "%s: small delta %lu ns\n",
Harvey Harrison77bf90e2008-03-03 11:37:23 -0800929 __func__, delta);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700930 return -ETIME;
931 }
Rusty Russella6bd8e12008-03-28 11:05:53 -0500932
933 /* Please wake us this far in the future. */
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200934 kvm_hypercall1(LHCALL_SET_CLOCKEVENT, delta);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700935 return 0;
936}
937
938static void lguest_clockevent_set_mode(enum clock_event_mode mode,
939 struct clock_event_device *evt)
940{
941 switch (mode) {
942 case CLOCK_EVT_MODE_UNUSED:
943 case CLOCK_EVT_MODE_SHUTDOWN:
944 /* A 0 argument shuts the clock down. */
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200945 kvm_hypercall0(LHCALL_SET_CLOCKEVENT);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700946 break;
947 case CLOCK_EVT_MODE_ONESHOT:
948 /* This is what we expect. */
949 break;
950 case CLOCK_EVT_MODE_PERIODIC:
951 BUG();
Thomas Gleixner18de5bc2007-07-21 04:37:34 -0700952 case CLOCK_EVT_MODE_RESUME:
953 break;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700954 }
955}
956
957/* This describes our primitive timer chip. */
958static struct clock_event_device lguest_clockevent = {
959 .name = "lguest",
960 .features = CLOCK_EVT_FEAT_ONESHOT,
961 .set_next_event = lguest_clockevent_set_next_event,
962 .set_mode = lguest_clockevent_set_mode,
963 .rating = INT_MAX,
964 .mult = 1,
965 .shift = 0,
966 .min_delta_ns = LG_CLOCK_MIN_DELTA,
967 .max_delta_ns = LG_CLOCK_MAX_DELTA,
968};
969
Rusty Russell2e04ef72009-07-30 16:03:45 -0600970/*
971 * This is the Guest timer interrupt handler (hardware interrupt 0). We just
972 * call the clockevent infrastructure and it does whatever needs doing.
973 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700974static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
975{
976 unsigned long flags;
977
978 /* Don't interrupt us while this is running. */
979 local_irq_save(flags);
980 lguest_clockevent.event_handler(&lguest_clockevent);
981 local_irq_restore(flags);
982}
983
Rusty Russell2e04ef72009-07-30 16:03:45 -0600984/*
985 * At some point in the boot process, we get asked to set up our timing
Rusty Russellb2b47c22007-07-26 10:41:02 -0700986 * infrastructure. The kernel doesn't expect timer interrupts before this, but
987 * we cleverly initialized the "blocked_interrupts" field of "struct
Rusty Russell2e04ef72009-07-30 16:03:45 -0600988 * lguest_data" so that timer interrupts were blocked until now.
989 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700990static void lguest_time_init(void)
991{
Rusty Russellb2b47c22007-07-26 10:41:02 -0700992 /* Set up the timer interrupt (0) to go to our simple timer routine */
Rusty Russell07ad1572007-07-19 01:49:22 -0700993 set_irq_handler(0, lguest_time_irq);
Rusty Russell07ad1572007-07-19 01:49:22 -0700994
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700995 clocksource_register(&lguest_clock);
996
Rusty Russellb2b47c22007-07-26 10:41:02 -0700997 /* We can't set cpumask in the initializer: damn C limitations! Set it
998 * here and register our timer device. */
Rusty Russell320ab2b2008-12-13 21:20:26 +1030999 lguest_clockevent.cpumask = cpumask_of(0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001000 clockevents_register_device(&lguest_clockevent);
1001
Rusty Russellb2b47c22007-07-26 10:41:02 -07001002 /* Finally, we unblock the timer interrupt. */
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001003 enable_lguest_irq(0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001004}
1005
Rusty Russellb2b47c22007-07-26 10:41:02 -07001006/*
1007 * Miscellaneous bits and pieces.
1008 *
1009 * Here is an oddball collection of functions which the Guest needs for things
1010 * to work. They're pretty simple.
1011 */
1012
Rusty Russell2e04ef72009-07-30 16:03:45 -06001013/*
1014 * The Guest needs to tell the Host what stack it expects traps to use. For
Rusty Russellb2b47c22007-07-26 10:41:02 -07001015 * native hardware, this is part of the Task State Segment mentioned above in
1016 * lguest_load_tr_desc(), but to help hypervisors there's this special call.
1017 *
1018 * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
1019 * segment), the privilege level (we're privilege level 1, the Host is 0 and
1020 * will not tolerate us trying to use that), the stack pointer, and the number
Rusty Russell2e04ef72009-07-30 16:03:45 -06001021 * of pages in the stack.
1022 */
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001023static void lguest_load_sp0(struct tss_struct *tss,
Rusty Russella6bd8e12008-03-28 11:05:53 -05001024 struct thread_struct *thread)
Rusty Russell07ad1572007-07-19 01:49:22 -07001025{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001026 lazy_hcall3(LHCALL_SET_STACK, __KERNEL_DS | 0x1, thread->sp0,
1027 THREAD_SIZE / PAGE_SIZE);
Rusty Russell07ad1572007-07-19 01:49:22 -07001028}
1029
Rusty Russellb2b47c22007-07-26 10:41:02 -07001030/* Let's just say, I wouldn't do debugging under a Guest. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001031static void lguest_set_debugreg(int regno, unsigned long value)
1032{
1033 /* FIXME: Implement */
1034}
1035
Rusty Russell2e04ef72009-07-30 16:03:45 -06001036/*
1037 * There are times when the kernel wants to make sure that no memory writes are
Rusty Russellb2b47c22007-07-26 10:41:02 -07001038 * caught in the cache (that they've all reached real hardware devices). This
1039 * doesn't matter for the Guest which has virtual hardware.
1040 *
1041 * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
1042 * (clflush) instruction is available and the kernel uses that. Otherwise, it
1043 * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
1044 * Unlike clflush, wbinvd can only be run at privilege level 0. So we can
1045 * ignore clflush, but replace wbinvd.
1046 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001047static void lguest_wbinvd(void)
1048{
1049}
1050
Rusty Russell2e04ef72009-07-30 16:03:45 -06001051/*
1052 * If the Guest expects to have an Advanced Programmable Interrupt Controller,
Rusty Russellb2b47c22007-07-26 10:41:02 -07001053 * we play dumb by ignoring writes and returning 0 for reads. So it's no
1054 * longer Programmable nor Controlling anything, and I don't think 8 lines of
1055 * code qualifies for Advanced. It will also never interrupt anything. It
Rusty Russell2e04ef72009-07-30 16:03:45 -06001056 * does, however, allow us to get through the Linux boot code.
1057 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001058#ifdef CONFIG_X86_LOCAL_APIC
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001059static void lguest_apic_write(u32 reg, u32 v)
Rusty Russell07ad1572007-07-19 01:49:22 -07001060{
1061}
1062
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001063static u32 lguest_apic_read(u32 reg)
Rusty Russell07ad1572007-07-19 01:49:22 -07001064{
1065 return 0;
1066}
Suresh Siddha511d9d32008-07-14 09:49:14 -07001067
1068static u64 lguest_apic_icr_read(void)
1069{
1070 return 0;
1071}
1072
1073static void lguest_apic_icr_write(u32 low, u32 id)
1074{
1075 /* Warn to see if there's any stray references */
1076 WARN_ON(1);
1077}
1078
1079static void lguest_apic_wait_icr_idle(void)
1080{
1081 return;
1082}
1083
1084static u32 lguest_apic_safe_wait_icr_idle(void)
1085{
1086 return 0;
1087}
1088
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001089static void set_lguest_basic_apic_ops(void)
1090{
1091 apic->read = lguest_apic_read;
1092 apic->write = lguest_apic_write;
1093 apic->icr_read = lguest_apic_icr_read;
1094 apic->icr_write = lguest_apic_icr_write;
1095 apic->wait_icr_idle = lguest_apic_wait_icr_idle;
1096 apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
Suresh Siddha511d9d32008-07-14 09:49:14 -07001097};
Rusty Russell07ad1572007-07-19 01:49:22 -07001098#endif
1099
Rusty Russellb2b47c22007-07-26 10:41:02 -07001100/* STOP! Until an interrupt comes in. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001101static void lguest_safe_halt(void)
1102{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001103 kvm_hypercall0(LHCALL_HALT);
Rusty Russell07ad1572007-07-19 01:49:22 -07001104}
1105
Rusty Russell2e04ef72009-07-30 16:03:45 -06001106/*
1107 * The SHUTDOWN hypercall takes a string to describe what's happening, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001108 * an argument which says whether this to restart (reboot) the Guest or not.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001109 *
1110 * Note that the Host always prefers that the Guest speak in physical addresses
Rusty Russell2e04ef72009-07-30 16:03:45 -06001111 * rather than virtual addresses, so we use __pa() here.
1112 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001113static void lguest_power_off(void)
1114{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001115 kvm_hypercall2(LHCALL_SHUTDOWN, __pa("Power down"),
1116 LGUEST_SHUTDOWN_POWEROFF);
Rusty Russell07ad1572007-07-19 01:49:22 -07001117}
1118
Rusty Russellb2b47c22007-07-26 10:41:02 -07001119/*
1120 * Panicing.
1121 *
1122 * Don't. But if you did, this is what happens.
1123 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001124static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
1125{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001126 kvm_hypercall2(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001127 /* The hcall won't return, but to keep gcc happy, we're "done". */
Rusty Russell07ad1572007-07-19 01:49:22 -07001128 return NOTIFY_DONE;
1129}
1130
1131static struct notifier_block paniced = {
1132 .notifier_call = lguest_panic
1133};
1134
Rusty Russellb2b47c22007-07-26 10:41:02 -07001135/* Setting up memory is fairly easy. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001136static __init char *lguest_memory_setup(void)
1137{
Rusty Russella6bd8e12008-03-28 11:05:53 -05001138 /* We do this here and not earlier because lockcheck used to barf if we
1139 * did it before start_kernel(). I think we fixed that, so it'd be
1140 * nice to move it back to lguest_init. Patch welcome... */
Rusty Russell07ad1572007-07-19 01:49:22 -07001141 atomic_notifier_chain_register(&panic_notifier_list, &paniced);
1142
Rusty Russell2e04ef72009-07-30 16:03:45 -06001143 /*
1144 *The Linux bootloader header contains an "e820" memory map: the
1145 * Launcher populated the first entry with our memory limit.
1146 */
Yinghai Lud0be6bd2008-06-15 18:58:51 -07001147 e820_add_region(boot_params.e820_map[0].addr,
H. Peter Anvin30c82642007-10-15 17:13:22 -07001148 boot_params.e820_map[0].size,
1149 boot_params.e820_map[0].type);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001150
1151 /* This string is for the boot messages. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001152 return "LGUEST";
1153}
1154
Rusty Russell2e04ef72009-07-30 16:03:45 -06001155/*
1156 * We will eventually use the virtio console device to produce console output,
Rusty Russelle1e72962007-10-25 15:02:50 +10001157 * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
Rusty Russell2e04ef72009-07-30 16:03:45 -06001158 * console output.
1159 */
Rusty Russell19f15372007-10-22 11:24:21 +10001160static __init int early_put_chars(u32 vtermno, const char *buf, int count)
1161{
1162 char scratch[17];
1163 unsigned int len = count;
1164
Rusty Russell2e04ef72009-07-30 16:03:45 -06001165 /* We use a nul-terminated string, so we make a copy. Icky, huh? */
Rusty Russell19f15372007-10-22 11:24:21 +10001166 if (len > sizeof(scratch) - 1)
1167 len = sizeof(scratch) - 1;
1168 scratch[len] = '\0';
1169 memcpy(scratch, buf, len);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001170 kvm_hypercall1(LHCALL_NOTIFY, __pa(scratch));
Rusty Russell19f15372007-10-22 11:24:21 +10001171
1172 /* This routine returns the number of bytes actually written. */
1173 return len;
1174}
1175
Rusty Russell2e04ef72009-07-30 16:03:45 -06001176/*
1177 * Rebooting also tells the Host we're finished, but the RESTART flag tells the
1178 * Launcher to reboot us.
1179 */
Rusty Russella6bd8e12008-03-28 11:05:53 -05001180static void lguest_restart(char *reason)
1181{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001182 kvm_hypercall2(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART);
Rusty Russella6bd8e12008-03-28 11:05:53 -05001183}
1184
Rusty Russellb2b47c22007-07-26 10:41:02 -07001185/*G:050
1186 * Patching (Powerfully Placating Performance Pedants)
1187 *
Rusty Russella6bd8e12008-03-28 11:05:53 -05001188 * We have already seen that pv_ops structures let us replace simple native
1189 * instructions with calls to the appropriate back end all throughout the
1190 * kernel. This allows the same kernel to run as a Guest and as a native
Rusty Russellb2b47c22007-07-26 10:41:02 -07001191 * kernel, but it's slow because of all the indirect branches.
1192 *
1193 * Remember that David Wheeler quote about "Any problem in computer science can
1194 * be solved with another layer of indirection"? The rest of that quote is
1195 * "... But that usually will create another problem." This is the first of
1196 * those problems.
1197 *
1198 * Our current solution is to allow the paravirt back end to optionally patch
1199 * over the indirect calls to replace them with something more efficient. We
Rusty Russella32a88132009-06-12 22:27:02 -06001200 * patch two of the simplest of the most commonly called functions: disable
1201 * interrupts and save interrupts. We usually have 6 or 10 bytes to patch
1202 * into: the Guest versions of these operations are small enough that we can
1203 * fit comfortably.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001204 *
1205 * First we need assembly templates of each of the patchable Guest operations,
Rusty Russell2e04ef72009-07-30 16:03:45 -06001206 * and these are in i386_head.S.
1207 */
Rusty Russellb2b47c22007-07-26 10:41:02 -07001208
1209/*G:060 We construct a table from the assembler templates: */
Rusty Russell07ad1572007-07-19 01:49:22 -07001210static const struct lguest_insns
1211{
1212 const char *start, *end;
1213} lguest_insns[] = {
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001214 [PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001215 [PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
Rusty Russell07ad1572007-07-19 01:49:22 -07001216};
Rusty Russellb2b47c22007-07-26 10:41:02 -07001217
Rusty Russell2e04ef72009-07-30 16:03:45 -06001218/*
1219 * Now our patch routine is fairly simple (based on the native one in
Rusty Russellb2b47c22007-07-26 10:41:02 -07001220 * paravirt.c). If we have a replacement, we copy it in and return how much of
Rusty Russell2e04ef72009-07-30 16:03:45 -06001221 * the available space we used.
1222 */
Andi Kleenab144f52007-08-10 22:31:03 +02001223static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
1224 unsigned long addr, unsigned len)
Rusty Russell07ad1572007-07-19 01:49:22 -07001225{
1226 unsigned int insn_len;
1227
Rusty Russellb2b47c22007-07-26 10:41:02 -07001228 /* Don't do anything special if we don't have a replacement */
Rusty Russell07ad1572007-07-19 01:49:22 -07001229 if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
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
1232 insn_len = lguest_insns[type].end - lguest_insns[type].start;
1233
Rusty Russell2e04ef72009-07-30 16:03:45 -06001234 /* Similarly if it can't fit (doesn't happen, but let's be thorough). */
Rusty Russell07ad1572007-07-19 01:49:22 -07001235 if (len < insn_len)
Andi Kleenab144f52007-08-10 22:31:03 +02001236 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001237
Rusty Russellb2b47c22007-07-26 10:41:02 -07001238 /* Copy in our instructions. */
Andi Kleenab144f52007-08-10 22:31:03 +02001239 memcpy(ibuf, lguest_insns[type].start, insn_len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001240 return insn_len;
1241}
1242
Rusty Russell2e04ef72009-07-30 16:03:45 -06001243/*G:029
1244 * Once we get to lguest_init(), we know we're a Guest. The various
Rusty Russella6bd8e12008-03-28 11:05:53 -05001245 * pv_ops structures in the kernel provide points for (almost) every routine we
Rusty Russell2e04ef72009-07-30 16:03:45 -06001246 * have to override to avoid privileged instructions.
1247 */
Rusty Russell814a0e52007-10-22 11:29:44 +10001248__init void lguest_init(void)
Rusty Russell07ad1572007-07-19 01:49:22 -07001249{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001250 /* We're under lguest. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001251 pv_info.name = "lguest";
Rusty Russell2e04ef72009-07-30 16:03:45 -06001252 /* Paravirt is enabled. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001253 pv_info.paravirt_enabled = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001254 /* We're running at privilege level 1, not 0 as normal. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001255 pv_info.kernel_rpl = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001256 /* Everyone except Xen runs with this set. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001257 pv_info.shared_kernel_pmd = 1;
Rusty Russell07ad1572007-07-19 01:49:22 -07001258
Rusty Russell2e04ef72009-07-30 16:03:45 -06001259 /*
1260 * We set up all the lguest overrides for sensitive operations. These
1261 * are detailed with the operations themselves.
1262 */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001263
Rusty Russell2e04ef72009-07-30 16:03:45 -06001264 /* Interrupt-related operations */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001265 pv_irq_ops.init_IRQ = lguest_init_IRQ;
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001266 pv_irq_ops.save_fl = PV_CALLEE_SAVE(save_fl);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001267 pv_irq_ops.restore_fl = __PV_IS_CALLEE_SAVE(lg_restore_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001268 pv_irq_ops.irq_disable = PV_CALLEE_SAVE(irq_disable);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001269 pv_irq_ops.irq_enable = __PV_IS_CALLEE_SAVE(lg_irq_enable);
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001270 pv_irq_ops.safe_halt = lguest_safe_halt;
1271
Rusty Russell2e04ef72009-07-30 16:03:45 -06001272 /* Setup operations */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001273 pv_init_ops.memory_setup = lguest_memory_setup;
1274 pv_init_ops.patch = lguest_patch;
1275
Rusty Russell2e04ef72009-07-30 16:03:45 -06001276 /* Intercepts of various CPU instructions */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001277 pv_cpu_ops.load_gdt = lguest_load_gdt;
1278 pv_cpu_ops.cpuid = lguest_cpuid;
1279 pv_cpu_ops.load_idt = lguest_load_idt;
1280 pv_cpu_ops.iret = lguest_iret;
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001281 pv_cpu_ops.load_sp0 = lguest_load_sp0;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001282 pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1283 pv_cpu_ops.set_ldt = lguest_set_ldt;
1284 pv_cpu_ops.load_tls = lguest_load_tls;
1285 pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1286 pv_cpu_ops.clts = lguest_clts;
1287 pv_cpu_ops.read_cr0 = lguest_read_cr0;
1288 pv_cpu_ops.write_cr0 = lguest_write_cr0;
1289 pv_cpu_ops.read_cr4 = lguest_read_cr4;
1290 pv_cpu_ops.write_cr4 = lguest_write_cr4;
1291 pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1292 pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1293 pv_cpu_ops.wbinvd = lguest_wbinvd;
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -08001294 pv_cpu_ops.start_context_switch = paravirt_start_context_switch;
1295 pv_cpu_ops.end_context_switch = lguest_end_context_switch;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001296
Rusty Russell2e04ef72009-07-30 16:03:45 -06001297 /* Pagetable management */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001298 pv_mmu_ops.write_cr3 = lguest_write_cr3;
1299 pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1300 pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1301 pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1302 pv_mmu_ops.set_pte = lguest_set_pte;
1303 pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1304 pv_mmu_ops.set_pmd = lguest_set_pmd;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001305#ifdef CONFIG_X86_PAE
1306 pv_mmu_ops.set_pte_atomic = lguest_set_pte_atomic;
1307 pv_mmu_ops.pte_clear = lguest_pte_clear;
1308 pv_mmu_ops.pmd_clear = lguest_pmd_clear;
1309 pv_mmu_ops.set_pud = lguest_set_pud;
1310#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001311 pv_mmu_ops.read_cr2 = lguest_read_cr2;
1312 pv_mmu_ops.read_cr3 = lguest_read_cr3;
Jeremy Fitzhardinge8965c1c2007-10-16 11:51:29 -07001313 pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -08001314 pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mmu_mode;
Rusty Russellb7ff99e2009-03-30 21:55:23 -06001315 pv_mmu_ops.pte_update = lguest_pte_update;
1316 pv_mmu_ops.pte_update_defer = lguest_pte_update;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001317
Rusty Russell07ad1572007-07-19 01:49:22 -07001318#ifdef CONFIG_X86_LOCAL_APIC
Rusty Russell2e04ef72009-07-30 16:03:45 -06001319 /* APIC read/write intercepts */
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001320 set_lguest_basic_apic_ops();
Rusty Russell07ad1572007-07-19 01:49:22 -07001321#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001322
Rusty Russell2e04ef72009-07-30 16:03:45 -06001323 /* Time operations */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001324 pv_time_ops.get_wallclock = lguest_get_wallclock;
1325 pv_time_ops.time_init = lguest_time_init;
Alok Katariae93ef942008-07-01 11:43:36 -07001326 pv_time_ops.get_tsc_khz = lguest_tsc_khz;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001327
Rusty Russell2e04ef72009-07-30 16:03:45 -06001328 /*
1329 * Now is a good time to look at the implementations of these functions
1330 * before returning to the rest of lguest_init().
1331 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001332
Rusty Russell2e04ef72009-07-30 16:03:45 -06001333 /*G:070
1334 * Now we've seen all the paravirt_ops, we return to
Rusty Russellb2b47c22007-07-26 10:41:02 -07001335 * lguest_init() where the rest of the fairly chaotic boot setup
Rusty Russell2e04ef72009-07-30 16:03:45 -06001336 * occurs.
1337 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001338
Rusty Russell2e04ef72009-07-30 16:03:45 -06001339 /*
1340 * The stack protector is a weird thing where gcc places a canary
Rusty Russell2cb78782009-06-03 14:52:24 +09301341 * value on the stack and then checks it on return. This file is
1342 * compiled with -fno-stack-protector it, so we got this far without
1343 * problems. The value of the canary is kept at offset 20 from the
1344 * %gs register, so we need to set that up before calling C functions
Rusty Russell2e04ef72009-07-30 16:03:45 -06001345 * in other files.
1346 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301347 setup_stack_canary_segment(0);
Rusty Russell2e04ef72009-07-30 16:03:45 -06001348
1349 /*
1350 * We could just call load_stack_canary_segment(), but we might as well
1351 * call switch_to_new_gdt() which loads the whole table and sets up the
1352 * per-cpu segment descriptor register %fs as well.
1353 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301354 switch_to_new_gdt(0);
1355
Rusty Russella91d74a2009-07-30 16:03:45 -06001356 /* We actually boot with all memory mapped, but let's say 128MB. */
Rusty Russell5d006d82008-07-29 09:58:29 -05001357 max_pfn_mapped = (128*1024*1024) >> PAGE_SHIFT;
1358
Rusty Russell2e04ef72009-07-30 16:03:45 -06001359 /*
1360 * The Host<->Guest Switcher lives at the top of our address space, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001361 * the Host told us how big it is when we made LGUEST_INIT hypercall:
Rusty Russell2e04ef72009-07-30 16:03:45 -06001362 * it put the answer in lguest_data.reserve_mem
1363 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001364 reserve_top_address(lguest_data.reserve_mem);
1365
Rusty Russell2e04ef72009-07-30 16:03:45 -06001366 /*
1367 * If we don't initialize the lock dependency checker now, it crashes
1368 * paravirt_disable_iospace.
1369 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001370 lockdep_init();
1371
Rusty Russell2e04ef72009-07-30 16:03:45 -06001372 /*
1373 * The IDE code spends about 3 seconds probing for disks: if we reserve
Rusty Russellb2b47c22007-07-26 10:41:02 -07001374 * all the I/O ports up front it can't get them and so doesn't probe.
1375 * Other device drivers are similar (but less severe). This cuts the
Rusty Russell2e04ef72009-07-30 16:03:45 -06001376 * kernel boot time on my machine from 4.1 seconds to 0.45 seconds.
1377 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001378 paravirt_disable_iospace();
1379
Rusty Russell2e04ef72009-07-30 16:03:45 -06001380 /*
1381 * This is messy CPU setup stuff which the native boot code does before
1382 * start_kernel, so we have to do, too:
1383 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001384 cpu_detect(&new_cpu_data);
1385 /* head.S usually sets up the first capability word, so do it here. */
1386 new_cpu_data.x86_capability[0] = cpuid_edx(1);
1387
1388 /* Math is always hard! */
1389 new_cpu_data.hard_math = 1;
1390
Rusty Russella6bd8e12008-03-28 11:05:53 -05001391 /* We don't have features. We have puppies! Puppies! */
Rusty Russell07ad1572007-07-19 01:49:22 -07001392#ifdef CONFIG_X86_MCE
1393 mce_disabled = 1;
1394#endif
Rusty Russell07ad1572007-07-19 01:49:22 -07001395#ifdef CONFIG_ACPI
1396 acpi_disabled = 1;
1397 acpi_ht = 0;
1398#endif
1399
Rusty Russell2e04ef72009-07-30 16:03:45 -06001400 /*
1401 * We set the preferred console to "hvc". This is the "hypervisor
Rusty Russellb2b47c22007-07-26 10:41:02 -07001402 * virtual console" driver written by the PowerPC people, which we also
Rusty Russell2e04ef72009-07-30 16:03:45 -06001403 * adapted for lguest's use.
1404 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001405 add_preferred_console("hvc", 0, NULL);
1406
Rusty Russell19f15372007-10-22 11:24:21 +10001407 /* Register our very early console. */
1408 virtio_cons_early_init(early_put_chars);
1409
Rusty Russell2e04ef72009-07-30 16:03:45 -06001410 /*
1411 * Last of all, we set the power management poweroff hook to point to
Rusty Russella6bd8e12008-03-28 11:05:53 -05001412 * the Guest routine to power off, and the reboot hook to our restart
Rusty Russell2e04ef72009-07-30 16:03:45 -06001413 * routine.
1414 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001415 pm_power_off = lguest_power_off;
Balaji Raoec04b132007-12-28 14:26:24 +05301416 machine_ops.restart = lguest_restart;
Rusty Russella6bd8e12008-03-28 11:05:53 -05001417
Rusty Russell2e04ef72009-07-30 16:03:45 -06001418 /*
1419 * Now we're set up, call i386_start_kernel() in head32.c and we proceed
1420 * to boot as normal. It never returns.
1421 */
Yinghai Luf0d43102008-05-29 12:56:36 -07001422 i386_start_kernel();
Rusty Russell07ad1572007-07-19 01:49:22 -07001423}
Rusty Russellb2b47c22007-07-26 10:41:02 -07001424/*
1425 * This marks the end of stage II of our journey, The Guest.
1426 *
Rusty Russelle1e72962007-10-25 15:02:50 +10001427 * It is now time for us to explore the layer of virtual drivers and complete
1428 * our understanding of the Guest in "make Drivers".
Rusty Russellb2b47c22007-07-26 10:41:02 -07001429 */