more/kvm-unit-tests/README.md

1 # Welcome to kvm-unit-tests
3 See http://www.linux-kvm.org/page/KVM-unit-tests for a high-level
18 NOTE: GCC cross-compiler is required for [build on macOS](README.macOS.md).
20 ## Cross-compiling
22 A cross compiler may be configured by specifying a cross prefix. For example,
25     ./configure --arch=arm64 --cross-prefix=aarch64-linux-gnu-
32     ./configure --cc=clang
35 clang may also be used with cross binutils when cross-compiling. For example,
38     ./configure --arch=riscv64 --cc=clang --cflags='--target=riscv64' \
39                 --cross-prefix=riscv64-linux-gnu-
48     (send tests/some-test somewhere)
50     ./some-test
52 `make install` will install all tests in PREFIX/share/kvm-unit-tests/tests,
61     ./x86-run ./x86/msr.flat
72     QEMU=/tmp/qemu/x86_64-softmmu/qemu-system-x86_64 ./x86-run ./x86/msr.flat
75 ACCEL=name environment variable:
77     ACCEL=kvm ./x86-run ./x86/msr.flat
95 to.  So that a given group can be executed by specifying its name in the
96 runner's -g option.
100 Unit tests use QEMU's '-append args...' parameter for command line
108 may be passed with '-initrd file' to become the unit test's environ,
114     QEMU_VERSION_STRING          string of the form `qemu -h | head -1`
115     KERNEL_VERSION_STRING        string of the form `uname -r`
117 Additionally these self-explanatory variables are reserved
125 host. kvm-unit-tests provides two ways to handle tests like those.
131      a) independently, `ARCH-run ARCH/test`
133      b) by specifying any other non-nodefault group it is in,
134         groups = nodefault mygroup : `./run_tests.sh -g mygroup`
136      c) by specifying all tests should be run, `./run_tests.sh -a`
152     c) by specifying all tests should be run, `./run_tests.sh -a`
153        (The -a switch ensures the ERRATA_FORCE is provided and set
166     .:                  configure script, top-level Makefile, and run_tests.sh
181   - C: please use standard linux-with-tabs, see Linux kernel
182     doc Documentation/process/coding-style.rst
183   - Shell: use TABs for indentation
187   - While the kernel standard requires 80 columns, we allow up to 120.
202 Please prefix messages with: [kvm-unit-tests PATCH]
207         subjectprefix = kvm-unit-tests PATCH
212 code. git-diff's orderFile feature allows us to specify the order in a