]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - Documentation/lguest/lguest.c
b2bbbb7f8c57266f0d91a76235e4b98e9e2bec14
[linux-2.6-omap-h63xx.git] / Documentation / lguest / lguest.c
1 /*P:100 This is the Launcher code, a simple program which lays out the
2  * "physical" memory for the new Guest by mapping the kernel image and
3  * the virtual devices, then opens /dev/lguest to tell the kernel
4  * about the Guest and control it. :*/
5 #define _LARGEFILE64_SOURCE
6 #define _GNU_SOURCE
7 #include <stdio.h>
8 #include <string.h>
9 #include <unistd.h>
10 #include <err.h>
11 #include <stdint.h>
12 #include <stdlib.h>
13 #include <elf.h>
14 #include <sys/mman.h>
15 #include <sys/param.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18 #include <sys/wait.h>
19 #include <fcntl.h>
20 #include <stdbool.h>
21 #include <errno.h>
22 #include <ctype.h>
23 #include <sys/socket.h>
24 #include <sys/ioctl.h>
25 #include <sys/time.h>
26 #include <time.h>
27 #include <netinet/in.h>
28 #include <net/if.h>
29 #include <linux/sockios.h>
30 #include <linux/if_tun.h>
31 #include <sys/uio.h>
32 #include <termios.h>
33 #include <getopt.h>
34 #include <zlib.h>
35 #include <assert.h>
36 #include <sched.h>
37 #include <limits.h>
38 #include <stddef.h>
39 #include <signal.h>
40 #include "linux/lguest_launcher.h"
41 #include "linux/virtio_config.h"
42 #include "linux/virtio_net.h"
43 #include "linux/virtio_blk.h"
44 #include "linux/virtio_console.h"
45 #include "linux/virtio_rng.h"
46 #include "linux/virtio_ring.h"
47 #include "asm-x86/bootparam.h"
48 /*L:110 We can ignore the 39 include files we need for this program, but I do
49  * want to draw attention to the use of kernel-style types.
50  *
51  * As Linus said, "C is a Spartan language, and so should your naming be."  I
52  * like these abbreviations, so we define them here.  Note that u64 is always
53  * unsigned long long, which works on all Linux systems: this means that we can
54  * use %llu in printf for any u64. */
55 typedef unsigned long long u64;
56 typedef uint32_t u32;
57 typedef uint16_t u16;
58 typedef uint8_t u8;
59 /*:*/
60
61 #define PAGE_PRESENT 0x7        /* Present, RW, Execute */
62 #define NET_PEERNUM 1
63 #define BRIDGE_PFX "bridge:"
64 #ifndef SIOCBRADDIF
65 #define SIOCBRADDIF     0x89a2          /* add interface to bridge      */
66 #endif
67 /* We can have up to 256 pages for devices. */
68 #define DEVICE_PAGES 256
69 /* This will occupy 2 pages: it must be a power of 2. */
70 #define VIRTQUEUE_NUM 128
71
72 /*L:120 verbose is both a global flag and a macro.  The C preprocessor allows
73  * this, and although I wouldn't recommend it, it works quite nicely here. */
74 static bool verbose;
75 #define verbose(args...) \
76         do { if (verbose) printf(args); } while(0)
77 /*:*/
78
79 /* The pipe to send commands to the waker process */
80 static int waker_fd;
81 /* The pointer to the start of guest memory. */
82 static void *guest_base;
83 /* The maximum guest physical address allowed, and maximum possible. */
84 static unsigned long guest_limit, guest_max;
85 /* The pipe for signal hander to write to. */
86 static int timeoutpipe[2];
87 static unsigned int timeout_usec = 500;
88
89 /* a per-cpu variable indicating whose vcpu is currently running */
90 static unsigned int __thread cpu_id;
91
92 /* This is our list of devices. */
93 struct device_list
94 {
95         /* Summary information about the devices in our list: ready to pass to
96          * select() to ask which need servicing.*/
97         fd_set infds;
98         int max_infd;
99
100         /* Counter to assign interrupt numbers. */
101         unsigned int next_irq;
102
103         /* Counter to print out convenient device numbers. */
104         unsigned int device_num;
105
106         /* The descriptor page for the devices. */
107         u8 *descpage;
108
109         /* A single linked list of devices. */
110         struct device *dev;
111         /* And a pointer to the last device for easy append and also for
112          * configuration appending. */
113         struct device *lastdev;
114 };
115
116 /* The list of Guest devices, based on command line arguments. */
117 static struct device_list devices;
118
119 /* The device structure describes a single device. */
120 struct device
121 {
122         /* The linked-list pointer. */
123         struct device *next;
124
125         /* The this device's descriptor, as mapped into the Guest. */
126         struct lguest_device_desc *desc;
127
128         /* The name of this device, for --verbose. */
129         const char *name;
130
131         /* If handle_input is set, it wants to be called when this file
132          * descriptor is ready. */
133         int fd;
134         bool (*handle_input)(int fd, struct device *me);
135
136         /* Any queues attached to this device */
137         struct virtqueue *vq;
138
139         /* Handle status being finalized (ie. feature bits stable). */
140         void (*ready)(struct device *me);
141
142         /* Device-specific data. */
143         void *priv;
144 };
145
146 /* The virtqueue structure describes a queue attached to a device. */
147 struct virtqueue
148 {
149         struct virtqueue *next;
150
151         /* Which device owns me. */
152         struct device *dev;
153
154         /* The configuration for this queue. */
155         struct lguest_vqconfig config;
156
157         /* The actual ring of buffers. */
158         struct vring vring;
159
160         /* Last available index we saw. */
161         u16 last_avail_idx;
162
163         /* The routine to call when the Guest pings us, or timeout. */
164         void (*handle_output)(int fd, struct virtqueue *me, bool timeout);
165
166         /* Outstanding buffers */
167         unsigned int inflight;
168
169         /* Is this blocked awaiting a timer? */
170         bool blocked;
171 };
172
173 /* Remember the arguments to the program so we can "reboot" */
174 static char **main_args;
175
176 /* Since guest is UP and we don't run at the same time, we don't need barriers.
177  * But I include them in the code in case others copy it. */
178 #define wmb()
179
180 /* Convert an iovec element to the given type.
181  *
182  * This is a fairly ugly trick: we need to know the size of the type and
183  * alignment requirement to check the pointer is kosher.  It's also nice to
184  * have the name of the type in case we report failure.
185  *
186  * Typing those three things all the time is cumbersome and error prone, so we
187  * have a macro which sets them all up and passes to the real function. */
188 #define convert(iov, type) \
189         ((type *)_convert((iov), sizeof(type), __alignof__(type), #type))
190
191 static void *_convert(struct iovec *iov, size_t size, size_t align,
192                       const char *name)
193 {
194         if (iov->iov_len != size)
195                 errx(1, "Bad iovec size %zu for %s", iov->iov_len, name);
196         if ((unsigned long)iov->iov_base % align != 0)
197                 errx(1, "Bad alignment %p for %s", iov->iov_base, name);
198         return iov->iov_base;
199 }
200
201 /* Wrapper for the last available index.  Makes it easier to change. */
202 #define lg_last_avail(vq)       ((vq)->last_avail_idx)
203
204 /* The virtio configuration space is defined to be little-endian.  x86 is
205  * little-endian too, but it's nice to be explicit so we have these helpers. */
206 #define cpu_to_le16(v16) (v16)
207 #define cpu_to_le32(v32) (v32)
208 #define cpu_to_le64(v64) (v64)
209 #define le16_to_cpu(v16) (v16)
210 #define le32_to_cpu(v32) (v32)
211 #define le64_to_cpu(v64) (v64)
212
213 /* Is this iovec empty? */
214 static bool iov_empty(const struct iovec iov[], unsigned int num_iov)
215 {
216         unsigned int i;
217
218         for (i = 0; i < num_iov; i++)
219                 if (iov[i].iov_len)
220                         return false;
221         return true;
222 }
223
224 /* Take len bytes from the front of this iovec. */
225 static void iov_consume(struct iovec iov[], unsigned num_iov, unsigned len)
226 {
227         unsigned int i;
228
229         for (i = 0; i < num_iov; i++) {
230                 unsigned int used;
231
232                 used = iov[i].iov_len < len ? iov[i].iov_len : len;
233                 iov[i].iov_base += used;
234                 iov[i].iov_len -= used;
235                 len -= used;
236         }
237         assert(len == 0);
238 }
239
240 /* The device virtqueue descriptors are followed by feature bitmasks. */
241 static u8 *get_feature_bits(struct device *dev)
242 {
243         return (u8 *)(dev->desc + 1)
244                 + dev->desc->num_vq * sizeof(struct lguest_vqconfig);
245 }
246
247 /*L:100 The Launcher code itself takes us out into userspace, that scary place
248  * where pointers run wild and free!  Unfortunately, like most userspace
249  * programs, it's quite boring (which is why everyone likes to hack on the
250  * kernel!).  Perhaps if you make up an Lguest Drinking Game at this point, it
251  * will get you through this section.  Or, maybe not.
252  *
253  * The Launcher sets up a big chunk of memory to be the Guest's "physical"
254  * memory and stores it in "guest_base".  In other words, Guest physical ==
255  * Launcher virtual with an offset.
256  *
257  * This can be tough to get your head around, but usually it just means that we
258  * use these trivial conversion functions when the Guest gives us it's
259  * "physical" addresses: */
260 static void *from_guest_phys(unsigned long addr)
261 {
262         return guest_base + addr;
263 }
264
265 static unsigned long to_guest_phys(const void *addr)
266 {
267         return (addr - guest_base);
268 }
269
270 /*L:130
271  * Loading the Kernel.
272  *
273  * We start with couple of simple helper routines.  open_or_die() avoids
274  * error-checking code cluttering the callers: */
275 static int open_or_die(const char *name, int flags)
276 {
277         int fd = open(name, flags);
278         if (fd < 0)
279                 err(1, "Failed to open %s", name);
280         return fd;
281 }
282
283 /* map_zeroed_pages() takes a number of pages. */
284 static void *map_zeroed_pages(unsigned int num)
285 {
286         int fd = open_or_die("/dev/zero", O_RDONLY);
287         void *addr;
288
289         /* We use a private mapping (ie. if we write to the page, it will be
290          * copied). */
291         addr = mmap(NULL, getpagesize() * num,
292                     PROT_READ|PROT_WRITE|PROT_EXEC, MAP_PRIVATE, fd, 0);
293         if (addr == MAP_FAILED)
294                 err(1, "Mmaping %u pages of /dev/zero", num);
295         close(fd);
296
297         return addr;
298 }
299
300 /* Get some more pages for a device. */
301 static void *get_pages(unsigned int num)
302 {
303         void *addr = from_guest_phys(guest_limit);
304
305         guest_limit += num * getpagesize();
306         if (guest_limit > guest_max)
307                 errx(1, "Not enough memory for devices");
308         return addr;
309 }
310
311 /* This routine is used to load the kernel or initrd.  It tries mmap, but if
312  * that fails (Plan 9's kernel file isn't nicely aligned on page boundaries),
313  * it falls back to reading the memory in. */
314 static void map_at(int fd, void *addr, unsigned long offset, unsigned long len)
315 {
316         ssize_t r;
317
318         /* We map writable even though for some segments are marked read-only.
319          * The kernel really wants to be writable: it patches its own
320          * instructions.
321          *
322          * MAP_PRIVATE means that the page won't be copied until a write is
323          * done to it.  This allows us to share untouched memory between
324          * Guests. */
325         if (mmap(addr, len, PROT_READ|PROT_WRITE|PROT_EXEC,
326                  MAP_FIXED|MAP_PRIVATE, fd, offset) != MAP_FAILED)
327                 return;
328
329         /* pread does a seek and a read in one shot: saves a few lines. */
330         r = pread(fd, addr, len, offset);
331         if (r != len)
332                 err(1, "Reading offset %lu len %lu gave %zi", offset, len, r);
333 }
334
335 /* This routine takes an open vmlinux image, which is in ELF, and maps it into
336  * the Guest memory.  ELF = Embedded Linking Format, which is the format used
337  * by all modern binaries on Linux including the kernel.
338  *
339  * The ELF headers give *two* addresses: a physical address, and a virtual
340  * address.  We use the physical address; the Guest will map itself to the
341  * virtual address.
342  *
343  * We return the starting address. */
344 static unsigned long map_elf(int elf_fd, const Elf32_Ehdr *ehdr)
345 {
346         Elf32_Phdr phdr[ehdr->e_phnum];
347         unsigned int i;
348
349         /* Sanity checks on the main ELF header: an x86 executable with a
350          * reasonable number of correctly-sized program headers. */
351         if (ehdr->e_type != ET_EXEC
352             || ehdr->e_machine != EM_386
353             || ehdr->e_phentsize != sizeof(Elf32_Phdr)
354             || ehdr->e_phnum < 1 || ehdr->e_phnum > 65536U/sizeof(Elf32_Phdr))
355                 errx(1, "Malformed elf header");
356
357         /* An ELF executable contains an ELF header and a number of "program"
358          * headers which indicate which parts ("segments") of the program to
359          * load where. */
360
361         /* We read in all the program headers at once: */
362         if (lseek(elf_fd, ehdr->e_phoff, SEEK_SET) < 0)
363                 err(1, "Seeking to program headers");
364         if (read(elf_fd, phdr, sizeof(phdr)) != sizeof(phdr))
365                 err(1, "Reading program headers");
366
367         /* Try all the headers: there are usually only three.  A read-only one,
368          * a read-write one, and a "note" section which we don't load. */
369         for (i = 0; i < ehdr->e_phnum; i++) {
370                 /* If this isn't a loadable segment, we ignore it */
371                 if (phdr[i].p_type != PT_LOAD)
372                         continue;
373
374                 verbose("Section %i: size %i addr %p\n",
375                         i, phdr[i].p_memsz, (void *)phdr[i].p_paddr);
376
377                 /* We map this section of the file at its physical address. */
378                 map_at(elf_fd, from_guest_phys(phdr[i].p_paddr),
379                        phdr[i].p_offset, phdr[i].p_filesz);
380         }
381
382         /* The entry point is given in the ELF header. */
383         return ehdr->e_entry;
384 }
385
386 /*L:150 A bzImage, unlike an ELF file, is not meant to be loaded.  You're
387  * supposed to jump into it and it will unpack itself.  We used to have to
388  * perform some hairy magic because the unpacking code scared me.
389  *
390  * Fortunately, Jeremy Fitzhardinge convinced me it wasn't that hard and wrote
391  * a small patch to jump over the tricky bits in the Guest, so now we just read
392  * the funky header so we know where in the file to load, and away we go! */
393 static unsigned long load_bzimage(int fd)
394 {
395         struct boot_params boot;
396         int r;
397         /* Modern bzImages get loaded at 1M. */
398         void *p = from_guest_phys(0x100000);
399
400         /* Go back to the start of the file and read the header.  It should be
401          * a Linux boot header (see Documentation/i386/boot.txt) */
402         lseek(fd, 0, SEEK_SET);
403         read(fd, &boot, sizeof(boot));
404
405         /* Inside the setup_hdr, we expect the magic "HdrS" */
406         if (memcmp(&boot.hdr.header, "HdrS", 4) != 0)
407                 errx(1, "This doesn't look like a bzImage to me");
408
409         /* Skip over the extra sectors of the header. */
410         lseek(fd, (boot.hdr.setup_sects+1) * 512, SEEK_SET);
411
412         /* Now read everything into memory. in nice big chunks. */
413         while ((r = read(fd, p, 65536)) > 0)
414                 p += r;
415
416         /* Finally, code32_start tells us where to enter the kernel. */
417         return boot.hdr.code32_start;
418 }
419
420 /*L:140 Loading the kernel is easy when it's a "vmlinux", but most kernels
421  * come wrapped up in the self-decompressing "bzImage" format.  With a little
422  * work, we can load those, too. */
423 static unsigned long load_kernel(int fd)
424 {
425         Elf32_Ehdr hdr;
426
427         /* Read in the first few bytes. */
428         if (read(fd, &hdr, sizeof(hdr)) != sizeof(hdr))
429                 err(1, "Reading kernel");
430
431         /* If it's an ELF file, it starts with "\177ELF" */
432         if (memcmp(hdr.e_ident, ELFMAG, SELFMAG) == 0)
433                 return map_elf(fd, &hdr);
434
435         /* Otherwise we assume it's a bzImage, and try to load it. */
436         return load_bzimage(fd);
437 }
438
439 /* This is a trivial little helper to align pages.  Andi Kleen hated it because
440  * it calls getpagesize() twice: "it's dumb code."
441  *
442  * Kernel guys get really het up about optimization, even when it's not
443  * necessary.  I leave this code as a reaction against that. */
444 static inline unsigned long page_align(unsigned long addr)
445 {
446         /* Add upwards and truncate downwards. */
447         return ((addr + getpagesize()-1) & ~(getpagesize()-1));
448 }
449
450 /*L:180 An "initial ram disk" is a disk image loaded into memory along with
451  * the kernel which the kernel can use to boot from without needing any
452  * drivers.  Most distributions now use this as standard: the initrd contains
453  * the code to load the appropriate driver modules for the current machine.
454  *
455  * Importantly, James Morris works for RedHat, and Fedora uses initrds for its
456  * kernels.  He sent me this (and tells me when I break it). */
457 static unsigned long load_initrd(const char *name, unsigned long mem)
458 {
459         int ifd;
460         struct stat st;
461         unsigned long len;
462
463         ifd = open_or_die(name, O_RDONLY);
464         /* fstat() is needed to get the file size. */
465         if (fstat(ifd, &st) < 0)
466                 err(1, "fstat() on initrd '%s'", name);
467
468         /* We map the initrd at the top of memory, but mmap wants it to be
469          * page-aligned, so we round the size up for that. */
470         len = page_align(st.st_size);
471         map_at(ifd, from_guest_phys(mem - len), 0, st.st_size);
472         /* Once a file is mapped, you can close the file descriptor.  It's a
473          * little odd, but quite useful. */
474         close(ifd);
475         verbose("mapped initrd %s size=%lu @ %p\n", name, len, (void*)mem-len);
476
477         /* We return the initrd size. */
478         return len;
479 }
480
481 /* Once we know how much memory we have we can construct simple linear page
482  * tables which set virtual == physical which will get the Guest far enough
483  * into the boot to create its own.
484  *
485  * We lay them out of the way, just below the initrd (which is why we need to
486  * know its size here). */
487 static unsigned long setup_pagetables(unsigned long mem,
488                                       unsigned long initrd_size)
489 {
490         unsigned long *pgdir, *linear;
491         unsigned int mapped_pages, i, linear_pages;
492         unsigned int ptes_per_page = getpagesize()/sizeof(void *);
493
494         mapped_pages = mem/getpagesize();
495
496         /* Each PTE page can map ptes_per_page pages: how many do we need? */
497         linear_pages = (mapped_pages + ptes_per_page-1)/ptes_per_page;
498
499         /* We put the toplevel page directory page at the top of memory. */
500         pgdir = from_guest_phys(mem) - initrd_size - getpagesize();
501
502         /* Now we use the next linear_pages pages as pte pages */
503         linear = (void *)pgdir - linear_pages*getpagesize();
504
505         /* Linear mapping is easy: put every page's address into the mapping in
506          * order.  PAGE_PRESENT contains the flags Present, Writable and
507          * Executable. */
508         for (i = 0; i < mapped_pages; i++)
509                 linear[i] = ((i * getpagesize()) | PAGE_PRESENT);
510
511         /* The top level points to the linear page table pages above. */
512         for (i = 0; i < mapped_pages; i += ptes_per_page) {
513                 pgdir[i/ptes_per_page]
514                         = ((to_guest_phys(linear) + i*sizeof(void *))
515                            | PAGE_PRESENT);
516         }
517
518         verbose("Linear mapping of %u pages in %u pte pages at %#lx\n",
519                 mapped_pages, linear_pages, to_guest_phys(linear));
520
521         /* We return the top level (guest-physical) address: the kernel needs
522          * to know where it is. */
523         return to_guest_phys(pgdir);
524 }
525 /*:*/
526
527 /* Simple routine to roll all the commandline arguments together with spaces
528  * between them. */
529 static void concat(char *dst, char *args[])
530 {
531         unsigned int i, len = 0;
532
533         for (i = 0; args[i]; i++) {
534                 if (i) {
535                         strcat(dst+len, " ");
536                         len++;
537                 }
538                 strcpy(dst+len, args[i]);
539                 len += strlen(args[i]);
540         }
541         /* In case it's empty. */
542         dst[len] = '\0';
543 }
544
545 /*L:185 This is where we actually tell the kernel to initialize the Guest.  We
546  * saw the arguments it expects when we looked at initialize() in lguest_user.c:
547  * the base of Guest "physical" memory, the top physical page to allow, the
548  * top level pagetable and the entry point for the Guest. */
549 static int tell_kernel(unsigned long pgdir, unsigned long start)
550 {
551         unsigned long args[] = { LHREQ_INITIALIZE,
552                                  (unsigned long)guest_base,
553                                  guest_limit / getpagesize(), pgdir, start };
554         int fd;
555
556         verbose("Guest: %p - %p (%#lx)\n",
557                 guest_base, guest_base + guest_limit, guest_limit);
558         fd = open_or_die("/dev/lguest", O_RDWR);
559         if (write(fd, args, sizeof(args)) < 0)
560                 err(1, "Writing to /dev/lguest");
561
562         /* We return the /dev/lguest file descriptor to control this Guest */
563         return fd;
564 }
565 /*:*/
566
567 static void add_device_fd(int fd)
568 {
569         FD_SET(fd, &devices.infds);
570         if (fd > devices.max_infd)
571                 devices.max_infd = fd;
572 }
573
574 /*L:200
575  * The Waker.
576  *
577  * With console, block and network devices, we can have lots of input which we
578  * need to process.  We could try to tell the kernel what file descriptors to
579  * watch, but handing a file descriptor mask through to the kernel is fairly
580  * icky.
581  *
582  * Instead, we fork off a process which watches the file descriptors and writes
583  * the LHREQ_BREAK command to the /dev/lguest file descriptor to tell the Host
584  * stop running the Guest.  This causes the Launcher to return from the
585  * /dev/lguest read with -EAGAIN, where it will write to /dev/lguest to reset
586  * the LHREQ_BREAK and wake us up again.
587  *
588  * This, of course, is merely a different *kind* of icky.
589  */
590 static void wake_parent(int pipefd, int lguest_fd)
591 {
592         /* Add the pipe from the Launcher to the fdset in the device_list, so
593          * we watch it, too. */
594         add_device_fd(pipefd);
595
596         for (;;) {
597                 fd_set rfds = devices.infds;
598                 unsigned long args[] = { LHREQ_BREAK, 1 };
599
600                 /* Wait until input is ready from one of the devices. */
601                 select(devices.max_infd+1, &rfds, NULL, NULL, NULL);
602                 /* Is it a message from the Launcher? */
603                 if (FD_ISSET(pipefd, &rfds)) {
604                         int fd;
605                         /* If read() returns 0, it means the Launcher has
606                          * exited.  We silently follow. */
607                         if (read(pipefd, &fd, sizeof(fd)) == 0)
608                                 exit(0);
609                         /* Otherwise it's telling us to change what file
610                          * descriptors we're to listen to.  Positive means
611                          * listen to a new one, negative means stop
612                          * listening. */
613                         if (fd >= 0)
614                                 FD_SET(fd, &devices.infds);
615                         else
616                                 FD_CLR(-fd - 1, &devices.infds);
617                 } else /* Send LHREQ_BREAK command. */
618                         pwrite(lguest_fd, args, sizeof(args), cpu_id);
619         }
620 }
621
622 /* This routine just sets up a pipe to the Waker process. */
623 static int setup_waker(int lguest_fd)
624 {
625         int pipefd[2], child;
626
627         /* We create a pipe to talk to the Waker, and also so it knows when the
628          * Launcher dies (and closes pipe). */
629         pipe(pipefd);
630         child = fork();
631         if (child == -1)
632                 err(1, "forking");
633
634         if (child == 0) {
635                 /* We are the Waker: close the "writing" end of our copy of the
636                  * pipe and start waiting for input. */
637                 close(pipefd[1]);
638                 wake_parent(pipefd[0], lguest_fd);
639         }
640         /* Close the reading end of our copy of the pipe. */
641         close(pipefd[0]);
642
643         /* Here is the fd used to talk to the waker. */
644         return pipefd[1];
645 }
646
647 /*
648  * Device Handling.
649  *
650  * When the Guest gives us a buffer, it sends an array of addresses and sizes.
651  * We need to make sure it's not trying to reach into the Launcher itself, so
652  * we have a convenient routine which checks it and exits with an error message
653  * if something funny is going on:
654  */
655 static void *_check_pointer(unsigned long addr, unsigned int size,
656                             unsigned int line)
657 {
658         /* We have to separately check addr and addr+size, because size could
659          * be huge and addr + size might wrap around. */
660         if (addr >= guest_limit || addr + size >= guest_limit)
661                 errx(1, "%s:%i: Invalid address %#lx", __FILE__, line, addr);
662         /* We return a pointer for the caller's convenience, now we know it's
663          * safe to use. */
664         return from_guest_phys(addr);
665 }
666 /* A macro which transparently hands the line number to the real function. */
667 #define check_pointer(addr,size) _check_pointer(addr, size, __LINE__)
668
669 /* Each buffer in the virtqueues is actually a chain of descriptors.  This
670  * function returns the next descriptor in the chain, or vq->vring.num if we're
671  * at the end. */
672 static unsigned next_desc(struct virtqueue *vq, unsigned int i)
673 {
674         unsigned int next;
675
676         /* If this descriptor says it doesn't chain, we're done. */
677         if (!(vq->vring.desc[i].flags & VRING_DESC_F_NEXT))
678                 return vq->vring.num;
679
680         /* Check they're not leading us off end of descriptors. */
681         next = vq->vring.desc[i].next;
682         /* Make sure compiler knows to grab that: we don't want it changing! */
683         wmb();
684
685         if (next >= vq->vring.num)
686                 errx(1, "Desc next is %u", next);
687
688         return next;
689 }
690
691 /* This looks in the virtqueue and for the first available buffer, and converts
692  * it to an iovec for convenient access.  Since descriptors consist of some
693  * number of output then some number of input descriptors, it's actually two
694  * iovecs, but we pack them into one and note how many of each there were.
695  *
696  * This function returns the descriptor number found, or vq->vring.num (which
697  * is never a valid descriptor number) if none was found. */
698 static unsigned get_vq_desc(struct virtqueue *vq,
699                             struct iovec iov[],
700                             unsigned int *out_num, unsigned int *in_num)
701 {
702         unsigned int i, head;
703         u16 last_avail;
704
705         /* Check it isn't doing very strange things with descriptor numbers. */
706         last_avail = lg_last_avail(vq);
707         if ((u16)(vq->vring.avail->idx - last_avail) > vq->vring.num)
708                 errx(1, "Guest moved used index from %u to %u",
709                      last_avail, vq->vring.avail->idx);
710
711         /* If there's nothing new since last we looked, return invalid. */
712         if (vq->vring.avail->idx == last_avail)
713                 return vq->vring.num;
714
715         /* Grab the next descriptor number they're advertising, and increment
716          * the index we've seen. */
717         head = vq->vring.avail->ring[last_avail % vq->vring.num];
718         lg_last_avail(vq)++;
719
720         /* If their number is silly, that's a fatal mistake. */
721         if (head >= vq->vring.num)
722                 errx(1, "Guest says index %u is available", head);
723
724         /* When we start there are none of either input nor output. */
725         *out_num = *in_num = 0;
726
727         i = head;
728         do {
729                 /* Grab the first descriptor, and check it's OK. */
730                 iov[*out_num + *in_num].iov_len = vq->vring.desc[i].len;
731                 iov[*out_num + *in_num].iov_base
732                         = check_pointer(vq->vring.desc[i].addr,
733                                         vq->vring.desc[i].len);
734                 /* If this is an input descriptor, increment that count. */
735                 if (vq->vring.desc[i].flags & VRING_DESC_F_WRITE)
736                         (*in_num)++;
737                 else {
738                         /* If it's an output descriptor, they're all supposed
739                          * to come before any input descriptors. */
740                         if (*in_num)
741                                 errx(1, "Descriptor has out after in");
742                         (*out_num)++;
743                 }
744
745                 /* If we've got too many, that implies a descriptor loop. */
746                 if (*out_num + *in_num > vq->vring.num)
747                         errx(1, "Looped descriptor");
748         } while ((i = next_desc(vq, i)) != vq->vring.num);
749
750         vq->inflight++;
751         return head;
752 }
753
754 /* After we've used one of their buffers, we tell them about it.  We'll then
755  * want to send them an interrupt, using trigger_irq(). */
756 static void add_used(struct virtqueue *vq, unsigned int head, int len)
757 {
758         struct vring_used_elem *used;
759
760         /* The virtqueue contains a ring of used buffers.  Get a pointer to the
761          * next entry in that used ring. */
762         used = &vq->vring.used->ring[vq->vring.used->idx % vq->vring.num];
763         used->id = head;
764         used->len = len;
765         /* Make sure buffer is written before we update index. */
766         wmb();
767         vq->vring.used->idx++;
768         vq->inflight--;
769 }
770
771 /* This actually sends the interrupt for this virtqueue */
772 static void trigger_irq(int fd, struct virtqueue *vq)
773 {
774         unsigned long buf[] = { LHREQ_IRQ, vq->config.irq };
775
776         /* If they don't want an interrupt, don't send one, unless empty. */
777         if ((vq->vring.avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
778             && vq->inflight)
779                 return;
780
781         /* Send the Guest an interrupt tell them we used something up. */
782         if (write(fd, buf, sizeof(buf)) != 0)
783                 err(1, "Triggering irq %i", vq->config.irq);
784 }
785
786 /* And here's the combo meal deal.  Supersize me! */
787 static void add_used_and_trigger(int fd, struct virtqueue *vq,
788                                  unsigned int head, int len)
789 {
790         add_used(vq, head, len);
791         trigger_irq(fd, vq);
792 }
793
794 /*
795  * The Console
796  *
797  * Here is the input terminal setting we save, and the routine to restore them
798  * on exit so the user gets their terminal back. */
799 static struct termios orig_term;
800 static void restore_term(void)
801 {
802         tcsetattr(STDIN_FILENO, TCSANOW, &orig_term);
803 }
804
805 /* We associate some data with the console for our exit hack. */
806 struct console_abort
807 {
808         /* How many times have they hit ^C? */
809         int count;
810         /* When did they start? */
811         struct timeval start;
812 };
813
814 /* This is the routine which handles console input (ie. stdin). */
815 static bool handle_console_input(int fd, struct device *dev)
816 {
817         int len;
818         unsigned int head, in_num, out_num;
819         struct iovec iov[dev->vq->vring.num];
820         struct console_abort *abort = dev->priv;
821
822         /* First we need a console buffer from the Guests's input virtqueue. */
823         head = get_vq_desc(dev->vq, iov, &out_num, &in_num);
824
825         /* If they're not ready for input, stop listening to this file
826          * descriptor.  We'll start again once they add an input buffer. */
827         if (head == dev->vq->vring.num)
828                 return false;
829
830         if (out_num)
831                 errx(1, "Output buffers in console in queue?");
832
833         /* This is why we convert to iovecs: the readv() call uses them, and so
834          * it reads straight into the Guest's buffer. */
835         len = readv(dev->fd, iov, in_num);
836         if (len <= 0) {
837                 /* This implies that the console is closed, is /dev/null, or
838                  * something went terribly wrong. */
839                 warnx("Failed to get console input, ignoring console.");
840                 /* Put the input terminal back. */
841                 restore_term();
842                 /* Remove callback from input vq, so it doesn't restart us. */
843                 dev->vq->handle_output = NULL;
844                 /* Stop listening to this fd: don't call us again. */
845                 return false;
846         }
847
848         /* Tell the Guest about the new input. */
849         add_used_and_trigger(fd, dev->vq, head, len);
850
851         /* Three ^C within one second?  Exit.
852          *
853          * This is such a hack, but works surprisingly well.  Each ^C has to be
854          * in a buffer by itself, so they can't be too fast.  But we check that
855          * we get three within about a second, so they can't be too slow. */
856         if (len == 1 && ((char *)iov[0].iov_base)[0] == 3) {
857                 if (!abort->count++)
858                         gettimeofday(&abort->start, NULL);
859                 else if (abort->count == 3) {
860                         struct timeval now;
861                         gettimeofday(&now, NULL);
862                         if (now.tv_sec <= abort->start.tv_sec+1) {
863                                 unsigned long args[] = { LHREQ_BREAK, 0 };
864                                 /* Close the fd so Waker will know it has to
865                                  * exit. */
866                                 close(waker_fd);
867                                 /* Just in case waker is blocked in BREAK, send
868                                  * unbreak now. */
869                                 write(fd, args, sizeof(args));
870                                 exit(2);
871                         }
872                         abort->count = 0;
873                 }
874         } else
875                 /* Any other key resets the abort counter. */
876                 abort->count = 0;
877
878         /* Everything went OK! */
879         return true;
880 }
881
882 /* Handling output for console is simple: we just get all the output buffers
883  * and write them to stdout. */
884 static void handle_console_output(int fd, struct virtqueue *vq, bool timeout)
885 {
886         unsigned int head, out, in;
887         int len;
888         struct iovec iov[vq->vring.num];
889
890         /* Keep getting output buffers from the Guest until we run out. */
891         while ((head = get_vq_desc(vq, iov, &out, &in)) != vq->vring.num) {
892                 if (in)
893                         errx(1, "Input buffers in output queue?");
894                 len = writev(STDOUT_FILENO, iov, out);
895                 add_used_and_trigger(fd, vq, head, len);
896         }
897 }
898
899 static void block_vq(struct virtqueue *vq)
900 {
901         struct itimerval itm;
902
903         vq->vring.used->flags |= VRING_USED_F_NO_NOTIFY;
904         vq->blocked = true;
905
906         itm.it_interval.tv_sec = 0;
907         itm.it_interval.tv_usec = 0;
908         itm.it_value.tv_sec = 0;
909         itm.it_value.tv_usec = timeout_usec;
910
911         setitimer(ITIMER_REAL, &itm, NULL);
912 }
913
914 /*
915  * The Network
916  *
917  * Handling output for network is also simple: we get all the output buffers
918  * and write them (ignoring the first element) to this device's file descriptor
919  * (/dev/net/tun).
920  */
921 static void handle_net_output(int fd, struct virtqueue *vq, bool timeout)
922 {
923         unsigned int head, out, in, num = 0;
924         int len;
925         struct iovec iov[vq->vring.num];
926         static int last_timeout_num;
927
928         /* Keep getting output buffers from the Guest until we run out. */
929         while ((head = get_vq_desc(vq, iov, &out, &in)) != vq->vring.num) {
930                 if (in)
931                         errx(1, "Input buffers in output queue?");
932                 /* Check header, but otherwise ignore it (we told the Guest we
933                  * supported no features, so it shouldn't have anything
934                  * interesting). */
935                 (void)convert(&iov[0], struct virtio_net_hdr);
936                 len = writev(vq->dev->fd, iov+1, out-1);
937                 add_used_and_trigger(fd, vq, head, len);
938                 num++;
939         }
940
941         /* Block further kicks and set up a timer if we saw anything. */
942         if (!timeout && num)
943                 block_vq(vq);
944
945         if (timeout) {
946                 if (num < last_timeout_num)
947                         timeout_usec += 10;
948                 else if (timeout_usec > 1)
949                         timeout_usec--;
950                 last_timeout_num = num;
951         }
952 }
953
954 /* This is where we handle a packet coming in from the tun device to our
955  * Guest. */
956 static bool handle_tun_input(int fd, struct device *dev)
957 {
958         unsigned int head, in_num, out_num;
959         int len;
960         struct iovec iov[dev->vq->vring.num];
961         struct virtio_net_hdr *hdr;
962
963         /* First we need a network buffer from the Guests's recv virtqueue. */
964         head = get_vq_desc(dev->vq, iov, &out_num, &in_num);
965         if (head == dev->vq->vring.num) {
966                 /* Now, it's expected that if we try to send a packet too
967                  * early, the Guest won't be ready yet.  Wait until the device
968                  * status says it's ready. */
969                 /* FIXME: Actually want DRIVER_ACTIVE here. */
970                 if (dev->desc->status & VIRTIO_CONFIG_S_DRIVER_OK)
971                         warn("network: no dma buffer!");
972
973                 /* Now tell it we want to know if new things appear. */
974                 dev->vq->vring.used->flags &= ~VRING_USED_F_NO_NOTIFY;
975                 wmb();
976
977                 /* We'll turn this back on if input buffers are registered. */
978                 return false;
979         } else if (out_num)
980                 errx(1, "Output buffers in network recv queue?");
981
982         /* First element is the header: we set it to 0 (no features). */
983         hdr = convert(&iov[0], struct virtio_net_hdr);
984         hdr->flags = 0;
985         hdr->gso_type = VIRTIO_NET_HDR_GSO_NONE;
986
987         /* Read the packet from the device directly into the Guest's buffer. */
988         len = readv(dev->fd, iov+1, in_num-1);
989         if (len <= 0)
990                 err(1, "reading network");
991
992         /* Tell the Guest about the new packet. */
993         add_used_and_trigger(fd, dev->vq, head, sizeof(*hdr) + len);
994
995         verbose("tun input packet len %i [%02x %02x] (%s)\n", len,
996                 ((u8 *)iov[1].iov_base)[0], ((u8 *)iov[1].iov_base)[1],
997                 head != dev->vq->vring.num ? "sent" : "discarded");
998
999         /* All good. */
1000         return true;
1001 }
1002
1003 /*L:215 This is the callback attached to the network and console input
1004  * virtqueues: it ensures we try again, in case we stopped console or net
1005  * delivery because Guest didn't have any buffers. */
1006 static void enable_fd(int fd, struct virtqueue *vq, bool timeout)
1007 {
1008         add_device_fd(vq->dev->fd);
1009         /* Tell waker to listen to it again */
1010         write(waker_fd, &vq->dev->fd, sizeof(vq->dev->fd));
1011 }
1012
1013 static void net_enable_fd(int fd, struct virtqueue *vq, bool timeout)
1014 {
1015         /* We don't need to know again when Guest refills receive buffer. */
1016         vq->vring.used->flags |= VRING_USED_F_NO_NOTIFY;
1017         enable_fd(fd, vq, timeout);
1018 }
1019
1020 /* When the Guest tells us they updated the status field, we handle it. */
1021 static void update_device_status(struct device *dev)
1022 {
1023         struct virtqueue *vq;
1024
1025         /* This is a reset. */
1026         if (dev->desc->status == 0) {
1027                 verbose("Resetting device %s\n", dev->name);
1028
1029                 /* Clear any features they've acked. */
1030                 memset(get_feature_bits(dev) + dev->desc->feature_len, 0,
1031                        dev->desc->feature_len);
1032
1033                 /* Zero out the virtqueues. */
1034                 for (vq = dev->vq; vq; vq = vq->next) {
1035                         memset(vq->vring.desc, 0,
1036                                vring_size(vq->config.num, getpagesize()));
1037                         lg_last_avail(vq) = 0;
1038                 }
1039         } else if (dev->desc->status & VIRTIO_CONFIG_S_FAILED) {
1040                 warnx("Device %s configuration FAILED", dev->name);
1041         } else if (dev->desc->status & VIRTIO_CONFIG_S_DRIVER_OK) {
1042                 unsigned int i;
1043
1044                 verbose("Device %s OK: offered", dev->name);
1045                 for (i = 0; i < dev->desc->feature_len; i++)
1046                         verbose(" %02x", get_feature_bits(dev)[i]);
1047                 verbose(", accepted");
1048                 for (i = 0; i < dev->desc->feature_len; i++)
1049                         verbose(" %02x", get_feature_bits(dev)
1050                                 [dev->desc->feature_len+i]);
1051
1052                 if (dev->ready)
1053                         dev->ready(dev);
1054         }
1055 }
1056
1057 /* This is the generic routine we call when the Guest uses LHCALL_NOTIFY. */
1058 static void handle_output(int fd, unsigned long addr)
1059 {
1060         struct device *i;
1061         struct virtqueue *vq;
1062
1063         /* Check each device and virtqueue. */
1064         for (i = devices.dev; i; i = i->next) {
1065                 /* Notifications to device descriptors update device status. */
1066                 if (from_guest_phys(addr) == i->desc) {
1067                         update_device_status(i);
1068                         return;
1069                 }
1070
1071                 /* Notifications to virtqueues mean output has occurred. */
1072                 for (vq = i->vq; vq; vq = vq->next) {
1073                         if (vq->config.pfn != addr/getpagesize())
1074                                 continue;
1075
1076                         /* Guest should acknowledge (and set features!)  before
1077                          * using the device. */
1078                         if (i->desc->status == 0) {
1079                                 warnx("%s gave early output", i->name);
1080                                 return;
1081                         }
1082
1083                         if (strcmp(vq->dev->name, "console") != 0)
1084                                 verbose("Output to %s\n", vq->dev->name);
1085                         if (vq->handle_output)
1086                                 vq->handle_output(fd, vq, false);
1087                         return;
1088                 }
1089         }
1090
1091         /* Early console write is done using notify on a nul-terminated string
1092          * in Guest memory. */
1093         if (addr >= guest_limit)
1094                 errx(1, "Bad NOTIFY %#lx", addr);
1095
1096         write(STDOUT_FILENO, from_guest_phys(addr),
1097               strnlen(from_guest_phys(addr), guest_limit - addr));
1098 }
1099
1100 static void handle_timeout(int fd)
1101 {
1102         char buf[32];
1103         struct device *i;
1104         struct virtqueue *vq;
1105
1106         /* Clear the pipe */
1107         read(timeoutpipe[0], buf, sizeof(buf));
1108
1109         /* Check each device and virtqueue: flush blocked ones. */
1110         for (i = devices.dev; i; i = i->next) {
1111                 for (vq = i->vq; vq; vq = vq->next) {
1112                         if (!vq->blocked)
1113                                 continue;
1114
1115                         vq->vring.used->flags &= ~VRING_USED_F_NO_NOTIFY;
1116                         vq->blocked = false;
1117                         if (vq->handle_output)
1118                                 vq->handle_output(fd, vq, true);
1119                 }
1120         }
1121 }
1122
1123 /* This is called when the Waker wakes us up: check for incoming file
1124  * descriptors. */
1125 static void handle_input(int fd)
1126 {
1127         /* select() wants a zeroed timeval to mean "don't wait". */
1128         struct timeval poll = { .tv_sec = 0, .tv_usec = 0 };
1129
1130         for (;;) {
1131                 struct device *i;
1132                 fd_set fds = devices.infds;
1133                 int num;
1134
1135                 num = select(devices.max_infd+1, &fds, NULL, NULL, &poll);
1136                 /* Could get interrupted */
1137                 if (num < 0)
1138                         continue;
1139                 /* If nothing is ready, we're done. */
1140                 if (num == 0)
1141                         break;
1142
1143                 /* Otherwise, call the device(s) which have readable file
1144                  * descriptors and a method of handling them.  */
1145                 for (i = devices.dev; i; i = i->next) {
1146                         if (i->handle_input && FD_ISSET(i->fd, &fds)) {
1147                                 int dev_fd;
1148                                 if (i->handle_input(fd, i))
1149                                         continue;
1150
1151                                 /* If handle_input() returns false, it means we
1152                                  * should no longer service it.  Networking and
1153                                  * console do this when there's no input
1154                                  * buffers to deliver into.  Console also uses
1155                                  * it when it discovers that stdin is closed. */
1156                                 FD_CLR(i->fd, &devices.infds);
1157                                 /* Tell waker to ignore it too, by sending a
1158                                  * negative fd number (-1, since 0 is a valid
1159                                  * FD number). */
1160                                 dev_fd = -i->fd - 1;
1161                                 write(waker_fd, &dev_fd, sizeof(dev_fd));
1162                         }
1163                 }
1164
1165                 /* Is this the timeout fd? */
1166                 if (FD_ISSET(timeoutpipe[0], &fds))
1167                         handle_timeout(fd);
1168         }
1169 }
1170
1171 /*L:190
1172  * Device Setup
1173  *
1174  * All devices need a descriptor so the Guest knows it exists, and a "struct
1175  * device" so the Launcher can keep track of it.  We have common helper
1176  * routines to allocate and manage them.
1177  */
1178
1179 /* The layout of the device page is a "struct lguest_device_desc" followed by a
1180  * number of virtqueue descriptors, then two sets of feature bits, then an
1181  * array of configuration bytes.  This routine returns the configuration
1182  * pointer. */
1183 static u8 *device_config(const struct device *dev)
1184 {
1185         return (void *)(dev->desc + 1)
1186                 + dev->desc->num_vq * sizeof(struct lguest_vqconfig)
1187                 + dev->desc->feature_len * 2;
1188 }
1189
1190 /* This routine allocates a new "struct lguest_device_desc" from descriptor
1191  * table page just above the Guest's normal memory.  It returns a pointer to
1192  * that descriptor. */
1193 static struct lguest_device_desc *new_dev_desc(u16 type)
1194 {
1195         struct lguest_device_desc d = { .type = type };
1196         void *p;
1197
1198         /* Figure out where the next device config is, based on the last one. */
1199         if (devices.lastdev)
1200                 p = device_config(devices.lastdev)
1201                         + devices.lastdev->desc->config_len;
1202         else
1203                 p = devices.descpage;
1204
1205         /* We only have one page for all the descriptors. */
1206         if (p + sizeof(d) > (void *)devices.descpage + getpagesize())
1207                 errx(1, "Too many devices");
1208
1209         /* p might not be aligned, so we memcpy in. */
1210         return memcpy(p, &d, sizeof(d));
1211 }
1212
1213 /* Each device descriptor is followed by the description of its virtqueues.  We
1214  * specify how many descriptors the virtqueue is to have. */
1215 static void add_virtqueue(struct device *dev, unsigned int num_descs,
1216                           void (*handle_output)(int, struct virtqueue *, bool))
1217 {
1218         unsigned int pages;
1219         struct virtqueue **i, *vq = malloc(sizeof(*vq));
1220         void *p;
1221
1222         /* First we need some memory for this virtqueue. */
1223         pages = (vring_size(num_descs, getpagesize()) + getpagesize() - 1)
1224                 / getpagesize();
1225         p = get_pages(pages);
1226
1227         /* Initialize the virtqueue */
1228         vq->next = NULL;
1229         vq->last_avail_idx = 0;
1230         vq->dev = dev;
1231         vq->inflight = 0;
1232         vq->blocked = false;
1233
1234         /* Initialize the configuration. */
1235         vq->config.num = num_descs;
1236         vq->config.irq = devices.next_irq++;
1237         vq->config.pfn = to_guest_phys(p) / getpagesize();
1238
1239         /* Initialize the vring. */
1240         vring_init(&vq->vring, num_descs, p, getpagesize());
1241
1242         /* Append virtqueue to this device's descriptor.  We use
1243          * device_config() to get the end of the device's current virtqueues;
1244          * we check that we haven't added any config or feature information
1245          * yet, otherwise we'd be overwriting them. */
1246         assert(dev->desc->config_len == 0 && dev->desc->feature_len == 0);
1247         memcpy(device_config(dev), &vq->config, sizeof(vq->config));
1248         dev->desc->num_vq++;
1249
1250         verbose("Virtqueue page %#lx\n", to_guest_phys(p));
1251
1252         /* Add to tail of list, so dev->vq is first vq, dev->vq->next is
1253          * second.  */
1254         for (i = &dev->vq; *i; i = &(*i)->next);
1255         *i = vq;
1256
1257         /* Set the routine to call when the Guest does something to this
1258          * virtqueue. */
1259         vq->handle_output = handle_output;
1260
1261         /* As an optimization, set the advisory "Don't Notify Me" flag if we
1262          * don't have a handler */
1263         if (!handle_output)
1264                 vq->vring.used->flags = VRING_USED_F_NO_NOTIFY;
1265 }
1266
1267 /* The first half of the feature bitmask is for us to advertise features.  The
1268  * second half is for the Guest to accept features. */
1269 static void add_feature(struct device *dev, unsigned bit)
1270 {
1271         u8 *features = get_feature_bits(dev);
1272
1273         /* We can't extend the feature bits once we've added config bytes */
1274         if (dev->desc->feature_len <= bit / CHAR_BIT) {
1275                 assert(dev->desc->config_len == 0);
1276                 dev->desc->feature_len = (bit / CHAR_BIT) + 1;
1277         }
1278
1279         features[bit / CHAR_BIT] |= (1 << (bit % CHAR_BIT));
1280 }
1281
1282 /* This routine sets the configuration fields for an existing device's
1283  * descriptor.  It only works for the last device, but that's OK because that's
1284  * how we use it. */
1285 static void set_config(struct device *dev, unsigned len, const void *conf)
1286 {
1287         /* Check we haven't overflowed our single page. */
1288         if (device_config(dev) + len > devices.descpage + getpagesize())
1289                 errx(1, "Too many devices");
1290
1291         /* Copy in the config information, and store the length. */
1292         memcpy(device_config(dev), conf, len);
1293         dev->desc->config_len = len;
1294 }
1295
1296 /* This routine does all the creation and setup of a new device, including
1297  * calling new_dev_desc() to allocate the descriptor and device memory.
1298  *
1299  * See what I mean about userspace being boring? */
1300 static struct device *new_device(const char *name, u16 type, int fd,
1301                                  bool (*handle_input)(int, struct device *))
1302 {
1303         struct device *dev = malloc(sizeof(*dev));
1304
1305         /* Now we populate the fields one at a time. */
1306         dev->fd = fd;
1307         /* If we have an input handler for this file descriptor, then we add it
1308          * to the device_list's fdset and maxfd. */
1309         if (handle_input)
1310                 add_device_fd(dev->fd);
1311         dev->desc = new_dev_desc(type);
1312         dev->handle_input = handle_input;
1313         dev->name = name;
1314         dev->vq = NULL;
1315         dev->ready = NULL;
1316
1317         /* Append to device list.  Prepending to a single-linked list is
1318          * easier, but the user expects the devices to be arranged on the bus
1319          * in command-line order.  The first network device on the command line
1320          * is eth0, the first block device /dev/vda, etc. */
1321         if (devices.lastdev)
1322                 devices.lastdev->next = dev;
1323         else
1324                 devices.dev = dev;
1325         devices.lastdev = dev;
1326
1327         return dev;
1328 }
1329
1330 /* Our first setup routine is the console.  It's a fairly simple device, but
1331  * UNIX tty handling makes it uglier than it could be. */
1332 static void setup_console(void)
1333 {
1334         struct device *dev;
1335
1336         /* If we can save the initial standard input settings... */
1337         if (tcgetattr(STDIN_FILENO, &orig_term) == 0) {
1338                 struct termios term = orig_term;
1339                 /* Then we turn off echo, line buffering and ^C etc.  We want a
1340                  * raw input stream to the Guest. */
1341                 term.c_lflag &= ~(ISIG|ICANON|ECHO);
1342                 tcsetattr(STDIN_FILENO, TCSANOW, &term);
1343                 /* If we exit gracefully, the original settings will be
1344                  * restored so the user can see what they're typing. */
1345                 atexit(restore_term);
1346         }
1347
1348         dev = new_device("console", VIRTIO_ID_CONSOLE,
1349                          STDIN_FILENO, handle_console_input);
1350         /* We store the console state in dev->priv, and initialize it. */
1351         dev->priv = malloc(sizeof(struct console_abort));
1352         ((struct console_abort *)dev->priv)->count = 0;
1353
1354         /* The console needs two virtqueues: the input then the output.  When
1355          * they put something the input queue, we make sure we're listening to
1356          * stdin.  When they put something in the output queue, we write it to
1357          * stdout. */
1358         add_virtqueue(dev, VIRTQUEUE_NUM, enable_fd);
1359         add_virtqueue(dev, VIRTQUEUE_NUM, handle_console_output);
1360
1361         verbose("device %u: console\n", devices.device_num++);
1362 }
1363 /*:*/
1364
1365 static void timeout_alarm(int sig)
1366 {
1367         write(timeoutpipe[1], "", 1);
1368 }
1369
1370 static void setup_timeout(void)
1371 {
1372         if (pipe(timeoutpipe) != 0)
1373                 err(1, "Creating timeout pipe");
1374
1375         if (fcntl(timeoutpipe[1], F_SETFL,
1376                   fcntl(timeoutpipe[1], F_GETFL) | O_NONBLOCK) != 0)
1377                 err(1, "Making timeout pipe nonblocking");
1378
1379         add_device_fd(timeoutpipe[0]);
1380         signal(SIGALRM, timeout_alarm);
1381 }
1382
1383 /*M:010 Inter-guest networking is an interesting area.  Simplest is to have a
1384  * --sharenet=<name> option which opens or creates a named pipe.  This can be
1385  * used to send packets to another guest in a 1:1 manner.
1386  *
1387  * More sopisticated is to use one of the tools developed for project like UML
1388  * to do networking.
1389  *
1390  * Faster is to do virtio bonding in kernel.  Doing this 1:1 would be
1391  * completely generic ("here's my vring, attach to your vring") and would work
1392  * for any traffic.  Of course, namespace and permissions issues need to be
1393  * dealt with.  A more sophisticated "multi-channel" virtio_net.c could hide
1394  * multiple inter-guest channels behind one interface, although it would
1395  * require some manner of hotplugging new virtio channels.
1396  *
1397  * Finally, we could implement a virtio network switch in the kernel. :*/
1398
1399 static u32 str2ip(const char *ipaddr)
1400 {
1401         unsigned int b[4];
1402
1403         if (sscanf(ipaddr, "%u.%u.%u.%u", &b[0], &b[1], &b[2], &b[3]) != 4)
1404                 errx(1, "Failed to parse IP address '%s'", ipaddr);
1405         return (b[0] << 24) | (b[1] << 16) | (b[2] << 8) | b[3];
1406 }
1407
1408 static void str2mac(const char *macaddr, unsigned char mac[6])
1409 {
1410         unsigned int m[6];
1411         if (sscanf(macaddr, "%02x:%02x:%02x:%02x:%02x:%02x",
1412                    &m[0], &m[1], &m[2], &m[3], &m[4], &m[5]) != 6)
1413                 errx(1, "Failed to parse mac address '%s'", macaddr);
1414         mac[0] = m[0];
1415         mac[1] = m[1];
1416         mac[2] = m[2];
1417         mac[3] = m[3];
1418         mac[4] = m[4];
1419         mac[5] = m[5];
1420 }
1421
1422 /* This code is "adapted" from libbridge: it attaches the Host end of the
1423  * network device to the bridge device specified by the command line.
1424  *
1425  * This is yet another James Morris contribution (I'm an IP-level guy, so I
1426  * dislike bridging), and I just try not to break it. */
1427 static void add_to_bridge(int fd, const char *if_name, const char *br_name)
1428 {
1429         int ifidx;
1430         struct ifreq ifr;
1431
1432         if (!*br_name)
1433                 errx(1, "must specify bridge name");
1434
1435         ifidx = if_nametoindex(if_name);
1436         if (!ifidx)
1437                 errx(1, "interface %s does not exist!", if_name);
1438
1439         strncpy(ifr.ifr_name, br_name, IFNAMSIZ);
1440         ifr.ifr_name[IFNAMSIZ-1] = '\0';
1441         ifr.ifr_ifindex = ifidx;
1442         if (ioctl(fd, SIOCBRADDIF, &ifr) < 0)
1443                 err(1, "can't add %s to bridge %s", if_name, br_name);
1444 }
1445
1446 /* This sets up the Host end of the network device with an IP address, brings
1447  * it up so packets will flow, the copies the MAC address into the hwaddr
1448  * pointer. */
1449 static void configure_device(int fd, const char *tapif, u32 ipaddr)
1450 {
1451         struct ifreq ifr;
1452         struct sockaddr_in *sin = (struct sockaddr_in *)&ifr.ifr_addr;
1453
1454         memset(&ifr, 0, sizeof(ifr));
1455         strcpy(ifr.ifr_name, tapif);
1456
1457         /* Don't read these incantations.  Just cut & paste them like I did! */
1458         sin->sin_family = AF_INET;
1459         sin->sin_addr.s_addr = htonl(ipaddr);
1460         if (ioctl(fd, SIOCSIFADDR, &ifr) != 0)
1461                 err(1, "Setting %s interface address", tapif);
1462         ifr.ifr_flags = IFF_UP;
1463         if (ioctl(fd, SIOCSIFFLAGS, &ifr) != 0)
1464                 err(1, "Bringing interface %s up", tapif);
1465 }
1466
1467 static void get_mac(int fd, const char *tapif, unsigned char hwaddr[6])
1468 {
1469         struct ifreq ifr;
1470
1471         memset(&ifr, 0, sizeof(ifr));
1472         strcpy(ifr.ifr_name, tapif);
1473
1474         /* SIOC stands for Socket I/O Control.  G means Get (vs S for Set
1475          * above).  IF means Interface, and HWADDR is hardware address.
1476          * Simple! */
1477         if (ioctl(fd, SIOCGIFHWADDR, &ifr) != 0)
1478                 err(1, "getting hw address for %s", tapif);
1479         memcpy(hwaddr, ifr.ifr_hwaddr.sa_data, 6);
1480 }
1481
1482 static int get_tun_device(char tapif[IFNAMSIZ])
1483 {
1484         struct ifreq ifr;
1485         int netfd;
1486
1487         /* Start with this zeroed.  Messy but sure. */
1488         memset(&ifr, 0, sizeof(ifr));
1489
1490         /* We open the /dev/net/tun device and tell it we want a tap device.  A
1491          * tap device is like a tun device, only somehow different.  To tell
1492          * the truth, I completely blundered my way through this code, but it
1493          * works now! */
1494         netfd = open_or_die("/dev/net/tun", O_RDWR);
1495         ifr.ifr_flags = IFF_TAP | IFF_NO_PI;
1496         strcpy(ifr.ifr_name, "tap%d");
1497         if (ioctl(netfd, TUNSETIFF, &ifr) != 0)
1498                 err(1, "configuring /dev/net/tun");
1499
1500         /* We don't need checksums calculated for packets coming in this
1501          * device: trust us! */
1502         ioctl(netfd, TUNSETNOCSUM, 1);
1503
1504         memcpy(tapif, ifr.ifr_name, IFNAMSIZ);
1505         return netfd;
1506 }
1507
1508 /*L:195 Our network is a Host<->Guest network.  This can either use bridging or
1509  * routing, but the principle is the same: it uses the "tun" device to inject
1510  * packets into the Host as if they came in from a normal network card.  We
1511  * just shunt packets between the Guest and the tun device. */
1512 static void setup_tun_net(char *arg)
1513 {
1514         struct device *dev;
1515         int netfd, ipfd;
1516         u32 ip = INADDR_ANY;
1517         bool bridging = false;
1518         char tapif[IFNAMSIZ], *p;
1519         struct virtio_net_config conf;
1520
1521         netfd = get_tun_device(tapif);
1522
1523         /* First we create a new network device. */
1524         dev = new_device("net", VIRTIO_ID_NET, netfd, handle_tun_input);
1525
1526         /* Network devices need a receive and a send queue, just like
1527          * console. */
1528         add_virtqueue(dev, VIRTQUEUE_NUM, net_enable_fd);
1529         add_virtqueue(dev, VIRTQUEUE_NUM, handle_net_output);
1530
1531         /* We need a socket to perform the magic network ioctls to bring up the
1532          * tap interface, connect to the bridge etc.  Any socket will do! */
1533         ipfd = socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
1534         if (ipfd < 0)
1535                 err(1, "opening IP socket");
1536
1537         /* If the command line was --tunnet=bridge:<name> do bridging. */
1538         if (!strncmp(BRIDGE_PFX, arg, strlen(BRIDGE_PFX))) {
1539                 arg += strlen(BRIDGE_PFX);
1540                 bridging = true;
1541         }
1542
1543         /* A mac address may follow the bridge name or IP address */
1544         p = strchr(arg, ':');
1545         if (p) {
1546                 str2mac(p+1, conf.mac);
1547                 *p = '\0';
1548         } else {
1549                 p = arg + strlen(arg);
1550                 /* None supplied; query the randomly assigned mac. */
1551                 get_mac(ipfd, tapif, conf.mac);
1552         }
1553
1554         /* arg is now either an IP address or a bridge name */
1555         if (bridging)
1556                 add_to_bridge(ipfd, tapif, arg);
1557         else
1558                 ip = str2ip(arg);
1559
1560         /* Set up the tun device. */
1561         configure_device(ipfd, tapif, ip);
1562
1563         /* Tell Guest what MAC address to use. */
1564         add_feature(dev, VIRTIO_NET_F_MAC);
1565         add_feature(dev, VIRTIO_F_NOTIFY_ON_EMPTY);
1566         set_config(dev, sizeof(conf), &conf);
1567
1568         /* We don't need the socket any more; setup is done. */
1569         close(ipfd);
1570
1571         devices.device_num++;
1572
1573         if (bridging)
1574                 verbose("device %u: tun %s attached to bridge: %s\n",
1575                         devices.device_num, tapif, arg);
1576         else
1577                 verbose("device %u: tun %s: %s\n",
1578                         devices.device_num, tapif, arg);
1579 }
1580
1581 /* Our block (disk) device should be really simple: the Guest asks for a block
1582  * number and we read or write that position in the file.  Unfortunately, that
1583  * was amazingly slow: the Guest waits until the read is finished before
1584  * running anything else, even if it could have been doing useful work.
1585  *
1586  * We could use async I/O, except it's reputed to suck so hard that characters
1587  * actually go missing from your code when you try to use it.
1588  *
1589  * So we farm the I/O out to thread, and communicate with it via a pipe. */
1590
1591 /* This hangs off device->priv. */
1592 struct vblk_info
1593 {
1594         /* The size of the file. */
1595         off64_t len;
1596
1597         /* The file descriptor for the file. */
1598         int fd;
1599
1600         /* IO thread listens on this file descriptor [0]. */
1601         int workpipe[2];
1602
1603         /* IO thread writes to this file descriptor to mark it done, then
1604          * Launcher triggers interrupt to Guest. */
1605         int done_fd;
1606 };
1607
1608 /*L:210
1609  * The Disk
1610  *
1611  * Remember that the block device is handled by a separate I/O thread.  We head
1612  * straight into the core of that thread here:
1613  */
1614 static bool service_io(struct device *dev)
1615 {
1616         struct vblk_info *vblk = dev->priv;
1617         unsigned int head, out_num, in_num, wlen;
1618         int ret;
1619         u8 *in;
1620         struct virtio_blk_outhdr *out;
1621         struct iovec iov[dev->vq->vring.num];
1622         off64_t off;
1623
1624         /* See if there's a request waiting.  If not, nothing to do. */
1625         head = get_vq_desc(dev->vq, iov, &out_num, &in_num);
1626         if (head == dev->vq->vring.num)
1627                 return false;
1628
1629         /* Every block request should contain at least one output buffer
1630          * (detailing the location on disk and the type of request) and one
1631          * input buffer (to hold the result). */
1632         if (out_num == 0 || in_num == 0)
1633                 errx(1, "Bad virtblk cmd %u out=%u in=%u",
1634                      head, out_num, in_num);
1635
1636         out = convert(&iov[0], struct virtio_blk_outhdr);
1637         in = convert(&iov[out_num+in_num-1], u8);
1638         off = out->sector * 512;
1639
1640         /* The block device implements "barriers", where the Guest indicates
1641          * that it wants all previous writes to occur before this write.  We
1642          * don't have a way of asking our kernel to do a barrier, so we just
1643          * synchronize all the data in the file.  Pretty poor, no? */
1644         if (out->type & VIRTIO_BLK_T_BARRIER)
1645                 fdatasync(vblk->fd);
1646
1647         /* In general the virtio block driver is allowed to try SCSI commands.
1648          * It'd be nice if we supported eject, for example, but we don't. */
1649         if (out->type & VIRTIO_BLK_T_SCSI_CMD) {
1650                 fprintf(stderr, "Scsi commands unsupported\n");
1651                 *in = VIRTIO_BLK_S_UNSUPP;
1652                 wlen = sizeof(*in);
1653         } else if (out->type & VIRTIO_BLK_T_OUT) {
1654                 /* Write */
1655
1656                 /* Move to the right location in the block file.  This can fail
1657                  * if they try to write past end. */
1658                 if (lseek64(vblk->fd, off, SEEK_SET) != off)
1659                         err(1, "Bad seek to sector %llu", out->sector);
1660
1661                 ret = writev(vblk->fd, iov+1, out_num-1);
1662                 verbose("WRITE to sector %llu: %i\n", out->sector, ret);
1663
1664                 /* Grr... Now we know how long the descriptor they sent was, we
1665                  * make sure they didn't try to write over the end of the block
1666                  * file (possibly extending it). */
1667                 if (ret > 0 && off + ret > vblk->len) {
1668                         /* Trim it back to the correct length */
1669                         ftruncate64(vblk->fd, vblk->len);
1670                         /* Die, bad Guest, die. */
1671                         errx(1, "Write past end %llu+%u", off, ret);
1672                 }
1673                 wlen = sizeof(*in);
1674                 *in = (ret >= 0 ? VIRTIO_BLK_S_OK : VIRTIO_BLK_S_IOERR);
1675         } else {
1676                 /* Read */
1677
1678                 /* Move to the right location in the block file.  This can fail
1679                  * if they try to read past end. */
1680                 if (lseek64(vblk->fd, off, SEEK_SET) != off)
1681                         err(1, "Bad seek to sector %llu", out->sector);
1682
1683                 ret = readv(vblk->fd, iov+1, in_num-1);
1684                 verbose("READ from sector %llu: %i\n", out->sector, ret);
1685                 if (ret >= 0) {
1686                         wlen = sizeof(*in) + ret;
1687                         *in = VIRTIO_BLK_S_OK;
1688                 } else {
1689                         wlen = sizeof(*in);
1690                         *in = VIRTIO_BLK_S_IOERR;
1691                 }
1692         }
1693
1694         /* We can't trigger an IRQ, because we're not the Launcher.  It does
1695          * that when we tell it we're done. */
1696         add_used(dev->vq, head, wlen);
1697         return true;
1698 }
1699
1700 /* This is the thread which actually services the I/O. */
1701 static int io_thread(void *_dev)
1702 {
1703         struct device *dev = _dev;
1704         struct vblk_info *vblk = dev->priv;
1705         char c;
1706
1707         /* Close other side of workpipe so we get 0 read when main dies. */
1708         close(vblk->workpipe[1]);
1709         /* Close the other side of the done_fd pipe. */
1710         close(dev->fd);
1711
1712         /* When this read fails, it means Launcher died, so we follow. */
1713         while (read(vblk->workpipe[0], &c, 1) == 1) {
1714                 /* We acknowledge each request immediately to reduce latency,
1715                  * rather than waiting until we've done them all.  I haven't
1716                  * measured to see if it makes any difference.
1717                  *
1718                  * That would be an interesting test, wouldn't it?  You could
1719                  * also try having more than one I/O thread. */
1720                 while (service_io(dev))
1721                         write(vblk->done_fd, &c, 1);
1722         }
1723         return 0;
1724 }
1725
1726 /* Now we've seen the I/O thread, we return to the Launcher to see what happens
1727  * when that thread tells us it's completed some I/O. */
1728 static bool handle_io_finish(int fd, struct device *dev)
1729 {
1730         char c;
1731
1732         /* If the I/O thread died, presumably it printed the error, so we
1733          * simply exit. */
1734         if (read(dev->fd, &c, 1) != 1)
1735                 exit(1);
1736
1737         /* It did some work, so trigger the irq. */
1738         trigger_irq(fd, dev->vq);
1739         return true;
1740 }
1741
1742 /* When the Guest submits some I/O, we just need to wake the I/O thread. */
1743 static void handle_virtblk_output(int fd, struct virtqueue *vq, bool timeout)
1744 {
1745         struct vblk_info *vblk = vq->dev->priv;
1746         char c = 0;
1747
1748         /* Wake up I/O thread and tell it to go to work! */
1749         if (write(vblk->workpipe[1], &c, 1) != 1)
1750                 /* Presumably it indicated why it died. */
1751                 exit(1);
1752 }
1753
1754 /*L:198 This actually sets up a virtual block device. */
1755 static void setup_block_file(const char *filename)
1756 {
1757         int p[2];
1758         struct device *dev;
1759         struct vblk_info *vblk;
1760         void *stack;
1761         struct virtio_blk_config conf;
1762
1763         /* This is the pipe the I/O thread will use to tell us I/O is done. */
1764         pipe(p);
1765
1766         /* The device responds to return from I/O thread. */
1767         dev = new_device("block", VIRTIO_ID_BLOCK, p[0], handle_io_finish);
1768
1769         /* The device has one virtqueue, where the Guest places requests. */
1770         add_virtqueue(dev, VIRTQUEUE_NUM, handle_virtblk_output);
1771
1772         /* Allocate the room for our own bookkeeping */
1773         vblk = dev->priv = malloc(sizeof(*vblk));
1774
1775         /* First we open the file and store the length. */
1776         vblk->fd = open_or_die(filename, O_RDWR|O_LARGEFILE);
1777         vblk->len = lseek64(vblk->fd, 0, SEEK_END);
1778
1779         /* We support barriers. */
1780         add_feature(dev, VIRTIO_BLK_F_BARRIER);
1781
1782         /* Tell Guest how many sectors this device has. */
1783         conf.capacity = cpu_to_le64(vblk->len / 512);
1784
1785         /* Tell Guest not to put in too many descriptors at once: two are used
1786          * for the in and out elements. */
1787         add_feature(dev, VIRTIO_BLK_F_SEG_MAX);
1788         conf.seg_max = cpu_to_le32(VIRTQUEUE_NUM - 2);
1789
1790         set_config(dev, sizeof(conf), &conf);
1791
1792         /* The I/O thread writes to this end of the pipe when done. */
1793         vblk->done_fd = p[1];
1794
1795         /* This is the second pipe, which is how we tell the I/O thread about
1796          * more work. */
1797         pipe(vblk->workpipe);
1798
1799         /* Create stack for thread and run it.  Since stack grows upwards, we
1800          * point the stack pointer to the end of this region. */
1801         stack = malloc(32768);
1802         /* SIGCHLD - We dont "wait" for our cloned thread, so prevent it from
1803          * becoming a zombie. */
1804         if (clone(io_thread, stack + 32768, CLONE_VM | SIGCHLD, dev) == -1)
1805                 err(1, "Creating clone");
1806
1807         /* We don't need to keep the I/O thread's end of the pipes open. */
1808         close(vblk->done_fd);
1809         close(vblk->workpipe[0]);
1810
1811         verbose("device %u: virtblock %llu sectors\n",
1812                 devices.device_num, le64_to_cpu(conf.capacity));
1813 }
1814
1815 /* Our random number generator device reads from /dev/random into the Guest's
1816  * input buffers.  The usual case is that the Guest doesn't want random numbers
1817  * and so has no buffers although /dev/random is still readable, whereas
1818  * console is the reverse.
1819  *
1820  * The same logic applies, however. */
1821 static bool handle_rng_input(int fd, struct device *dev)
1822 {
1823         int len;
1824         unsigned int head, in_num, out_num, totlen = 0;
1825         struct iovec iov[dev->vq->vring.num];
1826
1827         /* First we need a buffer from the Guests's virtqueue. */
1828         head = get_vq_desc(dev->vq, iov, &out_num, &in_num);
1829
1830         /* If they're not ready for input, stop listening to this file
1831          * descriptor.  We'll start again once they add an input buffer. */
1832         if (head == dev->vq->vring.num)
1833                 return false;
1834
1835         if (out_num)
1836                 errx(1, "Output buffers in rng?");
1837
1838         /* This is why we convert to iovecs: the readv() call uses them, and so
1839          * it reads straight into the Guest's buffer.  We loop to make sure we
1840          * fill it. */
1841         while (!iov_empty(iov, in_num)) {
1842                 len = readv(dev->fd, iov, in_num);
1843                 if (len <= 0)
1844                         err(1, "Read from /dev/random gave %i", len);
1845                 iov_consume(iov, in_num, len);
1846                 totlen += len;
1847         }
1848
1849         /* Tell the Guest about the new input. */
1850         add_used_and_trigger(fd, dev->vq, head, totlen);
1851
1852         /* Everything went OK! */
1853         return true;
1854 }
1855
1856 /* And this creates a "hardware" random number device for the Guest. */
1857 static void setup_rng(void)
1858 {
1859         struct device *dev;
1860         int fd;
1861
1862         fd = open_or_die("/dev/random", O_RDONLY);
1863
1864         /* The device responds to return from I/O thread. */
1865         dev = new_device("rng", VIRTIO_ID_RNG, fd, handle_rng_input);
1866
1867         /* The device has one virtqueue, where the Guest places inbufs. */
1868         add_virtqueue(dev, VIRTQUEUE_NUM, enable_fd);
1869
1870         verbose("device %u: rng\n", devices.device_num++);
1871 }
1872 /* That's the end of device setup. */
1873
1874 /*L:230 Reboot is pretty easy: clean up and exec() the Launcher afresh. */
1875 static void __attribute__((noreturn)) restart_guest(void)
1876 {
1877         unsigned int i;
1878
1879         /* Closing pipes causes the Waker thread and io_threads to die, and
1880          * closing /dev/lguest cleans up the Guest.  Since we don't track all
1881          * open fds, we simply close everything beyond stderr. */
1882         for (i = 3; i < FD_SETSIZE; i++)
1883                 close(i);
1884         execv(main_args[0], main_args);
1885         err(1, "Could not exec %s", main_args[0]);
1886 }
1887
1888 /*L:220 Finally we reach the core of the Launcher which runs the Guest, serves
1889  * its input and output, and finally, lays it to rest. */
1890 static void __attribute__((noreturn)) run_guest(int lguest_fd)
1891 {
1892         for (;;) {
1893                 unsigned long args[] = { LHREQ_BREAK, 0 };
1894                 unsigned long notify_addr;
1895                 int readval;
1896
1897                 /* We read from the /dev/lguest device to run the Guest. */
1898                 readval = pread(lguest_fd, &notify_addr,
1899                                 sizeof(notify_addr), cpu_id);
1900
1901                 /* One unsigned long means the Guest did HCALL_NOTIFY */
1902                 if (readval == sizeof(notify_addr)) {
1903                         verbose("Notify on address %#lx\n", notify_addr);
1904                         handle_output(lguest_fd, notify_addr);
1905                         continue;
1906                 /* ENOENT means the Guest died.  Reading tells us why. */
1907                 } else if (errno == ENOENT) {
1908                         char reason[1024] = { 0 };
1909                         pread(lguest_fd, reason, sizeof(reason)-1, cpu_id);
1910                         errx(1, "%s", reason);
1911                 /* ERESTART means that we need to reboot the guest */
1912                 } else if (errno == ERESTART) {
1913                         restart_guest();
1914                 /* EAGAIN means a signal (timeout).
1915                  * Anything else means a bug or incompatible change. */
1916                 } else if (errno != EAGAIN)
1917                         err(1, "Running guest failed");
1918
1919                 /* Only service input on thread for CPU 0. */
1920                 if (cpu_id != 0)
1921                         continue;
1922
1923                 /* Service input, then unset the BREAK to release the Waker. */
1924                 handle_input(lguest_fd);
1925                 if (pwrite(lguest_fd, args, sizeof(args), cpu_id) < 0)
1926                         err(1, "Resetting break");
1927         }
1928 }
1929 /*L:240
1930  * This is the end of the Launcher.  The good news: we are over halfway
1931  * through!  The bad news: the most fiendish part of the code still lies ahead
1932  * of us.
1933  *
1934  * Are you ready?  Take a deep breath and join me in the core of the Host, in
1935  * "make Host".
1936  :*/
1937
1938 static struct option opts[] = {
1939         { "verbose", 0, NULL, 'v' },
1940         { "tunnet", 1, NULL, 't' },
1941         { "block", 1, NULL, 'b' },
1942         { "rng", 0, NULL, 'r' },
1943         { "initrd", 1, NULL, 'i' },
1944         { NULL },
1945 };
1946 static void usage(void)
1947 {
1948         errx(1, "Usage: lguest [--verbose] "
1949              "[--tunnet=(<ipaddr>:<macaddr>|bridge:<bridgename>:<macaddr>)\n"
1950              "|--block=<filename>|--initrd=<filename>]...\n"
1951              "<mem-in-mb> vmlinux [args...]");
1952 }
1953
1954 /*L:105 The main routine is where the real work begins: */
1955 int main(int argc, char *argv[])
1956 {
1957         /* Memory, top-level pagetable, code startpoint and size of the
1958          * (optional) initrd. */
1959         unsigned long mem = 0, pgdir, start, initrd_size = 0;
1960         /* Two temporaries and the /dev/lguest file descriptor. */
1961         int i, c, lguest_fd;
1962         /* The boot information for the Guest. */
1963         struct boot_params *boot;
1964         /* If they specify an initrd file to load. */
1965         const char *initrd_name = NULL;
1966
1967         /* Save the args: we "reboot" by execing ourselves again. */
1968         main_args = argv;
1969         /* We don't "wait" for the children, so prevent them from becoming
1970          * zombies. */
1971         signal(SIGCHLD, SIG_IGN);
1972
1973         /* First we initialize the device list.  Since console and network
1974          * device receive input from a file descriptor, we keep an fdset
1975          * (infds) and the maximum fd number (max_infd) with the head of the
1976          * list.  We also keep a pointer to the last device.  Finally, we keep
1977          * the next interrupt number to use for devices (1: remember that 0 is
1978          * used by the timer). */
1979         FD_ZERO(&devices.infds);
1980         devices.max_infd = -1;
1981         devices.lastdev = NULL;
1982         devices.next_irq = 1;
1983
1984         cpu_id = 0;
1985         /* We need to know how much memory so we can set up the device
1986          * descriptor and memory pages for the devices as we parse the command
1987          * line.  So we quickly look through the arguments to find the amount
1988          * of memory now. */
1989         for (i = 1; i < argc; i++) {
1990                 if (argv[i][0] != '-') {
1991                         mem = atoi(argv[i]) * 1024 * 1024;
1992                         /* We start by mapping anonymous pages over all of
1993                          * guest-physical memory range.  This fills it with 0,
1994                          * and ensures that the Guest won't be killed when it
1995                          * tries to access it. */
1996                         guest_base = map_zeroed_pages(mem / getpagesize()
1997                                                       + DEVICE_PAGES);
1998                         guest_limit = mem;
1999                         guest_max = mem + DEVICE_PAGES*getpagesize();
2000                         devices.descpage = get_pages(1);
2001                         break;
2002                 }
2003         }
2004
2005         /* The options are fairly straight-forward */
2006         while ((c = getopt_long(argc, argv, "v", opts, NULL)) != EOF) {
2007                 switch (c) {
2008                 case 'v':
2009                         verbose = true;
2010                         break;
2011                 case 't':
2012                         setup_tun_net(optarg);
2013                         break;
2014                 case 'b':
2015                         setup_block_file(optarg);
2016                         break;
2017                 case 'r':
2018                         setup_rng();
2019                         break;
2020                 case 'i':
2021                         initrd_name = optarg;
2022                         break;
2023                 default:
2024                         warnx("Unknown argument %s", argv[optind]);
2025                         usage();
2026                 }
2027         }
2028         /* After the other arguments we expect memory and kernel image name,
2029          * followed by command line arguments for the kernel. */
2030         if (optind + 2 > argc)
2031                 usage();
2032
2033         verbose("Guest base is at %p\n", guest_base);
2034
2035         /* We always have a console device */
2036         setup_console();
2037
2038         /* We can timeout waiting for Guest network transmit. */
2039         setup_timeout();
2040
2041         /* Now we load the kernel */
2042         start = load_kernel(open_or_die(argv[optind+1], O_RDONLY));
2043
2044         /* Boot information is stashed at physical address 0 */
2045         boot = from_guest_phys(0);
2046
2047         /* Map the initrd image if requested (at top of physical memory) */
2048         if (initrd_name) {
2049                 initrd_size = load_initrd(initrd_name, mem);
2050                 /* These are the location in the Linux boot header where the
2051                  * start and size of the initrd are expected to be found. */
2052                 boot->hdr.ramdisk_image = mem - initrd_size;
2053                 boot->hdr.ramdisk_size = initrd_size;
2054                 /* The bootloader type 0xFF means "unknown"; that's OK. */
2055                 boot->hdr.type_of_loader = 0xFF;
2056         }
2057
2058         /* Set up the initial linear pagetables, starting below the initrd. */
2059         pgdir = setup_pagetables(mem, initrd_size);
2060
2061         /* The Linux boot header contains an "E820" memory map: ours is a
2062          * simple, single region. */
2063         boot->e820_entries = 1;
2064         boot->e820_map[0] = ((struct e820entry) { 0, mem, E820_RAM });
2065         /* The boot header contains a command line pointer: we put the command
2066          * line after the boot header. */
2067         boot->hdr.cmd_line_ptr = to_guest_phys(boot + 1);
2068         /* We use a simple helper to copy the arguments separated by spaces. */
2069         concat((char *)(boot + 1), argv+optind+2);
2070
2071         /* Boot protocol version: 2.07 supports the fields for lguest. */
2072         boot->hdr.version = 0x207;
2073
2074         /* The hardware_subarch value of "1" tells the Guest it's an lguest. */
2075         boot->hdr.hardware_subarch = 1;
2076
2077         /* Tell the entry path not to try to reload segment registers. */
2078         boot->hdr.loadflags |= KEEP_SEGMENTS;
2079
2080         /* We tell the kernel to initialize the Guest: this returns the open
2081          * /dev/lguest file descriptor. */
2082         lguest_fd = tell_kernel(pgdir, start);
2083
2084         /* We fork off a child process, which wakes the Launcher whenever one
2085          * of the input file descriptors needs attention.  We call this the
2086          * Waker, and we'll cover it in a moment. */
2087         waker_fd = setup_waker(lguest_fd);
2088
2089         /* Finally, run the Guest.  This doesn't return. */
2090         run_guest(lguest_fd);
2091 }
2092 /*:*/
2093
2094 /*M:999
2095  * Mastery is done: you now know everything I do.
2096  *
2097  * But surely you have seen code, features and bugs in your wanderings which
2098  * you now yearn to attack?  That is the real game, and I look forward to you
2099  * patching and forking lguest into the Your-Name-Here-visor.
2100  *
2101  * Farewell, and good coding!
2102  * Rusty Russell.
2103  */