blob: f63da5ef217c40deb6af93e0924246fc68f94008 [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 Russell89cfc992011-10-27 10:56:17 +103073#include <asm/kvm_para.h>
Rusty Russell07ad1572007-07-19 01:49:22 -070074
Rusty Russell9f542882011-07-22 14:39:50 +093075/*G:010
76 * Welcome to the Guest!
Rusty Russellb2b47c22007-07-26 10:41:02 -070077 *
78 * The Guest in our tale is a simple creature: identical to the Host but
79 * behaving in simplified but equivalent ways. In particular, the Guest is the
Rusty Russell2e04ef72009-07-30 16:03:45 -060080 * same kernel as the Host (or at least, built from the same source code).
81:*/
Rusty Russellb2b47c22007-07-26 10:41:02 -070082
Rusty Russell07ad1572007-07-19 01:49:22 -070083struct lguest_data lguest_data = {
84 .hcall_status = { [0 ... LHCALL_RING_SIZE-1] = 0xFF },
85 .noirq_start = (u32)lguest_noirq_start,
86 .noirq_end = (u32)lguest_noirq_end,
Rusty Russell47436aa2007-10-22 11:03:36 +100087 .kernel_address = PAGE_OFFSET,
Rusty Russell07ad1572007-07-19 01:49:22 -070088 .blocked_interrupts = { 1 }, /* Block timer interrupts */
Rusty Russellc18acd72007-10-22 11:03:35 +100089 .syscall_vec = SYSCALL_VECTOR,
Rusty Russell07ad1572007-07-19 01:49:22 -070090};
Rusty Russell07ad1572007-07-19 01:49:22 -070091
Rusty Russell2e04ef72009-07-30 16:03:45 -060092/*G:037
93 * async_hcall() is pretty simple: I'm quite proud of it really. We have a
Rusty Russellb2b47c22007-07-26 10:41:02 -070094 * ring buffer of stored hypercalls which the Host will run though next time we
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -060095 * do a normal hypercall. Each entry in the ring has 5 slots for the hypercall
Rusty Russellb2b47c22007-07-26 10:41:02 -070096 * arguments, and a "hcall_status" word which is 0 if the call is ready to go,
97 * and 255 once the Host has finished with it.
98 *
99 * If we come around to a slot which hasn't been finished, then the table is
100 * full and we just make the hypercall directly. This has the nice side
101 * effect of causing the Host to run all the stored calls in the ring buffer
Rusty Russell2e04ef72009-07-30 16:03:45 -0600102 * which empties it for next time!
103 */
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100104static void async_hcall(unsigned long call, unsigned long arg1,
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600105 unsigned long arg2, unsigned long arg3,
106 unsigned long arg4)
Rusty Russell07ad1572007-07-19 01:49:22 -0700107{
108 /* Note: This code assumes we're uniprocessor. */
109 static unsigned int next_call;
110 unsigned long flags;
111
Rusty Russell2e04ef72009-07-30 16:03:45 -0600112 /*
113 * Disable interrupts if not already disabled: we don't want an
Rusty Russellb2b47c22007-07-26 10:41:02 -0700114 * interrupt handler making a hypercall while we're already doing
Rusty Russell2e04ef72009-07-30 16:03:45 -0600115 * one!
116 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700117 local_irq_save(flags);
118 if (lguest_data.hcall_status[next_call] != 0xFF) {
119 /* Table full, so do normal hcall which will flush table. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600120 hcall(call, arg1, arg2, arg3, arg4);
Rusty Russell07ad1572007-07-19 01:49:22 -0700121 } else {
Jes Sorensenb410e7b2007-10-22 11:03:31 +1000122 lguest_data.hcalls[next_call].arg0 = call;
123 lguest_data.hcalls[next_call].arg1 = arg1;
124 lguest_data.hcalls[next_call].arg2 = arg2;
125 lguest_data.hcalls[next_call].arg3 = arg3;
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600126 lguest_data.hcalls[next_call].arg4 = arg4;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700127 /* Arguments must all be written before we mark it to go */
Rusty Russell07ad1572007-07-19 01:49:22 -0700128 wmb();
129 lguest_data.hcall_status[next_call] = 0;
130 if (++next_call == LHCALL_RING_SIZE)
131 next_call = 0;
132 }
133 local_irq_restore(flags);
134}
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100135
Rusty Russell2e04ef72009-07-30 16:03:45 -0600136/*G:035
137 * Notice the lazy_hcall() above, rather than hcall(). This is our first real
138 * optimization trick!
Rusty Russell633872b2007-11-05 21:55:57 +1100139 *
140 * When lazy_mode is set, it means we're allowed to defer all hypercalls and do
141 * them as a batch when lazy_mode is eventually turned off. Because hypercalls
142 * are reasonably expensive, batching them up makes sense. For example, a
143 * large munmap might update dozens of page table entries: that code calls
144 * paravirt_enter_lazy_mmu(), does the dozen updates, then calls
145 * lguest_leave_lazy_mode().
146 *
147 * So, when we're in lazy mode, we call async_hcall() to store the call for
Rusty Russell2e04ef72009-07-30 16:03:45 -0600148 * future processing:
149 */
Rusty Russell091ebf02010-04-14 21:43:54 -0600150static void lazy_hcall1(unsigned long call, unsigned long arg1)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200151{
152 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600153 hcall(call, arg1, 0, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200154 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600155 async_hcall(call, arg1, 0, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200156}
157
Rusty Russella91d74a2009-07-30 16:03:45 -0600158/* You can imagine what lazy_hcall2, 3 and 4 look like. :*/
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200159static void lazy_hcall2(unsigned long call,
Rusty Russell091ebf02010-04-14 21:43:54 -0600160 unsigned long arg1,
161 unsigned long arg2)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200162{
163 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600164 hcall(call, arg1, arg2, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200165 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600166 async_hcall(call, arg1, arg2, 0, 0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200167}
168
169static void lazy_hcall3(unsigned long call,
Rusty Russell091ebf02010-04-14 21:43:54 -0600170 unsigned long arg1,
171 unsigned long arg2,
172 unsigned long arg3)
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100173{
174 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600175 hcall(call, arg1, arg2, arg3, 0);
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100176 else
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600177 async_hcall(call, arg1, arg2, arg3, 0);
178}
179
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600180#ifdef CONFIG_X86_PAE
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600181static void lazy_hcall4(unsigned long call,
Rusty Russell091ebf02010-04-14 21:43:54 -0600182 unsigned long arg1,
183 unsigned long arg2,
184 unsigned long arg3,
185 unsigned long arg4)
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600186{
187 if (paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE)
Rusty Russell091ebf02010-04-14 21:43:54 -0600188 hcall(call, arg1, arg2, arg3, arg4);
Matias Zabaljaureguicefcad12009-06-12 22:27:07 -0600189 else
190 async_hcall(call, arg1, arg2, arg3, arg4);
Adrian Bunk9b56fdb2007-11-02 16:43:10 +0100191}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600192#endif
Rusty Russell633872b2007-11-05 21:55:57 +1100193
Rusty Russella91d74a2009-07-30 16:03:45 -0600194/*G:036
Rusty Russell9f542882011-07-22 14:39:50 +0930195 * When lazy mode is turned off, we issue the do-nothing hypercall to
196 * flush any stored calls, and call the generic helper to reset the
197 * per-cpu lazy mode variable.
198 */
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800199static void lguest_leave_lazy_mmu_mode(void)
Rusty Russell633872b2007-11-05 21:55:57 +1100200{
Rusty Russell091ebf02010-04-14 21:43:54 -0600201 hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800202 paravirt_leave_lazy_mmu();
203}
204
Rusty Russell9f542882011-07-22 14:39:50 +0930205/*
206 * We also catch the end of context switch; we enter lazy mode for much of
207 * that too, so again we need to flush here.
208 *
209 * (Technically, this is lazy CPU mode, and normally we're in lazy MMU
210 * mode, but unlike Xen, lguest doesn't care about the difference).
211 */
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800212static void lguest_end_context_switch(struct task_struct *next)
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -0800213{
Rusty Russell091ebf02010-04-14 21:43:54 -0600214 hcall(LHCALL_FLUSH_ASYNC, 0, 0, 0, 0);
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -0800215 paravirt_end_context_switch(next);
Rusty Russell633872b2007-11-05 21:55:57 +1100216}
Rusty Russell07ad1572007-07-19 01:49:22 -0700217
Rusty Russell61f4bc82009-06-12 22:27:03 -0600218/*G:032
Rusty Russelle1e72962007-10-25 15:02:50 +1000219 * After that diversion we return to our first native-instruction
220 * replacements: four functions for interrupt control.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700221 *
222 * The simplest way of implementing these would be to have "turn interrupts
223 * off" and "turn interrupts on" hypercalls. Unfortunately, this is too slow:
224 * these are by far the most commonly called functions of those we override.
225 *
226 * So instead we keep an "irq_enabled" field inside our "struct lguest_data",
227 * which the Guest can update with a single instruction. The Host knows to
Rusty Russella6bd8e12008-03-28 11:05:53 -0500228 * check there before it tries to deliver an interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700229 */
230
Rusty Russell2e04ef72009-07-30 16:03:45 -0600231/*
232 * save_flags() is expected to return the processor state (ie. "flags"). The
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100233 * flags word contains all kind of stuff, but in practice Linux only cares
Rusty Russell2e04ef72009-07-30 16:03:45 -0600234 * about the interrupt flag. Our "save_flags()" just returns that.
235 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700236static unsigned long save_fl(void)
237{
238 return lguest_data.irq_enabled;
239}
Rusty Russell07ad1572007-07-19 01:49:22 -0700240
Rusty Russellb2b47c22007-07-26 10:41:02 -0700241/* Interrupts go off... */
Rusty Russell07ad1572007-07-19 01:49:22 -0700242static void irq_disable(void)
243{
244 lguest_data.irq_enabled = 0;
245}
Rusty Russell61f4bc82009-06-12 22:27:03 -0600246
Rusty Russell2e04ef72009-07-30 16:03:45 -0600247/*
248 * Let's pause a moment. Remember how I said these are called so often?
Rusty Russell61f4bc82009-06-12 22:27:03 -0600249 * Jeremy Fitzhardinge optimized them so hard early in 2009 that he had to
250 * break some rules. In particular, these functions are assumed to save their
251 * own registers if they need to: normal C functions assume they can trash the
252 * eax register. To use normal C functions, we use
253 * PV_CALLEE_SAVE_REGS_THUNK(), which pushes %eax onto the stack, calls the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600254 * C function, then restores it.
255 */
Rusty Russell61f4bc82009-06-12 22:27:03 -0600256PV_CALLEE_SAVE_REGS_THUNK(save_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -0800257PV_CALLEE_SAVE_REGS_THUNK(irq_disable);
Rusty Russellf56a3842007-07-26 10:41:05 -0700258/*:*/
Rusty Russell61f4bc82009-06-12 22:27:03 -0600259
260/* These are in i386_head.S */
261extern void lg_irq_enable(void);
262extern void lg_restore_fl(unsigned long flags);
263
Rusty Russell2e04ef72009-07-30 16:03:45 -0600264/*M:003
Rusty Russella91d74a2009-07-30 16:03:45 -0600265 * We could be more efficient in our checking of outstanding interrupts, rather
266 * than using a branch. One way would be to put the "irq_enabled" field in a
267 * page by itself, and have the Host write-protect it when an interrupt comes
268 * in when irqs are disabled. There will then be a page fault as soon as
269 * interrupts are re-enabled.
Rusty Russella6bd8e12008-03-28 11:05:53 -0500270 *
271 * A better method is to implement soft interrupt disable generally for x86:
272 * instead of disabling interrupts, we set a flag. If an interrupt does come
273 * in, we then disable them for real. This is uncommon, so we could simply use
Rusty Russell2e04ef72009-07-30 16:03:45 -0600274 * a hypercall for interrupt control and not worry about efficiency.
275:*/
Rusty Russell07ad1572007-07-19 01:49:22 -0700276
Rusty Russellb2b47c22007-07-26 10:41:02 -0700277/*G:034
278 * The Interrupt Descriptor Table (IDT).
279 *
280 * The IDT tells the processor what to do when an interrupt comes in. Each
281 * entry in the table is a 64-bit descriptor: this holds the privilege level,
282 * address of the handler, and... well, who cares? The Guest just asks the
283 * Host to make the change anyway, because the Host controls the real IDT.
284 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100285static void lguest_write_idt_entry(gate_desc *dt,
286 int entrynum, const gate_desc *g)
Rusty Russell07ad1572007-07-19 01:49:22 -0700287{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600288 /*
289 * The gate_desc structure is 8 bytes long: we hand it to the Host in
Rusty Russella6bd8e12008-03-28 11:05:53 -0500290 * two 32-bit chunks. The whole 32-bit kernel used to hand descriptors
291 * around like this; typesafety wasn't a big concern in Linux's early
Rusty Russell2e04ef72009-07-30 16:03:45 -0600292 * years.
293 */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100294 u32 *desc = (u32 *)g;
Rusty Russellb2b47c22007-07-26 10:41:02 -0700295 /* Keep the local copy up to date. */
Glauber de Oliveira Costa8d947342008-01-30 13:31:12 +0100296 native_write_idt_entry(dt, entrynum, g);
Rusty Russellb2b47c22007-07-26 10:41:02 -0700297 /* Tell Host about this new entry. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600298 hcall(LHCALL_LOAD_IDT_ENTRY, entrynum, desc[0], desc[1], 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700299}
300
Rusty Russell2e04ef72009-07-30 16:03:45 -0600301/*
302 * Changing to a different IDT is very rare: we keep the IDT up-to-date every
Rusty Russellb2b47c22007-07-26 10:41:02 -0700303 * time it is written, so we can simply loop through all entries and tell the
Rusty Russell2e04ef72009-07-30 16:03:45 -0600304 * Host about them.
305 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100306static void lguest_load_idt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700307{
308 unsigned int i;
309 struct desc_struct *idt = (void *)desc->address;
310
311 for (i = 0; i < (desc->size+1)/8; i++)
Rusty Russell091ebf02010-04-14 21:43:54 -0600312 hcall(LHCALL_LOAD_IDT_ENTRY, i, idt[i].a, idt[i].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700313}
314
Rusty Russellb2b47c22007-07-26 10:41:02 -0700315/*
316 * The Global Descriptor Table.
317 *
318 * The Intel architecture defines another table, called the Global Descriptor
319 * Table (GDT). You tell the CPU where it is (and its size) using the "lgdt"
320 * instruction, and then several other instructions refer to entries in the
321 * table. There are three entries which the Switcher needs, so the Host simply
322 * controls the entire thing and the Guest asks it to make changes using the
323 * LOAD_GDT hypercall.
324 *
Rusty Russella489f0b2009-04-19 23:14:00 -0600325 * This is the exactly like the IDT code.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700326 */
Glauber de Oliveira Costa6b68f012008-01-30 13:31:12 +0100327static void lguest_load_gdt(const struct desc_ptr *desc)
Rusty Russell07ad1572007-07-19 01:49:22 -0700328{
Rusty Russella489f0b2009-04-19 23:14:00 -0600329 unsigned int i;
330 struct desc_struct *gdt = (void *)desc->address;
331
332 for (i = 0; i < (desc->size+1)/8; i++)
Rusty Russell091ebf02010-04-14 21:43:54 -0600333 hcall(LHCALL_LOAD_GDT_ENTRY, i, gdt[i].a, gdt[i].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700334}
335
Rusty Russell2e04ef72009-07-30 16:03:45 -0600336/*
Rusty Russell9b6efcd2010-09-21 10:54:01 -0600337 * For a single GDT entry which changes, we simply change our copy and
338 * then tell the host about it.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600339 */
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100340static void lguest_write_gdt_entry(struct desc_struct *dt, int entrynum,
341 const void *desc, int type)
Rusty Russell07ad1572007-07-19 01:49:22 -0700342{
Glauber de Oliveira Costa014b15b2008-01-30 13:31:13 +0100343 native_write_gdt_entry(dt, entrynum, desc, type);
Rusty Russella489f0b2009-04-19 23:14:00 -0600344 /* Tell Host about this new entry. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600345 hcall(LHCALL_LOAD_GDT_ENTRY, entrynum,
346 dt[entrynum].a, dt[entrynum].b, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700347}
348
Rusty Russell2e04ef72009-07-30 16:03:45 -0600349/*
Rusty Russell9b6efcd2010-09-21 10:54:01 -0600350 * There are three "thread local storage" GDT entries which change
Rusty Russellb2b47c22007-07-26 10:41:02 -0700351 * on every context switch (these three entries are how glibc implements
Rusty Russell9b6efcd2010-09-21 10:54:01 -0600352 * __thread variables). As an optimization, we have a hypercall
353 * specifically for this case.
354 *
355 * Wouldn't it be nicer to have a general LOAD_GDT_ENTRIES hypercall
356 * which took a range of entries?
Rusty Russell2e04ef72009-07-30 16:03:45 -0600357 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700358static void lguest_load_tls(struct thread_struct *t, unsigned int cpu)
359{
Rusty Russell2e04ef72009-07-30 16:03:45 -0600360 /*
361 * There's one problem which normal hardware doesn't have: the Host
Rusty Russell0d027c02007-08-09 20:57:13 +1000362 * can't handle us removing entries we're currently using. So we clear
Rusty Russell2e04ef72009-07-30 16:03:45 -0600363 * the GS register here: if it's needed it'll be reloaded anyway.
364 */
Tejun Heoccbeed32009-02-09 22:17:40 +0900365 lazy_load_gs(0);
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200366 lazy_hcall2(LHCALL_LOAD_TLS, __pa(&t->tls_array), cpu);
Rusty Russell07ad1572007-07-19 01:49:22 -0700367}
368
Rusty Russell2e04ef72009-07-30 16:03:45 -0600369/*G:038
370 * That's enough excitement for now, back to ploughing through each of the
371 * different pv_ops structures (we're about 1/3 of the way through).
Rusty Russellb2b47c22007-07-26 10:41:02 -0700372 *
373 * This is the Local Descriptor Table, another weird Intel thingy. Linux only
374 * uses this for some strange applications like Wine. We don't do anything
Rusty Russell2e04ef72009-07-30 16:03:45 -0600375 * here, so they'll get an informative and friendly Segmentation Fault.
376 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700377static void lguest_set_ldt(const void *addr, unsigned entries)
378{
379}
380
Rusty Russell2e04ef72009-07-30 16:03:45 -0600381/*
382 * This loads a GDT entry into the "Task Register": that entry points to a
Rusty Russellb2b47c22007-07-26 10:41:02 -0700383 * structure called the Task State Segment. Some comments scattered though the
384 * kernel code indicate that this used for task switching in ages past, along
385 * with blood sacrifice and astrology.
386 *
387 * Now there's nothing interesting in here that we don't get told elsewhere.
388 * But the native version uses the "ltr" instruction, which makes the Host
389 * complain to the Guest about a Segmentation Fault and it'll oops. So we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600390 * override the native version with a do-nothing version.
391 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700392static void lguest_load_tr_desc(void)
393{
394}
395
Rusty Russell2e04ef72009-07-30 16:03:45 -0600396/*
397 * The "cpuid" instruction is a way of querying both the CPU identity
Rusty Russellb2b47c22007-07-26 10:41:02 -0700398 * (manufacturer, model, etc) and its features. It was introduced before the
Rusty Russella6bd8e12008-03-28 11:05:53 -0500399 * Pentium in 1993 and keeps getting extended by both Intel, AMD and others.
400 * As you might imagine, after a decade and a half this treatment, it is now a
401 * giant ball of hair. Its entry in the current Intel manual runs to 28 pages.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700402 *
403 * This instruction even it has its own Wikipedia entry. The Wikipedia entry
Adrian Knoth8d431f42011-07-11 18:08:47 +0200404 * has been translated into 6 languages. I am not making this up!
Rusty Russellb2b47c22007-07-26 10:41:02 -0700405 *
406 * We could get funky here and identify ourselves as "GenuineLguest", but
407 * instead we just use the real "cpuid" instruction. Then I pretty much turned
408 * off feature bits until the Guest booted. (Don't say that: you'll damage
409 * lguest sales!) Shut up, inner voice! (Hey, just pointing out that this is
Lucas De Marchi0d2eb442011-03-17 16:24:16 -0300410 * hardly future proof.) No one's listening! They don't like you anyway,
Rusty Russellb2b47c22007-07-26 10:41:02 -0700411 * parenthetic weirdo!
412 *
413 * Replacing the cpuid so we can turn features off is great for the kernel, but
414 * anyone (including userspace) can just use the raw "cpuid" instruction and
415 * the Host won't even notice since it isn't privileged. So we try not to get
Rusty Russell2e04ef72009-07-30 16:03:45 -0600416 * too worked up about it.
417 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100418static void lguest_cpuid(unsigned int *ax, unsigned int *bx,
419 unsigned int *cx, unsigned int *dx)
Rusty Russell07ad1572007-07-19 01:49:22 -0700420{
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100421 int function = *ax;
Rusty Russell07ad1572007-07-19 01:49:22 -0700422
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100423 native_cpuid(ax, bx, cx, dx);
Rusty Russell07ad1572007-07-19 01:49:22 -0700424 switch (function) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600425 /*
426 * CPUID 0 gives the highest legal CPUID number (and the ID string).
427 * We futureproof our code a little by sticking to known CPUID values.
428 */
429 case 0:
Rusty Russell7a504922009-07-17 21:47:44 -0600430 if (*ax > 5)
431 *ax = 5;
432 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600433
434 /*
435 * CPUID 1 is a basic feature request.
436 *
437 * CX: we only allow kernel to see SSE3, CMPXCHG16B and SSSE3
438 * DX: SSE, SSE2, FXSR, MMX, CMOV, CMPXCHG8B, TSC, FPU and PAE.
439 */
440 case 1:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100441 *cx &= 0x00002201;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600442 *dx &= 0x07808151;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600443 /*
444 * The Host can do a nice optimization if it knows that the
Rusty Russellb2b47c22007-07-26 10:41:02 -0700445 * kernel mappings (addresses above 0xC0000000 or whatever
446 * PAGE_OFFSET is set to) haven't changed. But Linux calls
447 * flush_tlb_user() for both user and kernel mappings unless
Rusty Russell2e04ef72009-07-30 16:03:45 -0600448 * the Page Global Enable (PGE) feature bit is set.
449 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100450 *dx |= 0x00002000;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600451 /*
452 * We also lie, and say we're family id 5. 6 or greater
Rusty Russellcbd88c82009-03-09 10:06:22 -0600453 * leads to a rdmsr in early_init_intel which we can't handle.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600454 * Family ID is returned as bits 8-12 in ax.
455 */
Rusty Russellcbd88c82009-03-09 10:06:22 -0600456 *ax &= 0xFFFFF0FF;
457 *ax |= 0x00000500;
Rusty Russell07ad1572007-07-19 01:49:22 -0700458 break;
Rusty Russell89cfc992011-10-27 10:56:17 +1030459
460 /*
461 * This is used to detect if we're running under KVM. We might be,
462 * but that's a Host matter, not us. So say we're not.
463 */
464 case KVM_CPUID_SIGNATURE:
465 *bx = *cx = *dx = 0;
466 break;
467
Rusty Russell2e04ef72009-07-30 16:03:45 -0600468 /*
469 * 0x80000000 returns the highest Extended Function, so we futureproof
470 * like we do above by limiting it to known fields.
471 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700472 case 0x80000000:
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100473 if (*ax > 0x80000008)
474 *ax = 0x80000008;
Rusty Russell07ad1572007-07-19 01:49:22 -0700475 break;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600476
477 /*
478 * PAE systems can mark pages as non-executable. Linux calls this the
479 * NX bit. Intel calls it XD (eXecute Disable), AMD EVP (Enhanced
Adrian Knoth64be1152011-07-11 18:07:14 +0200480 * Virus Protection). We just switch it off here, since we don't
Rusty Russell2e04ef72009-07-30 16:03:45 -0600481 * support it.
482 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600483 case 0x80000001:
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600484 *dx &= ~(1 << 20);
485 break;
Rusty Russell07ad1572007-07-19 01:49:22 -0700486 }
487}
488
Rusty Russell2e04ef72009-07-30 16:03:45 -0600489/*
490 * Intel has four control registers, imaginatively named cr0, cr2, cr3 and cr4.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700491 * I assume there's a cr1, but it hasn't bothered us yet, so we'll not bother
492 * it. The Host needs to know when the Guest wants to change them, so we have
493 * a whole series of functions like read_cr0() and write_cr0().
494 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000495 * We start with cr0. cr0 allows you to turn on and off all kinds of basic
Rusty Russellb2b47c22007-07-26 10:41:02 -0700496 * features, but Linux only really cares about one: the horrifically-named Task
497 * Switched (TS) bit at bit 3 (ie. 8)
498 *
499 * What does the TS bit do? Well, it causes the CPU to trap (interrupt 7) if
500 * the floating point unit is used. Which allows us to restore FPU state
501 * lazily after a task switch, and Linux uses that gratefully, but wouldn't a
502 * name like "FPUTRAP bit" be a little less cryptic?
503 *
Rusty Russellad5173f2008-10-31 11:24:27 -0500504 * We store cr0 locally because the Host never changes it. The Guest sometimes
Rusty Russell2e04ef72009-07-30 16:03:45 -0600505 * wants to read it and we'd prefer not to bother the Host unnecessarily.
506 */
Rusty Russellad5173f2008-10-31 11:24:27 -0500507static unsigned long current_cr0;
Rusty Russell07ad1572007-07-19 01:49:22 -0700508static void lguest_write_cr0(unsigned long val)
509{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200510 lazy_hcall1(LHCALL_TS, val & X86_CR0_TS);
Rusty Russell07ad1572007-07-19 01:49:22 -0700511 current_cr0 = val;
512}
513
514static unsigned long lguest_read_cr0(void)
515{
516 return current_cr0;
517}
518
Rusty Russell2e04ef72009-07-30 16:03:45 -0600519/*
520 * Intel provided a special instruction to clear the TS bit for people too cool
Rusty Russellb2b47c22007-07-26 10:41:02 -0700521 * to use write_cr0() to do it. This "clts" instruction is faster, because all
Rusty Russell2e04ef72009-07-30 16:03:45 -0600522 * the vowels have been optimized out.
523 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700524static void lguest_clts(void)
525{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200526 lazy_hcall1(LHCALL_TS, 0);
Rusty Russell25c47bb2007-10-25 14:09:53 +1000527 current_cr0 &= ~X86_CR0_TS;
Rusty Russell07ad1572007-07-19 01:49:22 -0700528}
529
Rusty Russell2e04ef72009-07-30 16:03:45 -0600530/*
531 * cr2 is the virtual address of the last page fault, which the Guest only ever
Rusty Russellb2b47c22007-07-26 10:41:02 -0700532 * reads. The Host kindly writes this into our "struct lguest_data", so we
Rusty Russell2e04ef72009-07-30 16:03:45 -0600533 * just read it out of there.
534 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700535static unsigned long lguest_read_cr2(void)
536{
537 return lguest_data.cr2;
538}
539
Rusty Russellad5173f2008-10-31 11:24:27 -0500540/* See lguest_set_pte() below. */
541static bool cr3_changed = false;
Rusty Russell5dea1c82011-07-22 14:39:48 +0930542static unsigned long current_cr3;
Rusty Russellad5173f2008-10-31 11:24:27 -0500543
Rusty Russell2e04ef72009-07-30 16:03:45 -0600544/*
545 * cr3 is the current toplevel pagetable page: the principle is the same as
Rusty Russell5dea1c82011-07-22 14:39:48 +0930546 * cr0. Keep a local copy, and tell the Host when it changes.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600547 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700548static void lguest_write_cr3(unsigned long cr3)
549{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200550 lazy_hcall1(LHCALL_NEW_PGTABLE, cr3);
Rusty Russell5dea1c82011-07-22 14:39:48 +0930551 current_cr3 = cr3;
Rusty Russellbb4093d2010-12-16 17:03:15 -0600552
553 /* These two page tables are simple, linear, and used during boot */
554 if (cr3 != __pa(swapper_pg_dir) && cr3 != __pa(initial_page_table))
555 cr3_changed = true;
Rusty Russell07ad1572007-07-19 01:49:22 -0700556}
557
558static unsigned long lguest_read_cr3(void)
559{
Rusty Russell5dea1c82011-07-22 14:39:48 +0930560 return current_cr3;
Rusty Russell07ad1572007-07-19 01:49:22 -0700561}
562
Rusty Russelle1e72962007-10-25 15:02:50 +1000563/* cr4 is used to enable and disable PGE, but we don't care. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700564static unsigned long lguest_read_cr4(void)
565{
566 return 0;
567}
568
569static void lguest_write_cr4(unsigned long val)
570{
571}
572
Rusty Russellb2b47c22007-07-26 10:41:02 -0700573/*
574 * Page Table Handling.
575 *
576 * Now would be a good time to take a rest and grab a coffee or similarly
577 * relaxing stimulant. The easy parts are behind us, and the trek gradually
578 * winds uphill from here.
579 *
580 * Quick refresher: memory is divided into "pages" of 4096 bytes each. The CPU
581 * maps virtual addresses to physical addresses using "page tables". We could
582 * use one huge index of 1 million entries: each address is 4 bytes, so that's
583 * 1024 pages just to hold the page tables. But since most virtual addresses
Rusty Russelle1e72962007-10-25 15:02:50 +1000584 * are unused, we use a two level index which saves space. The cr3 register
Rusty Russellb2b47c22007-07-26 10:41:02 -0700585 * contains the physical address of the top level "page directory" page, which
586 * contains physical addresses of up to 1024 second-level pages. Each of these
587 * second level pages contains up to 1024 physical addresses of actual pages,
588 * or Page Table Entries (PTEs).
589 *
590 * Here's a diagram, where arrows indicate physical addresses:
591 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000592 * cr3 ---> +---------+
Rusty Russellb2b47c22007-07-26 10:41:02 -0700593 * | --------->+---------+
594 * | | | PADDR1 |
Rusty Russella91d74a2009-07-30 16:03:45 -0600595 * Mid-level | | PADDR2 |
Rusty Russellb2b47c22007-07-26 10:41:02 -0700596 * (PMD) page | | |
597 * | | Lower-level |
598 * | | (PTE) page |
599 * | | | |
600 * .... ....
601 *
602 * So to convert a virtual address to a physical address, we look up the top
603 * level, which points us to the second level, which gives us the physical
604 * address of that page. If the top level entry was not present, or the second
605 * level entry was not present, then the virtual address is invalid (we
606 * say "the page was not mapped").
607 *
608 * Put another way, a 32-bit virtual address is divided up like so:
609 *
610 * 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
611 * |<---- 10 bits ---->|<---- 10 bits ---->|<------ 12 bits ------>|
612 * Index into top Index into second Offset within page
613 * page directory page pagetable page
614 *
Rusty Russella91d74a2009-07-30 16:03:45 -0600615 * Now, unfortunately, this isn't the whole story: Intel added Physical Address
616 * Extension (PAE) to allow 32 bit systems to use 64GB of memory (ie. 36 bits).
617 * These are held in 64-bit page table entries, so we can now only fit 512
618 * entries in a page, and the neat three-level tree breaks down.
619 *
620 * The result is a four level page table:
621 *
622 * cr3 --> [ 4 Upper ]
623 * [ Level ]
624 * [ Entries ]
625 * [(PUD Page)]---> +---------+
626 * | --------->+---------+
627 * | | | PADDR1 |
628 * Mid-level | | PADDR2 |
629 * (PMD) page | | |
630 * | | Lower-level |
631 * | | (PTE) page |
632 * | | | |
633 * .... ....
634 *
635 *
636 * And the virtual address is decoded as:
637 *
638 * 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
639 * |<-2->|<--- 9 bits ---->|<---- 9 bits --->|<------ 12 bits ------>|
640 * Index into Index into mid Index into lower Offset within page
641 * top entries directory page pagetable page
642 *
643 * It's too hard to switch between these two formats at runtime, so Linux only
644 * supports one or the other depending on whether CONFIG_X86_PAE is set. Many
645 * distributions turn it on, and not just for people with silly amounts of
646 * memory: the larger PTE entries allow room for the NX bit, which lets the
647 * kernel disable execution of pages and increase security.
648 *
649 * This was a problem for lguest, which couldn't run on these distributions;
650 * then Matias Zabaljauregui figured it all out and implemented it, and only a
651 * handful of puppies were crushed in the process!
652 *
653 * Back to our point: the kernel spends a lot of time changing both the
654 * top-level page directory and lower-level pagetable pages. The Guest doesn't
655 * know physical addresses, so while it maintains these page tables exactly
656 * like normal, it also needs to keep the Host informed whenever it makes a
657 * change: the Host will create the real page tables based on the Guests'.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700658 */
659
Rusty Russell2e04ef72009-07-30 16:03:45 -0600660/*
Rusty Russella91d74a2009-07-30 16:03:45 -0600661 * The Guest calls this after it has set a second-level entry (pte), ie. to map
Rusty Russell9f542882011-07-22 14:39:50 +0930662 * a page into a process' address space. We tell the Host the toplevel and
Rusty Russella91d74a2009-07-30 16:03:45 -0600663 * address this corresponds to. The Guest uses one pagetable per process, so
664 * we need to tell the Host which one we're changing (mm->pgd).
Rusty Russell2e04ef72009-07-30 16:03:45 -0600665 */
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600666static void lguest_pte_update(struct mm_struct *mm, unsigned long addr,
667 pte_t *ptep)
668{
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600669#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600670 /* PAE needs to hand a 64 bit page table entry, so it uses two args. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600671 lazy_hcall4(LHCALL_SET_PTE, __pa(mm->pgd), addr,
672 ptep->pte_low, ptep->pte_high);
673#else
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200674 lazy_hcall3(LHCALL_SET_PTE, __pa(mm->pgd), addr, ptep->pte_low);
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600675#endif
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600676}
677
Rusty Russella91d74a2009-07-30 16:03:45 -0600678/* This is the "set and update" combo-meal-deal version. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700679static void lguest_set_pte_at(struct mm_struct *mm, unsigned long addr,
680 pte_t *ptep, pte_t pteval)
681{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600682 native_set_pte(ptep, pteval);
Rusty Russellb7ff99e2009-03-30 21:55:23 -0600683 lguest_pte_update(mm, addr, ptep);
Rusty Russell07ad1572007-07-19 01:49:22 -0700684}
685
Rusty Russell2e04ef72009-07-30 16:03:45 -0600686/*
687 * The Guest calls lguest_set_pud to set a top-level entry and lguest_set_pmd
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600688 * to set a middle-level entry when PAE is activated.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600689 *
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600690 * Again, we set the entry then tell the Host which page we changed,
Rusty Russell2e04ef72009-07-30 16:03:45 -0600691 * and the index of the entry we changed.
692 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600693#ifdef CONFIG_X86_PAE
694static void lguest_set_pud(pud_t *pudp, pud_t pudval)
695{
696 native_set_pud(pudp, pudval);
697
698 /* 32 bytes aligned pdpt address and the index. */
699 lazy_hcall2(LHCALL_SET_PGD, __pa(pudp) & 0xFFFFFFE0,
700 (__pa(pudp) & 0x1F) / sizeof(pud_t));
701}
702
703static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
704{
705 native_set_pmd(pmdp, pmdval);
706 lazy_hcall2(LHCALL_SET_PMD, __pa(pmdp) & PAGE_MASK,
707 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
708}
709#else
710
Rusty Russell2e04ef72009-07-30 16:03:45 -0600711/* The Guest calls lguest_set_pmd to set a top-level entry when !PAE. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700712static void lguest_set_pmd(pmd_t *pmdp, pmd_t pmdval)
713{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600714 native_set_pmd(pmdp, pmdval);
Matias Zabaljaureguiebe0ba82009-05-30 15:48:08 -0300715 lazy_hcall2(LHCALL_SET_PGD, __pa(pmdp) & PAGE_MASK,
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600716 (__pa(pmdp) & (PAGE_SIZE - 1)) / sizeof(pmd_t));
Rusty Russell07ad1572007-07-19 01:49:22 -0700717}
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600718#endif
Rusty Russell07ad1572007-07-19 01:49:22 -0700719
Rusty Russell2e04ef72009-07-30 16:03:45 -0600720/*
721 * There are a couple of legacy places where the kernel sets a PTE, but we
Rusty Russellb2b47c22007-07-26 10:41:02 -0700722 * don't know the top level any more. This is useless for us, since we don't
723 * know which pagetable is changing or what address, so we just tell the Host
724 * to forget all of them. Fortunately, this is very rare.
725 *
726 * ... except in early boot when the kernel sets up the initial pagetables,
Rusty Russellbb4093d2010-12-16 17:03:15 -0600727 * which makes booting astonishingly slow: 48 seconds! So we don't even tell
728 * the Host anything changed until we've done the first real page table switch,
729 * which brings boot back to 4.3 seconds.
Rusty Russell2e04ef72009-07-30 16:03:45 -0600730 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700731static void lguest_set_pte(pte_t *ptep, pte_t pteval)
732{
Matias Zabaljauregui90603d12009-06-12 22:27:06 -0600733 native_set_pte(ptep, pteval);
Rusty Russellad5173f2008-10-31 11:24:27 -0500734 if (cr3_changed)
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200735 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700736}
737
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600738#ifdef CONFIG_X86_PAE
Rusty Russella91d74a2009-07-30 16:03:45 -0600739/*
740 * With 64-bit PTE values, we need to be careful setting them: if we set 32
741 * bits at a time, the hardware could see a weird half-set entry. These
742 * versions ensure we update all 64 bits at once.
743 */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600744static void lguest_set_pte_atomic(pte_t *ptep, pte_t pte)
745{
746 native_set_pte_atomic(ptep, pte);
747 if (cr3_changed)
748 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
749}
750
Rusty Russella91d74a2009-07-30 16:03:45 -0600751static void lguest_pte_clear(struct mm_struct *mm, unsigned long addr,
752 pte_t *ptep)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600753{
754 native_pte_clear(mm, addr, ptep);
755 lguest_pte_update(mm, addr, ptep);
756}
757
Rusty Russella91d74a2009-07-30 16:03:45 -0600758static void lguest_pmd_clear(pmd_t *pmdp)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600759{
760 lguest_set_pmd(pmdp, __pmd(0));
761}
762#endif
763
Rusty Russell2e04ef72009-07-30 16:03:45 -0600764/*
765 * Unfortunately for Lguest, the pv_mmu_ops for page tables were based on
Rusty Russellb2b47c22007-07-26 10:41:02 -0700766 * native page table operations. On native hardware you can set a new page
767 * table entry whenever you want, but if you want to remove one you have to do
768 * a TLB flush (a TLB is a little cache of page table entries kept by the CPU).
769 *
770 * So the lguest_set_pte_at() and lguest_set_pmd() functions above are only
771 * called when a valid entry is written, not when it's removed (ie. marked not
772 * present). Instead, this is where we come when the Guest wants to remove a
773 * page table entry: we tell the Host to set that entry to 0 (ie. the present
Rusty Russell2e04ef72009-07-30 16:03:45 -0600774 * bit is zero).
775 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700776static void lguest_flush_tlb_single(unsigned long addr)
777{
Rusty Russellb2b47c22007-07-26 10:41:02 -0700778 /* Simply set it to zero: if it was not, it will fault back in. */
Rusty Russell5dea1c82011-07-22 14:39:48 +0930779 lazy_hcall3(LHCALL_SET_PTE, current_cr3, addr, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700780}
781
Rusty Russell2e04ef72009-07-30 16:03:45 -0600782/*
783 * This is what happens after the Guest has removed a large number of entries.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700784 * This tells the Host that any of the page table entries for userspace might
Rusty Russell2e04ef72009-07-30 16:03:45 -0600785 * have changed, ie. virtual addresses below PAGE_OFFSET.
786 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700787static void lguest_flush_tlb_user(void)
788{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200789 lazy_hcall1(LHCALL_FLUSH_TLB, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -0700790}
791
Rusty Russell2e04ef72009-07-30 16:03:45 -0600792/*
793 * This is called when the kernel page tables have changed. That's not very
Rusty Russellb2b47c22007-07-26 10:41:02 -0700794 * common (unless the Guest is using highmem, which makes the Guest extremely
Rusty Russell2e04ef72009-07-30 16:03:45 -0600795 * slow), so it's worth separating this from the user flushing above.
796 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700797static void lguest_flush_tlb_kernel(void)
798{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -0200799 lazy_hcall1(LHCALL_FLUSH_TLB, 1);
Rusty Russell07ad1572007-07-19 01:49:22 -0700800}
801
Rusty Russellb2b47c22007-07-26 10:41:02 -0700802/*
803 * The Unadvanced Programmable Interrupt Controller.
804 *
805 * This is an attempt to implement the simplest possible interrupt controller.
806 * I spent some time looking though routines like set_irq_chip_and_handler,
807 * set_irq_chip_and_handler_name, set_irq_chip_data and set_phasers_to_stun and
808 * I *think* this is as simple as it gets.
809 *
810 * We can tell the Host what interrupts we want blocked ready for using the
811 * lguest_data.interrupts bitmap, so disabling (aka "masking") them is as
812 * simple as setting a bit. We don't actually "ack" interrupts as such, we
813 * just mask and unmask them. I wonder if we should be cleverer?
814 */
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200815static void disable_lguest_irq(struct irq_data *data)
Rusty Russell07ad1572007-07-19 01:49:22 -0700816{
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200817 set_bit(data->irq, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -0700818}
819
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200820static void enable_lguest_irq(struct irq_data *data)
Rusty Russell07ad1572007-07-19 01:49:22 -0700821{
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200822 clear_bit(data->irq, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -0700823}
824
Rusty Russellb2b47c22007-07-26 10:41:02 -0700825/* This structure describes the lguest IRQ controller. */
Rusty Russell07ad1572007-07-19 01:49:22 -0700826static struct irq_chip lguest_irq_controller = {
827 .name = "lguest",
Thomas Gleixnerfe25c7f2010-09-28 14:57:24 +0200828 .irq_mask = disable_lguest_irq,
829 .irq_mask_ack = disable_lguest_irq,
830 .irq_unmask = enable_lguest_irq,
Rusty Russell07ad1572007-07-19 01:49:22 -0700831};
832
Rusty Russell2e04ef72009-07-30 16:03:45 -0600833/*
834 * This sets up the Interrupt Descriptor Table (IDT) entry for each hardware
Rusty Russellb2b47c22007-07-26 10:41:02 -0700835 * interrupt (except 128, which is used for system calls), and then tells the
836 * Linux infrastructure that each interrupt is controlled by our level-based
Rusty Russell2e04ef72009-07-30 16:03:45 -0600837 * lguest interrupt controller.
838 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700839static void __init lguest_init_IRQ(void)
840{
841 unsigned int i;
842
Rusty Russell10283752009-06-12 22:26:59 -0600843 for (i = FIRST_EXTERNAL_VECTOR; i < NR_VECTORS; i++) {
Rusty Russell2e04ef72009-07-30 16:03:45 -0600844 /* Some systems map "vectors" to interrupts weirdly. Not us! */
Rusty Russellced05dd2011-01-20 21:37:29 -0600845 __this_cpu_write(vector_irq[i], i - FIRST_EXTERNAL_VECTOR);
Rusty Russell10283752009-06-12 22:26:59 -0600846 if (i != SYSCALL_VECTOR)
847 set_intr_gate(i, interrupt[i - FIRST_EXTERNAL_VECTOR]);
Rusty Russell07ad1572007-07-19 01:49:22 -0700848 }
Rusty Russell2e04ef72009-07-30 16:03:45 -0600849
850 /*
851 * This call is required to set up for 4k stacks, where we have
852 * separate stacks for hard and soft interrupts.
853 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700854 irq_ctx_init(smp_processor_id());
855}
856
Rusty Russella91d74a2009-07-30 16:03:45 -0600857/*
858 * With CONFIG_SPARSE_IRQ, interrupt descriptors are allocated as-needed, so
859 * rather than set them in lguest_init_IRQ we are called here every time an
860 * lguest device needs an interrupt.
861 *
Thomas Gleixnerc2f31c32010-09-30 12:19:03 +0200862 * FIXME: irq_alloc_desc_at() can fail due to lack of memory, we should
Rusty Russella91d74a2009-07-30 16:03:45 -0600863 * pass that up!
864 */
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600865void lguest_setup_irq(unsigned int irq)
866{
Thomas Gleixnerc2f31c32010-09-30 12:19:03 +0200867 irq_alloc_desc_at(irq, 0);
Thomas Gleixner2c778652011-03-12 12:20:43 +0100868 irq_set_chip_and_handler_name(irq, &lguest_irq_controller,
Rusty Russell6db6a5f2009-03-09 10:06:28 -0600869 handle_level_irq, "level");
870}
871
Rusty Russellb2b47c22007-07-26 10:41:02 -0700872/*
873 * Time.
874 *
875 * It would be far better for everyone if the Guest had its own clock, but
Rusty Russell6c8dca52007-07-27 13:42:52 +1000876 * until then the Host gives us the time on every interrupt.
Rusty Russellb2b47c22007-07-26 10:41:02 -0700877 */
Rusty Russell07ad1572007-07-19 01:49:22 -0700878static unsigned long lguest_get_wallclock(void)
879{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000880 return lguest_data.time.tv_sec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700881}
882
Rusty Russell2e04ef72009-07-30 16:03:45 -0600883/*
884 * The TSC is an Intel thing called the Time Stamp Counter. The Host tells us
Rusty Russella6bd8e12008-03-28 11:05:53 -0500885 * what speed it runs at, or 0 if it's unusable as a reliable clock source.
886 * This matches what we want here: if we return 0 from this function, the x86
Rusty Russell2e04ef72009-07-30 16:03:45 -0600887 * TSC clock will give up and not register itself.
888 */
Alok Katariae93ef942008-07-01 11:43:36 -0700889static unsigned long lguest_tsc_khz(void)
Rusty Russell3fabc552008-03-11 09:35:56 -0500890{
891 return lguest_data.tsc_khz;
892}
893
Rusty Russell2e04ef72009-07-30 16:03:45 -0600894/*
895 * If we can't use the TSC, the kernel falls back to our lower-priority
896 * "lguest_clock", where we read the time value given to us by the Host.
897 */
Magnus Damm8e196082009-04-21 12:24:00 -0700898static cycle_t lguest_clock_read(struct clocksource *cs)
Rusty Russell07ad1572007-07-19 01:49:22 -0700899{
Rusty Russell6c8dca52007-07-27 13:42:52 +1000900 unsigned long sec, nsec;
901
Rusty Russell2e04ef72009-07-30 16:03:45 -0600902 /*
903 * Since the time is in two parts (seconds and nanoseconds), we risk
Rusty Russell3fabc552008-03-11 09:35:56 -0500904 * reading it just as it's changing from 99 & 0.999999999 to 100 and 0,
905 * and getting 99 and 0. As Linux tends to come apart under the stress
Rusty Russell2e04ef72009-07-30 16:03:45 -0600906 * of time travel, we must be careful:
907 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000908 do {
909 /* First we read the seconds part. */
910 sec = lguest_data.time.tv_sec;
Rusty Russell2e04ef72009-07-30 16:03:45 -0600911 /*
912 * This read memory barrier tells the compiler and the CPU that
Rusty Russell6c8dca52007-07-27 13:42:52 +1000913 * this can't be reordered: we have to complete the above
Rusty Russell2e04ef72009-07-30 16:03:45 -0600914 * before going on.
915 */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000916 rmb();
917 /* Now we read the nanoseconds part. */
918 nsec = lguest_data.time.tv_nsec;
919 /* Make sure we've done that. */
920 rmb();
921 /* Now if the seconds part has changed, try again. */
922 } while (unlikely(lguest_data.time.tv_sec != sec));
923
Rusty Russell3fabc552008-03-11 09:35:56 -0500924 /* Our lguest clock is in real nanoseconds. */
Rusty Russell6c8dca52007-07-27 13:42:52 +1000925 return sec*1000000000ULL + nsec;
Rusty Russell07ad1572007-07-19 01:49:22 -0700926}
927
Rusty Russell3fabc552008-03-11 09:35:56 -0500928/* This is the fallback clocksource: lower priority than the TSC clocksource. */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700929static struct clocksource lguest_clock = {
930 .name = "lguest",
Rusty Russell3fabc552008-03-11 09:35:56 -0500931 .rating = 200,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700932 .read = lguest_clock_read,
Rusty Russell6c8dca52007-07-27 13:42:52 +1000933 .mask = CLOCKSOURCE_MASK(64),
Tony Breeds05aa0262007-10-22 10:56:25 +1000934 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700935};
936
Rusty Russell2e04ef72009-07-30 16:03:45 -0600937/*
938 * We also need a "struct clock_event_device": Linux asks us to set it to go
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700939 * off some time in the future. Actually, James Morris figured all this out, I
Rusty Russell2e04ef72009-07-30 16:03:45 -0600940 * just applied the patch.
941 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700942static int lguest_clockevent_set_next_event(unsigned long delta,
943 struct clock_event_device *evt)
944{
Rusty Russella6bd8e12008-03-28 11:05:53 -0500945 /* FIXME: I don't think this can ever happen, but James tells me he had
946 * to put this code in. Maybe we should remove it now. Anyone? */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700947 if (delta < LG_CLOCK_MIN_DELTA) {
948 if (printk_ratelimit())
949 printk(KERN_DEBUG "%s: small delta %lu ns\n",
Harvey Harrison77bf90e2008-03-03 11:37:23 -0800950 __func__, delta);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700951 return -ETIME;
952 }
Rusty Russella6bd8e12008-03-28 11:05:53 -0500953
954 /* Please wake us this far in the future. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600955 hcall(LHCALL_SET_CLOCKEVENT, delta, 0, 0, 0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700956 return 0;
957}
958
959static void lguest_clockevent_set_mode(enum clock_event_mode mode,
960 struct clock_event_device *evt)
961{
962 switch (mode) {
963 case CLOCK_EVT_MODE_UNUSED:
964 case CLOCK_EVT_MODE_SHUTDOWN:
965 /* A 0 argument shuts the clock down. */
Rusty Russell091ebf02010-04-14 21:43:54 -0600966 hcall(LHCALL_SET_CLOCKEVENT, 0, 0, 0, 0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700967 break;
968 case CLOCK_EVT_MODE_ONESHOT:
969 /* This is what we expect. */
970 break;
971 case CLOCK_EVT_MODE_PERIODIC:
972 BUG();
Thomas Gleixner18de5bc2007-07-21 04:37:34 -0700973 case CLOCK_EVT_MODE_RESUME:
974 break;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700975 }
976}
977
978/* This describes our primitive timer chip. */
979static struct clock_event_device lguest_clockevent = {
980 .name = "lguest",
981 .features = CLOCK_EVT_FEAT_ONESHOT,
982 .set_next_event = lguest_clockevent_set_next_event,
983 .set_mode = lguest_clockevent_set_mode,
984 .rating = INT_MAX,
985 .mult = 1,
986 .shift = 0,
987 .min_delta_ns = LG_CLOCK_MIN_DELTA,
988 .max_delta_ns = LG_CLOCK_MAX_DELTA,
989};
990
Rusty Russell2e04ef72009-07-30 16:03:45 -0600991/*
992 * This is the Guest timer interrupt handler (hardware interrupt 0). We just
993 * call the clockevent infrastructure and it does whatever needs doing.
994 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700995static void lguest_time_irq(unsigned int irq, struct irq_desc *desc)
996{
997 unsigned long flags;
998
999 /* Don't interrupt us while this is running. */
1000 local_irq_save(flags);
1001 lguest_clockevent.event_handler(&lguest_clockevent);
1002 local_irq_restore(flags);
1003}
1004
Rusty Russell2e04ef72009-07-30 16:03:45 -06001005/*
1006 * At some point in the boot process, we get asked to set up our timing
Rusty Russellb2b47c22007-07-26 10:41:02 -07001007 * infrastructure. The kernel doesn't expect timer interrupts before this, but
1008 * we cleverly initialized the "blocked_interrupts" field of "struct
Rusty Russell2e04ef72009-07-30 16:03:45 -06001009 * lguest_data" so that timer interrupts were blocked until now.
1010 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001011static void lguest_time_init(void)
1012{
Rusty Russellb2b47c22007-07-26 10:41:02 -07001013 /* Set up the timer interrupt (0) to go to our simple timer routine */
Rusty Russell15517f72011-05-30 11:14:08 -06001014 lguest_setup_irq(0);
Thomas Gleixner2c778652011-03-12 12:20:43 +01001015 irq_set_handler(0, lguest_time_irq);
Rusty Russell07ad1572007-07-19 01:49:22 -07001016
John Stultzb01cc1b2010-04-26 19:03:05 -07001017 clocksource_register_hz(&lguest_clock, NSEC_PER_SEC);
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001018
Rusty Russellb2b47c22007-07-26 10:41:02 -07001019 /* We can't set cpumask in the initializer: damn C limitations! Set it
1020 * here and register our timer device. */
Rusty Russell320ab2b2008-12-13 21:20:26 +10301021 lguest_clockevent.cpumask = cpumask_of(0);
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001022 clockevents_register_device(&lguest_clockevent);
1023
Rusty Russellb2b47c22007-07-26 10:41:02 -07001024 /* Finally, we unblock the timer interrupt. */
Rusty Russellbb6f1d92010-12-16 17:03:13 -06001025 clear_bit(0, lguest_data.blocked_interrupts);
Rusty Russell07ad1572007-07-19 01:49:22 -07001026}
1027
Rusty Russellb2b47c22007-07-26 10:41:02 -07001028/*
1029 * Miscellaneous bits and pieces.
1030 *
1031 * Here is an oddball collection of functions which the Guest needs for things
1032 * to work. They're pretty simple.
1033 */
1034
Rusty Russell2e04ef72009-07-30 16:03:45 -06001035/*
1036 * The Guest needs to tell the Host what stack it expects traps to use. For
Rusty Russellb2b47c22007-07-26 10:41:02 -07001037 * native hardware, this is part of the Task State Segment mentioned above in
1038 * lguest_load_tr_desc(), but to help hypervisors there's this special call.
1039 *
1040 * We tell the Host the segment we want to use (__KERNEL_DS is the kernel data
1041 * segment), the privilege level (we're privilege level 1, the Host is 0 and
1042 * will not tolerate us trying to use that), the stack pointer, and the number
Rusty Russell2e04ef72009-07-30 16:03:45 -06001043 * of pages in the stack.
1044 */
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001045static void lguest_load_sp0(struct tss_struct *tss,
Rusty Russella6bd8e12008-03-28 11:05:53 -05001046 struct thread_struct *thread)
Rusty Russell07ad1572007-07-19 01:49:22 -07001047{
Matias Zabaljauregui4cd8b5e2009-03-14 13:37:52 -02001048 lazy_hcall3(LHCALL_SET_STACK, __KERNEL_DS | 0x1, thread->sp0,
1049 THREAD_SIZE / PAGE_SIZE);
Rusty Russell07ad1572007-07-19 01:49:22 -07001050}
1051
Rusty Russellb2b47c22007-07-26 10:41:02 -07001052/* Let's just say, I wouldn't do debugging under a Guest. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001053static void lguest_set_debugreg(int regno, unsigned long value)
1054{
1055 /* FIXME: Implement */
1056}
1057
Rusty Russell2e04ef72009-07-30 16:03:45 -06001058/*
1059 * There are times when the kernel wants to make sure that no memory writes are
Rusty Russellb2b47c22007-07-26 10:41:02 -07001060 * caught in the cache (that they've all reached real hardware devices). This
1061 * doesn't matter for the Guest which has virtual hardware.
1062 *
1063 * On the Pentium 4 and above, cpuid() indicates that the Cache Line Flush
1064 * (clflush) instruction is available and the kernel uses that. Otherwise, it
1065 * uses the older "Write Back and Invalidate Cache" (wbinvd) instruction.
1066 * Unlike clflush, wbinvd can only be run at privilege level 0. So we can
1067 * ignore clflush, but replace wbinvd.
1068 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001069static void lguest_wbinvd(void)
1070{
1071}
1072
Rusty Russell2e04ef72009-07-30 16:03:45 -06001073/*
1074 * If the Guest expects to have an Advanced Programmable Interrupt Controller,
Rusty Russellb2b47c22007-07-26 10:41:02 -07001075 * we play dumb by ignoring writes and returning 0 for reads. So it's no
1076 * longer Programmable nor Controlling anything, and I don't think 8 lines of
1077 * code qualifies for Advanced. It will also never interrupt anything. It
Rusty Russell2e04ef72009-07-30 16:03:45 -06001078 * does, however, allow us to get through the Linux boot code.
1079 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001080#ifdef CONFIG_X86_LOCAL_APIC
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001081static void lguest_apic_write(u32 reg, u32 v)
Rusty Russell07ad1572007-07-19 01:49:22 -07001082{
1083}
1084
Suresh Siddhaad66dd32008-07-11 13:11:56 -07001085static u32 lguest_apic_read(u32 reg)
Rusty Russell07ad1572007-07-19 01:49:22 -07001086{
1087 return 0;
1088}
Suresh Siddha511d9d32008-07-14 09:49:14 -07001089
1090static u64 lguest_apic_icr_read(void)
1091{
1092 return 0;
1093}
1094
1095static void lguest_apic_icr_write(u32 low, u32 id)
1096{
1097 /* Warn to see if there's any stray references */
1098 WARN_ON(1);
1099}
1100
1101static void lguest_apic_wait_icr_idle(void)
1102{
1103 return;
1104}
1105
1106static u32 lguest_apic_safe_wait_icr_idle(void)
1107{
1108 return 0;
1109}
1110
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001111static void set_lguest_basic_apic_ops(void)
1112{
1113 apic->read = lguest_apic_read;
1114 apic->write = lguest_apic_write;
1115 apic->icr_read = lguest_apic_icr_read;
1116 apic->icr_write = lguest_apic_icr_write;
1117 apic->wait_icr_idle = lguest_apic_wait_icr_idle;
1118 apic->safe_wait_icr_idle = lguest_apic_safe_wait_icr_idle;
Suresh Siddha511d9d32008-07-14 09:49:14 -07001119};
Rusty Russell07ad1572007-07-19 01:49:22 -07001120#endif
1121
Rusty Russellb2b47c22007-07-26 10:41:02 -07001122/* STOP! Until an interrupt comes in. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001123static void lguest_safe_halt(void)
1124{
Rusty Russell091ebf02010-04-14 21:43:54 -06001125 hcall(LHCALL_HALT, 0, 0, 0, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001126}
1127
Rusty Russell2e04ef72009-07-30 16:03:45 -06001128/*
1129 * The SHUTDOWN hypercall takes a string to describe what's happening, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001130 * an argument which says whether this to restart (reboot) the Guest or not.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001131 *
1132 * Note that the Host always prefers that the Guest speak in physical addresses
Rusty Russell2e04ef72009-07-30 16:03:45 -06001133 * rather than virtual addresses, so we use __pa() here.
1134 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001135static void lguest_power_off(void)
1136{
Rusty Russell091ebf02010-04-14 21:43:54 -06001137 hcall(LHCALL_SHUTDOWN, __pa("Power down"),
1138 LGUEST_SHUTDOWN_POWEROFF, 0, 0);
Rusty Russell07ad1572007-07-19 01:49:22 -07001139}
1140
Rusty Russellb2b47c22007-07-26 10:41:02 -07001141/*
1142 * Panicing.
1143 *
1144 * Don't. But if you did, this is what happens.
1145 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001146static int lguest_panic(struct notifier_block *nb, unsigned long l, void *p)
1147{
Rusty Russell091ebf02010-04-14 21:43:54 -06001148 hcall(LHCALL_SHUTDOWN, __pa(p), LGUEST_SHUTDOWN_POWEROFF, 0, 0);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001149 /* The hcall won't return, but to keep gcc happy, we're "done". */
Rusty Russell07ad1572007-07-19 01:49:22 -07001150 return NOTIFY_DONE;
1151}
1152
1153static struct notifier_block paniced = {
1154 .notifier_call = lguest_panic
1155};
1156
Rusty Russellb2b47c22007-07-26 10:41:02 -07001157/* Setting up memory is fairly easy. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001158static __init char *lguest_memory_setup(void)
1159{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001160 /*
Rusty Russell9f542882011-07-22 14:39:50 +09301161 * The Linux bootloader header contains an "e820" memory map: the
Rusty Russell2e04ef72009-07-30 16:03:45 -06001162 * Launcher populated the first entry with our memory limit.
1163 */
Yinghai Lud0be6bd2008-06-15 18:58:51 -07001164 e820_add_region(boot_params.e820_map[0].addr,
H. Peter Anvin30c82642007-10-15 17:13:22 -07001165 boot_params.e820_map[0].size,
1166 boot_params.e820_map[0].type);
Rusty Russellb2b47c22007-07-26 10:41:02 -07001167
1168 /* This string is for the boot messages. */
Rusty Russell07ad1572007-07-19 01:49:22 -07001169 return "LGUEST";
1170}
1171
Rusty Russell2e04ef72009-07-30 16:03:45 -06001172/*
1173 * We will eventually use the virtio console device to produce console output,
Rusty Russelle1e72962007-10-25 15:02:50 +10001174 * but before that is set up we use LHCALL_NOTIFY on normal memory to produce
Rusty Russell2e04ef72009-07-30 16:03:45 -06001175 * console output.
1176 */
Rusty Russell19f15372007-10-22 11:24:21 +10001177static __init int early_put_chars(u32 vtermno, const char *buf, int count)
1178{
1179 char scratch[17];
1180 unsigned int len = count;
1181
Rusty Russell2e04ef72009-07-30 16:03:45 -06001182 /* We use a nul-terminated string, so we make a copy. Icky, huh? */
Rusty Russell19f15372007-10-22 11:24:21 +10001183 if (len > sizeof(scratch) - 1)
1184 len = sizeof(scratch) - 1;
1185 scratch[len] = '\0';
1186 memcpy(scratch, buf, len);
Rusty Russell091ebf02010-04-14 21:43:54 -06001187 hcall(LHCALL_NOTIFY, __pa(scratch), 0, 0, 0);
Rusty Russell19f15372007-10-22 11:24:21 +10001188
1189 /* This routine returns the number of bytes actually written. */
1190 return len;
1191}
1192
Rusty Russell2e04ef72009-07-30 16:03:45 -06001193/*
1194 * Rebooting also tells the Host we're finished, but the RESTART flag tells the
1195 * Launcher to reboot us.
1196 */
Rusty Russella6bd8e12008-03-28 11:05:53 -05001197static void lguest_restart(char *reason)
1198{
Rusty Russell091ebf02010-04-14 21:43:54 -06001199 hcall(LHCALL_SHUTDOWN, __pa(reason), LGUEST_SHUTDOWN_RESTART, 0, 0);
Rusty Russella6bd8e12008-03-28 11:05:53 -05001200}
1201
Rusty Russellb2b47c22007-07-26 10:41:02 -07001202/*G:050
1203 * Patching (Powerfully Placating Performance Pedants)
1204 *
Rusty Russella6bd8e12008-03-28 11:05:53 -05001205 * We have already seen that pv_ops structures let us replace simple native
1206 * instructions with calls to the appropriate back end all throughout the
1207 * kernel. This allows the same kernel to run as a Guest and as a native
Rusty Russellb2b47c22007-07-26 10:41:02 -07001208 * kernel, but it's slow because of all the indirect branches.
1209 *
1210 * Remember that David Wheeler quote about "Any problem in computer science can
1211 * be solved with another layer of indirection"? The rest of that quote is
1212 * "... But that usually will create another problem." This is the first of
1213 * those problems.
1214 *
1215 * Our current solution is to allow the paravirt back end to optionally patch
1216 * over the indirect calls to replace them with something more efficient. We
Rusty Russella32a8812009-06-12 22:27:02 -06001217 * patch two of the simplest of the most commonly called functions: disable
1218 * interrupts and save interrupts. We usually have 6 or 10 bytes to patch
1219 * into: the Guest versions of these operations are small enough that we can
1220 * fit comfortably.
Rusty Russellb2b47c22007-07-26 10:41:02 -07001221 *
1222 * First we need assembly templates of each of the patchable Guest operations,
Rusty Russell2e04ef72009-07-30 16:03:45 -06001223 * and these are in i386_head.S.
1224 */
Rusty Russellb2b47c22007-07-26 10:41:02 -07001225
1226/*G:060 We construct a table from the assembler templates: */
Rusty Russell07ad1572007-07-19 01:49:22 -07001227static const struct lguest_insns
1228{
1229 const char *start, *end;
1230} lguest_insns[] = {
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001231 [PARAVIRT_PATCH(pv_irq_ops.irq_disable)] = { lgstart_cli, lgend_cli },
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001232 [PARAVIRT_PATCH(pv_irq_ops.save_fl)] = { lgstart_pushf, lgend_pushf },
Rusty Russell07ad1572007-07-19 01:49:22 -07001233};
Rusty Russellb2b47c22007-07-26 10:41:02 -07001234
Rusty Russell2e04ef72009-07-30 16:03:45 -06001235/*
1236 * Now our patch routine is fairly simple (based on the native one in
Rusty Russellb2b47c22007-07-26 10:41:02 -07001237 * paravirt.c). If we have a replacement, we copy it in and return how much of
Rusty Russell2e04ef72009-07-30 16:03:45 -06001238 * the available space we used.
1239 */
Andi Kleenab144f52007-08-10 22:31:03 +02001240static unsigned lguest_patch(u8 type, u16 clobber, void *ibuf,
1241 unsigned long addr, unsigned len)
Rusty Russell07ad1572007-07-19 01:49:22 -07001242{
1243 unsigned int insn_len;
1244
Rusty Russellb2b47c22007-07-26 10:41:02 -07001245 /* Don't do anything special if we don't have a replacement */
Rusty Russell07ad1572007-07-19 01:49:22 -07001246 if (type >= ARRAY_SIZE(lguest_insns) || !lguest_insns[type].start)
Andi Kleenab144f52007-08-10 22:31:03 +02001247 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001248
1249 insn_len = lguest_insns[type].end - lguest_insns[type].start;
1250
Rusty Russell2e04ef72009-07-30 16:03:45 -06001251 /* Similarly if it can't fit (doesn't happen, but let's be thorough). */
Rusty Russell07ad1572007-07-19 01:49:22 -07001252 if (len < insn_len)
Andi Kleenab144f52007-08-10 22:31:03 +02001253 return paravirt_patch_default(type, clobber, ibuf, addr, len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001254
Rusty Russellb2b47c22007-07-26 10:41:02 -07001255 /* Copy in our instructions. */
Andi Kleenab144f52007-08-10 22:31:03 +02001256 memcpy(ibuf, lguest_insns[type].start, insn_len);
Rusty Russell07ad1572007-07-19 01:49:22 -07001257 return insn_len;
1258}
1259
Rusty Russell2e04ef72009-07-30 16:03:45 -06001260/*G:029
1261 * Once we get to lguest_init(), we know we're a Guest. The various
Rusty Russella6bd8e12008-03-28 11:05:53 -05001262 * pv_ops structures in the kernel provide points for (almost) every routine we
Rusty Russell2e04ef72009-07-30 16:03:45 -06001263 * have to override to avoid privileged instructions.
1264 */
Rusty Russell814a0e52007-10-22 11:29:44 +10001265__init void lguest_init(void)
Rusty Russell07ad1572007-07-19 01:49:22 -07001266{
Rusty Russell2e04ef72009-07-30 16:03:45 -06001267 /* We're under lguest. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001268 pv_info.name = "lguest";
Rusty Russell2e04ef72009-07-30 16:03:45 -06001269 /* Paravirt is enabled. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001270 pv_info.paravirt_enabled = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001271 /* We're running at privilege level 1, not 0 as normal. */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001272 pv_info.kernel_rpl = 1;
Rusty Russell2e04ef72009-07-30 16:03:45 -06001273 /* Everyone except Xen runs with this set. */
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001274 pv_info.shared_kernel_pmd = 1;
Rusty Russell07ad1572007-07-19 01:49:22 -07001275
Rusty Russell2e04ef72009-07-30 16:03:45 -06001276 /*
1277 * We set up all the lguest overrides for sensitive operations. These
1278 * are detailed with the operations themselves.
1279 */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001280
Rusty Russell2e04ef72009-07-30 16:03:45 -06001281 /* Interrupt-related operations */
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001282 pv_irq_ops.save_fl = PV_CALLEE_SAVE(save_fl);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001283 pv_irq_ops.restore_fl = __PV_IS_CALLEE_SAVE(lg_restore_fl);
Jeremy Fitzhardingeecb93d12009-01-28 14:35:05 -08001284 pv_irq_ops.irq_disable = PV_CALLEE_SAVE(irq_disable);
Rusty Russell61f4bc82009-06-12 22:27:03 -06001285 pv_irq_ops.irq_enable = __PV_IS_CALLEE_SAVE(lg_irq_enable);
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001286 pv_irq_ops.safe_halt = lguest_safe_halt;
1287
Rusty Russell2e04ef72009-07-30 16:03:45 -06001288 /* Setup operations */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001289 pv_init_ops.patch = lguest_patch;
1290
Rusty Russell2e04ef72009-07-30 16:03:45 -06001291 /* Intercepts of various CPU instructions */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001292 pv_cpu_ops.load_gdt = lguest_load_gdt;
1293 pv_cpu_ops.cpuid = lguest_cpuid;
1294 pv_cpu_ops.load_idt = lguest_load_idt;
1295 pv_cpu_ops.iret = lguest_iret;
H. Peter Anvinfaca6222008-01-30 13:31:02 +01001296 pv_cpu_ops.load_sp0 = lguest_load_sp0;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001297 pv_cpu_ops.load_tr_desc = lguest_load_tr_desc;
1298 pv_cpu_ops.set_ldt = lguest_set_ldt;
1299 pv_cpu_ops.load_tls = lguest_load_tls;
1300 pv_cpu_ops.set_debugreg = lguest_set_debugreg;
1301 pv_cpu_ops.clts = lguest_clts;
1302 pv_cpu_ops.read_cr0 = lguest_read_cr0;
1303 pv_cpu_ops.write_cr0 = lguest_write_cr0;
1304 pv_cpu_ops.read_cr4 = lguest_read_cr4;
1305 pv_cpu_ops.write_cr4 = lguest_write_cr4;
1306 pv_cpu_ops.write_gdt_entry = lguest_write_gdt_entry;
1307 pv_cpu_ops.write_idt_entry = lguest_write_idt_entry;
1308 pv_cpu_ops.wbinvd = lguest_wbinvd;
Jeremy Fitzhardinge224101e2009-02-18 11:18:57 -08001309 pv_cpu_ops.start_context_switch = paravirt_start_context_switch;
1310 pv_cpu_ops.end_context_switch = lguest_end_context_switch;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001311
Rusty Russell2e04ef72009-07-30 16:03:45 -06001312 /* Pagetable management */
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001313 pv_mmu_ops.write_cr3 = lguest_write_cr3;
1314 pv_mmu_ops.flush_tlb_user = lguest_flush_tlb_user;
1315 pv_mmu_ops.flush_tlb_single = lguest_flush_tlb_single;
1316 pv_mmu_ops.flush_tlb_kernel = lguest_flush_tlb_kernel;
1317 pv_mmu_ops.set_pte = lguest_set_pte;
1318 pv_mmu_ops.set_pte_at = lguest_set_pte_at;
1319 pv_mmu_ops.set_pmd = lguest_set_pmd;
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -06001320#ifdef CONFIG_X86_PAE
1321 pv_mmu_ops.set_pte_atomic = lguest_set_pte_atomic;
1322 pv_mmu_ops.pte_clear = lguest_pte_clear;
1323 pv_mmu_ops.pmd_clear = lguest_pmd_clear;
1324 pv_mmu_ops.set_pud = lguest_set_pud;
1325#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001326 pv_mmu_ops.read_cr2 = lguest_read_cr2;
1327 pv_mmu_ops.read_cr3 = lguest_read_cr3;
Jeremy Fitzhardinge8965c1c2007-10-16 11:51:29 -07001328 pv_mmu_ops.lazy_mode.enter = paravirt_enter_lazy_mmu;
Jeremy Fitzhardingeb407fc52009-02-17 23:46:21 -08001329 pv_mmu_ops.lazy_mode.leave = lguest_leave_lazy_mmu_mode;
Rusty Russellb7ff99e2009-03-30 21:55:23 -06001330 pv_mmu_ops.pte_update = lguest_pte_update;
1331 pv_mmu_ops.pte_update_defer = lguest_pte_update;
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001332
Rusty Russell07ad1572007-07-19 01:49:22 -07001333#ifdef CONFIG_X86_LOCAL_APIC
Rusty Russell2e04ef72009-07-30 16:03:45 -06001334 /* APIC read/write intercepts */
Yinghai Luc1eeb2d2009-02-16 23:02:14 -08001335 set_lguest_basic_apic_ops();
Rusty Russell07ad1572007-07-19 01:49:22 -07001336#endif
Jeremy Fitzhardinge93b1eab2007-10-16 11:51:29 -07001337
Thomas Gleixner6b18ae32009-08-20 10:19:54 +02001338 x86_init.resources.memory_setup = lguest_memory_setup;
Thomas Gleixner66bcaf02009-08-20 09:59:09 +02001339 x86_init.irqs.intr_init = lguest_init_IRQ;
Thomas Gleixner845b3942009-08-19 15:37:03 +02001340 x86_init.timers.timer_init = lguest_time_init;
Thomas Gleixner2d826402009-08-20 17:06:25 +02001341 x86_platform.calibrate_tsc = lguest_tsc_khz;
Feng Tang7bd867d2009-09-10 10:48:56 +08001342 x86_platform.get_wallclock = lguest_get_wallclock;
Thomas Gleixner6b18ae32009-08-20 10:19:54 +02001343
Rusty Russell2e04ef72009-07-30 16:03:45 -06001344 /*
1345 * Now is a good time to look at the implementations of these functions
1346 * before returning to the rest of lguest_init().
1347 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001348
Rusty Russell2e04ef72009-07-30 16:03:45 -06001349 /*G:070
1350 * Now we've seen all the paravirt_ops, we return to
Rusty Russellb2b47c22007-07-26 10:41:02 -07001351 * lguest_init() where the rest of the fairly chaotic boot setup
Rusty Russell2e04ef72009-07-30 16:03:45 -06001352 * occurs.
1353 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001354
Rusty Russell2e04ef72009-07-30 16:03:45 -06001355 /*
1356 * The stack protector is a weird thing where gcc places a canary
Rusty Russell2cb78782009-06-03 14:52:24 +09301357 * value on the stack and then checks it on return. This file is
1358 * compiled with -fno-stack-protector it, so we got this far without
1359 * problems. The value of the canary is kept at offset 20 from the
1360 * %gs register, so we need to set that up before calling C functions
Rusty Russell2e04ef72009-07-30 16:03:45 -06001361 * in other files.
1362 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301363 setup_stack_canary_segment(0);
Rusty Russell2e04ef72009-07-30 16:03:45 -06001364
1365 /*
1366 * We could just call load_stack_canary_segment(), but we might as well
1367 * call switch_to_new_gdt() which loads the whole table and sets up the
1368 * per-cpu segment descriptor register %fs as well.
1369 */
Rusty Russell2cb78782009-06-03 14:52:24 +09301370 switch_to_new_gdt(0);
1371
Rusty Russell2e04ef72009-07-30 16:03:45 -06001372 /*
1373 * The Host<->Guest Switcher lives at the top of our address space, and
Rusty Russella6bd8e12008-03-28 11:05:53 -05001374 * the Host told us how big it is when we made LGUEST_INIT hypercall:
Rusty Russell2e04ef72009-07-30 16:03:45 -06001375 * it put the answer in lguest_data.reserve_mem
1376 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001377 reserve_top_address(lguest_data.reserve_mem);
1378
Rusty Russell2e04ef72009-07-30 16:03:45 -06001379 /*
1380 * If we don't initialize the lock dependency checker now, it crashes
Rusty Russellcdae0ad2009-09-23 22:26:42 -06001381 * atomic_notifier_chain_register, then paravirt_disable_iospace.
Rusty Russell2e04ef72009-07-30 16:03:45 -06001382 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001383 lockdep_init();
1384
Rusty Russellcdae0ad2009-09-23 22:26:42 -06001385 /* Hook in our special panic hypercall code. */
1386 atomic_notifier_chain_register(&panic_notifier_list, &paniced);
1387
Rusty Russell2e04ef72009-07-30 16:03:45 -06001388 /*
1389 * The IDE code spends about 3 seconds probing for disks: if we reserve
Rusty Russellb2b47c22007-07-26 10:41:02 -07001390 * all the I/O ports up front it can't get them and so doesn't probe.
1391 * Other device drivers are similar (but less severe). This cuts the
Rusty Russell2e04ef72009-07-30 16:03:45 -06001392 * kernel boot time on my machine from 4.1 seconds to 0.45 seconds.
1393 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001394 paravirt_disable_iospace();
1395
Rusty Russell2e04ef72009-07-30 16:03:45 -06001396 /*
1397 * This is messy CPU setup stuff which the native boot code does before
1398 * start_kernel, so we have to do, too:
1399 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001400 cpu_detect(&new_cpu_data);
1401 /* head.S usually sets up the first capability word, so do it here. */
1402 new_cpu_data.x86_capability[0] = cpuid_edx(1);
1403
1404 /* Math is always hard! */
1405 new_cpu_data.hard_math = 1;
1406
Rusty Russella6bd8e12008-03-28 11:05:53 -05001407 /* We don't have features. We have puppies! Puppies! */
Rusty Russell07ad1572007-07-19 01:49:22 -07001408#ifdef CONFIG_X86_MCE
1409 mce_disabled = 1;
1410#endif
Rusty Russell07ad1572007-07-19 01:49:22 -07001411#ifdef CONFIG_ACPI
1412 acpi_disabled = 1;
Rusty Russell07ad1572007-07-19 01:49:22 -07001413#endif
1414
Rusty Russell2e04ef72009-07-30 16:03:45 -06001415 /*
1416 * We set the preferred console to "hvc". This is the "hypervisor
Rusty Russellb2b47c22007-07-26 10:41:02 -07001417 * virtual console" driver written by the PowerPC people, which we also
Rusty Russell2e04ef72009-07-30 16:03:45 -06001418 * adapted for lguest's use.
1419 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001420 add_preferred_console("hvc", 0, NULL);
1421
Rusty Russell19f15372007-10-22 11:24:21 +10001422 /* Register our very early console. */
1423 virtio_cons_early_init(early_put_chars);
1424
Rusty Russell2e04ef72009-07-30 16:03:45 -06001425 /*
1426 * Last of all, we set the power management poweroff hook to point to
Rusty Russella6bd8e12008-03-28 11:05:53 -05001427 * the Guest routine to power off, and the reboot hook to our restart
Rusty Russell2e04ef72009-07-30 16:03:45 -06001428 * routine.
1429 */
Rusty Russell07ad1572007-07-19 01:49:22 -07001430 pm_power_off = lguest_power_off;
Balaji Raoec04b132007-12-28 14:26:24 +05301431 machine_ops.restart = lguest_restart;
Rusty Russella6bd8e12008-03-28 11:05:53 -05001432
Rusty Russell2e04ef72009-07-30 16:03:45 -06001433 /*
1434 * Now we're set up, call i386_start_kernel() in head32.c and we proceed
1435 * to boot as normal. It never returns.
1436 */
Yinghai Luf0d43102008-05-29 12:56:36 -07001437 i386_start_kernel();
Rusty Russell07ad1572007-07-19 01:49:22 -07001438}
Rusty Russellb2b47c22007-07-26 10:41:02 -07001439/*
1440 * This marks the end of stage II of our journey, The Guest.
1441 *
Rusty Russelle1e72962007-10-25 15:02:50 +10001442 * It is now time for us to explore the layer of virtual drivers and complete
1443 * our understanding of the Guest in "make Drivers".
Rusty Russellb2b47c22007-07-26 10:41:02 -07001444 */