Commit | Line | Data |
---|---|---|
f938d2c8 RR |
1 | /*P:400 This contains run_guest() which actually calls into the Host<->Guest |
2 | * Switcher and analyzes the return, such as determining if the Guest wants the | |
3 | * Host to do something. This file also contains useful helper routines, and a | |
4 | * couple of non-obvious setup and teardown pieces which were implemented after | |
5 | * days of debugging pain. :*/ | |
d7e28ffe RR |
6 | #include <linux/module.h> |
7 | #include <linux/stringify.h> | |
8 | #include <linux/stddef.h> | |
9 | #include <linux/io.h> | |
10 | #include <linux/mm.h> | |
11 | #include <linux/vmalloc.h> | |
12 | #include <linux/cpu.h> | |
13 | #include <linux/freezer.h> | |
625efab1 | 14 | #include <linux/highmem.h> |
d7e28ffe | 15 | #include <asm/paravirt.h> |
d7e28ffe RR |
16 | #include <asm/pgtable.h> |
17 | #include <asm/uaccess.h> | |
18 | #include <asm/poll.h> | |
d7e28ffe | 19 | #include <asm/asm-offsets.h> |
d7e28ffe RR |
20 | #include "lg.h" |
21 | ||
d7e28ffe RR |
22 | |
23 | static struct vm_struct *switcher_vma; | |
24 | static struct page **switcher_page; | |
25 | ||
d7e28ffe RR |
26 | /* This One Big lock protects all inter-guest data structures. */ |
27 | DEFINE_MUTEX(lguest_lock); | |
d7e28ffe | 28 | |
bff672e6 RR |
29 | /*H:010 We need to set up the Switcher at a high virtual address. Remember the |
30 | * Switcher is a few hundred bytes of assembler code which actually changes the | |
31 | * CPU to run the Guest, and then changes back to the Host when a trap or | |
32 | * interrupt happens. | |
33 | * | |
34 | * The Switcher code must be at the same virtual address in the Guest as the | |
35 | * Host since it will be running as the switchover occurs. | |
36 | * | |
37 | * Trying to map memory at a particular address is an unusual thing to do, so | |
625efab1 | 38 | * it's not a simple one-liner. */ |
d7e28ffe RR |
39 | static __init int map_switcher(void) |
40 | { | |
41 | int i, err; | |
42 | struct page **pagep; | |
43 | ||
bff672e6 RR |
44 | /* |
45 | * Map the Switcher in to high memory. | |
46 | * | |
47 | * It turns out that if we choose the address 0xFFC00000 (4MB under the | |
48 | * top virtual address), it makes setting up the page tables really | |
49 | * easy. | |
50 | */ | |
51 | ||
52 | /* We allocate an array of "struct page"s. map_vm_area() wants the | |
53 | * pages in this form, rather than just an array of pointers. */ | |
d7e28ffe RR |
54 | switcher_page = kmalloc(sizeof(switcher_page[0])*TOTAL_SWITCHER_PAGES, |
55 | GFP_KERNEL); | |
56 | if (!switcher_page) { | |
57 | err = -ENOMEM; | |
58 | goto out; | |
59 | } | |
60 | ||
bff672e6 RR |
61 | /* Now we actually allocate the pages. The Guest will see these pages, |
62 | * so we make sure they're zeroed. */ | |
d7e28ffe RR |
63 | for (i = 0; i < TOTAL_SWITCHER_PAGES; i++) { |
64 | unsigned long addr = get_zeroed_page(GFP_KERNEL); | |
65 | if (!addr) { | |
66 | err = -ENOMEM; | |
67 | goto free_some_pages; | |
68 | } | |
69 | switcher_page[i] = virt_to_page(addr); | |
70 | } | |
71 | ||
bff672e6 RR |
72 | /* Now we reserve the "virtual memory area" we want: 0xFFC00000 |
73 | * (SWITCHER_ADDR). We might not get it in theory, but in practice | |
74 | * it's worked so far. */ | |
d7e28ffe RR |
75 | switcher_vma = __get_vm_area(TOTAL_SWITCHER_PAGES * PAGE_SIZE, |
76 | VM_ALLOC, SWITCHER_ADDR, VMALLOC_END); | |
77 | if (!switcher_vma) { | |
78 | err = -ENOMEM; | |
79 | printk("lguest: could not map switcher pages high\n"); | |
80 | goto free_pages; | |
81 | } | |
82 | ||
bff672e6 RR |
83 | /* This code actually sets up the pages we've allocated to appear at |
84 | * SWITCHER_ADDR. map_vm_area() takes the vma we allocated above, the | |
85 | * kind of pages we're mapping (kernel pages), and a pointer to our | |
86 | * array of struct pages. It increments that pointer, but we don't | |
87 | * care. */ | |
d7e28ffe RR |
88 | pagep = switcher_page; |
89 | err = map_vm_area(switcher_vma, PAGE_KERNEL, &pagep); | |
90 | if (err) { | |
91 | printk("lguest: map_vm_area failed: %i\n", err); | |
92 | goto free_vma; | |
93 | } | |
bff672e6 | 94 | |
625efab1 JS |
95 | /* Now the Switcher is mapped at the right address, we can't fail! |
96 | * Copy in the compiled-in Switcher code (from <arch>_switcher.S). */ | |
d7e28ffe RR |
97 | memcpy(switcher_vma->addr, start_switcher_text, |
98 | end_switcher_text - start_switcher_text); | |
99 | ||
d7e28ffe RR |
100 | printk(KERN_INFO "lguest: mapped switcher at %p\n", |
101 | switcher_vma->addr); | |
bff672e6 | 102 | /* And we succeeded... */ |
d7e28ffe RR |
103 | return 0; |
104 | ||
105 | free_vma: | |
106 | vunmap(switcher_vma->addr); | |
107 | free_pages: | |
108 | i = TOTAL_SWITCHER_PAGES; | |
109 | free_some_pages: | |
110 | for (--i; i >= 0; i--) | |
111 | __free_pages(switcher_page[i], 0); | |
112 | kfree(switcher_page); | |
113 | out: | |
114 | return err; | |
115 | } | |
bff672e6 | 116 | /*:*/ |
d7e28ffe | 117 | |
bff672e6 RR |
118 | /* Cleaning up the mapping when the module is unloaded is almost... |
119 | * too easy. */ | |
d7e28ffe RR |
120 | static void unmap_switcher(void) |
121 | { | |
122 | unsigned int i; | |
123 | ||
bff672e6 | 124 | /* vunmap() undoes *both* map_vm_area() and __get_vm_area(). */ |
d7e28ffe | 125 | vunmap(switcher_vma->addr); |
bff672e6 | 126 | /* Now we just need to free the pages we copied the switcher into */ |
d7e28ffe RR |
127 | for (i = 0; i < TOTAL_SWITCHER_PAGES; i++) |
128 | __free_pages(switcher_page[i], 0); | |
129 | } | |
130 | ||
e1e72965 | 131 | /*H:032 |
dde79789 RR |
132 | * Dealing With Guest Memory. |
133 | * | |
e1e72965 RR |
134 | * Before we go too much further into the Host, we need to grok the routines |
135 | * we use to deal with Guest memory. | |
136 | * | |
dde79789 | 137 | * When the Guest gives us (what it thinks is) a physical address, we can use |
3c6b5bfa RR |
138 | * the normal copy_from_user() & copy_to_user() on the corresponding place in |
139 | * the memory region allocated by the Launcher. | |
dde79789 RR |
140 | * |
141 | * But we can't trust the Guest: it might be trying to access the Launcher | |
142 | * code. We have to check that the range is below the pfn_limit the Launcher | |
143 | * gave us. We have to make sure that addr + len doesn't give us a false | |
144 | * positive by overflowing, too. */ | |
d7e28ffe RR |
145 | int lguest_address_ok(const struct lguest *lg, |
146 | unsigned long addr, unsigned long len) | |
147 | { | |
148 | return (addr+len) / PAGE_SIZE < lg->pfn_limit && (addr+len >= addr); | |
149 | } | |
150 | ||
2d37f94a RR |
151 | /* This routine copies memory from the Guest. Here we can see how useful the |
152 | * kill_lguest() routine we met in the Launcher can be: we return a random | |
153 | * value (all zeroes) instead of needing to return an error. */ | |
154 | void __lgread(struct lguest *lg, void *b, unsigned long addr, unsigned bytes) | |
d7e28ffe RR |
155 | { |
156 | if (!lguest_address_ok(lg, addr, bytes) | |
3c6b5bfa | 157 | || copy_from_user(b, lg->mem_base + addr, bytes) != 0) { |
d7e28ffe RR |
158 | /* copy_from_user should do this, but as we rely on it... */ |
159 | memset(b, 0, bytes); | |
160 | kill_guest(lg, "bad read address %#lx len %u", addr, bytes); | |
161 | } | |
162 | } | |
163 | ||
2d37f94a RR |
164 | /* This is the write (copy into guest) version. */ |
165 | void __lgwrite(struct lguest *lg, unsigned long addr, const void *b, | |
166 | unsigned bytes) | |
d7e28ffe RR |
167 | { |
168 | if (!lguest_address_ok(lg, addr, bytes) | |
3c6b5bfa | 169 | || copy_to_user(lg->mem_base + addr, b, bytes) != 0) |
d7e28ffe RR |
170 | kill_guest(lg, "bad write address %#lx len %u", addr, bytes); |
171 | } | |
2d37f94a | 172 | /*:*/ |
d7e28ffe | 173 | |
bff672e6 RR |
174 | /*H:030 Let's jump straight to the the main loop which runs the Guest. |
175 | * Remember, this is called by the Launcher reading /dev/lguest, and we keep | |
176 | * going around and around until something interesting happens. */ | |
d7e28ffe RR |
177 | int run_guest(struct lguest *lg, unsigned long __user *user) |
178 | { | |
bff672e6 | 179 | /* We stop running once the Guest is dead. */ |
d7e28ffe | 180 | while (!lg->dead) { |
cc6d4fbc RR |
181 | /* First we run any hypercalls the Guest wants done. */ |
182 | if (lg->hcall) | |
183 | do_hypercalls(lg); | |
184 | ||
15045275 | 185 | /* It's possible the Guest did a NOTIFY hypercall to the |
bff672e6 | 186 | * Launcher, in which case we return from the read() now. */ |
15045275 RR |
187 | if (lg->pending_notify) { |
188 | if (put_user(lg->pending_notify, user)) | |
d7e28ffe | 189 | return -EFAULT; |
15045275 | 190 | return sizeof(lg->pending_notify); |
d7e28ffe RR |
191 | } |
192 | ||
bff672e6 | 193 | /* Check for signals */ |
d7e28ffe RR |
194 | if (signal_pending(current)) |
195 | return -ERESTARTSYS; | |
196 | ||
197 | /* If Waker set break_out, return to Launcher. */ | |
198 | if (lg->break_out) | |
199 | return -EAGAIN; | |
200 | ||
bff672e6 RR |
201 | /* Check if there are any interrupts which can be delivered |
202 | * now: if so, this sets up the hander to be executed when we | |
203 | * next run the Guest. */ | |
d7e28ffe RR |
204 | maybe_do_interrupt(lg); |
205 | ||
bff672e6 RR |
206 | /* All long-lived kernel loops need to check with this horrible |
207 | * thing called the freezer. If the Host is trying to suspend, | |
208 | * it stops us. */ | |
d7e28ffe RR |
209 | try_to_freeze(); |
210 | ||
bff672e6 RR |
211 | /* Just make absolutely sure the Guest is still alive. One of |
212 | * those hypercalls could have been fatal, for example. */ | |
d7e28ffe RR |
213 | if (lg->dead) |
214 | break; | |
215 | ||
bff672e6 RR |
216 | /* If the Guest asked to be stopped, we sleep. The Guest's |
217 | * clock timer or LHCALL_BREAK from the Waker will wake us. */ | |
d7e28ffe RR |
218 | if (lg->halted) { |
219 | set_current_state(TASK_INTERRUPTIBLE); | |
220 | schedule(); | |
221 | continue; | |
222 | } | |
223 | ||
bff672e6 RR |
224 | /* OK, now we're ready to jump into the Guest. First we put up |
225 | * the "Do Not Disturb" sign: */ | |
d7e28ffe RR |
226 | local_irq_disable(); |
227 | ||
625efab1 JS |
228 | /* Actually run the Guest until something happens. */ |
229 | lguest_arch_run_guest(lg); | |
bff672e6 RR |
230 | |
231 | /* Now we're ready to be interrupted or moved to other CPUs */ | |
d7e28ffe RR |
232 | local_irq_enable(); |
233 | ||
625efab1 JS |
234 | /* Now we deal with whatever happened to the Guest. */ |
235 | lguest_arch_handle_trap(lg); | |
d7e28ffe | 236 | } |
625efab1 | 237 | |
bff672e6 | 238 | /* The Guest is dead => "No such file or directory" */ |
d7e28ffe RR |
239 | return -ENOENT; |
240 | } | |
241 | ||
bff672e6 RR |
242 | /*H:000 |
243 | * Welcome to the Host! | |
244 | * | |
245 | * By this point your brain has been tickled by the Guest code and numbed by | |
246 | * the Launcher code; prepare for it to be stretched by the Host code. This is | |
247 | * the heart. Let's begin at the initialization routine for the Host's lg | |
248 | * module. | |
249 | */ | |
d7e28ffe RR |
250 | static int __init init(void) |
251 | { | |
252 | int err; | |
253 | ||
bff672e6 | 254 | /* Lguest can't run under Xen, VMI or itself. It does Tricky Stuff. */ |
d7e28ffe | 255 | if (paravirt_enabled()) { |
93b1eab3 | 256 | printk("lguest is afraid of %s\n", pv_info.name); |
d7e28ffe RR |
257 | return -EPERM; |
258 | } | |
259 | ||
bff672e6 | 260 | /* First we put the Switcher up in very high virtual memory. */ |
d7e28ffe RR |
261 | err = map_switcher(); |
262 | if (err) | |
c18acd73 | 263 | goto out; |
d7e28ffe | 264 | |
bff672e6 | 265 | /* Now we set up the pagetable implementation for the Guests. */ |
d7e28ffe | 266 | err = init_pagetables(switcher_page, SHARED_SWITCHER_PAGES); |
c18acd73 RR |
267 | if (err) |
268 | goto unmap; | |
bff672e6 | 269 | |
c18acd73 RR |
270 | /* We might need to reserve an interrupt vector. */ |
271 | err = init_interrupts(); | |
272 | if (err) | |
273 | goto free_pgtables; | |
274 | ||
bff672e6 | 275 | /* /dev/lguest needs to be registered. */ |
d7e28ffe | 276 | err = lguest_device_init(); |
c18acd73 RR |
277 | if (err) |
278 | goto free_interrupts; | |
bff672e6 | 279 | |
625efab1 JS |
280 | /* Finally we do some architecture-specific setup. */ |
281 | lguest_arch_host_init(); | |
bff672e6 RR |
282 | |
283 | /* All good! */ | |
d7e28ffe | 284 | return 0; |
c18acd73 RR |
285 | |
286 | free_interrupts: | |
287 | free_interrupts(); | |
288 | free_pgtables: | |
289 | free_pagetables(); | |
290 | unmap: | |
291 | unmap_switcher(); | |
292 | out: | |
293 | return err; | |
d7e28ffe RR |
294 | } |
295 | ||
bff672e6 | 296 | /* Cleaning up is just the same code, backwards. With a little French. */ |
d7e28ffe RR |
297 | static void __exit fini(void) |
298 | { | |
299 | lguest_device_remove(); | |
c18acd73 | 300 | free_interrupts(); |
d7e28ffe RR |
301 | free_pagetables(); |
302 | unmap_switcher(); | |
bff672e6 | 303 | |
625efab1 | 304 | lguest_arch_host_fini(); |
d7e28ffe | 305 | } |
625efab1 | 306 | /*:*/ |
d7e28ffe | 307 | |
bff672e6 RR |
308 | /* The Host side of lguest can be a module. This is a nice way for people to |
309 | * play with it. */ | |
d7e28ffe RR |
310 | module_init(init); |
311 | module_exit(fini); | |
312 | MODULE_LICENSE("GPL"); | |
313 | MODULE_AUTHOR("Rusty Russell <rusty@rustcorp.com.au>"); |