QEMU Build and Test System

Details about how QEMU’s build system works and how it is integrated into our testing infrastructure. You will need to understand some of the basics if you are adding new files and targets to the build.

• The QEMU build system architecture
  • Stage 1: configure
    • Modifying configure
    • Python virtual environments and the build process
    • Bundled Python packages
  • Stage 2: Meson
    • Adding checks
    • Support scripts
  • Stage 3: Make
    • Useful make targets
  • Important files for the build system
    • Statically defined files
    • Dynamically created files
• QEMU and Kconfig
  • The Kconfig language
  • Guidelines for writing Kconfig files
  • Writing and modifying default configurations
  • Kconfig.host
• Testing in QEMU
  • Testing with “make check”
    • Unit tests
    • QTest
    • Writing portable test cases
    • QAPI schema tests
    • check-block
  • QEMU iotests
    • Writing a new test case
    • Debugging a test case
    • Test case groups
  • Container based tests
    • Introduction
    • Docker Prerequisites
    • Podman Prerequisites
    • Quickstart
    • Registry
    • Images
    • Tests
    • Debugging a Docker test failure
    • Options
  • Thread Sanitizer
    • Thread Sanitizer in Docker
    • Building and Testing with TSan
    • TSan Suppressions
    • TSan Annotations
  • docker-binfmt-image-debian-% targets
    • Setting up binfmt_misc
    • Example invocation
  • VM testing
    • Quickstart
    • QEMU binaries
    • Make jobs
    • Debugging
    • Manual invocation
    • Adding new guests
  • Image fuzzer testing
  • Integration tests using the Avocado Framework
    • Running tests
    • Manual Installation
    • Overview
    • QEMUMachine
    • Attribute reference
    • Parameter reference
    • Skipping tests
    • Uninstalling Avocado
  • Testing with “make check-tcg”
    • Running subset of tests
    • TCG test dependencies
  • Other TCG Tests
    • KVM Unit Tests
    • Linux Test Project
  • GCC gcov support
• ACPI/SMBIOS avocado tests using biosbits
  • References:
• QTest Device Emulation Testing Framework
  • Qtest Driver Framework
    • QGraph concepts
    • Creating a new driver and its interface
    • Adding a new test
    • Qgraph API reference
  • QTest Protocol
    • Valid requests
  • libqtest API reference
• CI
  • Definition of terms
    • Automated tests
    • Unit testing
    • Functional testing
    • System testing
    • Flaky tests
    • Gating
    • Continuous Integration (CI)
    • References
  • Custom CI/CD variables
    • Set variable globally in the user’s CI namespace
    • Set variable manually when pushing a branch or tag to the user’s repository
    • Setting aliases in your git config
    • Variable naming and grouping
    • Maintainer controlled job variables
    • Contributor controlled runtime variables
    • Other misc variables
  • Jobs on Custom Runners
    • Machine Setup Howto
• How to use the QAPI code generator
  • Introduction
  • The QAPI schema language
    • Schema syntax
    • Built-in Types
    • Include directives
    • Pragma directives
    • Enumeration types
    • Type references and array types
    • Struct types
    • Union types
    • Alternate types
    • Commands
    • Events
    • Features
    • Naming rules and reserved names
    • Downstream extensions
    • Configuring the schema
    • Documentation comments
  • Client JSON Protocol introspection
  • Compatibility considerations
  • Code generation
    • Code generated for QAPI types
    • Code generated for visiting QAPI types
    • Code generated for commands
    • Code generated for events
    • Code generated for introspection
• Fuzzing
  • Basics
  • Building the fuzzers
  • Useful libFuzzer flags
  • Generating Coverage Reports
  • Adding a new fuzzer
  • The Generic Fuzzer
  • OSS-Fuzz
  • Building Crash Reproducers
  • Implementation Details / Fuzzer Lifecycle
• Control-Flow Integrity (CFI)
  • Basics
  • Building with CFI
  • Using QEMU built with CFI
  • Incompatible code with CFI
  • Disabling CFI for a specific function
  • CFI and fuzzing