tools/kvm/README

   1 Native Linux KVM tool
   2 =====================
   3 The goal of this tool is to provide a clean, from-scratch, lightweight
   4 KVM host tool implementation that can boot Linux guest images (just a
   5 hobby, won't be big and professional like QEMU) with no BIOS
   6 dependencies and with only the minimal amount of legacy device
   7 emulation.
   8
   9 It's great as a learning tool if you want to get your feet wet in
  10 virtualization land: it's only 5 KLOC of clean C code that can already
  11 boot a guest Linux image.
  12
  13 Right now it can boot a Linux image and provide you output via a serial
  14 console, over the host terminal, i.e. you can use it to boot a guest
  15 Linux image in a terminal or over ssh and log into the guest without
  16 much guest or host side setup work needed.
  17
  18 1. To try out the tool, clone the git repository:
  19
  20   git clone git://github.com/penberg/linux-kvm.git
  21
  22 or alternatively, if you already have a kernel source tree:
  23
  24   git remote add kvm-tool git://github.com/penberg/linux-kvm.git
  25   git remote update
  26   git checkout -b kvm-tool/master kvm-tool
  27
  28 2. Compile the tool:
  29
  30   cd tools/kvm && make
  31
  32 3. Download a raw userspace image:
  33
  34   wget http://wiki.qemu.org/download/linux-0.2.img.bz2 && bunzip2
  35 linux-0.2.img.bz2
  36
  37 4. The guest kernel has to be built with the following configuration:
  38
  39  - For the default console output:
  40         CONFIG_SERIAL_8250=y
  41         CONFIG_SERIAL_8250_CONSOLE=y
  42
  43  - For running 32bit images on 64bit hosts:
  44         CONFIG_IA32_EMULATION=y
  45
  46  - Proper FS options according to image FS (e.g. CONFIG_EXT2_FS, CONFIG_EXT4_FS).
  47
  48  - For all virtio devices listed below:
  49         CONFIG_VIRTIO=y
  50         CONFIG_VIRTIO_RING=y
  51         CONFIG_VIRTIO_PCI=y
  52
  53  - For virtio-blk devices (--disk, -d):
  54         CONFIG_VIRTIO_BLK=y
  55
  56  - For virtio-net devices ([--network, -n] virtio):
  57         CONFIG_VIRTIO_NET=y
  58
  59  - For virtio-9p devices (--virtio-9p):
  60         CONFIG_NET_9P=y
  61         CONFIG_NET_9P_VIRTIO=y
  62         CONFIG_9P_FS=y
  63
  64  - For virtio-balloon device (--balloon):
  65         CONFIG_VIRTIO_BALLOON=y
  66
  67  - For virtio-console device (--console virtio):
  68         CONFIG_VIRTIO_CONSOLE=y
  69
  70  - For virtio-rng device (--rng):
  71         CONFIG_HW_RANDOM_VIRTIO=y
  72
  73
  74 5. And finally, launch the hypervisor:
  75
  76   ./kvm run --disk linux-0.2.img \
  77             --kernel ../../arch/x86/boot/bzImage \
  78 or
  79
  80   sudo ./kvm run --disk linux-0.2.img \
  81                  --kernel ../../arch/x86/boot/bzImage \
  82                  --network virtio
  83
  84 The tool has been written by Pekka Enberg, Cyrill Gorcunov, Asias He,
  85 Sasha Levin and Prasad Joshi. Special thanks to Avi Kivity for his help
  86 on KVM internals and Ingo Molnar for all-around support and encouragement!
  87
  88 See the following thread for original discussion for motivation of this
  89 project:
  90
  91 http://thread.gmane.org/gmane.linux.kernel/962051/focus=962620
  92
  93 Build dependencies
  94 =====================
  95 For deb based systems:
  96 32-bit:
  97 sudo apt-get install build-essential
  98 64-bit:
  99 sudo apt-get install build-essential libc6-dev-i386
 100
 101 For rpm based systems:
 102 32-bit:
 103 yum install glibc-devel
 104 64-bit:
 105 yum install glibc-devel glibc-devel.i386
 106
 107 On 64-bit Arch Linux make sure the multilib repository is enabled in your
 108 /etc/pacman.conf and run
 109 pacman -Sy lib32-glibc