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