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