lguest_launcher.h 2.5 KB

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