libeap/tests/hwsim/vm/README

   1 These scripts allow you to run the hwsim tests inside a KVM virtual machine.
   2
   3 To set it up, first compile a kernel with the kernel-config file as the
   4 .config. You can adjust it as needed, the configuration is for a 64-bit
   5 x86 system and should be close to minimal. The architecture must be the
   6 same as your host since the host's filesystem is used.
   7
   8 Install the required tools: at least 'kvm', if you want tracing trace-cmd,
   9 valgrind if you want, etc.
  10
  11 Compile the hwsim tests as per the instructions given, you may have to
  12 install some extra development packages (e.g. binutils-dev for libbfd).
  13
  14 Create a vm-config file and put the KERNELDIR option into it (see the
  15 vm-run.sh script). If you want valgrind, also increase the memory size.
  16
  17 Now you can run the vm-run.sh script and it will execute the tests using
  18 your system's root filesystem (read-only) inside the VM. The options you
  19 give it are passed through to run-all.sh, see there.
  20
  21 To speed up testing, it is possible to run multiple VMs concurrently and
  22 split the test cases between all the VMs. If the host system has enough
  23 memory and CPU resources, this can significantly speed up the full test
  24 cycle. For example, a 4 core system with 4 GB of RAM can easily run 8
  25 parallel VMs (assuming valgrind is not used with its higher memory
  26 requirements). This can be run with:
  27
  28 ./parallel-vm.sh <number of VMs> [arguments..]
  29
  30
  31 --------------------------------------------------------------------------------
  32
  33 Code Coverage Analysis for user space code
  34
  35 Code coverage for wpa_supplicant and hostapd can be generated from the
  36 test run with following command line:
  37
  38 ./vm-run.sh --codecov [other arguments..]
  39
  40 This builds a separate copies of wpa_supplicant and hostapd into a
  41 directory that is writable from the virtual machine to collect the gcov
  42 data. lcov is then used to prepare the reports at the end of the test
  43 run.
  44
  45
  46 Code Coverage Analysis for kernel code
  47
  48 In order to do code coverage analysis, reconfigure the kernel to include
  49
  50 CONFIG_GCOV_KERNEL=y
  51 CONFIG_GCOV_PROFILE_ALL=y
  52
  53 Note that for gcc 4.7, kernel version 3.13-rc1 or higher is required.
  54
  55 The scripts inside the VM will automatically copy the gcov data out of the
  56 VM into the logs directory. To post-process this data, you'll want to use
  57 lcov and run
  58
  59 cd /tmp/hwsim-test-logs/<timestamp>
  60 lcov -b <path to kernel dir> -c -d gcov/ > gcov/data
  61 genhtml -o html/ gcov/data
  62
  63 Then open html/index.html in your browser.
  64
  65 Note that in this case you need to keep your build and source directories
  66 across the test run (otherwise, it's safe to only keep the kernel image.)