drivers/lguest/lguest_user.c

   1 /*P:200 This contains all the /dev/lguest code, whereby the userspace launcher
   2  * controls and communicates with the Guest.  For example, the first write will
   3  * tell us the Guest's memory layout, pagetable, entry point and kernel address
   4  * offset.  A read will run the Guest until something happens, such as a signal
   5  * or the Guest doing a NOTIFY out to the Launcher. :*/
   6 #include <linux/uaccess.h>
   7 #include <linux/miscdevice.h>
   8 #include <linux/fs.h>
   9 #include "lg.h"
  10
  11 /*L:055 When something happens, the Waker process needs a way to stop the
  12  * kernel running the Guest and return to the Launcher.  So the Waker writes
  13  * LHREQ_BREAK and the value "1" to /dev/lguest to do this.  Once the Launcher
  14  * has done whatever needs attention, it writes LHREQ_BREAK and "0" to release
  15  * the Waker. */
  16 static int break_guest_out(struct lguest *lg, const unsigned long __user *input)
  17 {
  18         unsigned long on;
  19
  20         /* Fetch whether they're turning break on or off. */
  21         if (get_user(on, input) != 0)
  22                 return -EFAULT;
  23
  24         if (on) {
  25                 lg->break_out = 1;
  26                 /* Pop it out of the Guest (may be running on different CPU) */
  27                 wake_up_process(lg->tsk);
  28                 /* Wait for them to reset it */
  29                 return wait_event_interruptible(lg->break_wq, !lg->break_out);
  30         } else {
  31                 lg->break_out = 0;
  32                 wake_up(&lg->break_wq);
  33                 return 0;
  34         }
  35 }
  36
  37 /*L:050 Sending an interrupt is done by writing LHREQ_IRQ and an interrupt
  38  * number to /dev/lguest. */
  39 static int user_send_irq(struct lguest *lg, const unsigned long __user *input)
  40 {
  41         unsigned long irq;
  42
  43         if (get_user(irq, input) != 0)
  44                 return -EFAULT;
  45         if (irq >= LGUEST_IRQS)
  46                 return -EINVAL;
  47         /* Next time the Guest runs, the core code will see if it can deliver
  48          * this interrupt. */
  49         set_bit(irq, lg->irqs_pending);
  50         return 0;
  51 }
  52
  53 /*L:040 Once our Guest is initialized, the Launcher makes it run by reading
  54  * from /dev/lguest. */
  55 static ssize_t read(struct file *file, char __user *user, size_t size,loff_t*o)
  56 {
  57         struct lguest *lg = file->private_data;
  58
  59         /* You must write LHREQ_INITIALIZE first! */
  60         if (!lg)
  61                 return -EINVAL;
  62
  63         /* If you're not the task which owns the Guest, go away. */
  64         if (current != lg->tsk)
  65                 return -EPERM;
  66
  67         /* If the guest is already dead, we indicate why */
  68         if (lg->dead) {
  69                 size_t len;
  70
  71                 /* lg->dead either contains an error code, or a string. */
  72                 if (IS_ERR(lg->dead))
  73                         return PTR_ERR(lg->dead);
  74
  75                 /* We can only return as much as the buffer they read with. */
  76                 len = min(size, strlen(lg->dead)+1);
  77                 if (copy_to_user(user, lg->dead, len) != 0)
  78                         return -EFAULT;
  79                 return len;
  80         }
  81
  82         /* If we returned from read() last time because the Guest notified,
  83          * clear the flag. */
  84         if (lg->pending_notify)
  85                 lg->pending_notify = 0;
  86
  87         /* Run the Guest until something interesting happens. */
  88         return run_guest(lg, (unsigned long __user *)user);
  89 }
  90
  91 static int lg_cpu_start(struct lg_cpu *cpu, unsigned id, unsigned long start_ip)
  92 {
  93         if (id >= NR_CPUS)
  94                 return -EINVAL;
  95
  96         cpu->id = id;
  97         cpu->lg = container_of((cpu - id), struct lguest, cpus[0]);
  98         cpu->lg->nr_cpus++;
  99
 100         return 0;
 101 }
 102
 103 /*L:020 The initialization write supplies 4 pointer sized (32 or 64 bit)
 104  * values (in addition to the LHREQ_INITIALIZE value).  These are:
 105  *
 106  * base: The start of the Guest-physical memory inside the Launcher memory.
 107  *
 108  * pfnlimit: The highest (Guest-physical) page number the Guest should be
 109  * allowed to access.  The Guest memory lives inside the Launcher, so it sets
 110  * this to ensure the Guest can only reach its own memory.
 111  *
 112  * pgdir: The (Guest-physical) address of the top of the initial Guest
 113  * pagetables (which are set up by the Launcher).
 114  *
 115  * start: The first instruction to execute ("eip" in x86-speak).
 116  */
 117 static int initialize(struct file *file, const unsigned long __user *input)
 118 {
 119         /* "struct lguest" contains everything we (the Host) know about a
 120          * Guest. */
 121         struct lguest *lg;
 122         int err;
 123         unsigned long args[4];
 124
 125         /* We grab the Big Lguest lock, which protects against multiple
 126          * simultaneous initializations. */
 127         mutex_lock(&lguest_lock);
 128         /* You can't initialize twice!  Close the device and start again... */
 129         if (file->private_data) {
 130                 err = -EBUSY;
 131                 goto unlock;
 132         }
 133
 134         if (copy_from_user(args, input, sizeof(args)) != 0) {
 135                 err = -EFAULT;
 136                 goto unlock;
 137         }
 138
 139         lg = kzalloc(sizeof(*lg), GFP_KERNEL);
 140         if (!lg) {
 141                 err = -ENOMEM;
 142                 goto unlock;
 143         }
 144
 145         /* Populate the easy fields of our "struct lguest" */
 146         lg->mem_base = (void __user *)(long)args[0];
 147         lg->pfn_limit = args[1];
 148
 149         /* This is the first cpu */
 150         err = cpu_start(&lg->cpus[0], 0, args[3]);
 151         if (err)
 152                 goto release_guest;
 153
 154         /* We need a complete page for the Guest registers: they are accessible
 155          * to the Guest and we can only grant it access to whole pages. */
 156         lg->regs_page = get_zeroed_page(GFP_KERNEL);
 157         if (!lg->regs_page) {
 158                 err = -ENOMEM;
 159                 goto release_guest;
 160         }
 161         /* We actually put the registers at the bottom of the page. */
 162         lg->regs = (void *)lg->regs_page + PAGE_SIZE - sizeof(*lg->regs);
 163
 164         /* Initialize the Guest's shadow page tables, using the toplevel
 165          * address the Launcher gave us.  This allocates memory, so can
 166          * fail. */
 167         err = init_guest_pagetable(lg, args[2]);
 168         if (err)
 169                 goto free_regs;
 170
 171         /* Now we initialize the Guest's registers, handing it the start
 172          * address. */
 173         lguest_arch_setup_regs(lg, args[3]);
 174
 175         /* The timer for lguest's clock needs initialization. */
 176         init_clockdev(lg);
 177
 178         /* We keep a pointer to the Launcher task (ie. current task) for when
 179          * other Guests want to wake this one (inter-Guest I/O). */
 180         lg->tsk = current;
 181         /* We need to keep a pointer to the Launcher's memory map, because if
 182          * the Launcher dies we need to clean it up.  If we don't keep a
 183          * reference, it is destroyed before close() is called. */
 184         lg->mm = get_task_mm(lg->tsk);
 185
 186         /* Initialize the queue for the waker to wait on */
 187         init_waitqueue_head(&lg->break_wq);
 188
 189         /* We remember which CPU's pages this Guest used last, for optimization
 190          * when the same Guest runs on the same CPU twice. */
 191         lg->last_pages = NULL;
 192
 193         /* We keep our "struct lguest" in the file's private_data. */
 194         file->private_data = lg;
 195
 196         mutex_unlock(&lguest_lock);
 197
 198         /* And because this is a write() call, we return the length used. */
 199         return sizeof(args);
 200
 201 free_regs:
 202         free_page(lg->regs_page);
 203 release_guest:
 204         kfree(lg);
 205 unlock:
 206         mutex_unlock(&lguest_lock);
 207         return err;
 208 }
 209
 210 /*L:010 The first operation the Launcher does must be a write.  All writes
 211  * start with an unsigned long number: for the first write this must be
 212  * LHREQ_INITIALIZE to set up the Guest.  After that the Launcher can use
 213  * writes of other values to send interrupts. */
 214 static ssize_t write(struct file *file, const char __user *in,
 215                      size_t size, loff_t *off)
 216 {
 217         /* Once the guest is initialized, we hold the "struct lguest" in the
 218          * file private data. */
 219         struct lguest *lg = file->private_data;
 220         const unsigned long __user *input = (const unsigned long __user *)in;
 221         unsigned long req;
 222
 223         if (get_user(req, input) != 0)
 224                 return -EFAULT;
 225         input++;
 226
 227         /* If you haven't initialized, you must do that first. */
 228         if (req != LHREQ_INITIALIZE && !lg)
 229                 return -EINVAL;
 230
 231         /* Once the Guest is dead, all you can do is read() why it died. */
 232         if (lg && lg->dead)
 233                 return -ENOENT;
 234
 235         /* If you're not the task which owns the Guest, you can only break */
 236         if (lg && current != lg->tsk && req != LHREQ_BREAK)
 237                 return -EPERM;
 238
 239         switch (req) {
 240         case LHREQ_INITIALIZE:
 241                 return initialize(file, input);
 242         case LHREQ_IRQ:
 243                 return user_send_irq(lg, input);
 244         case LHREQ_BREAK:
 245                 return break_guest_out(lg, input);
 246         default:
 247                 return -EINVAL;
 248         }
 249 }
 250
 251 /*L:060 The final piece of interface code is the close() routine.  It reverses
 252  * everything done in initialize().  This is usually called because the
 253  * Launcher exited.
 254  *
 255  * Note that the close routine returns 0 or a negative error number: it can't
 256  * really fail, but it can whine.  I blame Sun for this wart, and K&R C for
 257  * letting them do it. :*/
 258 static int close(struct inode *inode, struct file *file)
 259 {
 260         struct lguest *lg = file->private_data;
 261
 262         /* If we never successfully initialized, there's nothing to clean up */
 263         if (!lg)
 264                 return 0;
 265
 266         /* We need the big lock, to protect from inter-guest I/O and other
 267          * Launchers initializing guests. */
 268         mutex_lock(&lguest_lock);
 269         /* Cancels the hrtimer set via LHCALL_SET_CLOCKEVENT. */
 270         hrtimer_cancel(&lg->hrt);
 271         /* Free up the shadow page tables for the Guest. */
 272         free_guest_pagetable(lg);
 273         /* Now all the memory cleanups are done, it's safe to release the
 274          * Launcher's memory management structure. */
 275         mmput(lg->mm);
 276         /* If lg->dead doesn't contain an error code it will be NULL or a
 277          * kmalloc()ed string, either of which is ok to hand to kfree(). */
 278         if (!IS_ERR(lg->dead))
 279                 kfree(lg->dead);
 280         /* We can free up the register page we allocated. */
 281         free_page(lg->regs_page);
 282         /* We clear the entire structure, which also marks it as free for the
 283          * next user. */
 284         memset(lg, 0, sizeof(*lg));
 285         /* Release lock and exit. */
 286         mutex_unlock(&lguest_lock);
 287
 288         return 0;
 289 }
 290
 291 /*L:000
 292  * Welcome to our journey through the Launcher!
 293  *
 294  * The Launcher is the Host userspace program which sets up, runs and services
 295  * the Guest.  In fact, many comments in the Drivers which refer to "the Host"
 296  * doing things are inaccurate: the Launcher does all the device handling for
 297  * the Guest, but the Guest can't know that.
 298  *
 299  * Just to confuse you: to the Host kernel, the Launcher *is* the Guest and we
 300  * shall see more of that later.
 301  *
 302  * We begin our understanding with the Host kernel interface which the Launcher
 303  * uses: reading and writing a character device called /dev/lguest.  All the
 304  * work happens in the read(), write() and close() routines: */
 305 static struct file_operations lguest_fops = {
 306         .owner   = THIS_MODULE,
 307         .release = close,
 308         .write   = write,
 309         .read    = read,
 310 };
 311
 312 /* This is a textbook example of a "misc" character device.  Populate a "struct
 313  * miscdevice" and register it with misc_register(). */
 314 static struct miscdevice lguest_dev = {
 315         .minor  = MISC_DYNAMIC_MINOR,
 316         .name   = "lguest",
 317         .fops   = &lguest_fops,
 318 };
 319
 320 int __init lguest_device_init(void)
 321 {
 322         return misc_register(&lguest_dev);
 323 }
 324
 325 void __exit lguest_device_remove(void)
 326 {
 327         misc_deregister(&lguest_dev);
 328 }