This is an implementation of a KVM-based ARMv8-compatible CPU. More...

#include <armv8_cpu.hh>

Inheritance diagram for ArmV8KvmCPU:

Classes
struct	IntRegInfo
	Mapping between integer registers in gem5 and KVM. More...

struct	MiscRegInfo
	Mapping between misc registers in gem5 and registers in KVM. More...

Public Member Functions
	ArmV8KvmCPU (ArmV8KvmCPUParams *params)

virtual	~ArmV8KvmCPU ()

void	startup () override

void	dump () const override
	Dump the internal state to the terminal. More...

Public Member Functions inherited from BaseArmKvmCPU
	BaseArmKvmCPU (BaseArmKvmCPUParams *params)

virtual	~BaseArmKvmCPU ()

void	startup () override

Public Member Functions inherited from BaseKvmCPU
	BaseKvmCPU (BaseKvmCPUParams *params)

virtual	~BaseKvmCPU ()

void	init () override

void	startup () override

void	regStats () override

void	serializeThread (CheckpointOut &cp, ThreadID tid) const override

void	unserializeThread (CheckpointIn &cp, ThreadID tid) override

DrainState	drain () override

void	drainResume () override

void	notifyFork () override

void	switchOut () override

void	takeOverFrom (BaseCPU *cpu) override

void	verifyMemoryMode () const override

MasterPort &	getDataPort () override

MasterPort &	getInstPort () override

void	wakeup (ThreadID tid=0) override

void	activateContext (ThreadID thread_num) override

void	suspendContext (ThreadID thread_num) override

void	deallocateContext (ThreadID thread_num)

void	haltContext (ThreadID thread_num) override

long	getVCpuID () const

ThreadContext *	getContext (int tn) override

Counter	totalInsts () const override

Counter	totalOps () const override

void	finishMMIOPending ()
	Callback from KvmCPUPort to transition the CPU out of RunningMMIOPending when all timing requests have completed. More...

void	kick () const
	Force an exit from KVM. More...

Protected Member Functions
void	updateKvmState () override
	Update the KVM state from the current thread context. More...

void	updateThreadContext () override
	Update the current thread context with the KVM state. More...

const std::vector < ArmV8KvmCPU::MiscRegInfo > &	getSysRegMap () const
	Get a map between system registers in kvm and gem5 registers. More...

Protected Member Functions inherited from BaseArmKvmCPU
Tick	kvmRun (Tick ticks) override
	Request KVM to run the guest for a given number of ticks. More...

const RegIndexVector &	getRegList () const
	Get a list of registers supported by getOneReg() and setOneReg(). More...

void	kvmArmVCpuInit (const struct kvm_vcpu_init &init)
	Tell the kernel to initialize this CPU. More...

Protected Member Functions inherited from BaseKvmCPU
void	tick ()
	Execute the CPU until the next event in the main event queue or until the guest needs service from gem5. More...

virtual uint64_t	getHostCycles () const
	Get the value of the hardware cycle counter in the guest. More...

virtual Tick	kvmRunDrain ()
	Request the CPU to run until draining completes. More...

struct kvm_run *	getKvmRunState ()
	Get a pointer to the kvm_run structure containing all the input and output parameters from kvmRun(). More...

uint8_t *	getGuestData (uint64_t offset) const
	Retrieve a pointer to guest data stored at the end of the kvm_run structure. More...

void	kvmNonMaskableInterrupt ()
	Send a non-maskable interrupt to the guest. More...

void	kvmInterrupt (const struct kvm_interrupt &interrupt)
	Send a normal interrupt to the guest. More...

std::string	getAndFormatOneReg (uint64_t id) const
	Get and format one register for printout. More...

virtual bool	archIsDrained () const
	Is the architecture specific code in a state that prevents draining? More...

Tick	doMMIOAccess (Addr paddr, void *data, int size, bool write)
	Inject a memory mapped IO request into gem5. More...

int	ioctl (int request, long p1) const
	vCPU ioctl interface. More...

int	ioctl (int request, void *p1) const

int	ioctl (int request) const

void	getRegisters (struct kvm_regs &regs) const
	Get/Set the register state of the guest vCPU. More...

void	setRegisters (const struct kvm_regs &regs)

void	getSpecialRegisters (struct kvm_sregs &regs) const

void	setSpecialRegisters (const struct kvm_sregs &regs)

void	getFPUState (struct kvm_fpu &state) const
	Get/Set the guest FPU/vector state. More...

void	setFPUState (const struct kvm_fpu &state)

void	setOneReg (uint64_t id, const void *addr)
	Get/Set single register using the KVM_(SET\|GET)_ONE_REG API. More...

void	setOneReg (uint64_t id, uint64_t value)

void	setOneReg (uint64_t id, uint32_t value)

void	getOneReg (uint64_t id, void *addr) const

uint64_t	getOneRegU64 (uint64_t id) const

uint32_t	getOneRegU32 (uint64_t id) const

void	syncThreadContext ()
	Update a thread context if the KVM state is dirty with respect to the cached thread context. More...

void	syncKvmState ()
	Update the KVM if the thread context is dirty. More...

virtual Tick	handleKvmExit ()
	Main kvmRun exit handler, calls the relevant handleKvmExit* depending on exit type. More...

virtual Tick	handleKvmExitIO ()
	The guest performed a legacy IO request (out/inp on x86) More...

virtual Tick	handleKvmExitHypercall ()
	The guest requested a monitor service using a hypercall. More...

virtual Tick	handleKvmExitIRQWindowOpen ()
	The guest exited because an interrupt window was requested. More...

virtual Tick	handleKvmExitUnknown ()
	An unknown architecture dependent error occurred when starting the vCPU. More...

virtual Tick	handleKvmExitException ()
	An unhandled virtualization exception occured. More...

virtual Tick	handleKvmExitFailEntry ()
	KVM failed to start the virtualized CPU. More...

void	setSignalMask (const sigset_t *mask)
	Set the signal mask used in kvmRun() More...

Protected Attributes
std::vector < ArmV8KvmCPU::MiscRegInfo >	sysRegMap
	Cached mapping between system registers in kvm and misc regs in gem5. More...

Protected Attributes inherited from BaseArmKvmCPU
bool	irqAsserted
	Cached state of the IRQ line. More...

bool	fiqAsserted
	Cached state of the FIQ line. More...

Protected Attributes inherited from BaseKvmCPU
Status	_status
	CPU run state. More...

KVMCpuPort	dataPort
	Port for data requests. More...

KVMCpuPort	instPort
	Unused dummy port for the instruction interface. More...

const bool	alwaysSyncTC
	Be conservative and always synchronize the thread context on KVM entry/exit. More...

bool	threadContextDirty
	Is the gem5 context dirty? Set to true to force an update of the KVM vCPU state upon the next call to kvmRun(). More...

bool	kvmStateDirty
	Is the KVM state dirty? Set to true to force an update of the KVM vCPU state upon the next call to kvmRun(). More...

const long	vcpuID
	KVM internal ID of the vCPU. More...

pthread_t	vcpuThread
	ID of the vCPU thread. More...

Static Protected Attributes
static const std::vector < ArmV8KvmCPU::IntRegInfo >	intRegMap
	Mapping between gem5 integer registers and integer registers in kvm. More...

static const std::vector < ArmV8KvmCPU::MiscRegInfo >	miscRegMap
	Mapping between gem5 misc registers registers and registers in kvm. More...

static const std::vector < ArmV8KvmCPU::MiscRegInfo >	miscRegIdMap
	Mapping between gem5 ID misc registers registers and registers in kvm. More...

Additional Inherited Members
Static Public Member Functions inherited from BaseCPU
static int	numSimulatedInsts ()

static int	numSimulatedOps ()

static void	wakeup (ThreadID tid)

Public Attributes inherited from BaseKvmCPU
SimpleThread *	thread
	A cached copy of a thread's state in the form of a SimpleThread object. More...

ThreadContext *	tc
	ThreadContext object, provides an interface for external objects to modify this thread's state. More...

KvmVM &	vm

Counter	ctrInsts
	Number of instructions executed by the CPU. More...

Stats::Scalar	numInsts

Stats::Scalar	numVMExits

Stats::Scalar	numVMHalfEntries

Stats::Scalar	numExitSignal

Stats::Scalar	numMMIO

Stats::Scalar	numCoalescedMMIO

Stats::Scalar	numIO

Stats::Scalar	numHalt

Stats::Scalar	numInterrupts

Stats::Scalar	numHypercalls

Protected Types inherited from BaseArmKvmCPU
typedef std::vector< uint64_t >	RegIndexVector

Protected Types inherited from BaseKvmCPU
enum	Status { Idle, Running, RunningService, RunningMMIOPending, RunningServiceCompletion }

Detailed Description

This is an implementation of a KVM-based ARMv8-compatible CPU.

Known limitations:

The system-register-based generic timer can only be simulated by the host kernel. Workaround: Use a memory mapped timer instead to simulate the timer in gem5.
Simulating devices (e.g., the generic timer) in the host kernel requires that the host kernel also simulates the GIC.
ID registers in the host and in gem5 must match for switching between simulated CPUs and KVM. This is particularly important for ID registers describing memory system capabilities (e.g., ASID size, physical address size).
Switching between a virtualized CPU and a simulated CPU is currently not supported if in-kernel device emulation is used. This could be worked around by adding support for switching to the gem5 (e.g., the KvmGic) side of the device models. A simpler workaround is to avoid in-kernel device models altogether.

Definition at line 80 of file armv8_cpu.hh.

Constructor & Destructor Documentation

ArmV8KvmCPU::ArmV8KvmCPU ( ArmV8KvmCPUParams * params )

Definition at line 121 of file armv8_cpu.cc.

ArmV8KvmCPU::~ArmV8KvmCPU ( )

virtual

Definition at line 126 of file armv8_cpu.cc.

Member Function Documentation

void ArmV8KvmCPU::dump ( ) const

overridevirtual

Dump the internal state to the terminal.

Reimplemented from BaseKvmCPU.

Definition at line 144 of file armv8_cpu.cc.

References ArmISA::decodeAArch64SysReg(), EXTRACT_FIELD, BaseKvmCPU::getAndFormatOneReg(), BaseArmKvmCPU::getRegList(), ArmISA::i, SparcISA::id, inform, INT_REG, intRegMap, kvmFPReg(), kvmXReg(), miscRegIdMap, miscRegMap, ArmISA::miscRegName, NUM_QREGS, NUM_XREGS, X86ISA::reg, X86ISA::type, and X86ISA::val.

const std::vector< ArmV8KvmCPU::MiscRegInfo > & ArmV8KvmCPU::getSysRegMap ( ) const

protected

Get a map between system registers in kvm and gem5 registers.

This method returns a mapping between system registers in kvm and misc regs in gem5. The actual mapping is only created the first time the method is called and stored in a cache (ArmV8KvmCPU::sysRegMap).

Returns: Vector of kvm<->misc reg mappings.

Definition at line 336 of file armv8_cpu.cc.

References ArmISA::decodeAArch64SysReg(), EXTRACT_FIELD, BaseArmKvmCPU::getRegList(), ArmISA::MISCREG_HYP_WR, ArmISA::MISCREG_IMPLEMENTED, ArmISA::MISCREG_MON_NS0_WR, ArmISA::MISCREG_MON_NS1_WR, ArmISA::MISCREG_PRI_NS_WR, ArmISA::MISCREG_PRI_S_WR, ArmISA::MISCREG_USR_NS_WR, ArmISA::MISCREG_USR_S_WR, ArmISA::MISCREG_WARN_NOT_FAIL, ArmISA::miscRegInfo, ArmISA::miscRegName, X86ISA::reg, sysRegMap, and X86ISA::type.

Referenced by updateKvmState(), and updateThreadContext().

void ArmV8KvmCPU::startup ( )

override

Definition at line 131 of file armv8_cpu.cc.

References DPRINTF, miscRegIdMap, ThreadContext::readMiscReg(), BaseKvmCPU::setOneReg(), BaseArmKvmCPU::startup(), and BaseKvmCPU::tc.

void ArmV8KvmCPU::updateKvmState ( )

overrideprotectedvirtual

Update the KVM state from the current thread context.

The base CPU calls this method before starting the guest CPU when the contextDirty flag is set. The architecture dependent CPU implementation is expected to update all guest state (registers, special registers, and FPU state).

Implements BaseKvmCPU.

Definition at line 211 of file armv8_cpu.cc.

References ArmISA::CCREG_C, ArmISA::CCREG_GE, ArmISA::CCREG_NZ, ArmISA::CCREG_V, KvmFPReg::data, DPRINTF, FP_REGS_PER_VFP_REG, BaseKvmCPU::getAndFormatOneReg(), getSysRegMap(), KvmFPReg::i, ArmISA::i, ThreadContext::instAddr(), INT_REG, ArmISA::INTREG_X0, intRegMap, ArmISA::j, kvmFPReg(), kvmXReg(), ArmISA::MISCREG_CPSR, miscRegMap, NUM_QREGS, NUM_XREGS, ThreadContext::readCCReg(), ThreadContext::readFloatRegBits(), ThreadContext::readIntReg(), ThreadContext::readMiscReg(), X86ISA::reg, KvmFPReg::s, BaseKvmCPU::setOneReg(), and BaseKvmCPU::tc.

void ArmV8KvmCPU::updateThreadContext ( )

overrideprotectedvirtual

Update the current thread context with the KVM state.

The base CPU after the guest updates any of the KVM state. In practice, this happens after kvmRun is called. The architecture dependent code is expected to read the state of the guest CPU and update gem5's thread state.

Implements BaseKvmCPU.

Definition at line 267 of file armv8_cpu.cc.

References ArmISA::CCREG_C, ArmISA::CCREG_GE, ArmISA::CCREG_NZ, ArmISA::CCREG_V, KvmFPReg::data, DPRINTF, FP_REGS_PER_VFP_REG, BaseKvmCPU::getAndFormatOneReg(), BaseKvmCPU::getOneReg(), BaseKvmCPU::getOneRegU64(), getSysRegMap(), KvmFPReg::i, ArmISA::i, ArmISA::inAArch64(), INT_REG, ArmISA::IntReg64Map, ArmISA::INTREG_X0, intRegMap, ArmISA::j, kvmFPReg(), kvmXReg(), ArmISA::MISCREG_CPSR, miscRegMap, NUM_QREGS, NUM_XREGS, pc, ThreadContext::pcState(), X86ISA::reg, KvmFPReg::s, ThreadContext::setCCReg(), ThreadContext::setFloatRegBits(), ThreadContext::setIntReg(), ThreadContext::setIntRegFlat(), ThreadContext::setMiscRegNoEffect(), and BaseKvmCPU::tc.

Member Data Documentation

const std::vector< ArmV8KvmCPU::IntRegInfo > ArmV8KvmCPU::intRegMap

staticprotected

Initial value:

= {
    { INT_REG(regs.sp), INTREG_SP0, "SP(EL0)" },
    { INT_REG(sp_el1), INTREG_SP1, "SP(EL1)" },
}

Mapping between gem5 integer registers and integer registers in kvm.

Definition at line 134 of file armv8_cpu.hh.

Referenced by dump(), updateKvmState(), and updateThreadContext().

const std::vector< ArmV8KvmCPU::MiscRegInfo > ArmV8KvmCPU::miscRegIdMap

staticprotected

Initial value:

= {
    MiscRegInfo(SYS_MPIDR_EL1, MISCREG_MPIDR_EL1, "MPIDR(EL1)"),
}

Mapping between gem5 ID misc registers registers and registers in kvm.

Definition at line 138 of file armv8_cpu.hh.

Referenced by dump(), and startup().

const std::vector< ArmV8KvmCPU::MiscRegInfo > ArmV8KvmCPU::miscRegMap

staticprotected

Initial value:

= {
    MiscRegInfo(INT_REG(elr_el1), MISCREG_ELR_EL1, "ELR(EL1)"),
    MiscRegInfo(INT_REG(spsr[KVM_SPSR_EL1]), MISCREG_SPSR_EL1, "SPSR(EL1)"),
    MiscRegInfo(INT_REG(spsr[KVM_SPSR_ABT]), MISCREG_SPSR_ABT, "SPSR(ABT)"),
    MiscRegInfo(INT_REG(spsr[KVM_SPSR_UND]), MISCREG_SPSR_UND, "SPSR(UND)"),
    MiscRegInfo(INT_REG(spsr[KVM_SPSR_IRQ]), MISCREG_SPSR_IRQ, "SPSR(IRQ)"),
    MiscRegInfo(INT_REG(spsr[KVM_SPSR_FIQ]), MISCREG_SPSR_FIQ, "SPSR(FIQ)"),
    MiscRegInfo(INT_REG(fp_regs.fpsr), MISCREG_FPSR, "FPSR"),
    MiscRegInfo(INT_REG(fp_regs.fpcr), MISCREG_FPCR, "FPCR"),
}

Mapping between gem5 misc registers registers and registers in kvm.

Definition at line 136 of file armv8_cpu.hh.

Referenced by dump(), updateKvmState(), and updateThreadContext().

std::vector<ArmV8KvmCPU::MiscRegInfo> ArmV8KvmCPU::sysRegMap

mutableprotected

Cached mapping between system registers in kvm and misc regs in gem5.

Definition at line 141 of file armv8_cpu.hh.

Referenced by getSysRegMap().

The documentation for this class was generated from the following files:

arch/arm/kvm/armv8_cpu.hh
arch/arm/kvm/armv8_cpu.cc

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation