Rusty Russell | 7334492 | 2007-10-25 14:12:20 +1000 | [diff] [blame] | 1 | #ifndef _LINUX_LGUEST_LAUNCHER |
| 2 | #define _LINUX_LGUEST_LAUNCHER |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 3 | /* Everything the "lguest" userspace program needs to know. */ |
Rusty Russell | b45d8cb | 2007-10-22 10:56:24 +1000 | [diff] [blame] | 4 | #include <linux/types.h> |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 5 | |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 6 | /*D:010 |
| 7 | * Drivers |
| 8 | * |
| 9 | * The Guest needs devices to do anything useful. Since we don't let it touch |
| 10 | * real devices (think of the damage it could do!) we provide virtual devices. |
| 11 | * We could emulate a PCI bus with various devices on it, but that is a fairly |
| 12 | * complex burden for the Host and suboptimal for the Guest, so we have our own |
Rusty Russell | e1e7296 | 2007-10-25 15:02:50 +1000 | [diff] [blame] | 13 | * simple lguest bus and we use "virtio" drivers. These drivers need a set of |
| 14 | * routines from us which will actually do the virtual I/O, but they handle all |
| 15 | * the net/block/console stuff themselves. This means that if we want to add |
| 16 | * a new device, we simply need to write a new virtio driver and create support |
| 17 | * for it in the Launcher: this code won't need to change. |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 18 | * |
Rusty Russell | a6bd8e1 | 2008-03-28 11:05:53 -0500 | [diff] [blame] | 19 | * Virtio devices are also used by kvm, so we can simply reuse their optimized |
| 20 | * device drivers. And one day when everyone uses virtio, my plan will be |
| 21 | * complete. Bwahahahah! |
| 22 | * |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame] | 23 | * Devices are described by a simplified ID, a status byte, and some "config" |
| 24 | * bytes which describe this device's configuration. This is placed by the |
| 25 | * Launcher just above the top of physical memory: |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 26 | */ |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 27 | struct lguest_device_desc { |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame] | 28 | /* The device type: console, network, disk etc. Type 0 terminates. */ |
| 29 | __u8 type; |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 30 | /* The number of virtqueues (first in config array) */ |
| 31 | __u8 num_vq; |
| 32 | /* The number of bytes of feature bits. Multiply by 2: one for host |
Rusty Russell | a6bd8e1 | 2008-03-28 11:05:53 -0500 | [diff] [blame] | 33 | * features and one for Guest acknowledgements. */ |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 34 | __u8 feature_len; |
| 35 | /* The number of bytes of the config array after virtqueues. */ |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame] | 36 | __u8 config_len; |
| 37 | /* A status byte, written by the Guest. */ |
| 38 | __u8 status; |
| 39 | __u8 config[0]; |
| 40 | }; |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 41 | |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame] | 42 | /*D:135 This is how we expect the device configuration field for a virtqueue |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 43 | * to be laid out in config space. */ |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame] | 44 | struct lguest_vqconfig { |
| 45 | /* The number of entries in the virtio_ring */ |
| 46 | __u16 num; |
| 47 | /* The interrupt we get when something happens. */ |
| 48 | __u16 irq; |
| 49 | /* The page number of the virtio ring for this device. */ |
Rusty Russell | b45d8cb | 2007-10-22 10:56:24 +1000 | [diff] [blame] | 50 | __u32 pfn; |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 51 | }; |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 52 | /*:*/ |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 53 | |
| 54 | /* Write command first word is a request. */ |
| 55 | enum lguest_req |
| 56 | { |
Matias Zabaljauregui | 58a2456 | 2008-09-29 01:40:07 -0300 | [diff] [blame] | 57 | LHREQ_INITIALIZE, /* + base, pfnlimit, start */ |
Rusty Russell | 1504527 | 2007-10-22 11:24:10 +1000 | [diff] [blame] | 58 | LHREQ_GETDMA, /* No longer used */ |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 59 | LHREQ_IRQ, /* + irq */ |
| 60 | LHREQ_BREAK, /* + on/off flag (on blocks until someone does off) */ |
| 61 | }; |
Rusty Russell | 2966af7 | 2008-12-30 09:25:58 -0600 | [diff] [blame] | 62 | |
| 63 | /* The alignment to use between consumer and producer parts of vring. |
| 64 | * x86 pagesize for historical reasons. */ |
| 65 | #define LGUEST_VRING_ALIGN 4096 |
Rusty Russell | 7334492 | 2007-10-25 14:12:20 +1000 | [diff] [blame] | 66 | #endif /* _LINUX_LGUEST_LAUNCHER */ |