gem5  v22.0.0.2
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
gem5::BaseArmKvmCPU Class Reference

#include <base_cpu.hh>

Inheritance diagram for gem5::BaseArmKvmCPU:
gem5::BaseKvmCPU gem5::ArmV8KvmCPU

Public Member Functions

 BaseArmKvmCPU (const BaseArmKvmCPUParams &params)
 
virtual ~BaseArmKvmCPU ()
 
void startup () override
 
- Public Member Functions inherited from gem5::BaseKvmCPU
 BaseKvmCPU (const BaseKvmCPUParams &params)
 
virtual ~BaseKvmCPU ()
 
void init () override
 
void startup () 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
 
PortgetDataPort () override
 
PortgetInstPort () 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
 
ThreadContextgetContext (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...
 
virtual void dump () const
 Dump the internal state to the terminal. More...
 
void kick () const
 Force an exit from KVM. More...
 

Protected Types

typedef std::vector< uint64_t > RegIndexVector
 
- Protected Types inherited from gem5::BaseKvmCPU
enum  Status {
  Idle, Running, RunningService, RunningMMIOPending,
  RunningServiceCompletion
}
 

Protected Member Functions

Tick kvmRun (Tick ticks) override
 Request KVM to run the guest for a given number of ticks. More...
 
void stutterPC (PCStateBase &pc) const override
 Modify a PCStatePtr's value so that its next PC is the current PC. More...
 
void ioctlRun () override
 Override for synchronizing state in kvm_run. More...
 
const RegIndexVectorgetRegList () const
 Get a list of registers supported by getOneReg() and setOneReg(). More...
 
void kvmArmVCpuInit (const kvm_vcpu_init &init)
 Tell the kernel to initialize this CPU. More...
 
- Protected Member Functions inherited from gem5::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
 
virtual void updateKvmState ()=0
 Update the KVM state from the current thread context. More...
 
virtual void updateThreadContext ()=0
 Update the current thread context with the KVM state. More...
 
void syncThreadContext ()
 Update a thread context if the KVM state is dirty with respect to the cached thread context. More...
 
EventQueuedeviceEventQueue ()
 Get a pointer to the event queue owning devices. 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

bool irqAsserted
 Cached state of the IRQ line. More...
 
bool fiqAsserted
 Cached state of the FIQ line. More...
 
ArmInterruptPinvirtTimerPin
 If the user-space GIC and the kernel-space timer are used simultaneously, set up this interrupt pin to forward interrupt from the timer to the GIC when timer IRQ level change is intercepted. More...
 
uint64_t prevDeviceIRQLevel
 KVM records whether each in-kernel device IRQ is asserted or disasserted in the kvmRunState->s.regs.device_irq_level bit map, and guarantees at least one KVM exit when the level changes. More...
 
- Protected Attributes inherited from gem5::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...
 
long vcpuID
 KVM internal ID of the vCPU. More...
 
pthread_t vcpuThread
 ID of the vCPU thread. More...
 

Private Member Functions

std::unique_ptr< kvm_reg_list > tryGetRegList (uint64_t nelem) const
 
bool getRegList (kvm_reg_list &regs) const
 Get a list of registers supported by getOneReg() and setOneReg(). More...
 

Private Attributes

RegIndexVector _regIndexList
 Cached copy of the list of registers supported by KVM. More...
 

Additional Inherited Members

- Public Attributes inherited from gem5::BaseKvmCPU
SimpleThreadthread
 A cached copy of a thread's state in the form of a SimpleThread object. More...
 
ThreadContexttc
 ThreadContext object, provides an interface for external objects to modify this thread's state. More...
 
KvmVMvm
 
gem5::BaseKvmCPU::StatGroup stats
 
Counter ctrInsts
 Number of instructions executed by the CPU. More...
 

Detailed Description

Definition at line 55 of file base_cpu.hh.

Member Typedef Documentation

◆ RegIndexVector

typedef std::vector<uint64_t> gem5::BaseArmKvmCPU::RegIndexVector
protected

Definition at line 98 of file base_cpu.hh.

Constructor & Destructor Documentation

◆ BaseArmKvmCPU()

gem5::BaseArmKvmCPU::BaseArmKvmCPU ( const BaseArmKvmCPUParams &  params)

Definition at line 82 of file base_cpu.cc.

◆ ~BaseArmKvmCPU()

gem5::BaseArmKvmCPU::~BaseArmKvmCPU ( )
virtual

Definition at line 89 of file base_cpu.cc.

Member Function Documentation

◆ getRegList() [1/2]

const BaseArmKvmCPU::RegIndexVector & gem5::BaseArmKvmCPU::getRegList ( ) const
protected

Get a list of registers supported by getOneReg() and setOneReg().

This method returns a list of all registers supported by kvm. The actual list is only requested the first time this method is called. Subsequent calls return a cached copy of the register list.

Returns
Vector of register indexes.

Definition at line 191 of file base_cpu.cc.

References _regIndexList, gem5::VegaISA::p, and panic.

Referenced by gem5::ArmV8KvmCPU::dump(), and gem5::ArmV8KvmCPU::getSysRegMap().

◆ getRegList() [2/2]

bool gem5::BaseArmKvmCPU::getRegList ( kvm_reg_list &  regs) const
private

Get a list of registers supported by getOneReg() and setOneReg().

Returns
False if the number of elements allocated in the list is too small to hold the complete register list (the required size is written to regs.n in this case). True on success.

Definition at line 228 of file base_cpu.cc.

References gem5::BaseKvmCPU::ioctl(), and panic.

◆ ioctlRun()

void gem5::BaseArmKvmCPU::ioctlRun ( )
overrideprotectedvirtual

Override for synchronizing state in kvm_run.

Reimplemented from gem5::BaseKvmCPU.

Definition at line 171 of file base_cpu.cc.

References gem5::BaseKvmCPU::getOneReg(), gem5::BaseKvmCPU::ioctlRun(), gem5::VegaISA::l, and gem5::BaseKvmCPU::setOneReg().

◆ kvmArmVCpuInit()

void gem5::BaseArmKvmCPU::kvmArmVCpuInit ( const kvm_vcpu_init &  init)
protected

Tell the kernel to initialize this CPU.

The kernel needs to know what type of the CPU that we want to emulate. The specified CPU type has to be compatible with the host CPU. In practice, we usually call KvmVM::kvmArmPreferredTarget() to discover the host CPU.

Parameters
targetCPU type to emulate

Definition at line 220 of file base_cpu.cc.

References gem5::BaseKvmCPU::init(), gem5::BaseKvmCPU::ioctl(), and panic.

Referenced by startup().

◆ kvmRun()

Tick gem5::BaseArmKvmCPU::kvmRun ( Tick  ticks)
overrideprotectedvirtual

Request KVM to run the guest for a given number of ticks.

The method returns the approximate number of ticks executed.

Note
The returned number of ticks can be both larger or smaller than the requested number of ticks. A smaller number can, for example, occur when the guest executes MMIO. A larger number is typically due to performance counter inaccuracies.
This method is virtual in order to allow implementations to check for architecture specific events (e.g., interrupts) before entering the VM.
It is the response of the caller (normally tick()) to make sure that the KVM state is synchronized and that the TC is invalidated after entering KVM.
This method does not normally cause any state transitions. However, if it may suspend the CPU by suspending the thread, which leads to a transition to the Idle state. In such a case, kvm must not be entered.
Parameters
ticksNumber of ticks to execute, set to 0 to exit immediately after finishing pending operations.
Returns
Number of ticks executed (see note)

Reimplemented from gem5::BaseKvmCPU.

Definition at line 117 of file base_cpu.cc.

References gem5::ArmInterruptPin::clear(), DPRINTF, fiqAsserted, gem5::BaseKvmCPU::getKvmRunState(), gem5::KvmVM::hasKernelIRQChip(), gem5::ArmISA::INT_FIQ, gem5::ArmISA::INT_IRQ, INTERRUPT_VCPU_FIQ, INTERRUPT_VCPU_IRQ, irqAsserted, gem5::BaseKvmCPU::kvmRun(), prevDeviceIRQLevel, gem5::ArmInterruptPin::raise(), gem5::KvmVM::setIRQLine(), gem5::BaseKvmCPU::vcpuID, virtTimerPin, gem5::BaseKvmCPU::vm, and warn_if.

◆ startup()

void gem5::BaseArmKvmCPU::startup ( )
override

◆ stutterPC()

void gem5::BaseArmKvmCPU::stutterPC ( PCStateBase pc) const
inlineoverrideprotectedvirtual

Modify a PCStatePtr's value so that its next PC is the current PC.

This needs to be implemented in KVM base classes since modifying the next PC value is an ISA specific operation. This is only used in doMMIOAccess, for reasons explained in a comment there.

Implements gem5::BaseKvmCPU.

Definition at line 67 of file base_cpu.hh.

References gem5::MipsISA::pc.

◆ tryGetRegList()

std::unique_ptr<kvm_reg_list> gem5::BaseArmKvmCPU::tryGetRegList ( uint64_t  nelem) const
private

Member Data Documentation

◆ _regIndexList

RegIndexVector gem5::BaseArmKvmCPU::_regIndexList
mutableprivate

Cached copy of the list of registers supported by KVM.

Definition at line 139 of file base_cpu.hh.

Referenced by getRegList().

◆ fiqAsserted

bool gem5::BaseArmKvmCPU::fiqAsserted
protected

Cached state of the FIQ line.

Definition at line 78 of file base_cpu.hh.

Referenced by kvmRun().

◆ irqAsserted

bool gem5::BaseArmKvmCPU::irqAsserted
protected

Cached state of the IRQ line.

Definition at line 76 of file base_cpu.hh.

Referenced by kvmRun().

◆ prevDeviceIRQLevel

uint64_t gem5::BaseArmKvmCPU::prevDeviceIRQLevel
protected

KVM records whether each in-kernel device IRQ is asserted or disasserted in the kvmRunState->s.regs.device_irq_level bit map, and guarantees at least one KVM exit when the level changes.

We use only the KVM_ARM_DEV_EL1_VTIMER bit field currently to track the level of the in-kernel timer, and preserve the last level in this class member.

Definition at line 95 of file base_cpu.hh.

Referenced by kvmRun().

◆ virtTimerPin

ArmInterruptPin* gem5::BaseArmKvmCPU::virtTimerPin
protected

If the user-space GIC and the kernel-space timer are used simultaneously, set up this interrupt pin to forward interrupt from the timer to the GIC when timer IRQ level change is intercepted.

Definition at line 85 of file base_cpu.hh.

Referenced by kvmRun(), and startup().


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

Generated on Thu Jul 28 2022 13:32:57 for gem5 by doxygen 1.8.17