OpenCpuX/qemu-arm - Open Source Instruction-Set Simulation Integration Kit

Overview

This is an adaptation of the QEMU ARMv7 and ARMv8 processor models to run as a core model using the OpenCpuX API. It is not directly based on QEMU but uses a fork of Unicorn for a library-ready version of QEMU.

It uses the Capstone disassembler framework for ARMv7 and ARMv8 disassembly.

System Requirements

• CMake, version 3.6 or higher
• gcc and g++

How to build

For all platforms

• Clone the repository and cd into the repository

• Initialize and update the submodules:

    git submodule init
    git submodule update --init --recursive
  

Linux

• Create a BUILD directory

    mkdir BUILD
    cd BUILD
  

• Run CMake with gcc and g++ in 64bit mode, then make to build both the test harness and the unicorn core

    CXX="g++ -m64" CC="gcc -m64" cmake -DOCX_QEMU_ARM_BUILD_TESTS=ON ..
    make
  

• The module should pass the regression tests are specified by the ocx test harness:

    make test
  
    Test project ocx-qemu-arm/BUILD
        Start 1: ocx-qemu-arm
    1/1 Test #1: ocx-qemu-arm .....................   Passed    0.02 sec
  
    100% tests passed, 0 tests failed out of 1
  

• Script for maintaining multiple builds for debug/release:

    #!/bin/sh
  
    for build in DEBUG RELEASE; do
        mkdir -p BUILD/$build/BUILD
        cd BUILD/$build/BUILD
  
        export CXX="g++ -m64"
        export CC="gcc -m64"
  
        cmake ../../.. -DCMAKE_BUILD_TYPE=$build -DCMAKE_INSTALL_PREFIX=..
        make -j 10
        make install
  
        cd ../../..
    done
  

Visual Studio 2017 and up

• Start Visual Studio

• Use File -> Open Folder... to open the directory to which you have cloned the ocx-qemu-arm repository.

• Visual Studio will detect that this is a CMake project and will generate the necessary build files. Once this has completed ...

• Build -> Build all

• The module should pass the regression tests are specified by the ocx test harness:

  Test -> Run CTest for ocx-qemu-arm

    Test project C:/msys64/home/tobies/ocx-qemu-arm/out/build/x64-Debug
    Start 1: ocx-qemu-arm
    1/1 Test #1: ocx-qemu-arm .....................   Passed    0.14 sec
    100% tests passed, 0 tests failed out of 1
    Total Test time (real) =   0.16 sec
  

Supported core variants

The following core variants are supported, check also the modeldb file:

Core Variant	Architecture
Cortex-A7	ARMv7-A
Cortex-A8	ARMv7-A
Cortex-A9	ARMv7-A
Cortex-A15	ARMv7-A
Cortex-A53	ARMv8-A
Cortex-A57	ARMv8-A
Cortex-A72	ARMv8-A
Cortex-Max	ARMv8-A

Some Cortex-M and Cortex-R cores can be instantiated and have support for their instruction set and register visibility, but these have not been validated and require additional peripheral IP to be fully functional.

Configuration Information

The following assignments are used in the QEMU ARM core:

ocx::core::interrupt

The core expects the following IRQ inputs to be indicated via calls to interrupt with the associated irq value. All IRQs are active high. Calling interrupt with irq value 4 or higher will wakeup a core blocked in a WFE or WFI instruction without delivering a specific IRQ.

Name	irq
IRQ	0
FIQ	1
VIRQ	2
VFIQ	3
wakeup events	4+

ocx::env::signal

The core indicates occurrences of counter interrupts via calls to signal with the associated sigid value:

Name	sigid
CNTPNSIRQ	0
CNTVIRQ	1
CNTHPIRQ	2
CNTPSIRQ	3

ocx::env::get_param

The core will attempt to read the following parameter values from the environment:

Name	Type	Description
gicv3	bool	Enable GICv3 support