lguest: PAE support
[linux-2.6.git] / drivers / lguest / page_tables.c
1 /*P:700 The pagetable code, on the other hand, still shows the scars of
2  * previous encounters.  It's functional, and as neat as it can be in the
3  * circumstances, but be wary, for these things are subtle and break easily.
4  * The Guest provides a virtual to physical mapping, but we can neither trust
5  * it nor use it: we verify and convert it here then point the CPU to the
6  * converted Guest pages when running the Guest. :*/
7
8 /* Copyright (C) Rusty Russell IBM Corporation 2006.
9  * GPL v2 and any later version */
10 #include <linux/mm.h>
11 #include <linux/types.h>
12 #include <linux/spinlock.h>
13 #include <linux/random.h>
14 #include <linux/percpu.h>
15 #include <asm/tlbflush.h>
16 #include <asm/uaccess.h>
17 #include <asm/bootparam.h>
18 #include "lg.h"
19
20 /*M:008 We hold reference to pages, which prevents them from being swapped.
21  * It'd be nice to have a callback in the "struct mm_struct" when Linux wants
22  * to swap out.  If we had this, and a shrinker callback to trim PTE pages, we
23  * could probably consider launching Guests as non-root. :*/
24
25 /*H:300
26  * The Page Table Code
27  *
28  * We use two-level page tables for the Guest.  If you're not entirely
29  * comfortable with virtual addresses, physical addresses and page tables then
30  * I recommend you review arch/x86/lguest/boot.c's "Page Table Handling" (with
31  * diagrams!).
32  *
33  * The Guest keeps page tables, but we maintain the actual ones here: these are
34  * called "shadow" page tables.  Which is a very Guest-centric name: these are
35  * the real page tables the CPU uses, although we keep them up to date to
36  * reflect the Guest's.  (See what I mean about weird naming?  Since when do
37  * shadows reflect anything?)
38  *
39  * Anyway, this is the most complicated part of the Host code.  There are seven
40  * parts to this:
41  *  (i) Looking up a page table entry when the Guest faults,
42  *  (ii) Making sure the Guest stack is mapped,
43  *  (iii) Setting up a page table entry when the Guest tells us one has changed,
44  *  (iv) Switching page tables,
45  *  (v) Flushing (throwing away) page tables,
46  *  (vi) Mapping the Switcher when the Guest is about to run,
47  *  (vii) Setting up the page tables initially.
48  :*/
49
50
51 /* 1024 entries in a page table page maps 1024 pages: 4MB.  The Switcher is
52  * conveniently placed at the top 4MB, so it uses a separate, complete PTE
53  * page.  */
54 #define SWITCHER_PGD_INDEX (PTRS_PER_PGD - 1)
55
56 /* For PAE we need the PMD index as well. We use the last 2MB, so we
57  * will need the last pmd entry of the last pmd page.  */
58 #ifdef CONFIG_X86_PAE
59 #define SWITCHER_PMD_INDEX      (PTRS_PER_PMD - 1)
60 #define RESERVE_MEM             2U
61 #define CHECK_GPGD_MASK         _PAGE_PRESENT
62 #else
63 #define RESERVE_MEM             4U
64 #define CHECK_GPGD_MASK         _PAGE_TABLE
65 #endif
66
67 /* We actually need a separate PTE page for each CPU.  Remember that after the
68  * Switcher code itself comes two pages for each CPU, and we don't want this
69  * CPU's guest to see the pages of any other CPU. */
70 static DEFINE_PER_CPU(pte_t *, switcher_pte_pages);
71 #define switcher_pte_page(cpu) per_cpu(switcher_pte_pages, cpu)
72
73 /*H:320 The page table code is curly enough to need helper functions to keep it
74  * clear and clean.
75  *
76  * There are two functions which return pointers to the shadow (aka "real")
77  * page tables.
78  *
79  * spgd_addr() takes the virtual address and returns a pointer to the top-level
80  * page directory entry (PGD) for that address.  Since we keep track of several
81  * page tables, the "i" argument tells us which one we're interested in (it's
82  * usually the current one). */
83 static pgd_t *spgd_addr(struct lg_cpu *cpu, u32 i, unsigned long vaddr)
84 {
85         unsigned int index = pgd_index(vaddr);
86
87 #ifndef CONFIG_X86_PAE
88         /* We kill any Guest trying to touch the Switcher addresses. */
89         if (index >= SWITCHER_PGD_INDEX) {
90                 kill_guest(cpu, "attempt to access switcher pages");
91                 index = 0;
92         }
93 #endif
94         /* Return a pointer index'th pgd entry for the i'th page table. */
95         return &cpu->lg->pgdirs[i].pgdir[index];
96 }
97
98 #ifdef CONFIG_X86_PAE
99 /* This routine then takes the PGD entry given above, which contains the
100  * address of the PMD page.  It then returns a pointer to the PMD entry for the
101  * given address. */
102 static pmd_t *spmd_addr(struct lg_cpu *cpu, pgd_t spgd, unsigned long vaddr)
103 {
104         unsigned int index = pmd_index(vaddr);
105         pmd_t *page;
106
107         /* We kill any Guest trying to touch the Switcher addresses. */
108         if (pgd_index(vaddr) == SWITCHER_PGD_INDEX &&
109                                         index >= SWITCHER_PMD_INDEX) {
110                 kill_guest(cpu, "attempt to access switcher pages");
111                 index = 0;
112         }
113
114         /* You should never call this if the PGD entry wasn't valid */
115         BUG_ON(!(pgd_flags(spgd) & _PAGE_PRESENT));
116         page = __va(pgd_pfn(spgd) << PAGE_SHIFT);
117
118         return &page[index];
119 }
120 #endif
121
122 /* This routine then takes the page directory entry returned above, which
123  * contains the address of the page table entry (PTE) page.  It then returns a
124  * pointer to the PTE entry for the given address. */
125 static pte_t *spte_addr(struct lg_cpu *cpu, pgd_t spgd, unsigned long vaddr)
126 {
127 #ifdef CONFIG_X86_PAE
128         pmd_t *pmd = spmd_addr(cpu, spgd, vaddr);
129         pte_t *page = __va(pmd_pfn(*pmd) << PAGE_SHIFT);
130
131         /* You should never call this if the PMD entry wasn't valid */
132         BUG_ON(!(pmd_flags(*pmd) & _PAGE_PRESENT));
133 #else
134         pte_t *page = __va(pgd_pfn(spgd) << PAGE_SHIFT);
135         /* You should never call this if the PGD entry wasn't valid */
136         BUG_ON(!(pgd_flags(spgd) & _PAGE_PRESENT));
137 #endif
138
139         return &page[pte_index(vaddr)];
140 }
141
142 /* These two functions just like the above two, except they access the Guest
143  * page tables.  Hence they return a Guest address. */
144 static unsigned long gpgd_addr(struct lg_cpu *cpu, unsigned long vaddr)
145 {
146         unsigned int index = vaddr >> (PGDIR_SHIFT);
147         return cpu->lg->pgdirs[cpu->cpu_pgd].gpgdir + index * sizeof(pgd_t);
148 }
149
150 #ifdef CONFIG_X86_PAE
151 static unsigned long gpmd_addr(pgd_t gpgd, unsigned long vaddr)
152 {
153         unsigned long gpage = pgd_pfn(gpgd) << PAGE_SHIFT;
154         BUG_ON(!(pgd_flags(gpgd) & _PAGE_PRESENT));
155         return gpage + pmd_index(vaddr) * sizeof(pmd_t);
156 }
157 #endif
158
159 static unsigned long gpte_addr(struct lg_cpu *cpu,
160                                 pgd_t gpgd, unsigned long vaddr)
161 {
162 #ifdef CONFIG_X86_PAE
163         pmd_t gpmd;
164 #endif
165         unsigned long gpage;
166
167         BUG_ON(!(pgd_flags(gpgd) & _PAGE_PRESENT));
168 #ifdef CONFIG_X86_PAE
169         gpmd = lgread(cpu, gpmd_addr(gpgd, vaddr), pmd_t);
170         gpage = pmd_pfn(gpmd) << PAGE_SHIFT;
171         BUG_ON(!(pmd_flags(gpmd) & _PAGE_PRESENT));
172 #else
173         gpage = pgd_pfn(gpgd) << PAGE_SHIFT;
174 #endif
175         return gpage + pte_index(vaddr) * sizeof(pte_t);
176 }
177 /*:*/
178
179 /*M:014 get_pfn is slow: we could probably try to grab batches of pages here as
180  * an optimization (ie. pre-faulting). :*/
181
182 /*H:350 This routine takes a page number given by the Guest and converts it to
183  * an actual, physical page number.  It can fail for several reasons: the
184  * virtual address might not be mapped by the Launcher, the write flag is set
185  * and the page is read-only, or the write flag was set and the page was
186  * shared so had to be copied, but we ran out of memory.
187  *
188  * This holds a reference to the page, so release_pte() is careful to put that
189  * back. */
190 static unsigned long get_pfn(unsigned long virtpfn, int write)
191 {
192         struct page *page;
193
194         /* gup me one page at this address please! */
195         if (get_user_pages_fast(virtpfn << PAGE_SHIFT, 1, write, &page) == 1)
196                 return page_to_pfn(page);
197
198         /* This value indicates failure. */
199         return -1UL;
200 }
201
202 /*H:340 Converting a Guest page table entry to a shadow (ie. real) page table
203  * entry can be a little tricky.  The flags are (almost) the same, but the
204  * Guest PTE contains a virtual page number: the CPU needs the real page
205  * number. */
206 static pte_t gpte_to_spte(struct lg_cpu *cpu, pte_t gpte, int write)
207 {
208         unsigned long pfn, base, flags;
209
210         /* The Guest sets the global flag, because it thinks that it is using
211          * PGE.  We only told it to use PGE so it would tell us whether it was
212          * flushing a kernel mapping or a userspace mapping.  We don't actually
213          * use the global bit, so throw it away. */
214         flags = (pte_flags(gpte) & ~_PAGE_GLOBAL);
215
216         /* The Guest's pages are offset inside the Launcher. */
217         base = (unsigned long)cpu->lg->mem_base / PAGE_SIZE;
218
219         /* We need a temporary "unsigned long" variable to hold the answer from
220          * get_pfn(), because it returns 0xFFFFFFFF on failure, which wouldn't
221          * fit in spte.pfn.  get_pfn() finds the real physical number of the
222          * page, given the virtual number. */
223         pfn = get_pfn(base + pte_pfn(gpte), write);
224         if (pfn == -1UL) {
225                 kill_guest(cpu, "failed to get page %lu", pte_pfn(gpte));
226                 /* When we destroy the Guest, we'll go through the shadow page
227                  * tables and release_pte() them.  Make sure we don't think
228                  * this one is valid! */
229                 flags = 0;
230         }
231         /* Now we assemble our shadow PTE from the page number and flags. */
232         return pfn_pte(pfn, __pgprot(flags));
233 }
234
235 /*H:460 And to complete the chain, release_pte() looks like this: */
236 static void release_pte(pte_t pte)
237 {
238         /* Remember that get_user_pages_fast() took a reference to the page, in
239          * get_pfn()?  We have to put it back now. */
240         if (pte_flags(pte) & _PAGE_PRESENT)
241                 put_page(pte_page(pte));
242 }
243 /*:*/
244
245 static void check_gpte(struct lg_cpu *cpu, pte_t gpte)
246 {
247         if ((pte_flags(gpte) & _PAGE_PSE) ||
248             pte_pfn(gpte) >= cpu->lg->pfn_limit)
249                 kill_guest(cpu, "bad page table entry");
250 }
251
252 static void check_gpgd(struct lg_cpu *cpu, pgd_t gpgd)
253 {
254         if ((pgd_flags(gpgd) & ~CHECK_GPGD_MASK) ||
255            (pgd_pfn(gpgd) >= cpu->lg->pfn_limit))
256                 kill_guest(cpu, "bad page directory entry");
257 }
258
259 #ifdef CONFIG_X86_PAE
260 static void check_gpmd(struct lg_cpu *cpu, pmd_t gpmd)
261 {
262         if ((pmd_flags(gpmd) & ~_PAGE_TABLE) ||
263            (pmd_pfn(gpmd) >= cpu->lg->pfn_limit))
264                 kill_guest(cpu, "bad page middle directory entry");
265 }
266 #endif
267
268 /*H:330
269  * (i) Looking up a page table entry when the Guest faults.
270  *
271  * We saw this call in run_guest(): when we see a page fault in the Guest, we
272  * come here.  That's because we only set up the shadow page tables lazily as
273  * they're needed, so we get page faults all the time and quietly fix them up
274  * and return to the Guest without it knowing.
275  *
276  * If we fixed up the fault (ie. we mapped the address), this routine returns
277  * true.  Otherwise, it was a real fault and we need to tell the Guest. */
278 bool demand_page(struct lg_cpu *cpu, unsigned long vaddr, int errcode)
279 {
280         pgd_t gpgd;
281         pgd_t *spgd;
282         unsigned long gpte_ptr;
283         pte_t gpte;
284         pte_t *spte;
285
286 #ifdef CONFIG_X86_PAE
287         pmd_t *spmd;
288         pmd_t gpmd;
289 #endif
290
291         /* First step: get the top-level Guest page table entry. */
292         gpgd = lgread(cpu, gpgd_addr(cpu, vaddr), pgd_t);
293         /* Toplevel not present?  We can't map it in. */
294         if (!(pgd_flags(gpgd) & _PAGE_PRESENT))
295                 return false;
296
297         /* Now look at the matching shadow entry. */
298         spgd = spgd_addr(cpu, cpu->cpu_pgd, vaddr);
299         if (!(pgd_flags(*spgd) & _PAGE_PRESENT)) {
300                 /* No shadow entry: allocate a new shadow PTE page. */
301                 unsigned long ptepage = get_zeroed_page(GFP_KERNEL);
302                 /* This is not really the Guest's fault, but killing it is
303                  * simple for this corner case. */
304                 if (!ptepage) {
305                         kill_guest(cpu, "out of memory allocating pte page");
306                         return false;
307                 }
308                 /* We check that the Guest pgd is OK. */
309                 check_gpgd(cpu, gpgd);
310                 /* And we copy the flags to the shadow PGD entry.  The page
311                  * number in the shadow PGD is the page we just allocated. */
312                 set_pgd(spgd, __pgd(__pa(ptepage) | pgd_flags(gpgd)));
313         }
314
315 #ifdef CONFIG_X86_PAE
316         gpmd = lgread(cpu, gpmd_addr(gpgd, vaddr), pmd_t);
317         /* middle level not present?  We can't map it in. */
318         if (!(pmd_flags(gpmd) & _PAGE_PRESENT))
319                 return false;
320
321         /* Now look at the matching shadow entry. */
322         spmd = spmd_addr(cpu, *spgd, vaddr);
323
324         if (!(pmd_flags(*spmd) & _PAGE_PRESENT)) {
325                 /* No shadow entry: allocate a new shadow PTE page. */
326                 unsigned long ptepage = get_zeroed_page(GFP_KERNEL);
327
328                 /* This is not really the Guest's fault, but killing it is
329                 * simple for this corner case. */
330                 if (!ptepage) {
331                         kill_guest(cpu, "out of memory allocating pte page");
332                         return false;
333                 }
334
335                 /* We check that the Guest pmd is OK. */
336                 check_gpmd(cpu, gpmd);
337
338                 /* And we copy the flags to the shadow PMD entry.  The page
339                  * number in the shadow PMD is the page we just allocated. */
340                 native_set_pmd(spmd, __pmd(__pa(ptepage) | pmd_flags(gpmd)));
341         }
342 #endif
343         /* OK, now we look at the lower level in the Guest page table: keep its
344          * address, because we might update it later. */
345         gpte_ptr = gpte_addr(cpu, gpgd, vaddr);
346         gpte = lgread(cpu, gpte_ptr, pte_t);
347
348         /* If this page isn't in the Guest page tables, we can't page it in. */
349         if (!(pte_flags(gpte) & _PAGE_PRESENT))
350                 return false;
351
352         /* Check they're not trying to write to a page the Guest wants
353          * read-only (bit 2 of errcode == write). */
354         if ((errcode & 2) && !(pte_flags(gpte) & _PAGE_RW))
355                 return false;
356
357         /* User access to a kernel-only page? (bit 3 == user access) */
358         if ((errcode & 4) && !(pte_flags(gpte) & _PAGE_USER))
359                 return false;
360
361         /* Check that the Guest PTE flags are OK, and the page number is below
362          * the pfn_limit (ie. not mapping the Launcher binary). */
363         check_gpte(cpu, gpte);
364
365         /* Add the _PAGE_ACCESSED and (for a write) _PAGE_DIRTY flag */
366         gpte = pte_mkyoung(gpte);
367         if (errcode & 2)
368                 gpte = pte_mkdirty(gpte);
369
370         /* Get the pointer to the shadow PTE entry we're going to set. */
371         spte = spte_addr(cpu, *spgd, vaddr);
372         /* If there was a valid shadow PTE entry here before, we release it.
373          * This can happen with a write to a previously read-only entry. */
374         release_pte(*spte);
375
376         /* If this is a write, we insist that the Guest page is writable (the
377          * final arg to gpte_to_spte()). */
378         if (pte_dirty(gpte))
379                 *spte = gpte_to_spte(cpu, gpte, 1);
380         else
381                 /* If this is a read, don't set the "writable" bit in the page
382                  * table entry, even if the Guest says it's writable.  That way
383                  * we will come back here when a write does actually occur, so
384                  * we can update the Guest's _PAGE_DIRTY flag. */
385                 native_set_pte(spte, gpte_to_spte(cpu, pte_wrprotect(gpte), 0));
386
387         /* Finally, we write the Guest PTE entry back: we've set the
388          * _PAGE_ACCESSED and maybe the _PAGE_DIRTY flags. */
389         lgwrite(cpu, gpte_ptr, pte_t, gpte);
390
391         /* The fault is fixed, the page table is populated, the mapping
392          * manipulated, the result returned and the code complete.  A small
393          * delay and a trace of alliteration are the only indications the Guest
394          * has that a page fault occurred at all. */
395         return true;
396 }
397
398 /*H:360
399  * (ii) Making sure the Guest stack is mapped.
400  *
401  * Remember that direct traps into the Guest need a mapped Guest kernel stack.
402  * pin_stack_pages() calls us here: we could simply call demand_page(), but as
403  * we've seen that logic is quite long, and usually the stack pages are already
404  * mapped, so it's overkill.
405  *
406  * This is a quick version which answers the question: is this virtual address
407  * mapped by the shadow page tables, and is it writable? */
408 static bool page_writable(struct lg_cpu *cpu, unsigned long vaddr)
409 {
410         pgd_t *spgd;
411         unsigned long flags;
412
413 #ifdef CONFIG_X86_PAE
414         pmd_t *spmd;
415 #endif
416         /* Look at the current top level entry: is it present? */
417         spgd = spgd_addr(cpu, cpu->cpu_pgd, vaddr);
418         if (!(pgd_flags(*spgd) & _PAGE_PRESENT))
419                 return false;
420
421 #ifdef CONFIG_X86_PAE
422         spmd = spmd_addr(cpu, *spgd, vaddr);
423         if (!(pmd_flags(*spmd) & _PAGE_PRESENT))
424                 return false;
425 #endif
426
427         /* Check the flags on the pte entry itself: it must be present and
428          * writable. */
429         flags = pte_flags(*(spte_addr(cpu, *spgd, vaddr)));
430
431         return (flags & (_PAGE_PRESENT|_PAGE_RW)) == (_PAGE_PRESENT|_PAGE_RW);
432 }
433
434 /* So, when pin_stack_pages() asks us to pin a page, we check if it's already
435  * in the page tables, and if not, we call demand_page() with error code 2
436  * (meaning "write"). */
437 void pin_page(struct lg_cpu *cpu, unsigned long vaddr)
438 {
439         if (!page_writable(cpu, vaddr) && !demand_page(cpu, vaddr, 2))
440                 kill_guest(cpu, "bad stack page %#lx", vaddr);
441 }
442
443 #ifdef CONFIG_X86_PAE
444 static void release_pmd(pmd_t *spmd)
445 {
446         /* If the entry's not present, there's nothing to release. */
447         if (pmd_flags(*spmd) & _PAGE_PRESENT) {
448                 unsigned int i;
449                 pte_t *ptepage = __va(pmd_pfn(*spmd) << PAGE_SHIFT);
450                 /* For each entry in the page, we might need to release it. */
451                 for (i = 0; i < PTRS_PER_PTE; i++)
452                         release_pte(ptepage[i]);
453                 /* Now we can free the page of PTEs */
454                 free_page((long)ptepage);
455                 /* And zero out the PMD entry so we never release it twice. */
456                 native_set_pmd(spmd, __pmd(0));
457         }
458 }
459
460 static void release_pgd(pgd_t *spgd)
461 {
462         /* If the entry's not present, there's nothing to release. */
463         if (pgd_flags(*spgd) & _PAGE_PRESENT) {
464                 unsigned int i;
465                 pmd_t *pmdpage = __va(pgd_pfn(*spgd) << PAGE_SHIFT);
466
467                 for (i = 0; i < PTRS_PER_PMD; i++)
468                         release_pmd(&pmdpage[i]);
469
470                 /* Now we can free the page of PMDs */
471                 free_page((long)pmdpage);
472                 /* And zero out the PGD entry so we never release it twice. */
473                 set_pgd(spgd, __pgd(0));
474         }
475 }
476
477 #else /* !CONFIG_X86_PAE */
478 /*H:450 If we chase down the release_pgd() code, it looks like this: */
479 static void release_pgd(pgd_t *spgd)
480 {
481         /* If the entry's not present, there's nothing to release. */
482         if (pgd_flags(*spgd) & _PAGE_PRESENT) {
483                 unsigned int i;
484                 /* Converting the pfn to find the actual PTE page is easy: turn
485                  * the page number into a physical address, then convert to a
486                  * virtual address (easy for kernel pages like this one). */
487                 pte_t *ptepage = __va(pgd_pfn(*spgd) << PAGE_SHIFT);
488                 /* For each entry in the page, we might need to release it. */
489                 for (i = 0; i < PTRS_PER_PTE; i++)
490                         release_pte(ptepage[i]);
491                 /* Now we can free the page of PTEs */
492                 free_page((long)ptepage);
493                 /* And zero out the PGD entry so we never release it twice. */
494                 *spgd = __pgd(0);
495         }
496 }
497 #endif
498 /*H:445 We saw flush_user_mappings() twice: once from the flush_user_mappings()
499  * hypercall and once in new_pgdir() when we re-used a top-level pgdir page.
500  * It simply releases every PTE page from 0 up to the Guest's kernel address. */
501 static void flush_user_mappings(struct lguest *lg, int idx)
502 {
503         unsigned int i;
504         /* Release every pgd entry up to the kernel's address. */
505         for (i = 0; i < pgd_index(lg->kernel_address); i++)
506                 release_pgd(lg->pgdirs[idx].pgdir + i);
507 }
508
509 /*H:440 (v) Flushing (throwing away) page tables,
510  *
511  * The Guest has a hypercall to throw away the page tables: it's used when a
512  * large number of mappings have been changed. */
513 void guest_pagetable_flush_user(struct lg_cpu *cpu)
514 {
515         /* Drop the userspace part of the current page table. */
516         flush_user_mappings(cpu->lg, cpu->cpu_pgd);
517 }
518 /*:*/
519
520 /* We walk down the guest page tables to get a guest-physical address */
521 unsigned long guest_pa(struct lg_cpu *cpu, unsigned long vaddr)
522 {
523         pgd_t gpgd;
524         pte_t gpte;
525
526 #ifdef CONFIG_X86_PAE
527         pmd_t gpmd;
528 #endif
529         /* First step: get the top-level Guest page table entry. */
530         gpgd = lgread(cpu, gpgd_addr(cpu, vaddr), pgd_t);
531         /* Toplevel not present?  We can't map it in. */
532         if (!(pgd_flags(gpgd) & _PAGE_PRESENT)) {
533                 kill_guest(cpu, "Bad address %#lx", vaddr);
534                 return -1UL;
535         }
536
537         gpte = lgread(cpu, gpte_addr(cpu, gpgd, vaddr), pte_t);
538 #ifdef CONFIG_X86_PAE
539         gpmd = lgread(cpu, gpmd_addr(gpgd, vaddr), pmd_t);
540         if (!(pmd_flags(gpmd) & _PAGE_PRESENT))
541                 kill_guest(cpu, "Bad address %#lx", vaddr);
542 #endif
543         gpte = lgread(cpu, gpte_addr(cpu, gpgd, vaddr), pte_t);
544         if (!(pte_flags(gpte) & _PAGE_PRESENT))
545                 kill_guest(cpu, "Bad address %#lx", vaddr);
546
547         return pte_pfn(gpte) * PAGE_SIZE | (vaddr & ~PAGE_MASK);
548 }
549
550 /* We keep several page tables.  This is a simple routine to find the page
551  * table (if any) corresponding to this top-level address the Guest has given
552  * us. */
553 static unsigned int find_pgdir(struct lguest *lg, unsigned long pgtable)
554 {
555         unsigned int i;
556         for (i = 0; i < ARRAY_SIZE(lg->pgdirs); i++)
557                 if (lg->pgdirs[i].pgdir && lg->pgdirs[i].gpgdir == pgtable)
558                         break;
559         return i;
560 }
561
562 /*H:435 And this is us, creating the new page directory.  If we really do
563  * allocate a new one (and so the kernel parts are not there), we set
564  * blank_pgdir. */
565 static unsigned int new_pgdir(struct lg_cpu *cpu,
566                               unsigned long gpgdir,
567                               int *blank_pgdir)
568 {
569         unsigned int next;
570 #ifdef CONFIG_X86_PAE
571         pmd_t *pmd_table;
572 #endif
573
574         /* We pick one entry at random to throw out.  Choosing the Least
575          * Recently Used might be better, but this is easy. */
576         next = random32() % ARRAY_SIZE(cpu->lg->pgdirs);
577         /* If it's never been allocated at all before, try now. */
578         if (!cpu->lg->pgdirs[next].pgdir) {
579                 cpu->lg->pgdirs[next].pgdir =
580                                         (pgd_t *)get_zeroed_page(GFP_KERNEL);
581                 /* If the allocation fails, just keep using the one we have */
582                 if (!cpu->lg->pgdirs[next].pgdir)
583                         next = cpu->cpu_pgd;
584                 else {
585 #ifdef CONFIG_X86_PAE
586                         /* In PAE mode, allocate a pmd page and populate the
587                          * last pgd entry. */
588                         pmd_table = (pmd_t *)get_zeroed_page(GFP_KERNEL);
589                         if (!pmd_table) {
590                                 free_page((long)cpu->lg->pgdirs[next].pgdir);
591                                 set_pgd(cpu->lg->pgdirs[next].pgdir, __pgd(0));
592                                 next = cpu->cpu_pgd;
593                         } else {
594                                 set_pgd(cpu->lg->pgdirs[next].pgdir +
595                                         SWITCHER_PGD_INDEX,
596                                         __pgd(__pa(pmd_table) | _PAGE_PRESENT));
597                                 /* This is a blank page, so there are no kernel
598                                  * mappings: caller must map the stack! */
599                                 *blank_pgdir = 1;
600                         }
601 #else
602                         *blank_pgdir = 1;
603 #endif
604                 }
605         }
606         /* Record which Guest toplevel this shadows. */
607         cpu->lg->pgdirs[next].gpgdir = gpgdir;
608         /* Release all the non-kernel mappings. */
609         flush_user_mappings(cpu->lg, next);
610
611         return next;
612 }
613
614 /*H:430 (iv) Switching page tables
615  *
616  * Now we've seen all the page table setting and manipulation, let's see
617  * what happens when the Guest changes page tables (ie. changes the top-level
618  * pgdir).  This occurs on almost every context switch. */
619 void guest_new_pagetable(struct lg_cpu *cpu, unsigned long pgtable)
620 {
621         int newpgdir, repin = 0;
622
623         /* Look to see if we have this one already. */
624         newpgdir = find_pgdir(cpu->lg, pgtable);
625         /* If not, we allocate or mug an existing one: if it's a fresh one,
626          * repin gets set to 1. */
627         if (newpgdir == ARRAY_SIZE(cpu->lg->pgdirs))
628                 newpgdir = new_pgdir(cpu, pgtable, &repin);
629         /* Change the current pgd index to the new one. */
630         cpu->cpu_pgd = newpgdir;
631         /* If it was completely blank, we map in the Guest kernel stack */
632         if (repin)
633                 pin_stack_pages(cpu);
634 }
635
636 /*H:470 Finally, a routine which throws away everything: all PGD entries in all
637  * the shadow page tables, including the Guest's kernel mappings.  This is used
638  * when we destroy the Guest. */
639 static void release_all_pagetables(struct lguest *lg)
640 {
641         unsigned int i, j;
642
643         /* Every shadow pagetable this Guest has */
644         for (i = 0; i < ARRAY_SIZE(lg->pgdirs); i++)
645                 if (lg->pgdirs[i].pgdir) {
646 #ifdef CONFIG_X86_PAE
647                         pgd_t *spgd;
648                         pmd_t *pmdpage;
649                         unsigned int k;
650
651                         /* Get the last pmd page. */
652                         spgd = lg->pgdirs[i].pgdir + SWITCHER_PGD_INDEX;
653                         pmdpage = __va(pgd_pfn(*spgd) << PAGE_SHIFT);
654
655                         /* And release the pmd entries of that pmd page,
656                          * except for the switcher pmd. */
657                         for (k = 0; k < SWITCHER_PMD_INDEX; k++)
658                                 release_pmd(&pmdpage[k]);
659 #endif
660                         /* Every PGD entry except the Switcher at the top */
661                         for (j = 0; j < SWITCHER_PGD_INDEX; j++)
662                                 release_pgd(lg->pgdirs[i].pgdir + j);
663                 }
664 }
665
666 /* We also throw away everything when a Guest tells us it's changed a kernel
667  * mapping.  Since kernel mappings are in every page table, it's easiest to
668  * throw them all away.  This traps the Guest in amber for a while as
669  * everything faults back in, but it's rare. */
670 void guest_pagetable_clear_all(struct lg_cpu *cpu)
671 {
672         release_all_pagetables(cpu->lg);
673         /* We need the Guest kernel stack mapped again. */
674         pin_stack_pages(cpu);
675 }
676 /*:*/
677 /*M:009 Since we throw away all mappings when a kernel mapping changes, our
678  * performance sucks for guests using highmem.  In fact, a guest with
679  * PAGE_OFFSET 0xc0000000 (the default) and more than about 700MB of RAM is
680  * usually slower than a Guest with less memory.
681  *
682  * This, of course, cannot be fixed.  It would take some kind of... well, I
683  * don't know, but the term "puissant code-fu" comes to mind. :*/
684
685 /*H:420 This is the routine which actually sets the page table entry for then
686  * "idx"'th shadow page table.
687  *
688  * Normally, we can just throw out the old entry and replace it with 0: if they
689  * use it demand_page() will put the new entry in.  We need to do this anyway:
690  * The Guest expects _PAGE_ACCESSED to be set on its PTE the first time a page
691  * is read from, and _PAGE_DIRTY when it's written to.
692  *
693  * But Avi Kivity pointed out that most Operating Systems (Linux included) set
694  * these bits on PTEs immediately anyway.  This is done to save the CPU from
695  * having to update them, but it helps us the same way: if they set
696  * _PAGE_ACCESSED then we can put a read-only PTE entry in immediately, and if
697  * they set _PAGE_DIRTY then we can put a writable PTE entry in immediately.
698  */
699 static void do_set_pte(struct lg_cpu *cpu, int idx,
700                        unsigned long vaddr, pte_t gpte)
701 {
702         /* Look up the matching shadow page directory entry. */
703         pgd_t *spgd = spgd_addr(cpu, idx, vaddr);
704 #ifdef CONFIG_X86_PAE
705         pmd_t *spmd;
706 #endif
707
708         /* If the top level isn't present, there's no entry to update. */
709         if (pgd_flags(*spgd) & _PAGE_PRESENT) {
710 #ifdef CONFIG_X86_PAE
711                 spmd = spmd_addr(cpu, *spgd, vaddr);
712                 if (pmd_flags(*spmd) & _PAGE_PRESENT) {
713 #endif
714                         /* Otherwise, we start by releasing
715                          * the existing entry. */
716                         pte_t *spte = spte_addr(cpu, *spgd, vaddr);
717                         release_pte(*spte);
718
719                         /* If they're setting this entry as dirty or accessed,
720                          * we might as well put that entry they've given us
721                          * in now.  This shaves 10% off a
722                          * copy-on-write micro-benchmark. */
723                         if (pte_flags(gpte) & (_PAGE_DIRTY | _PAGE_ACCESSED)) {
724                                 check_gpte(cpu, gpte);
725                                 native_set_pte(spte,
726                                                 gpte_to_spte(cpu, gpte,
727                                                 pte_flags(gpte) & _PAGE_DIRTY));
728                         } else
729                                 /* Otherwise kill it and we can demand_page()
730                                  * it in later. */
731                                 native_set_pte(spte, __pte(0));
732 #ifdef CONFIG_X86_PAE
733                 }
734 #endif
735         }
736 }
737
738 /*H:410 Updating a PTE entry is a little trickier.
739  *
740  * We keep track of several different page tables (the Guest uses one for each
741  * process, so it makes sense to cache at least a few).  Each of these have
742  * identical kernel parts: ie. every mapping above PAGE_OFFSET is the same for
743  * all processes.  So when the page table above that address changes, we update
744  * all the page tables, not just the current one.  This is rare.
745  *
746  * The benefit is that when we have to track a new page table, we can keep all
747  * the kernel mappings.  This speeds up context switch immensely. */
748 void guest_set_pte(struct lg_cpu *cpu,
749                    unsigned long gpgdir, unsigned long vaddr, pte_t gpte)
750 {
751         /* Kernel mappings must be changed on all top levels.  Slow, but doesn't
752          * happen often. */
753         if (vaddr >= cpu->lg->kernel_address) {
754                 unsigned int i;
755                 for (i = 0; i < ARRAY_SIZE(cpu->lg->pgdirs); i++)
756                         if (cpu->lg->pgdirs[i].pgdir)
757                                 do_set_pte(cpu, i, vaddr, gpte);
758         } else {
759                 /* Is this page table one we have a shadow for? */
760                 int pgdir = find_pgdir(cpu->lg, gpgdir);
761                 if (pgdir != ARRAY_SIZE(cpu->lg->pgdirs))
762                         /* If so, do the update. */
763                         do_set_pte(cpu, pgdir, vaddr, gpte);
764         }
765 }
766
767 /*H:400
768  * (iii) Setting up a page table entry when the Guest tells us one has changed.
769  *
770  * Just like we did in interrupts_and_traps.c, it makes sense for us to deal
771  * with the other side of page tables while we're here: what happens when the
772  * Guest asks for a page table to be updated?
773  *
774  * We already saw that demand_page() will fill in the shadow page tables when
775  * needed, so we can simply remove shadow page table entries whenever the Guest
776  * tells us they've changed.  When the Guest tries to use the new entry it will
777  * fault and demand_page() will fix it up.
778  *
779  * So with that in mind here's our code to to update a (top-level) PGD entry:
780  */
781 void guest_set_pgd(struct lguest *lg, unsigned long gpgdir, u32 idx)
782 {
783         int pgdir;
784
785         if (idx >= SWITCHER_PGD_INDEX)
786                 return;
787
788         /* If they're talking about a page table we have a shadow for... */
789         pgdir = find_pgdir(lg, gpgdir);
790         if (pgdir < ARRAY_SIZE(lg->pgdirs))
791                 /* ... throw it away. */
792                 release_pgd(lg->pgdirs[pgdir].pgdir + idx);
793 }
794 #ifdef CONFIG_X86_PAE
795 void guest_set_pmd(struct lguest *lg, unsigned long pmdp, u32 idx)
796 {
797         guest_pagetable_clear_all(&lg->cpus[0]);
798 }
799 #endif
800
801 /* Once we know how much memory we have we can construct simple identity
802  * (which set virtual == physical) and linear mappings
803  * which will get the Guest far enough into the boot to create its own.
804  *
805  * We lay them out of the way, just below the initrd (which is why we need to
806  * know its size here). */
807 static unsigned long setup_pagetables(struct lguest *lg,
808                                       unsigned long mem,
809                                       unsigned long initrd_size)
810 {
811         pgd_t __user *pgdir;
812         pte_t __user *linear;
813         unsigned long mem_base = (unsigned long)lg->mem_base;
814         unsigned int mapped_pages, i, linear_pages;
815 #ifdef CONFIG_X86_PAE
816         pmd_t __user *pmds;
817         unsigned int j;
818         pgd_t pgd;
819         pmd_t pmd;
820 #else
821         unsigned int phys_linear;
822 #endif
823
824         /* We have mapped_pages frames to map, so we need
825          * linear_pages page tables to map them. */
826         mapped_pages = mem / PAGE_SIZE;
827         linear_pages = (mapped_pages + PTRS_PER_PTE - 1) / PTRS_PER_PTE;
828
829         /* We put the toplevel page directory page at the top of memory. */
830         pgdir = (pgd_t *)(mem + mem_base - initrd_size - PAGE_SIZE);
831
832         /* Now we use the next linear_pages pages as pte pages */
833         linear = (void *)pgdir - linear_pages * PAGE_SIZE;
834
835 #ifdef CONFIG_X86_PAE
836         pmds = (void *)linear - PAGE_SIZE;
837 #endif
838         /* Linear mapping is easy: put every page's address into the
839          * mapping in order. */
840         for (i = 0; i < mapped_pages; i++) {
841                 pte_t pte;
842                 pte = pfn_pte(i, __pgprot(_PAGE_PRESENT|_PAGE_RW|_PAGE_USER));
843                 if (copy_to_user(&linear[i], &pte, sizeof(pte)) != 0)
844                         return -EFAULT;
845         }
846
847         /* The top level points to the linear page table pages above.
848          * We setup the identity and linear mappings here. */
849 #ifdef CONFIG_X86_PAE
850         for (i = 0, j; i < mapped_pages && j < PTRS_PER_PMD;
851              i += PTRS_PER_PTE, j++) {
852                 native_set_pmd(&pmd, __pmd(((unsigned long)(linear + i)
853                 - mem_base) | _PAGE_PRESENT | _PAGE_RW | _PAGE_USER));
854
855                 if (copy_to_user(&pmds[j], &pmd, sizeof(pmd)) != 0)
856                         return -EFAULT;
857         }
858
859         set_pgd(&pgd, __pgd(((u32)pmds - mem_base) | _PAGE_PRESENT));
860         if (copy_to_user(&pgdir[0], &pgd, sizeof(pgd)) != 0)
861                 return -EFAULT;
862         if (copy_to_user(&pgdir[3], &pgd, sizeof(pgd)) != 0)
863                 return -EFAULT;
864 #else
865         phys_linear = (unsigned long)linear - mem_base;
866         for (i = 0; i < mapped_pages; i += PTRS_PER_PTE) {
867                 pgd_t pgd;
868                 pgd = __pgd((phys_linear + i * sizeof(pte_t)) |
869                             (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER));
870
871                 if (copy_to_user(&pgdir[i / PTRS_PER_PTE], &pgd, sizeof(pgd))
872                     || copy_to_user(&pgdir[pgd_index(PAGE_OFFSET)
873                                            + i / PTRS_PER_PTE],
874                                     &pgd, sizeof(pgd)))
875                         return -EFAULT;
876         }
877 #endif
878
879         /* We return the top level (guest-physical) address: remember where
880          * this is. */
881         return (unsigned long)pgdir - mem_base;
882 }
883
884 /*H:500 (vii) Setting up the page tables initially.
885  *
886  * When a Guest is first created, the Launcher tells us where the toplevel of
887  * its first page table is.  We set some things up here: */
888 int init_guest_pagetable(struct lguest *lg)
889 {
890         u64 mem;
891         u32 initrd_size;
892         struct boot_params __user *boot = (struct boot_params *)lg->mem_base;
893 #ifdef CONFIG_X86_PAE
894         pgd_t *pgd;
895         pmd_t *pmd_table;
896 #endif
897         /* Get the Guest memory size and the ramdisk size from the boot header
898          * located at lg->mem_base (Guest address 0). */
899         if (copy_from_user(&mem, &boot->e820_map[0].size, sizeof(mem))
900             || get_user(initrd_size, &boot->hdr.ramdisk_size))
901                 return -EFAULT;
902
903         /* We start on the first shadow page table, and give it a blank PGD
904          * page. */
905         lg->pgdirs[0].gpgdir = setup_pagetables(lg, mem, initrd_size);
906         if (IS_ERR_VALUE(lg->pgdirs[0].gpgdir))
907                 return lg->pgdirs[0].gpgdir;
908         lg->pgdirs[0].pgdir = (pgd_t *)get_zeroed_page(GFP_KERNEL);
909         if (!lg->pgdirs[0].pgdir)
910                 return -ENOMEM;
911 #ifdef CONFIG_X86_PAE
912         pgd = lg->pgdirs[0].pgdir;
913         pmd_table = (pmd_t *) get_zeroed_page(GFP_KERNEL);
914         if (!pmd_table)
915                 return -ENOMEM;
916
917         set_pgd(pgd + SWITCHER_PGD_INDEX,
918                 __pgd(__pa(pmd_table) | _PAGE_PRESENT));
919 #endif
920         lg->cpus[0].cpu_pgd = 0;
921         return 0;
922 }
923
924 /* When the Guest calls LHCALL_LGUEST_INIT we do more setup. */
925 void page_table_guest_data_init(struct lg_cpu *cpu)
926 {
927         /* We get the kernel address: above this is all kernel memory. */
928         if (get_user(cpu->lg->kernel_address,
929                 &cpu->lg->lguest_data->kernel_address)
930                 /* We tell the Guest that it can't use the top 2 or 4 MB
931                  * of virtual addresses used by the Switcher. */
932                 || put_user(RESERVE_MEM * 1024 * 1024,
933                         &cpu->lg->lguest_data->reserve_mem)
934                 || put_user(cpu->lg->pgdirs[0].gpgdir,
935                         &cpu->lg->lguest_data->pgdir))
936                 kill_guest(cpu, "bad guest page %p", cpu->lg->lguest_data);
937
938         /* In flush_user_mappings() we loop from 0 to
939          * "pgd_index(lg->kernel_address)".  This assumes it won't hit the
940          * Switcher mappings, so check that now. */
941 #ifdef CONFIG_X86_PAE
942         if (pgd_index(cpu->lg->kernel_address) == SWITCHER_PGD_INDEX &&
943                 pmd_index(cpu->lg->kernel_address) == SWITCHER_PMD_INDEX)
944 #else
945         if (pgd_index(cpu->lg->kernel_address) >= SWITCHER_PGD_INDEX)
946 #endif
947                 kill_guest(cpu, "bad kernel address %#lx",
948                                  cpu->lg->kernel_address);
949 }
950
951 /* When a Guest dies, our cleanup is fairly simple. */
952 void free_guest_pagetable(struct lguest *lg)
953 {
954         unsigned int i;
955
956         /* Throw away all page table pages. */
957         release_all_pagetables(lg);
958         /* Now free the top levels: free_page() can handle 0 just fine. */
959         for (i = 0; i < ARRAY_SIZE(lg->pgdirs); i++)
960                 free_page((long)lg->pgdirs[i].pgdir);
961 }
962
963 /*H:480 (vi) Mapping the Switcher when the Guest is about to run.
964  *
965  * The Switcher and the two pages for this CPU need to be visible in the
966  * Guest (and not the pages for other CPUs).  We have the appropriate PTE pages
967  * for each CPU already set up, we just need to hook them in now we know which
968  * Guest is about to run on this CPU. */
969 void map_switcher_in_guest(struct lg_cpu *cpu, struct lguest_pages *pages)
970 {
971         pte_t *switcher_pte_page = __get_cpu_var(switcher_pte_pages);
972         pte_t regs_pte;
973         unsigned long pfn;
974
975 #ifdef CONFIG_X86_PAE
976         pmd_t switcher_pmd;
977         pmd_t *pmd_table;
978
979         native_set_pmd(&switcher_pmd, pfn_pmd(__pa(switcher_pte_page) >>
980                        PAGE_SHIFT, PAGE_KERNEL_EXEC));
981
982         pmd_table = __va(pgd_pfn(cpu->lg->
983                         pgdirs[cpu->cpu_pgd].pgdir[SWITCHER_PGD_INDEX])
984                                                                 << PAGE_SHIFT);
985         native_set_pmd(&pmd_table[SWITCHER_PMD_INDEX], switcher_pmd);
986 #else
987         pgd_t switcher_pgd;
988
989         /* Make the last PGD entry for this Guest point to the Switcher's PTE
990          * page for this CPU (with appropriate flags). */
991         switcher_pgd = __pgd(__pa(switcher_pte_page) | __PAGE_KERNEL_EXEC);
992
993         cpu->lg->pgdirs[cpu->cpu_pgd].pgdir[SWITCHER_PGD_INDEX] = switcher_pgd;
994
995 #endif
996         /* We also change the Switcher PTE page.  When we're running the Guest,
997          * we want the Guest's "regs" page to appear where the first Switcher
998          * page for this CPU is.  This is an optimization: when the Switcher
999          * saves the Guest registers, it saves them into the first page of this
1000          * CPU's "struct lguest_pages": if we make sure the Guest's register
1001          * page is already mapped there, we don't have to copy them out
1002          * again. */
1003         pfn = __pa(cpu->regs_page) >> PAGE_SHIFT;
1004         native_set_pte(&regs_pte, pfn_pte(pfn, PAGE_KERNEL));
1005         native_set_pte(&switcher_pte_page[pte_index((unsigned long)pages)],
1006                         regs_pte);
1007 }
1008 /*:*/
1009
1010 static void free_switcher_pte_pages(void)
1011 {
1012         unsigned int i;
1013
1014         for_each_possible_cpu(i)
1015                 free_page((long)switcher_pte_page(i));
1016 }
1017
1018 /*H:520 Setting up the Switcher PTE page for given CPU is fairly easy, given
1019  * the CPU number and the "struct page"s for the Switcher code itself.
1020  *
1021  * Currently the Switcher is less than a page long, so "pages" is always 1. */
1022 static __init void populate_switcher_pte_page(unsigned int cpu,
1023                                               struct page *switcher_page[],
1024                                               unsigned int pages)
1025 {
1026         unsigned int i;
1027         pte_t *pte = switcher_pte_page(cpu);
1028
1029         /* The first entries are easy: they map the Switcher code. */
1030         for (i = 0; i < pages; i++) {
1031                 native_set_pte(&pte[i], mk_pte(switcher_page[i],
1032                                 __pgprot(_PAGE_PRESENT|_PAGE_ACCESSED)));
1033         }
1034
1035         /* The only other thing we map is this CPU's pair of pages. */
1036         i = pages + cpu*2;
1037
1038         /* First page (Guest registers) is writable from the Guest */
1039         native_set_pte(&pte[i], pfn_pte(page_to_pfn(switcher_page[i]),
1040                          __pgprot(_PAGE_PRESENT|_PAGE_ACCESSED|_PAGE_RW)));
1041
1042         /* The second page contains the "struct lguest_ro_state", and is
1043          * read-only. */
1044         native_set_pte(&pte[i+1], pfn_pte(page_to_pfn(switcher_page[i+1]),
1045                            __pgprot(_PAGE_PRESENT|_PAGE_ACCESSED)));
1046 }
1047
1048 /* We've made it through the page table code.  Perhaps our tired brains are
1049  * still processing the details, or perhaps we're simply glad it's over.
1050  *
1051  * If nothing else, note that all this complexity in juggling shadow page tables
1052  * in sync with the Guest's page tables is for one reason: for most Guests this
1053  * page table dance determines how bad performance will be.  This is why Xen
1054  * uses exotic direct Guest pagetable manipulation, and why both Intel and AMD
1055  * have implemented shadow page table support directly into hardware.
1056  *
1057  * There is just one file remaining in the Host. */
1058
1059 /*H:510 At boot or module load time, init_pagetables() allocates and populates
1060  * the Switcher PTE page for each CPU. */
1061 __init int init_pagetables(struct page **switcher_page, unsigned int pages)
1062 {
1063         unsigned int i;
1064
1065         for_each_possible_cpu(i) {
1066                 switcher_pte_page(i) = (pte_t *)get_zeroed_page(GFP_KERNEL);
1067                 if (!switcher_pte_page(i)) {
1068                         free_switcher_pte_pages();
1069                         return -ENOMEM;
1070                 }
1071                 populate_switcher_pte_page(i, switcher_page, pages);
1072         }
1073         return 0;
1074 }
1075 /*:*/
1076
1077 /* Cleaning up simply involves freeing the PTE page for each CPU. */
1078 void free_pagetables(void)
1079 {
1080         free_switcher_pte_pages();
1081 }