blob: 5c4f240289b437a7e0002e5c4e202a34c1d9512b [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
Rob Landley61516582011-05-06 09:27:36 -070010 * (such as the example in Documentation/virtual/lguest/lguest.c) is called the
Rusty Russellf938d2c2007-07-26 10:41:02 -070011 * 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 Russell9f542882011-07-22 14:39:50 +093074/*G:010
75 * Welcome to the Guest!
Rusty Russellb2b47c22007-07-26 10:41:02 -070076 *
77 * The Guest in our tale is a simple creature: identical to the Host but
78 * behaving in simplified but equivalent ways. In particular, the Guest is the
Rusty Russell2e04ef72009-07-30 16:03:45 -060079 * same kernel as the Host (or at least, built from the same source code).
80:*/
Rusty Russellb2b47c22007-07-26 10:41:02 -070081
Rusty Russell07ad1572007-07-19 01:49:22 -070082struct lguest_data lguest_data = {
83 .hcall_status = { [0 ... LHCALL_RING_SIZE-1] = 0xFF },
84 .noirq_start = (u32)lguest_noirq_start,
85 .noirq_end = (u32)lguest_noirq_end,
Rusty Russell47436aa2007-10-22 11:03:36 +100086 .kernel_address = PAGE_OFFSET,
Rusty Russell07ad1572007-07-19 01:49:22 -070087 .blocked_interrupts = { 1 }, /* Block timer interrupts */
Rusty Russellc18acd72007-10-22 11:03:35 +100088 .syscall_vec = SYSCALL_VECTOR,
Rusty Russell07ad1572007-07-19 01:49:22 -070089};
Rusty Russell07ad1572007-07-19 01:49:22 -070090
Rusty Russell2e04ef72009-07-30 16:03:45 -060091/*G:037
92 * async_hcall() is pretty simple: I'm quite proud of it really. We have a
Rusty Russellb2b47c22007-07-26 10:41:02 -070093 * ring buffer of stored hypercalls which the Host will run though next time we
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -060094 * do a normal hypercall. Each entry in the ring has 5 slots for the hypercall
Rusty Russellb2b47c22007-07-26 10:41:02 -070095 * arguments, and a "hcall_status" word which is 0 if the call is ready to go,
96 * and 255 once the Host has finished with it.
97 *
98 * If we come around to a slot which hasn't been finished, then the table is
99 * full and we just make the hypercall directly. This has the nice side
100 * effect of causing the Host to run all the stored calls in the ring buffer
Rusty Russell2e04ef72009-07-30 16:03:45 -0600101 * which empties it for next time!
102 */
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100103static void async_hcall(unsigned long call, unsigned long arg1,
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600104 unsigned long arg2, unsigned long arg3,
105 unsigned long arg4)
Rusty Russell07ad1572007-07-19 01:49:22 -0700106{
107 /* Note: This code assumes we're uniprocessor. */
108 static unsigned int next_call;
109 unsigned long flags;
110
Rusty Russell2e04ef72009-07-30 16:03:45 -0600111 /*
112 * Disable interrupts if not already disabled: we don't want an
Rusty Russellb2b47c22007-07-26 10:41:02 -0700113 * interrupt handler making a hypercall while we're already doing
Rusty Russell2e04ef72009-07-30 16:03:45 -0600114 * one!
115 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700116 local_irq_save(flags);
117 if (lguest_data.hcall_status[next_call] != 0xFF) {
118 /* Table full, so do normal hcall which will flush table. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600119 hcall(call, arg1, arg2, arg3, arg4);
Rusty Russell07ad1572007-07-19 01:49:22 -0700120 } else {
Jes Sorensenb410e7b2007-10-22 11:03:31 +1000121 lguest_data.hcalls[next_call].arg0 = call;
122 lguest_data.hcalls[next_call].arg1 = arg1;
123 lguest_data.hcalls[next_call].arg2 = arg2;
124 lguest_data.hcalls[next_call].arg3 = arg3;
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600125 lguest_data.hcalls[next_call].arg4 = arg4;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700126 /* Arguments must all be written before we mark it to go */
Rusty Russell07ad1572007-07-19 01:49:22 -0700127 wmb();
128 lguest_data.hcall_status[next_call] = 0;
129 if (++next_call == LHCALL_RING_SIZE)
130 next_call = 0;
131 }
132 local_irq_restore(flags);
133}
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100134
Rusty Russell2e04ef72009-07-30 16:03:45 -0600135/*G:035
136 * Notice the lazy_hcall() above, rather than hcall(). This is our first real
137 * optimization trick!
Rusty Russell633872b2007-11-05 21:55:57 +1100138 *
139 * When lazy_mode is set, it means we're allowed to defer all hypercalls and do
140 * them as a batch when lazy_mode is eventually turned off. Because hypercalls
141 * are reasonably expensive, batching them up makes sense. For example, a
142 * large munmap might update dozens of page table entries: that code calls
143 * paravirt_enter_lazy_mmu(), does the dozen updates, then calls
144 * lguest_leave_lazy_mode().
145 *
146 * So, when we're in lazy mode, we call async_hcall() to store the call for
Rusty Russell2e04ef72009-07-30 16:03:45 -0600147 * future processing:
148 */
Rusty Russell091ebf02010-04-14 21:43:54 -0600149static void lazy_hcall1(unsigned long call, unsigned long arg1)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200150{
151 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600152 hcall(call, arg1, 0, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200153 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,
Rusty Russell091ebf02010-04-14 21:43:54 -0600159 unsigned long arg1,
160 unsigned long arg2)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200161{
162 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600163 hcall(call, arg1, arg2, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200164 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,
Rusty Russell091ebf02010-04-14 21:43:54 -0600169 unsigned long arg1,
170 unsigned long arg2,
171 unsigned long arg3)
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100172{
173 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600174 hcall(call, arg1, arg2, arg3, 0);
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,
Rusty Russell091ebf02010-04-14 21:43:54 -0600181 unsigned long arg1,
182 unsigned long arg2,
183 unsigned long arg3,
184 unsigned long arg4)
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600185{
186 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600187 hcall(call, arg1, arg2, arg3, arg4);
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600188 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
Rusty Russell9f542882011-07-22 14:39:50 +0930194 * When lazy mode is turned off, we issue the do-nothing hypercall to
195 * flush any stored calls, and call the generic helper to reset the
196 * per-cpu lazy mode variable.
197 */
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800198static void lguest_leave_lazy_mmu_mode(void)
Rusty Russell633872b2007-11-05 21:55:57 +1100199{
Rusty Russell091ebf02010-04-14 21:43:54 -0600200 hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800201 paravirt_leave_lazy_mmu();
202}
203
Rusty Russell9f542882011-07-22 14:39:50 +0930204/*
205 * We also catch the end of context switch; we enter lazy mode for much of
206 * that too, so again we need to flush here.
207 *
208 * (Technically, this is lazy CPU mode, and normally we're in lazy MMU
209 * mode, but unlike Xen, lguest doesn't care about the difference).
210 */
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800211static void lguest_end_context_switch(struct task_struct *next)
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800212{
Rusty Russell091ebf02010-04-14 21:43:54 -0600213 hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800214 paravirt_end_context_switch(next);
Rusty Russell633872b2007-11-05 21:55:57 +1100215}
Rusty Russell07ad1572007-07-19 01:49:22 -0700216
Rusty Russell61f4bc82009-06-12 22:27:03 -0600217/*G:032
Rusty Russelle1e72962007-10-25 15:02:50 +1000218 * After that diversion we return to our first native-instruction
219 * replacements: four functions for interrupt control.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700220 *
221 * The simplest way of implementing these would be to have "turn interrupts
222 * off" and "turn interrupts on" hypercalls. Unfortunately, this is too slow:
223 * these are by far the most commonly called functions of those we override.
224 *
225 * So instead we keep an "irq_enabled" field inside our "struct lguest_data",
226 * which the Guest can update with a single instruction. The Host knows to
Rusty Russella6bd8e12008-03-28 11:05:53 -0500227 * check there before it tries to deliver an interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700228 */
229
Rusty Russell2e04ef72009-07-30 16:03:45 -0600230/*
231 * save_flags() is expected to return the processor state (ie. "flags"). The
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100232 * flags word contains all kind of stuff, but in practice Linux only cares
Rusty Russell2e04ef72009-07-30 16:03:45 -0600233 * about the interrupt flag. Our "save_flags()" just returns that.
234 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700235static unsigned long save_fl(void)
236{
237 return lguest_data.irq_enabled;
238}
Rusty Russell07ad1572007-07-19 01:49:22 -0700239
Rusty Russellb2b47c22007-07-26 10:41:02 -0700240/* Interrupts go off... */
Rusty Russell07ad1572007-07-19 01:49:22 -0700241static void irq_disable(void)
242{
243 lguest_data.irq_enabled = 0;
244}
Rusty Russell61f4bc82009-06-12 22:27:03 -0600245
Rusty Russell2e04ef72009-07-30 16:03:45 -0600246/*
247 * Let's pause a moment. Remember how I said these are called so often?
Rusty Russell61f4bc82009-06-12 22:27:03 -0600248 * Jeremy Fitzhardinge optimized them so hard early in 2009 that he had to
249 * break some rules. In particular, these functions are assumed to save their
250 * own registers if they need to: normal C functions assume they can trash the
251 * eax register. To use normal C functions, we use
252 * PV_CALLEE_SAVE_REGS_THUNK(), which pushes %eax onto the stack, calls the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600253 * C function, then restores it.
254 */
Rusty Russell61f4bc82009-06-12 22:27:03 -0600255PV_CALLEE_SAVE_REGS_THUNK(save_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -0800256PV_CALLEE_SAVE_REGS_THUNK(irq_disable);
Rusty Russellf56a3842007-07-26 10:41:05 -0700257/*:*/
Rusty Russell61f4bc82009-06-12 22:27:03 -0600258
259/* These are in i386_head.S */
260extern void lg_irq_enable(void);
261extern void lg_restore_fl(unsigned long flags);
262
Rusty Russell2e04ef72009-07-30 16:03:45 -0600263/*M:003
Rusty Russella91d74a2009-07-30 16:03:45 -0600264 * We could be more efficient in our checking of outstanding interrupts, rather
265 * than using a branch. One way would be to put the "irq_enabled" field in a
266 * page by itself, and have the Host write-protect it when an interrupt comes
267 * in when irqs are disabled. There will then be a page fault as soon as
268 * interrupts are re-enabled.
Rusty Russella6bd8e12008-03-28 11:05:53 -0500269 *
270 * A better method is to implement soft interrupt disable generally for x86:
271 * instead of disabling interrupts, we set a flag. If an interrupt does come
272 * in, we then disable them for real. This is uncommon, so we could simply use
Rusty Russell2e04ef72009-07-30 16:03:45 -0600273 * a hypercall for interrupt control and not worry about efficiency.
274:*/
Rusty Russell07ad1572007-07-19 01:49:22 -0700275
Rusty Russellb2b47c22007-07-26 10:41:02 -0700276/*G:034
277 * The Interrupt Descriptor Table (IDT).
278 *
279 * The IDT tells the processor what to do when an interrupt comes in. Each
280 * entry in the table is a 64-bit descriptor: this holds the privilege level,
281 * address of the handler, and... well, who cares? The Guest just asks the
282 * Host to make the change anyway, because the Host controls the real IDT.
283 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100284static void lguest_write_idt_entry(gate_desc *dt,
285 int entrynum, const gate_desc *g)
Rusty Russell07ad1572007-07-19 01:49:22 -0700286{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600287 /*
288 * The gate_desc structure is 8 bytes long: we hand it to the Host in
Rusty Russella6bd8e12008-03-28 11:05:53 -0500289 * two 32-bit chunks. The whole 32-bit kernel used to hand descriptors
290 * around like this; typesafety wasn't a big concern in Linux's early
Rusty Russell2e04ef72009-07-30 16:03:45 -0600291 * years.
292 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100293 u32 *desc = (u32 *)g;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700294 /* Keep the local copy up to date. */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100295 native_write_idt_entry(dt, entrynum, g);
Rusty Russellb2b47c22007-07-26 10:41:02 -0700296 /* Tell Host about this new entry. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600297 hcall(LHCALL_LOAD_IDT_ENTRY, entrynum, desc[0], desc[1], 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700298}
299
Rusty Russell2e04ef72009-07-30 16:03:45 -0600300/*
301 * Changing to a different IDT is very rare: we keep the IDT up-to-date every
Rusty Russellb2b47c22007-07-26 10:41:02 -0700302 * time it is written, so we can simply loop through all entries and tell the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600303 * Host about them.
304 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100305static void lguest_load_idt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700306{
307 unsigned int i;
308 struct desc_struct *idt = (void *)desc->address;
309
310 for (i = 0; i < (desc->size+1)/8; i++)
Rusty Russell091ebf02010-04-14 21:43:54 -0600311 hcall(LHCALL_LOAD_IDT_ENTRY, i, idt[i].a, idt[i].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700312}
313
Rusty Russellb2b47c22007-07-26 10:41:02 -0700314/*
315 * The Global Descriptor Table.
316 *
317 * The Intel architecture defines another table, called the Global Descriptor
318 * Table (GDT). You tell the CPU where it is (and its size) using the "lgdt"
319 * instruction, and then several other instructions refer to entries in the
320 * table. There are three entries which the Switcher needs, so the Host simply
321 * controls the entire thing and the Guest asks it to make changes using the
322 * LOAD_GDT hypercall.
323 *
Rusty Russella489f0b2009-04-19 23:14:00 -0600324 * This is the exactly like the IDT code.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700325 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100326static void lguest_load_gdt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700327{
Rusty Russella489f0b2009-04-19 23:14:00 -0600328 unsigned int i;
329 struct desc_struct *gdt = (void *)desc->address;
330
331 for (i = 0; i < (desc->size+1)/8; i++)
Rusty Russell091ebf02010-04-14 21:43:54 -0600332 hcall(LHCALL_LOAD_GDT_ENTRY, i, gdt[i].a, gdt[i].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700333}
334
Rusty Russell2e04ef72009-07-30 16:03:45 -0600335/*
Rusty Russell9b6efcd2010-09-21 10:54:01 -0600336 * For a single GDT entry which changes, we simply change our copy and
337 * then tell the host about it.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600338 */
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100339static void lguest_write_gdt_entry(struct desc_struct *dt, int entrynum,
340 const void *desc, int type)
Rusty Russell07ad1572007-07-19 01:49:22 -0700341{
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100342 native_write_gdt_entry(dt, entrynum, desc, type);
Rusty Russella489f0b2009-04-19 23:14:00 -0600343 /* Tell Host about this new entry. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600344 hcall(LHCALL_LOAD_GDT_ENTRY, entrynum,
345 dt[entrynum].a, dt[entrynum].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700346}
347
Rusty Russell2e04ef72009-07-30 16:03:45 -0600348/*
Rusty Russell9b6efcd2010-09-21 10:54:01 -0600349 * There are three "thread local storage" GDT entries which change
Rusty Russellb2b47c22007-07-26 10:41:02 -0700350 * on every context switch (these three entries are how glibc implements
Rusty Russell9b6efcd2010-09-21 10:54:01 -0600351 * __thread variables). As an optimization, we have a hypercall
352 * specifically for this case.
353 *
354 * Wouldn't it be nicer to have a general LOAD_GDT_ENTRIES hypercall
355 * which took a range of entries?
Rusty Russell2e04ef72009-07-30 16:03:45 -0600356 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700357static void lguest_load_tls(struct thread_struct *t, unsigned int cpu)
358{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600359 /*
360 * There's one problem which normal hardware doesn't have: the Host
Rusty Russell0d027c02007-08-09 20:57:13 +1000361 * can't handle us removing entries we're currently using. So we clear
Rusty Russell2e04ef72009-07-30 16:03:45 -0600362 * the GS register here: if it's needed it'll be reloaded anyway.
363 */
Tejun Heoccbeed32009-02-09 22:17:40 +0900364 lazy_load_gs(0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200365 lazy_hcall2(LHCALL_LOAD_TLS, __pa(&t->tls_array), cpu);
Rusty Russell07ad1572007-07-19 01:49:22 -0700366}
367
Rusty Russell2e04ef72009-07-30 16:03:45 -0600368/*G:038
369 * That's enough excitement for now, back to ploughing through each of the
370 * different pv_ops structures (we're about 1/3 of the way through).
Rusty Russellb2b47c22007-07-26 10:41:02 -0700371 *
372 * This is the Local Descriptor Table, another weird Intel thingy. Linux only
373 * uses this for some strange applications like Wine. We don't do anything
Rusty Russell2e04ef72009-07-30 16:03:45 -0600374 * here, so they'll get an informative and friendly Segmentation Fault.
375 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700376static void lguest_set_ldt(const void *addr, unsigned entries)
377{
378}
379
Rusty Russell2e04ef72009-07-30 16:03:45 -0600380/*
381 * This loads a GDT entry into the "Task Register": that entry points to a
Rusty Russellb2b47c22007-07-26 10:41:02 -0700382 * structure called the Task State Segment. Some comments scattered though the
383 * kernel code indicate that this used for task switching in ages past, along
384 * with blood sacrifice and astrology.
385 *
386 * Now there's nothing interesting in here that we don't get told elsewhere.
387 * But the native version uses the "ltr" instruction, which makes the Host
388 * complain to the Guest about a Segmentation Fault and it'll oops. So we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600389 * override the native version with a do-nothing version.
390 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700391static void lguest_load_tr_desc(void)
392{
393}
394
Rusty Russell2e04ef72009-07-30 16:03:45 -0600395/*
396 * The "cpuid" instruction is a way of querying both the CPU identity
Rusty Russellb2b47c22007-07-26 10:41:02 -0700397 * (manufacturer, model, etc) and its features. It was introduced before the
Rusty Russella6bd8e12008-03-28 11:05:53 -0500398 * Pentium in 1993 and keeps getting extended by both Intel, AMD and others.
399 * As you might imagine, after a decade and a half this treatment, it is now a
400 * giant ball of hair. Its entry in the current Intel manual runs to 28 pages.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700401 *
402 * This instruction even it has its own Wikipedia entry. The Wikipedia entry
Rusty Russell2e04ef72009-07-30 16:03:45 -0600403 * has been translated into 5 languages. I am not making this up!
Rusty Russellb2b47c22007-07-26 10:41:02 -0700404 *
405 * We could get funky here and identify ourselves as "GenuineLguest", but
406 * instead we just use the real "cpuid" instruction. Then I pretty much turned
407 * off feature bits until the Guest booted. (Don't say that: you'll damage
408 * lguest sales!) Shut up, inner voice! (Hey, just pointing out that this is
Lucas De Marchi0d2eb442011-03-17 16:24:16 -0300409 * hardly future proof.) No one's listening! They don't like you anyway,
Rusty Russellb2b47c22007-07-26 10:41:02 -0700410 * parenthetic weirdo!
411 *
412 * Replacing the cpuid so we can turn features off is great for the kernel, but
413 * anyone (including userspace) can just use the raw "cpuid" instruction and
414 * the Host won't even notice since it isn't privileged. So we try not to get
Rusty Russell2e04ef72009-07-30 16:03:45 -0600415 * too worked up about it.
416 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100417static void lguest_cpuid(unsigned int *ax, unsigned int *bx,
418 unsigned int *cx, unsigned int *dx)
Rusty Russell07ad1572007-07-19 01:49:22 -0700419{
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100420 int function = *ax;
Rusty Russell07ad1572007-07-19 01:49:22 -0700421
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100422 native_cpuid(ax, bx, cx, dx);
Rusty Russell07ad1572007-07-19 01:49:22 -0700423 switch (function) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600424 /*
425 * CPUID 0 gives the highest legal CPUID number (and the ID string).
426 * We futureproof our code a little by sticking to known CPUID values.
427 */
428 case 0:
Rusty Russell7a504922009-07-17 21:47:44 -0600429 if (*ax > 5)
430 *ax = 5;
431 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600432
433 /*
434 * CPUID 1 is a basic feature request.
435 *
436 * CX: we only allow kernel to see SSE3, CMPXCHG16B and SSSE3
437 * DX: SSE, SSE2, FXSR, MMX, CMOV, CMPXCHG8B, TSC, FPU and PAE.
438 */
439 case 1:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100440 *cx &= 0x00002201;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600441 *dx &= 0x07808151;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600442 /*
443 * The Host can do a nice optimization if it knows that the
Rusty Russellb2b47c22007-07-26 10:41:02 -0700444 * kernel mappings (addresses above 0xC0000000 or whatever
445 * PAGE_OFFSET is set to) haven't changed. But Linux calls
446 * flush_tlb_user() for both user and kernel mappings unless
Rusty Russell2e04ef72009-07-30 16:03:45 -0600447 * the Page Global Enable (PGE) feature bit is set.
448 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100449 *dx |= 0x00002000;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600450 /*
451 * We also lie, and say we're family id 5. 6 or greater
Rusty Russellcbd88c82009-03-09 10:06:22 -0600452 * leads to a rdmsr in early_init_intel which we can't handle.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600453 * Family ID is returned as bits 8-12 in ax.
454 */
Rusty Russellcbd88c82009-03-09 10:06:22 -0600455 *ax &= 0xFFFFF0FF;
456 *ax |= 0x00000500;
Rusty Russell07ad1572007-07-19 01:49:22 -0700457 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600458 /*
459 * 0x80000000 returns the highest Extended Function, so we futureproof
460 * like we do above by limiting it to known fields.
461 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700462 case 0x80000000:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100463 if (*ax > 0x80000008)
464 *ax = 0x80000008;
Rusty Russell07ad1572007-07-19 01:49:22 -0700465 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600466
467 /*
468 * PAE systems can mark pages as non-executable. Linux calls this the
469 * NX bit. Intel calls it XD (eXecute Disable), AMD EVP (Enhanced
Adrian Knoth64be1152011-07-11 18:07:14 +0200470 * Virus Protection). We just switch it off here, since we don't
Rusty Russell2e04ef72009-07-30 16:03:45 -0600471 * support it.
472 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600473 case 0x80000001:
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600474 *dx &= ~(1 << 20);
475 break;
Rusty Russell07ad1572007-07-19 01:49:22 -0700476 }
477}
478
Rusty Russell2e04ef72009-07-30 16:03:45 -0600479/*
480 * Intel has four control registers, imaginatively named cr0, cr2, cr3 and cr4.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700481 * I assume there's a cr1, but it hasn't bothered us yet, so we'll not bother
482 * it. The Host needs to know when the Guest wants to change them, so we have
483 * a whole series of functions like read_cr0() and write_cr0().
484 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000485 * We start with cr0. cr0 allows you to turn on and off all kinds of basic
Rusty Russellb2b47c22007-07-26 10:41:02 -0700486 * features, but Linux only really cares about one: the horrifically-named Task
487 * Switched (TS) bit at bit 3 (ie. 8)
488 *
489 * What does the TS bit do? Well, it causes the CPU to trap (interrupt 7) if
490 * the floating point unit is used. Which allows us to restore FPU state
491 * lazily after a task switch, and Linux uses that gratefully, but wouldn't a
492 * name like "FPUTRAP bit" be a little less cryptic?
493 *
Rusty Russellad5173f2008-10-31 11:24:27 -0500494 * We store cr0 locally because the Host never changes it. The Guest sometimes
Rusty Russell2e04ef72009-07-30 16:03:45 -0600495 * wants to read it and we'd prefer not to bother the Host unnecessarily.
496 */
Rusty Russellad5173f2008-10-31 11:24:27 -0500497static unsigned long current_cr0;
Rusty Russell07ad1572007-07-19 01:49:22 -0700498static void lguest_write_cr0(unsigned long val)
499{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200500 lazy_hcall1(LHCALL_TS, val & X86_CR0_TS);
Rusty Russell07ad1572007-07-19 01:49:22 -0700501 current_cr0 = val;
502}
503
504static unsigned long lguest_read_cr0(void)
505{
506 return current_cr0;
507}
508
Rusty Russell2e04ef72009-07-30 16:03:45 -0600509/*
510 * Intel provided a special instruction to clear the TS bit for people too cool
Rusty Russellb2b47c22007-07-26 10:41:02 -0700511 * to use write_cr0() to do it. This "clts" instruction is faster, because all
Rusty Russell2e04ef72009-07-30 16:03:45 -0600512 * the vowels have been optimized out.
513 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700514static void lguest_clts(void)
515{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200516 lazy_hcall1(LHCALL_TS, 0);
Rusty Russell25c47bb2007-10-25 14:09:53 +1000517 current_cr0 &= ~X86_CR0_TS;
Rusty Russell07ad1572007-07-19 01:49:22 -0700518}
519
Rusty Russell2e04ef72009-07-30 16:03:45 -0600520/*
521 * cr2 is the virtual address of the last page fault, which the Guest only ever
Rusty Russellb2b47c22007-07-26 10:41:02 -0700522 * reads. The Host kindly writes this into our "struct lguest_data", so we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600523 * just read it out of there.
524 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700525static unsigned long lguest_read_cr2(void)
526{
527 return lguest_data.cr2;
528}
529
Rusty Russellad5173f2008-10-31 11:24:27 -0500530/* See lguest_set_pte() below. */
531static bool cr3_changed = false;
Rusty Russell5dea1c82011-07-22 14:39:48 +0930532static unsigned long current_cr3;
Rusty Russellad5173f2008-10-31 11:24:27 -0500533
Rusty Russell2e04ef72009-07-30 16:03:45 -0600534/*
535 * cr3 is the current toplevel pagetable page: the principle is the same as
Rusty Russell5dea1c82011-07-22 14:39:48 +0930536 * cr0. Keep a local copy, and tell the Host when it changes.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600537 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700538static void lguest_write_cr3(unsigned long cr3)
539{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200540 lazy_hcall1(LHCALL_NEW_PGTABLE, cr3);
Rusty Russell5dea1c82011-07-22 14:39:48 +0930541 current_cr3 = cr3;
Rusty Russellbb4093d2010-12-16 17:03:15 -0600542
543 /* These two page tables are simple, linear, and used during boot */
544 if (cr3 != __pa(swapper_pg_dir) && cr3 != __pa(initial_page_table))
545 cr3_changed = true;
Rusty Russell07ad1572007-07-19 01:49:22 -0700546}
547
548static unsigned long lguest_read_cr3(void)
549{
Rusty Russell5dea1c82011-07-22 14:39:48 +0930550 return current_cr3;
Rusty Russell07ad1572007-07-19 01:49:22 -0700551}
552
Rusty Russelle1e72962007-10-25 15:02:50 +1000553/* cr4 is used to enable and disable PGE, but we don't care. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700554static unsigned long lguest_read_cr4(void)
555{
556 return 0;
557}
558
559static void lguest_write_cr4(unsigned long val)
560{
561}
562
Rusty Russellb2b47c22007-07-26 10:41:02 -0700563/*
564 * Page Table Handling.
565 *
566 * Now would be a good time to take a rest and grab a coffee or similarly
567 * relaxing stimulant. The easy parts are behind us, and the trek gradually
568 * winds uphill from here.
569 *
570 * Quick refresher: memory is divided into "pages" of 4096 bytes each. The CPU
571 * maps virtual addresses to physical addresses using "page tables". We could
572 * use one huge index of 1 million entries: each address is 4 bytes, so that's
573 * 1024 pages just to hold the page tables. But since most virtual addresses
Rusty Russelle1e72962007-10-25 15:02:50 +1000574 * are unused, we use a two level index which saves space. The cr3 register
Rusty Russellb2b47c22007-07-26 10:41:02 -0700575 * contains the physical address of the top level "page directory" page, which
576 * contains physical addresses of up to 1024 second-level pages. Each of these
577 * second level pages contains up to 1024 physical addresses of actual pages,
578 * or Page Table Entries (PTEs).
579 *
580 * Here's a diagram, where arrows indicate physical addresses:
581 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000582 * cr3 ---> +---------+
Rusty Russellb2b47c22007-07-26 10:41:02 -0700583 * | --------->+---------+
584 * | | | PADDR1 |
Rusty Russella91d74a2009-07-30 16:03:45 -0600585 * Mid-level | | PADDR2 |
Rusty Russellb2b47c22007-07-26 10:41:02 -0700586 * (PMD) page | | |
587 * | | Lower-level |
588 * | | (PTE) page |
589 * | | | |
590 * .... ....
591 *
592 * So to convert a virtual address to a physical address, we look up the top
593 * level, which points us to the second level, which gives us the physical
594 * address of that page. If the top level entry was not present, or the second
595 * level entry was not present, then the virtual address is invalid (we
596 * say "the page was not mapped").
597 *
598 * Put another way, a 32-bit virtual address is divided up like so:
599 *
600 * 1 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
601 * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
602 * Index into top Index into second Offset within page
603 * page directory page pagetable page
604 *
Rusty Russella91d74a2009-07-30 16:03:45 -0600605 * Now, unfortunately, this isn't the whole story: Intel added Physical Address
606 * Extension (PAE) to allow 32 bit systems to use 64GB of memory (ie. 36 bits).
607 * These are held in 64-bit page table entries, so we can now only fit 512
608 * entries in a page, and the neat three-level tree breaks down.
609 *
610 * The result is a four level page table:
611 *
612 * cr3 --> [ 4 Upper ]
613 * [ Level ]
614 * [ Entries ]
615 * [(PUD Page)]---> +---------+
616 * | --------->+---------+
617 * | | | PADDR1 |
618 * Mid-level | | PADDR2 |
619 * (PMD) page | | |
620 * | | Lower-level |
621 * | | (PTE) page |
622 * | | | |
623 * .... ....
624 *
625 *
626 * And the virtual address is decoded as:
627 *
628 * 1 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
629 * |<-2->|<--- 9 bits ---->|<---- 9 bits --->|<------ 12 bits ------>|
630 * Index into Index into mid Index into lower Offset within page
631 * top entries directory page pagetable page
632 *
633 * It's too hard to switch between these two formats at runtime, so Linux only
634 * supports one or the other depending on whether CONFIG_X86_PAE is set. Many
635 * distributions turn it on, and not just for people with silly amounts of
636 * memory: the larger PTE entries allow room for the NX bit, which lets the
637 * kernel disable execution of pages and increase security.
638 *
639 * This was a problem for lguest, which couldn't run on these distributions;
640 * then Matias Zabaljauregui figured it all out and implemented it, and only a
641 * handful of puppies were crushed in the process!
642 *
643 * Back to our point: the kernel spends a lot of time changing both the
644 * top-level page directory and lower-level pagetable pages. The Guest doesn't
645 * know physical addresses, so while it maintains these page tables exactly
646 * like normal, it also needs to keep the Host informed whenever it makes a
647 * change: the Host will create the real page tables based on the Guests'.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700648 */
649
Rusty Russell2e04ef72009-07-30 16:03:45 -0600650/*
Rusty Russella91d74a2009-07-30 16:03:45 -0600651 * The Guest calls this after it has set a second-level entry (pte), ie. to map
Rusty Russell9f542882011-07-22 14:39:50 +0930652 * a page into a process' address space. We tell the Host the toplevel and
Rusty Russella91d74a2009-07-30 16:03:45 -0600653 * address this corresponds to. The Guest uses one pagetable per process, so
654 * we need to tell the Host which one we're changing (mm->pgd).
Rusty Russell2e04ef72009-07-30 16:03:45 -0600655 */
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600656static void lguest_pte_update(struct mm_struct *mm, unsigned long addr,
657 pte_t *ptep)
658{
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600659#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600660 /* PAE needs to hand a 64 bit page table entry, so it uses two args. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600661 lazy_hcall4(LHCALL_SET_PTE, __pa(mm->pgd), addr,
662 ptep->pte_low, ptep->pte_high);
663#else
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200664 lazy_hcall3(LHCALL_SET_PTE, __pa(mm->pgd), addr, ptep->pte_low);
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600665#endif
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600666}
667
Rusty Russella91d74a2009-07-30 16:03:45 -0600668/* This is the "set and update" combo-meal-deal version. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700669static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
670 pte_t *ptep, pte_t pteval)
671{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600672 native_set_pte(ptep, pteval);
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600673 lguest_pte_update(mm, addr, ptep);
Rusty Russell07ad1572007-07-19 01:49:22 -0700674}
675
Rusty Russell2e04ef72009-07-30 16:03:45 -0600676/*
677 * The Guest calls lguest_set_pud to set a top-level entry and lguest_set_pmd
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600678 * to set a middle-level entry when PAE is activated.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600679 *
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600680 * Again, we set the entry then tell the Host which page we changed,
Rusty Russell2e04ef72009-07-30 16:03:45 -0600681 * and the index of the entry we changed.
682 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600683#ifdef CONFIG_X86_PAE
684static void lguest_set_pud(pud_t *pudp, pud_t pudval)
685{
686 native_set_pud(pudp, pudval);
687
688 /* 32 bytes aligned pdpt address and the index. */
689 lazy_hcall2(LHCALL_SET_PGD, __pa(pudp) & 0xFFFFFFE0,
690 (__pa(pudp) & 0x1F) / sizeof(pud_t));
691}
692
693static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
694{
695 native_set_pmd(pmdp, pmdval);
696 lazy_hcall2(LHCALL_SET_PMD, __pa(pmdp) & PAGE_MASK,
697 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
698}
699#else
700
Rusty Russell2e04ef72009-07-30 16:03:45 -0600701/* The Guest calls lguest_set_pmd to set a top-level entry when !PAE. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700702static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
703{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600704 native_set_pmd(pmdp, pmdval);
Matias Zabaljaureguiebe0ba82009-05-30 15:48:08 -0300705 lazy_hcall2(LHCALL_SET_PGD, __pa(pmdp) & PAGE_MASK,
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600706 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
Rusty Russell07ad1572007-07-19 01:49:22 -0700707}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600708#endif
Rusty Russell07ad1572007-07-19 01:49:22 -0700709
Rusty Russell2e04ef72009-07-30 16:03:45 -0600710/*
711 * There are a couple of legacy places where the kernel sets a PTE, but we
Rusty Russellb2b47c22007-07-26 10:41:02 -0700712 * don't know the top level any more. This is useless for us, since we don't
713 * know which pagetable is changing or what address, so we just tell the Host
714 * to forget all of them. Fortunately, this is very rare.
715 *
716 * ... except in early boot when the kernel sets up the initial pagetables,
Rusty Russellbb4093d2010-12-16 17:03:15 -0600717 * which makes booting astonishingly slow: 48 seconds! So we don't even tell
718 * the Host anything changed until we've done the first real page table switch,
719 * which brings boot back to 4.3 seconds.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600720 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700721static void lguest_set_pte(pte_t *ptep, pte_t pteval)
722{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600723 native_set_pte(ptep, pteval);
Rusty Russellad5173f2008-10-31 11:24:27 -0500724 if (cr3_changed)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200725 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700726}
727
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600728#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600729/*
730 * With 64-bit PTE values, we need to be careful setting them: if we set 32
731 * bits at a time, the hardware could see a weird half-set entry. These
732 * versions ensure we update all 64 bits at once.
733 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600734static void lguest_set_pte_atomic(pte_t *ptep, pte_t pte)
735{
736 native_set_pte_atomic(ptep, pte);
737 if (cr3_changed)
738 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
739}
740
Rusty Russella91d74a2009-07-30 16:03:45 -0600741static void lguest_pte_clear(struct mm_struct *mm, unsigned long addr,
742 pte_t *ptep)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600743{
744 native_pte_clear(mm, addr, ptep);
745 lguest_pte_update(mm, addr, ptep);
746}
747
Rusty Russella91d74a2009-07-30 16:03:45 -0600748static void lguest_pmd_clear(pmd_t *pmdp)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600749{
750 lguest_set_pmd(pmdp, __pmd(0));
751}
752#endif
753
Rusty Russell2e04ef72009-07-30 16:03:45 -0600754/*
755 * Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
Rusty Russellb2b47c22007-07-26 10:41:02 -0700756 * native page table operations. On native hardware you can set a new page
757 * table entry whenever you want, but if you want to remove one you have to do
758 * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
759 *
760 * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
761 * called when a valid entry is written, not when it's removed (ie. marked not
762 * present). Instead, this is where we come when the Guest wants to remove a
763 * page table entry: we tell the Host to set that entry to 0 (ie. the present
Rusty Russell2e04ef72009-07-30 16:03:45 -0600764 * bit is zero).
765 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700766static void lguest_flush_tlb_single(unsigned long addr)
767{
Rusty Russellb2b47c22007-07-26 10:41:02 -0700768 /* Simply set it to zero: if it was not, it will fault back in. */
Rusty Russell5dea1c82011-07-22 14:39:48 +0930769 lazy_hcall3(LHCALL_SET_PTE, current_cr3, addr, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700770}
771
Rusty Russell2e04ef72009-07-30 16:03:45 -0600772/*
773 * This is what happens after the Guest has removed a large number of entries.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700774 * This tells the Host that any of the page table entries for userspace might
Rusty Russell2e04ef72009-07-30 16:03:45 -0600775 * have changed, ie. virtual addresses below PAGE_OFFSET.
776 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700777static void lguest_flush_tlb_user(void)
778{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200779 lazy_hcall1(LHCALL_FLUSH_TLB, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700780}
781
Rusty Russell2e04ef72009-07-30 16:03:45 -0600782/*
783 * This is called when the kernel page tables have changed. That's not very
Rusty Russellb2b47c22007-07-26 10:41:02 -0700784 * common (unless the Guest is using highmem, which makes the Guest extremely
Rusty Russell2e04ef72009-07-30 16:03:45 -0600785 * slow), so it's worth separating this from the user flushing above.
786 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700787static void lguest_flush_tlb_kernel(void)
788{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200789 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700790}
791
Rusty Russellb2b47c22007-07-26 10:41:02 -0700792/*
793 * The Unadvanced Programmable Interrupt Controller.
794 *
795 * This is an attempt to implement the simplest possible interrupt controller.
796 * I spent some time looking though routines like set_irq_chip_and_handler,
797 * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
798 * I *think* this is as simple as it gets.
799 *
800 * We can tell the Host what interrupts we want blocked ready for using the
801 * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
802 * simple as setting a bit. We don't actually "ack" interrupts as such, we
803 * just mask and unmask them. I wonder if we should be cleverer?
804 */
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200805static void disable_lguest_irq(struct irq_data *data)
Rusty Russell07ad1572007-07-19 01:49:22 -0700806{
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200807 set_bit(data->irq, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -0700808}
809
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200810static void enable_lguest_irq(struct irq_data *data)
Rusty Russell07ad1572007-07-19 01:49:22 -0700811{
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200812 clear_bit(data->irq, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -0700813}
814
Rusty Russellb2b47c22007-07-26 10:41:02 -0700815/* This structure describes the lguest IRQ controller. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700816static struct irq_chip lguest_irq_controller = {
817 .name = "lguest",
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200818 .irq_mask = disable_lguest_irq,
819 .irq_mask_ack = disable_lguest_irq,
820 .irq_unmask = enable_lguest_irq,
Rusty Russell07ad1572007-07-19 01:49:22 -0700821};
822
Rusty Russell2e04ef72009-07-30 16:03:45 -0600823/*
824 * This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
Rusty Russellb2b47c22007-07-26 10:41:02 -0700825 * interrupt (except 128, which is used for system calls), and then tells the
826 * Linux infrastructure that each interrupt is controlled by our level-based
Rusty Russell2e04ef72009-07-30 16:03:45 -0600827 * lguest interrupt controller.
828 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700829static void __init lguest_init_IRQ(void)
830{
831 unsigned int i;
832
Rusty Russell10283752009-06-12 22:26:59 -0600833 for (i = FIRST_EXTERNAL_VECTOR; i < NR_VECTORS; i++) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600834 /* Some systems map "vectors" to interrupts weirdly. Not us! */
Rusty Russellced05dd2011-01-20 21:37:29 -0600835 __this_cpu_write(vector_irq[i], i - FIRST_EXTERNAL_VECTOR);
Rusty Russell10283752009-06-12 22:26:59 -0600836 if (i != SYSCALL_VECTOR)
837 set_intr_gate(i, interrupt[i - FIRST_EXTERNAL_VECTOR]);
Rusty Russell07ad1572007-07-19 01:49:22 -0700838 }
Rusty Russell2e04ef72009-07-30 16:03:45 -0600839
840 /*
841 * This call is required to set up for 4k stacks, where we have
842 * separate stacks for hard and soft interrupts.
843 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700844 irq_ctx_init(smp_processor_id());
845}
846
Rusty Russella91d74a2009-07-30 16:03:45 -0600847/*
848 * With CONFIG_SPARSE_IRQ, interrupt descriptors are allocated as-needed, so
849 * rather than set them in lguest_init_IRQ we are called here every time an
850 * lguest device needs an interrupt.
851 *
Thomas Gleixnerc2f31c32010-09-30 12:19:03 +0200852 * FIXME: irq_alloc_desc_at() can fail due to lack of memory, we should
Rusty Russella91d74a2009-07-30 16:03:45 -0600853 * pass that up!
854 */
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600855void lguest_setup_irq(unsigned int irq)
856{
Thomas Gleixnerc2f31c32010-09-30 12:19:03 +0200857 irq_alloc_desc_at(irq, 0);
Thomas Gleixner2c778652011-03-12 12:20:43 +0100858 irq_set_chip_and_handler_name(irq, &lguest_irq_controller,
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600859 handle_level_irq, "level");
860}
861
Rusty Russellb2b47c22007-07-26 10:41:02 -0700862/*
863 * Time.
864 *
865 * It would be far better for everyone if the Guest had its own clock, but
Rusty Russell6c8dca52007-07-27 13:42:52 +1000866 * until then the Host gives us the time on every interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700867 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700868static unsigned long lguest_get_wallclock(void)
869{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000870 return lguest_data.time.tv_sec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700871}
872
Rusty Russell2e04ef72009-07-30 16:03:45 -0600873/*
874 * The TSC is an Intel thing called the Time Stamp Counter. The Host tells us
Rusty Russella6bd8e12008-03-28 11:05:53 -0500875 * what speed it runs at, or 0 if it's unusable as a reliable clock source.
876 * This matches what we want here: if we return 0 from this function, the x86
Rusty Russell2e04ef72009-07-30 16:03:45 -0600877 * TSC clock will give up and not register itself.
878 */
Alok Katariae93ef942008-07-01 11:43:36 -0700879static unsigned long lguest_tsc_khz(void)
Rusty Russell3fabc552008-03-11 09:35:56 -0500880{
881 return lguest_data.tsc_khz;
882}
883
Rusty Russell2e04ef72009-07-30 16:03:45 -0600884/*
885 * If we can't use the TSC, the kernel falls back to our lower-priority
886 * "lguest_clock", where we read the time value given to us by the Host.
887 */
Magnus Damm8e196082009-04-21 12:24:00 -0700888static cycle_t lguest_clock_read(struct clocksource *cs)
Rusty Russell07ad1572007-07-19 01:49:22 -0700889{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000890 unsigned long sec, nsec;
891
Rusty Russell2e04ef72009-07-30 16:03:45 -0600892 /*
893 * Since the time is in two parts (seconds and nanoseconds), we risk
Rusty Russell3fabc552008-03-11 09:35:56 -0500894 * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
895 * and getting 99 and 0. As Linux tends to come apart under the stress
Rusty Russell2e04ef72009-07-30 16:03:45 -0600896 * of time travel, we must be careful:
897 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000898 do {
899 /* First we read the seconds part. */
900 sec = lguest_data.time.tv_sec;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600901 /*
902 * This read memory barrier tells the compiler and the CPU that
Rusty Russell6c8dca52007-07-27 13:42:52 +1000903 * this can't be reordered: we have to complete the above
Rusty Russell2e04ef72009-07-30 16:03:45 -0600904 * before going on.
905 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000906 rmb();
907 /* Now we read the nanoseconds part. */
908 nsec = lguest_data.time.tv_nsec;
909 /* Make sure we've done that. */
910 rmb();
911 /* Now if the seconds part has changed, try again. */
912 } while (unlikely(lguest_data.time.tv_sec != sec));
913
Rusty Russell3fabc552008-03-11 09:35:56 -0500914 /* Our lguest clock is in real nanoseconds. */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000915 return sec*1000000000ULL + nsec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700916}
917
Rusty Russell3fabc552008-03-11 09:35:56 -0500918/* This is the fallback clocksource: lower priority than the TSC clocksource. */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700919static struct clocksource lguest_clock = {
920 .name = "lguest",
Rusty Russell3fabc552008-03-11 09:35:56 -0500921 .rating = 200,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700922 .read = lguest_clock_read,
Rusty Russell6c8dca52007-07-27 13:42:52 +1000923 .mask = CLOCKSOURCE_MASK(64),
Tony Breeds05aa0262007-10-22 10:56:25 +1000924 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700925};
926
Rusty Russell2e04ef72009-07-30 16:03:45 -0600927/*
928 * We also need a "struct clock_event_device": Linux asks us to set it to go
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700929 * off some time in the future. Actually, James Morris figured all this out, I
Rusty Russell2e04ef72009-07-30 16:03:45 -0600930 * just applied the patch.
931 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700932static int lguest_clockevent_set_next_event(unsigned long delta,
933 struct clock_event_device *evt)
934{
Rusty Russella6bd8e12008-03-28 11:05:53 -0500935 /* FIXME: I don't think this can ever happen, but James tells me he had
936 * to put this code in. Maybe we should remove it now. Anyone? */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700937 if (delta < LG_CLOCK_MIN_DELTA) {
938 if (printk_ratelimit())
939 printk(KERN_DEBUG "%s: small delta %lu ns\n",
Harvey Harrison77bf90e2008-03-03 11:37:23 -0800940 __func__, delta);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700941 return -ETIME;
942 }
Rusty Russella6bd8e12008-03-28 11:05:53 -0500943
944 /* Please wake us this far in the future. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600945 hcall(LHCALL_SET_CLOCKEVENT, delta, 0, 0, 0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700946 return 0;
947}
948
949static void lguest_clockevent_set_mode(enum clock_event_mode mode,
950 struct clock_event_device *evt)
951{
952 switch (mode) {
953 case CLOCK_EVT_MODE_UNUSED:
954 case CLOCK_EVT_MODE_SHUTDOWN:
955 /* A 0 argument shuts the clock down. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600956 hcall(LHCALL_SET_CLOCKEVENT, 0, 0, 0, 0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700957 break;
958 case CLOCK_EVT_MODE_ONESHOT:
959 /* This is what we expect. */
960 break;
961 case CLOCK_EVT_MODE_PERIODIC:
962 BUG();
Thomas Gleixner18de5bc2007-07-21 04:37:34 -0700963 case CLOCK_EVT_MODE_RESUME:
964 break;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700965 }
966}
967
968/* This describes our primitive timer chip. */
969static struct clock_event_device lguest_clockevent = {
970 .name = "lguest",
971 .features = CLOCK_EVT_FEAT_ONESHOT,
972 .set_next_event = lguest_clockevent_set_next_event,
973 .set_mode = lguest_clockevent_set_mode,
974 .rating = INT_MAX,
975 .mult = 1,
976 .shift = 0,
977 .min_delta_ns = LG_CLOCK_MIN_DELTA,
978 .max_delta_ns = LG_CLOCK_MAX_DELTA,
979};
980
Rusty Russell2e04ef72009-07-30 16:03:45 -0600981/*
982 * This is the Guest timer interrupt handler (hardware interrupt 0). We just
983 * call the clockevent infrastructure and it does whatever needs doing.
984 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700985static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
986{
987 unsigned long flags;
988
989 /* Don't interrupt us while this is running. */
990 local_irq_save(flags);
991 lguest_clockevent.event_handler(&lguest_clockevent);
992 local_irq_restore(flags);
993}
994
Rusty Russell2e04ef72009-07-30 16:03:45 -0600995/*
996 * At some point in the boot process, we get asked to set up our timing
Rusty Russellb2b47c22007-07-26 10:41:02 -0700997 * infrastructure. The kernel doesn't expect timer interrupts before this, but
998 * we cleverly initialized the "blocked_interrupts" field of "struct
Rusty Russell2e04ef72009-07-30 16:03:45 -0600999 * lguest_data" so that timer interrupts were blocked until now.
1000 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001001static void lguest_time_init(void)
1002{
Rusty Russellb2b47c22007-07-26 10:41:02 -07001003 /* Set up the timer interrupt (0) to go to our simple timer routine */
Rusty Russell15517f72011-05-30 11:14:08 -06001004 lguest_setup_irq(0);
Thomas Gleixner2c778652011-03-12 12:20:43 +01001005 irq_set_handler(0, lguest_time_irq);
Rusty Russell07ad1572007-07-19 01:49:22 -07001006
John Stultzb01cc1b2010-04-26 19:03:05 -07001007 clocksource_register_hz(&lguest_clock, NSEC_PER_SEC);
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001008
Rusty Russellb2b47c22007-07-26 10:41:02 -07001009 /* We can't set cpumask in the initializer: damn C limitations! Set it
1010 * here and register our timer device. */
Rusty Russell320ab2b2008-12-13 21:20:26 +10301011 lguest_clockevent.cpumask = cpumask_of(0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001012 clockevents_register_device(&lguest_clockevent);
1013
Rusty Russellb2b47c22007-07-26 10:41:02 -07001014 /* Finally, we unblock the timer interrupt. */
Rusty Russellbb6f1d92010-12-16 17:03:13 -06001015 clear_bit(0, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -07001016}
1017
Rusty Russellb2b47c22007-07-26 10:41:02 -07001018/*
1019 * Miscellaneous bits and pieces.
1020 *
1021 * Here is an oddball collection of functions which the Guest needs for things
1022 * to work. They're pretty simple.
1023 */
1024
Rusty Russell2e04ef72009-07-30 16:03:45 -06001025/*
1026 * The Guest needs to tell the Host what stack it expects traps to use. For
Rusty Russellb2b47c22007-07-26 10:41:02 -07001027 * native hardware, this is part of the Task State Segment mentioned above in
1028 * lguest_load_tr_desc(), but to help hypervisors there's this special call.
1029 *
1030 * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
1031 * segment), the privilege level (we're privilege level 1, the Host is 0 and
1032 * will not tolerate us trying to use that), the stack pointer, and the number
Rusty Russell2e04ef72009-07-30 16:03:45 -06001033 * of pages in the stack.
1034 */
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001035static void lguest_load_sp0(struct tss_struct *tss,
Rusty Russella6bd8e12008-03-28 11:05:53 -05001036 struct thread_struct *thread)
Rusty Russell07ad1572007-07-19 01:49:22 -07001037{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001038 lazy_hcall3(LHCALL_SET_STACK, __KERNEL_DS | 0x1, thread->sp0,
1039 THREAD_SIZE / PAGE_SIZE);
Rusty Russell07ad1572007-07-19 01:49:22 -07001040}
1041
Rusty Russellb2b47c22007-07-26 10:41:02 -07001042/* Let's just say, I wouldn't do debugging under a Guest. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001043static void lguest_set_debugreg(int regno, unsigned long value)
1044{
1045 /* FIXME: Implement */
1046}
1047
Rusty Russell2e04ef72009-07-30 16:03:45 -06001048/*
1049 * There are times when the kernel wants to make sure that no memory writes are
Rusty Russellb2b47c22007-07-26 10:41:02 -07001050 * caught in the cache (that they've all reached real hardware devices). This
1051 * doesn't matter for the Guest which has virtual hardware.
1052 *
1053 * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
1054 * (clflush) instruction is available and the kernel uses that. Otherwise, it
1055 * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
1056 * Unlike clflush, wbinvd can only be run at privilege level 0. So we can
1057 * ignore clflush, but replace wbinvd.
1058 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001059static void lguest_wbinvd(void)
1060{
1061}
1062
Rusty Russell2e04ef72009-07-30 16:03:45 -06001063/*
1064 * If the Guest expects to have an Advanced Programmable Interrupt Controller,
Rusty Russellb2b47c22007-07-26 10:41:02 -07001065 * we play dumb by ignoring writes and returning 0 for reads. So it's no
1066 * longer Programmable nor Controlling anything, and I don't think 8 lines of
1067 * code qualifies for Advanced. It will also never interrupt anything. It
Rusty Russell2e04ef72009-07-30 16:03:45 -06001068 * does, however, allow us to get through the Linux boot code.
1069 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001070#ifdef CONFIG_X86_LOCAL_APIC
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001071static void lguest_apic_write(u32 reg, u32 v)
Rusty Russell07ad1572007-07-19 01:49:22 -07001072{
1073}
1074
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001075static u32 lguest_apic_read(u32 reg)
Rusty Russell07ad1572007-07-19 01:49:22 -07001076{
1077 return 0;
1078}
Suresh Siddha511d9d32008-07-14 09:49:14 -07001079
1080static u64 lguest_apic_icr_read(void)
1081{
1082 return 0;
1083}
1084
1085static void lguest_apic_icr_write(u32 low, u32 id)
1086{
1087 /* Warn to see if there's any stray references */
1088 WARN_ON(1);
1089}
1090
1091static void lguest_apic_wait_icr_idle(void)
1092{
1093 return;
1094}
1095
1096static u32 lguest_apic_safe_wait_icr_idle(void)
1097{
1098 return 0;
1099}
1100
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001101static void set_lguest_basic_apic_ops(void)
1102{
1103 apic->read = lguest_apic_read;
1104 apic->write = lguest_apic_write;
1105 apic->icr_read = lguest_apic_icr_read;
1106 apic->icr_write = lguest_apic_icr_write;
1107 apic->wait_icr_idle = lguest_apic_wait_icr_idle;
1108 apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
Suresh Siddha511d9d32008-07-14 09:49:14 -07001109};
Rusty Russell07ad1572007-07-19 01:49:22 -07001110#endif
1111
Rusty Russellb2b47c22007-07-26 10:41:02 -07001112/* STOP! Until an interrupt comes in. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001113static void lguest_safe_halt(void)
1114{
Rusty Russell091ebf02010-04-14 21:43:54 -06001115 hcall(LHCALL_HALT, 0, 0, 0, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001116}
1117
Rusty Russell2e04ef72009-07-30 16:03:45 -06001118/*
1119 * The SHUTDOWN hypercall takes a string to describe what's happening, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001120 * an argument which says whether this to restart (reboot) the Guest or not.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001121 *
1122 * Note that the Host always prefers that the Guest speak in physical addresses
Rusty Russell2e04ef72009-07-30 16:03:45 -06001123 * rather than virtual addresses, so we use __pa() here.
1124 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001125static void lguest_power_off(void)
1126{
Rusty Russell091ebf02010-04-14 21:43:54 -06001127 hcall(LHCALL_SHUTDOWN, __pa("Power down"),
1128 LGUEST_SHUTDOWN_POWEROFF, 0, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001129}
1130
Rusty Russellb2b47c22007-07-26 10:41:02 -07001131/*
1132 * Panicing.
1133 *
1134 * Don't. But if you did, this is what happens.
1135 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001136static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
1137{
Rusty Russell091ebf02010-04-14 21:43:54 -06001138 hcall(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF, 0, 0);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001139 /* The hcall won't return, but to keep gcc happy, we're "done". */
Rusty Russell07ad1572007-07-19 01:49:22 -07001140 return NOTIFY_DONE;
1141}
1142
1143static struct notifier_block paniced = {
1144 .notifier_call = lguest_panic
1145};
1146
Rusty Russellb2b47c22007-07-26 10:41:02 -07001147/* Setting up memory is fairly easy. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001148static __init char *lguest_memory_setup(void)
1149{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001150 /*
Rusty Russell9f542882011-07-22 14:39:50 +09301151 * The Linux bootloader header contains an "e820" memory map: the
Rusty Russell2e04ef72009-07-30 16:03:45 -06001152 * Launcher populated the first entry with our memory limit.
1153 */
Yinghai Lud0be6bd2008-06-15 18:58:51 -07001154 e820_add_region(boot_params.e820_map[0].addr,
H. Peter Anvin30c82642007-10-15 17:13:22 -07001155 boot_params.e820_map[0].size,
1156 boot_params.e820_map[0].type);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001157
1158 /* This string is for the boot messages. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001159 return "LGUEST";
1160}
1161
Rusty Russell2e04ef72009-07-30 16:03:45 -06001162/*
1163 * We will eventually use the virtio console device to produce console output,
Rusty Russelle1e72962007-10-25 15:02:50 +10001164 * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
Rusty Russell2e04ef72009-07-30 16:03:45 -06001165 * console output.
1166 */
Rusty Russell19f15372007-10-22 11:24:21 +10001167static __init int early_put_chars(u32 vtermno, const char *buf, int count)
1168{
1169 char scratch[17];
1170 unsigned int len = count;
1171
Rusty Russell2e04ef72009-07-30 16:03:45 -06001172 /* We use a nul-terminated string, so we make a copy. Icky, huh? */
Rusty Russell19f15372007-10-22 11:24:21 +10001173 if (len > sizeof(scratch) - 1)
1174 len = sizeof(scratch) - 1;
1175 scratch[len] = '\0';
1176 memcpy(scratch, buf, len);
Rusty Russell091ebf02010-04-14 21:43:54 -06001177 hcall(LHCALL_NOTIFY, __pa(scratch), 0, 0, 0);
Rusty Russell19f15372007-10-22 11:24:21 +10001178
1179 /* This routine returns the number of bytes actually written. */
1180 return len;
1181}
1182
Rusty Russell2e04ef72009-07-30 16:03:45 -06001183/*
1184 * Rebooting also tells the Host we're finished, but the RESTART flag tells the
1185 * Launcher to reboot us.
1186 */
Rusty Russella6bd8e12008-03-28 11:05:53 -05001187static void lguest_restart(char *reason)
1188{
Rusty Russell091ebf02010-04-14 21:43:54 -06001189 hcall(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART, 0, 0);
Rusty Russella6bd8e12008-03-28 11:05:53 -05001190}
1191
Rusty Russellb2b47c22007-07-26 10:41:02 -07001192/*G:050
1193 * Patching (Powerfully Placating Performance Pedants)
1194 *
Rusty Russella6bd8e12008-03-28 11:05:53 -05001195 * We have already seen that pv_ops structures let us replace simple native
1196 * instructions with calls to the appropriate back end all throughout the
1197 * kernel. This allows the same kernel to run as a Guest and as a native
Rusty Russellb2b47c22007-07-26 10:41:02 -07001198 * kernel, but it's slow because of all the indirect branches.
1199 *
1200 * Remember that David Wheeler quote about "Any problem in computer science can
1201 * be solved with another layer of indirection"? The rest of that quote is
1202 * "... But that usually will create another problem." This is the first of
1203 * those problems.
1204 *
1205 * Our current solution is to allow the paravirt back end to optionally patch
1206 * over the indirect calls to replace them with something more efficient. We
Rusty Russella32a8812009-06-12 22:27:02 -06001207 * patch two of the simplest of the most commonly called functions: disable
1208 * interrupts and save interrupts. We usually have 6 or 10 bytes to patch
1209 * into: the Guest versions of these operations are small enough that we can
1210 * fit comfortably.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001211 *
1212 * First we need assembly templates of each of the patchable Guest operations,
Rusty Russell2e04ef72009-07-30 16:03:45 -06001213 * and these are in i386_head.S.
1214 */
Rusty Russellb2b47c22007-07-26 10:41:02 -07001215
1216/*G:060 We construct a table from the assembler templates: */
Rusty Russell07ad1572007-07-19 01:49:22 -07001217static const struct lguest_insns
1218{
1219 const char *start, *end;
1220} lguest_insns[] = {
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001221 [PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001222 [PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
Rusty Russell07ad1572007-07-19 01:49:22 -07001223};
Rusty Russellb2b47c22007-07-26 10:41:02 -07001224
Rusty Russell2e04ef72009-07-30 16:03:45 -06001225/*
1226 * Now our patch routine is fairly simple (based on the native one in
Rusty Russellb2b47c22007-07-26 10:41:02 -07001227 * paravirt.c). If we have a replacement, we copy it in and return how much of
Rusty Russell2e04ef72009-07-30 16:03:45 -06001228 * the available space we used.
1229 */
Andi Kleenab144f52007-08-10 22:31:03 +02001230static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
1231 unsigned long addr, unsigned len)
Rusty Russell07ad1572007-07-19 01:49:22 -07001232{
1233 unsigned int insn_len;
1234
Rusty Russellb2b47c22007-07-26 10:41:02 -07001235 /* Don't do anything special if we don't have a replacement */
Rusty Russell07ad1572007-07-19 01:49:22 -07001236 if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
Andi Kleenab144f52007-08-10 22:31:03 +02001237 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001238
1239 insn_len = lguest_insns[type].end - lguest_insns[type].start;
1240
Rusty Russell2e04ef72009-07-30 16:03:45 -06001241 /* Similarly if it can't fit (doesn't happen, but let's be thorough). */
Rusty Russell07ad1572007-07-19 01:49:22 -07001242 if (len < insn_len)
Andi Kleenab144f52007-08-10 22:31:03 +02001243 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001244
Rusty Russellb2b47c22007-07-26 10:41:02 -07001245 /* Copy in our instructions. */
Andi Kleenab144f52007-08-10 22:31:03 +02001246 memcpy(ibuf, lguest_insns[type].start, insn_len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001247 return insn_len;
1248}
1249
Rusty Russell2e04ef72009-07-30 16:03:45 -06001250/*G:029
1251 * Once we get to lguest_init(), we know we're a Guest. The various
Rusty Russella6bd8e12008-03-28 11:05:53 -05001252 * pv_ops structures in the kernel provide points for (almost) every routine we
Rusty Russell2e04ef72009-07-30 16:03:45 -06001253 * have to override to avoid privileged instructions.
1254 */
Rusty Russell814a0e52007-10-22 11:29:44 +10001255__init void lguest_init(void)
Rusty Russell07ad1572007-07-19 01:49:22 -07001256{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001257 /* We're under lguest. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001258 pv_info.name = "lguest";
Rusty Russell2e04ef72009-07-30 16:03:45 -06001259 /* Paravirt is enabled. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001260 pv_info.paravirt_enabled = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001261 /* We're running at privilege level 1, not 0 as normal. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001262 pv_info.kernel_rpl = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001263 /* Everyone except Xen runs with this set. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001264 pv_info.shared_kernel_pmd = 1;
Rusty Russell07ad1572007-07-19 01:49:22 -07001265
Rusty Russell2e04ef72009-07-30 16:03:45 -06001266 /*
1267 * We set up all the lguest overrides for sensitive operations. These
1268 * are detailed with the operations themselves.
1269 */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001270
Rusty Russell2e04ef72009-07-30 16:03:45 -06001271 /* Interrupt-related operations */
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001272 pv_irq_ops.save_fl = PV_CALLEE_SAVE(save_fl);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001273 pv_irq_ops.restore_fl = __PV_IS_CALLEE_SAVE(lg_restore_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001274 pv_irq_ops.irq_disable = PV_CALLEE_SAVE(irq_disable);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001275 pv_irq_ops.irq_enable = __PV_IS_CALLEE_SAVE(lg_irq_enable);
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001276 pv_irq_ops.safe_halt = lguest_safe_halt;
1277
Rusty Russell2e04ef72009-07-30 16:03:45 -06001278 /* Setup operations */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001279 pv_init_ops.patch = lguest_patch;
1280
Rusty Russell2e04ef72009-07-30 16:03:45 -06001281 /* Intercepts of various CPU instructions */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001282 pv_cpu_ops.load_gdt = lguest_load_gdt;
1283 pv_cpu_ops.cpuid = lguest_cpuid;
1284 pv_cpu_ops.load_idt = lguest_load_idt;
1285 pv_cpu_ops.iret = lguest_iret;
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001286 pv_cpu_ops.load_sp0 = lguest_load_sp0;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001287 pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1288 pv_cpu_ops.set_ldt = lguest_set_ldt;
1289 pv_cpu_ops.load_tls = lguest_load_tls;
1290 pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1291 pv_cpu_ops.clts = lguest_clts;
1292 pv_cpu_ops.read_cr0 = lguest_read_cr0;
1293 pv_cpu_ops.write_cr0 = lguest_write_cr0;
1294 pv_cpu_ops.read_cr4 = lguest_read_cr4;
1295 pv_cpu_ops.write_cr4 = lguest_write_cr4;
1296 pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1297 pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1298 pv_cpu_ops.wbinvd = lguest_wbinvd;
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -08001299 pv_cpu_ops.start_context_switch = paravirt_start_context_switch;
1300 pv_cpu_ops.end_context_switch = lguest_end_context_switch;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001301
Rusty Russell2e04ef72009-07-30 16:03:45 -06001302 /* Pagetable management */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001303 pv_mmu_ops.write_cr3 = lguest_write_cr3;
1304 pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1305 pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1306 pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1307 pv_mmu_ops.set_pte = lguest_set_pte;
1308 pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1309 pv_mmu_ops.set_pmd = lguest_set_pmd;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001310#ifdef CONFIG_X86_PAE
1311 pv_mmu_ops.set_pte_atomic = lguest_set_pte_atomic;
1312 pv_mmu_ops.pte_clear = lguest_pte_clear;
1313 pv_mmu_ops.pmd_clear = lguest_pmd_clear;
1314 pv_mmu_ops.set_pud = lguest_set_pud;
1315#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001316 pv_mmu_ops.read_cr2 = lguest_read_cr2;
1317 pv_mmu_ops.read_cr3 = lguest_read_cr3;
Jeremy Fitzhardinge8965c1c2007-10-16 11:51:29 -07001318 pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -08001319 pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mmu_mode;
Rusty Russellb7ff99e2009-03-30 21:55:23 -06001320 pv_mmu_ops.pte_update = lguest_pte_update;
1321 pv_mmu_ops.pte_update_defer = lguest_pte_update;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001322
Rusty Russell07ad1572007-07-19 01:49:22 -07001323#ifdef CONFIG_X86_LOCAL_APIC
Rusty Russell2e04ef72009-07-30 16:03:45 -06001324 /* APIC read/write intercepts */
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001325 set_lguest_basic_apic_ops();
Rusty Russell07ad1572007-07-19 01:49:22 -07001326#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001327
Thomas Gleixner6b18ae32009-08-20 10:19:54 +02001328 x86_init.resources.memory_setup = lguest_memory_setup;
Thomas Gleixner66bcaf02009-08-20 09:59:09 +02001329 x86_init.irqs.intr_init = lguest_init_IRQ;
Thomas Gleixner845b3942009-08-19 15:37:03 +02001330 x86_init.timers.timer_init = lguest_time_init;
Thomas Gleixner2d826402009-08-20 17:06:25 +02001331 x86_platform.calibrate_tsc = lguest_tsc_khz;
Feng Tang7bd867d2009-09-10 10:48:56 +08001332 x86_platform.get_wallclock = lguest_get_wallclock;
Thomas Gleixner6b18ae32009-08-20 10:19:54 +02001333
Rusty Russell2e04ef72009-07-30 16:03:45 -06001334 /*
1335 * Now is a good time to look at the implementations of these functions
1336 * before returning to the rest of lguest_init().
1337 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001338
Rusty Russell2e04ef72009-07-30 16:03:45 -06001339 /*G:070
1340 * Now we've seen all the paravirt_ops, we return to
Rusty Russellb2b47c22007-07-26 10:41:02 -07001341 * lguest_init() where the rest of the fairly chaotic boot setup
Rusty Russell2e04ef72009-07-30 16:03:45 -06001342 * occurs.
1343 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001344
Rusty Russell2e04ef72009-07-30 16:03:45 -06001345 /*
1346 * The stack protector is a weird thing where gcc places a canary
Rusty Russell2cb78782009-06-03 14:52:24 +09301347 * value on the stack and then checks it on return. This file is
1348 * compiled with -fno-stack-protector it, so we got this far without
1349 * problems. The value of the canary is kept at offset 20 from the
1350 * %gs register, so we need to set that up before calling C functions
Rusty Russell2e04ef72009-07-30 16:03:45 -06001351 * in other files.
1352 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301353 setup_stack_canary_segment(0);
Rusty Russell2e04ef72009-07-30 16:03:45 -06001354
1355 /*
1356 * We could just call load_stack_canary_segment(), but we might as well
1357 * call switch_to_new_gdt() which loads the whole table and sets up the
1358 * per-cpu segment descriptor register %fs as well.
1359 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301360 switch_to_new_gdt(0);
1361
Rusty Russell2e04ef72009-07-30 16:03:45 -06001362 /*
1363 * The Host<->Guest Switcher lives at the top of our address space, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001364 * the Host told us how big it is when we made LGUEST_INIT hypercall:
Rusty Russell2e04ef72009-07-30 16:03:45 -06001365 * it put the answer in lguest_data.reserve_mem
1366 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001367 reserve_top_address(lguest_data.reserve_mem);
1368
Rusty Russell2e04ef72009-07-30 16:03:45 -06001369 /*
1370 * If we don't initialize the lock dependency checker now, it crashes
Rusty Russellcdae0ad2009-09-23 22:26:42 -06001371 * atomic_notifier_chain_register, then paravirt_disable_iospace.
Rusty Russell2e04ef72009-07-30 16:03:45 -06001372 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001373 lockdep_init();
1374
Rusty Russellcdae0ad2009-09-23 22:26:42 -06001375 /* Hook in our special panic hypercall code. */
1376 atomic_notifier_chain_register(&panic_notifier_list, &paniced);
1377
Rusty Russell2e04ef72009-07-30 16:03:45 -06001378 /*
1379 * The IDE code spends about 3 seconds probing for disks: if we reserve
Rusty Russellb2b47c22007-07-26 10:41:02 -07001380 * all the I/O ports up front it can't get them and so doesn't probe.
1381 * Other device drivers are similar (but less severe). This cuts the
Rusty Russell2e04ef72009-07-30 16:03:45 -06001382 * kernel boot time on my machine from 4.1 seconds to 0.45 seconds.
1383 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001384 paravirt_disable_iospace();
1385
Rusty Russell2e04ef72009-07-30 16:03:45 -06001386 /*
1387 * This is messy CPU setup stuff which the native boot code does before
1388 * start_kernel, so we have to do, too:
1389 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001390 cpu_detect(&new_cpu_data);
1391 /* head.S usually sets up the first capability word, so do it here. */
1392 new_cpu_data.x86_capability[0] = cpuid_edx(1);
1393
1394 /* Math is always hard! */
1395 new_cpu_data.hard_math = 1;
1396
Rusty Russella6bd8e12008-03-28 11:05:53 -05001397 /* We don't have features. We have puppies! Puppies! */
Rusty Russell07ad1572007-07-19 01:49:22 -07001398#ifdef CONFIG_X86_MCE
1399 mce_disabled = 1;
1400#endif
Rusty Russell07ad1572007-07-19 01:49:22 -07001401#ifdef CONFIG_ACPI
1402 acpi_disabled = 1;
Rusty Russell07ad1572007-07-19 01:49:22 -07001403#endif
1404
Rusty Russell2e04ef72009-07-30 16:03:45 -06001405 /*
1406 * We set the preferred console to "hvc". This is the "hypervisor
Rusty Russellb2b47c22007-07-26 10:41:02 -07001407 * virtual console" driver written by the PowerPC people, which we also
Rusty Russell2e04ef72009-07-30 16:03:45 -06001408 * adapted for lguest's use.
1409 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001410 add_preferred_console("hvc", 0, NULL);
1411
Rusty Russell19f15372007-10-22 11:24:21 +10001412 /* Register our very early console. */
1413 virtio_cons_early_init(early_put_chars);
1414
Rusty Russell2e04ef72009-07-30 16:03:45 -06001415 /*
1416 * Last of all, we set the power management poweroff hook to point to
Rusty Russella6bd8e12008-03-28 11:05:53 -05001417 * the Guest routine to power off, and the reboot hook to our restart
Rusty Russell2e04ef72009-07-30 16:03:45 -06001418 * routine.
1419 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001420 pm_power_off = lguest_power_off;
Balaji Raoec04b132007-12-28 14:26:24 +05301421 machine_ops.restart = lguest_restart;
Rusty Russella6bd8e12008-03-28 11:05:53 -05001422
Rusty Russell2e04ef72009-07-30 16:03:45 -06001423 /*
1424 * Now we're set up, call i386_start_kernel() in head32.c and we proceed
1425 * to boot as normal. It never returns.
1426 */
Yinghai Luf0d43102008-05-29 12:56:36 -07001427 i386_start_kernel();
Rusty Russell07ad1572007-07-19 01:49:22 -07001428}
Rusty Russellb2b47c22007-07-26 10:41:02 -07001429/*
1430 * This marks the end of stage II of our journey, The Guest.
1431 *
Rusty Russelle1e72962007-10-25 15:02:50 +10001432 * It is now time for us to explore the layer of virtual drivers and complete
1433 * our understanding of the Guest in "make Drivers".
Rusty Russellb2b47c22007-07-26 10:41:02 -07001434 */