drivers/lguest/core.c

   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. :*/
   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>
  14 #include <linux/highmem.h>
  15 #include <asm/paravirt.h>
  16 #include <asm/pgtable.h>
  17 #include <asm/uaccess.h>
  18 #include <asm/poll.h>
  19 #include <asm/asm-offsets.h>
  20 #include "lg.h"
  21
  22
  23 static struct vm_struct *switcher_vma;
  24 static struct page **switcher_page;
  25
  26 /* This One Big lock protects all inter-guest data structures. */
  27 DEFINE_MUTEX(lguest_lock);
  28
  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
  38  * it's not a simple one-liner. */
  39 static __init int map_switcher(void)
  40 {
  41         int i, err;
  42         struct page **pagep;
  43
  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. */
  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
  61         /* Now we actually allocate the pages.  The Guest will see these pages,
  62          * so we make sure they're zeroed. */
  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
  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. */
  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
  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. */
  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         }
  94
  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). */
  97         memcpy(switcher_vma->addr, start_switcher_text,
  98                end_switcher_text - start_switcher_text);
  99
 100         printk(KERN_INFO "lguest: mapped switcher at %p\n",
 101                switcher_vma->addr);
 102         /* And we succeeded... */
 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 }
 116 /*:*/
 117
 118 /* Cleaning up the mapping when the module is unloaded is almost...
 119  * too easy. */
 120 static void unmap_switcher(void)
 121 {
 122         unsigned int i;
 123
 124         /* vunmap() undoes *both* map_vm_area() and __get_vm_area(). */
 125         vunmap(switcher_vma->addr);
 126         /* Now we just need to free the pages we copied the switcher into */
 127         for (i = 0; i < TOTAL_SWITCHER_PAGES; i++)
 128                 __free_pages(switcher_page[i], 0);
 129 }
 130
 131 /*L:305
 132  * Dealing With Guest Memory.
 133  *
 134  * When the Guest gives us (what it thinks is) a physical address, we can use
 135  * the normal copy_from_user() & copy_to_user() on the corresponding place in
 136  * the memory region allocated by the Launcher.
 137  *
 138  * But we can't trust the Guest: it might be trying to access the Launcher
 139  * code.  We have to check that the range is below the pfn_limit the Launcher
 140  * gave us.  We have to make sure that addr + len doesn't give us a false
 141  * positive by overflowing, too. */
 142 int lguest_address_ok(const struct lguest *lg,
 143                       unsigned long addr, unsigned long len)
 144 {
 145         return (addr+len) / PAGE_SIZE < lg->pfn_limit && (addr+len >= addr);
 146 }
 147
 148 /* This routine copies memory from the Guest.  Here we can see how useful the
 149  * kill_lguest() routine we met in the Launcher can be: we return a random
 150  * value (all zeroes) instead of needing to return an error. */
 151 void __lgread(struct lguest *lg, void *b, unsigned long addr, unsigned bytes)
 152 {
 153         if (!lguest_address_ok(lg, addr, bytes)
 154             || copy_from_user(b, lg->mem_base + addr, bytes) != 0) {
 155                 /* copy_from_user should do this, but as we rely on it... */
 156                 memset(b, 0, bytes);
 157                 kill_guest(lg, "bad read address %#lx len %u", addr, bytes);
 158         }
 159 }
 160
 161 /* This is the write (copy into guest) version. */
 162 void __lgwrite(struct lguest *lg, unsigned long addr, const void *b,
 163                unsigned bytes)
 164 {
 165         if (!lguest_address_ok(lg, addr, bytes)
 166             || copy_to_user(lg->mem_base + addr, b, bytes) != 0)
 167                 kill_guest(lg, "bad write address %#lx len %u", addr, bytes);
 168 }
 169 /*:*/
 170
 171 /*H:030 Let's jump straight to the the main loop which runs the Guest.
 172  * Remember, this is called by the Launcher reading /dev/lguest, and we keep
 173  * going around and around until something interesting happens. */
 174 int run_guest(struct lguest *lg, unsigned long __user *user)
 175 {
 176         /* We stop running once the Guest is dead. */
 177         while (!lg->dead) {
 178                 /* First we run any hypercalls the Guest wants done. */
 179                 if (lg->hcall)
 180                         do_hypercalls(lg);
 181
 182                 /* It's possible the Guest did a NOTIFY hypercall to the
 183                  * Launcher, in which case we return from the read() now. */
 184                 if (lg->pending_notify) {
 185                         if (put_user(lg->pending_notify, user))
 186                                 return -EFAULT;
 187                         return sizeof(lg->pending_notify);
 188                 }
 189
 190                 /* Check for signals */
 191                 if (signal_pending(current))
 192                         return -ERESTARTSYS;
 193
 194                 /* If Waker set break_out, return to Launcher. */
 195                 if (lg->break_out)
 196                         return -EAGAIN;
 197
 198                 /* Check if there are any interrupts which can be delivered
 199                  * now: if so, this sets up the hander to be executed when we
 200                  * next run the Guest. */
 201                 maybe_do_interrupt(lg);
 202
 203                 /* All long-lived kernel loops need to check with this horrible
 204                  * thing called the freezer.  If the Host is trying to suspend,
 205                  * it stops us. */
 206                 try_to_freeze();
 207
 208                 /* Just make absolutely sure the Guest is still alive.  One of
 209                  * those hypercalls could have been fatal, for example. */
 210                 if (lg->dead)
 211                         break;
 212
 213                 /* If the Guest asked to be stopped, we sleep.  The Guest's
 214                  * clock timer or LHCALL_BREAK from the Waker will wake us. */
 215                 if (lg->halted) {
 216                         set_current_state(TASK_INTERRUPTIBLE);
 217                         schedule();
 218                         continue;
 219                 }
 220
 221                 /* OK, now we're ready to jump into the Guest.  First we put up
 222                  * the "Do Not Disturb" sign: */
 223                 local_irq_disable();
 224
 225                 /* Actually run the Guest until something happens. */
 226                 lguest_arch_run_guest(lg);
 227
 228                 /* Now we're ready to be interrupted or moved to other CPUs */
 229                 local_irq_enable();
 230
 231                 /* Now we deal with whatever happened to the Guest. */
 232                 lguest_arch_handle_trap(lg);
 233         }
 234
 235         /* The Guest is dead => "No such file or directory" */
 236         return -ENOENT;
 237 }
 238
 239 /*H:000
 240  * Welcome to the Host!
 241  *
 242  * By this point your brain has been tickled by the Guest code and numbed by
 243  * the Launcher code; prepare for it to be stretched by the Host code.  This is
 244  * the heart.  Let's begin at the initialization routine for the Host's lg
 245  * module.
 246  */
 247 static int __init init(void)
 248 {
 249         int err;
 250
 251         /* Lguest can't run under Xen, VMI or itself.  It does Tricky Stuff. */
 252         if (paravirt_enabled()) {
 253                 printk("lguest is afraid of %s\n", pv_info.name);
 254                 return -EPERM;
 255         }
 256
 257         /* First we put the Switcher up in very high virtual memory. */
 258         err = map_switcher();
 259         if (err)
 260                 goto out;
 261
 262         /* Now we set up the pagetable implementation for the Guests. */
 263         err = init_pagetables(switcher_page, SHARED_SWITCHER_PAGES);
 264         if (err)
 265                 goto unmap;
 266
 267         /* We might need to reserve an interrupt vector. */
 268         err = init_interrupts();
 269         if (err)
 270                 goto free_pgtables;
 271
 272         /* /dev/lguest needs to be registered. */
 273         err = lguest_device_init();
 274         if (err)
 275                 goto free_interrupts;
 276
 277         /* Finally we do some architecture-specific setup. */
 278         lguest_arch_host_init();
 279
 280         /* All good! */
 281         return 0;
 282
 283 free_interrupts:
 284         free_interrupts();
 285 free_pgtables:
 286         free_pagetables();
 287 unmap:
 288         unmap_switcher();
 289 out:
 290         return err;
 291 }
 292
 293 /* Cleaning up is just the same code, backwards.  With a little French. */
 294 static void __exit fini(void)
 295 {
 296         lguest_device_remove();
 297         free_interrupts();
 298         free_pagetables();
 299         unmap_switcher();
 300
 301         lguest_arch_host_fini();
 302 }
 303 /*:*/
 304
 305 /* The Host side of lguest can be a module.  This is a nice way for people to
 306  * play with it.  */
 307 module_init(init);
 308 module_exit(fini);
 309 MODULE_LICENSE("GPL");
 310 MODULE_AUTHOR("Rusty Russell <rusty@rustcorp.com.au>");