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