x86 implementation of a KVM-based hardware virtualized CPU. More...

#include <x86_cpu.hh>

Inheritance diagram for X86KvmCPU:

Public Member Functions
	X86KvmCPU (X86KvmCPUParams *params)

virtual	~X86KvmCPU ()

void	startup () override


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

void	dumpFpuRegs () const

void	dumpIntRegs () const

void	dumpSpecRegs () const

void	dumpDebugRegs () const

void	dumpXCRs () const

void	dumpXSave () const

void	dumpVCpuEvents () const

void	dumpMSRs () const

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

virtual	~BaseKvmCPU ()

void	init () override

void	startup () override

void	serializeThread (CheckpointOut &cp, ThreadID tid) const override
	Serialize a single thread. More...

void	unserializeThread (CheckpointIn &cp, ThreadID tid) override
	Unserialize one thread. More...

DrainState	drain () override

void	drainResume () override

void	notifyFork () override

void	switchOut () override
	Prepare for another CPU to take over execution. More...

void	takeOverFrom (BaseCPU *cpu) override
	Load the state of a CPU from the previous CPU object, invoked on all new CPUs that are about to be switched in. More...

void	verifyMemoryMode () const override
	Verify that the system is in a memory mode supported by the CPU. More...

Port &	getDataPort () override
	Purely virtual method that returns a reference to the data port. More...

Port &	getInstPort () override
	Purely virtual method that returns a reference to the instruction port. More...

void	wakeup (ThreadID tid=0) override

void	activateContext (ThreadID thread_num) override
	Notify the CPU that the indicated context is now active. More...

void	suspendContext (ThreadID thread_num) override
	Notify the CPU that the indicated context is now suspended. More...

void	deallocateContext (ThreadID thread_num)

void	haltContext (ThreadID thread_num) override
	Notify the CPU that the indicated context is now halted. More...

long	getVCpuID () const

ThreadContext *	getContext (int tn) override
	Given a thread num get tho thread context for it. More...

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...

Public Member Functions inherited from BaseCPU
virtual PortProxy::SendFunctionalFunc	getSendFunctional ()
	Returns a sendFunctional delegate for use with port proxies. More...

int	cpuId () const
	Reads this CPU's ID. More...

uint32_t	socketId () const
	Reads this CPU's Socket ID. More...

RequestorID	dataRequestorId () const
	Reads this CPU's unique data requestor ID. More...

RequestorID	instRequestorId () const
	Reads this CPU's unique instruction requestor ID. More...

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port on this CPU. More...

uint32_t	taskId () const
	Get cpu task id. More...

void	taskId (uint32_t id)
	Set cpu task id. More...

uint32_t	getPid () const

void	setPid (uint32_t pid)

void	workItemBegin ()

void	workItemEnd ()

Tick	instCount ()

BaseInterrupts *	getInterruptController (ThreadID tid)

void	postInterrupt (ThreadID tid, int int_num, int index)

void	clearInterrupt (ThreadID tid, int int_num, int index)

void	clearInterrupts (ThreadID tid)

bool	checkInterrupts (ThreadID tid) const

Trace::InstTracer *	getTracer ()
	Provide access to the tracer pointer. More...

int	findContext (ThreadContext *tc)
	Given a Thread Context pointer return the thread num. More...

unsigned	numContexts ()
	Get the number of thread contexts available. More...

ThreadID	contextToThread (ContextID cid)
	Convert ContextID to threadID. More...

const Params *	params () const

	BaseCPU (Params *params, bool is_checker=false)

virtual	~BaseCPU ()

void	init () override

void	startup () override

void	regStats () override

void	regProbePoints () override

void	registerThreadContexts ()

void	deschedulePowerGatingEvent ()

void	schedulePowerGatingEvent ()

void	flushTLBs ()
	Flush all TLBs in the CPU. More...

bool	switchedOut () const
	Determine if the CPU is switched out. More...

unsigned int	cacheLineSize () const
	Get the cache line size of the system. More...

void	serialize (CheckpointOut &cp) const override
	Serialize this object to the given output stream. More...

void	unserialize (CheckpointIn &cp) override
	Reconstruct the state of this object from a checkpoint. More...

void	scheduleInstStop (ThreadID tid, Counter insts, const char *cause)
	Schedule an event that exits the simulation loops after a predefined number of instructions. More...

uint64_t	getCurrentInstCount (ThreadID tid)
	Get the number of instructions executed by the specified thread on this CPU. More...

void	traceFunctions (Addr pc)

void	armMonitor (ThreadID tid, Addr address)

bool	mwait (ThreadID tid, PacketPtr pkt)

void	mwaitAtomic (ThreadID tid, ThreadContext tc, BaseTLB dtb)

AddressMonitor *	getCpuAddrMonitor (ThreadID tid)

bool	waitForRemoteGDB () const

virtual void	probeInstCommit (const StaticInstPtr &inst, Addr pc)
	Helper method to trigger PMU probes for a committed instruction. More...

Protected Types
typedef std::vector< struct kvm_msr_entry >	KvmMSRVector

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

Protected Types inherited from BaseCPU
enum	CPUState { CPU_STATE_ON, CPU_STATE_SLEEP, CPU_STATE_WAKEUP }

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

Tick	kvmRunDrain () override
	Run the virtual CPU until draining completes. More...

Tick	kvmRunWrapper (Tick ticks)
	Wrapper that synchronizes state in kvm_run. More...

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

const Kvm::MSRIndexVector &	getMsrIntersection () const
	Get a list of MSRs supported by both gem5 and KVM. More...

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...

void	deliverInterrupts ()
	Inject pending interrupts from gem5 into the virtual CPU. More...

Tick	handleKvmExitIO () override
	Handle x86 legacy IO (in/out) More...

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

bool	archIsDrained () const override
	Check if there are pending events in the vCPU that prevents it from being drained. More...


void	setCPUID (const struct kvm_cpuid2 &cpuid)
	Methods to access CPUID information using the extended API. More...

void	setCPUID (const Kvm::CPUIDVector &cpuid)


void	setMSRs (const struct kvm_msrs &msrs)
	Methods to access MSRs in the guest. More...

void	setMSRs (const KvmMSRVector &msrs)

void	getMSRs (struct kvm_msrs &msrs) const

void	setMSR (uint32_t index, uint64_t value)

uint64_t	getMSR (uint32_t index) const


void	getDebugRegisters (struct kvm_debugregs &regs) const
	Wrappers around KVM's state transfer methods. More...

void	setDebugRegisters (const struct kvm_debugregs &regs)

void	getXCRs (struct kvm_xcrs &regs) const

void	setXCRs (const struct kvm_xcrs &regs)

void	getXSave (struct kvm_xsave &xsave) const

void	setXSave (const struct kvm_xsave &xsave)

void	getVCpuEvents (struct kvm_vcpu_events &events) const

void	setVCpuEvents (const struct kvm_vcpu_events &events)

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...

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...

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...

EventQueue *	deviceEventQueue ()
	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	handleKvmExitHypercall ()
	The guest requested a monitor service using a hypercall. 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 Member Functions inherited from BaseCPU
void	updateCycleCounters (CPUState state)
	base method keeping track of cycle progression More...

void	enterPwrGating ()

ProbePoints::PMUUPtr	pmuProbePoint (const char *name)
	Helper method to instantiate probe points belonging to this object. More...

Private Member Functions
void	updateCPUID ()
	Transfer gem5's CPUID values into the virtual CPU. More...

void	handleIOMiscReg32 (int miscreg)
	Handle a 32-bit IO access that should be mapped to a MiscReg. More...


void	updateKvmStateRegs ()
	Support routines to update the state of the KVM CPU from gem5's state representation. More...

void	updateKvmStateSRegs ()
	Update control registers (CRx, segments, etc.) More...

void	updateKvmStateFPU ()
	Update FPU and SIMD registers. More...

void	updateKvmStateFPULegacy ()
	Update FPU and SIMD registers using the legacy API. More...

void	updateKvmStateFPUXSave ()
	Update FPU and SIMD registers using the XSave API. More...

void	updateKvmStateMSRs ()
	Update MSR registers. More...


void	updateThreadContextRegs (const struct kvm_regs &regs, const struct kvm_sregs &sregs)
	Support routines to update the state of gem5's thread context from KVM's state representation. More...

void	updateThreadContextSRegs (const struct kvm_sregs &sregs)
	Update control registers (CRx, segments, etc.) More...

void	updateThreadContextFPU (const struct kvm_fpu &fpu)
	Update FPU and SIMD registers using the legacy API. More...

void	updateThreadContextXSave (const struct kvm_xsave &kxsave)
	Update FPU and SIMD registers using the XSave API. More...

void	updateThreadContextMSRs ()
	Update MSR registers. More...

Private Attributes
Kvm::MSRIndexVector	cachedMsrIntersection
	Cached intersection of supported MSRs. More...


bool	haveDebugRegs
	Kvm::capDebugRegs() available? More...

bool	haveXSave
	Kvm::capXSave() available? More...

bool	useXSave
	Should the XSave interface be used to sync the FPU and SIMD registers? More...

bool	haveXCRs
	Kvm::capXCRs() available? More...

Additional Inherited Members
Public Types inherited from BaseCPU
typedef BaseCPUParams	Params

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

static int	numSimulatedOps ()

static void	wakeup (ThreadID tid)

static int	numSimulatedCPUs ()

static Counter	numSimulatedInsts ()

static Counter	numSimulatedOps ()

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

BaseKvmCPU::StatGroup	stats

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

Public Attributes inherited from BaseCPU
ThreadID	numThreads
	Number of threads we're actually simulating (<= SMT_MAX_THREADS). More...

System *	system

Stats::Scalar	numCycles

Stats::Scalar	numWorkItemsStarted

Stats::Scalar	numWorkItemsCompleted

Cycles	syscallRetryLatency

Static Public Attributes inherited from BaseCPU
static const uint32_t	invldPid = std::numeric_limits<uint32_t>::max()
	Invalid or unknown Pid. More...

static const Addr	PCMask = ~((Addr)sizeof(TheISA::MachInst) - 1)

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...

Protected Attributes inherited from BaseCPU
Tick	instCnt
	Instruction count used for SPARC misc register. More...

int	_cpuId

const uint32_t	_socketId
	Each cpu will have a socket ID that corresponds to its physical location in the system. More...

RequestorID	_instRequestorId
	instruction side request id that must be placed in all requests More...

RequestorID	_dataRequestorId
	data side request id that must be placed in all requests More...

uint32_t	_taskId
	An intrenal representation of a task identifier within gem5. More...

uint32_t	_pid
	The current OS process ID that is executing on this processor. More...

bool	_switchedOut
	Is the CPU switched out or active? More...

const unsigned int	_cacheLineSize
	Cache the cache line size that we get from the system. More...

std::vector< BaseInterrupts * >	interrupts

std::vector< ThreadContext * >	threadContexts

Trace::InstTracer *	tracer

Cycles	previousCycle

CPUState	previousState

const Cycles	pwrGatingLatency

const bool	powerGatingOnIdle

EventFunctionWrapper	enterPwrGatingEvent

ProbePoints::PMUUPtr	ppRetiredInsts
	Instruction commit probe point. More...

ProbePoints::PMUUPtr	ppRetiredInstsPC

ProbePoints::PMUUPtr	ppRetiredLoads
	Retired load instructions. More...

ProbePoints::PMUUPtr	ppRetiredStores
	Retired store instructions. More...

ProbePoints::PMUUPtr	ppRetiredBranches
	Retired branches (any type) More...

ProbePoints::PMUUPtr	ppAllCycles
	CPU cycle counter even if any thread Context is suspended. More...

ProbePoints::PMUUPtr	ppActiveCycles
	CPU cycle counter, only counts if any thread contexts is active. More...

ProbePointArg< bool > *	ppSleeping
	ProbePoint that signals transitions of threadContexts sets. More...

Detailed Description

x86 implementation of a KVM-based hardware virtualized CPU.

Definition at line 39 of file x86_cpu.hh.

Member Typedef Documentation

◆ KvmMSRVector

typedef std::vector<struct kvm_msr_entry> X86KvmCPU::KvmMSRVector

protected

Definition at line 60 of file x86_cpu.hh.

Constructor & Destructor Documentation

◆ X86KvmCPU()

X86KvmCPU::X86KvmCPU ( X86KvmCPUParams * params )

Definition at line 523 of file x86_cpu.cc.

References Kvm::capDebugRegs(), Kvm::capExtendedCPUID(), Kvm::capSetTSSAddress(), Kvm::capUserNMI(), Kvm::capVCPUEvents(), Kvm::capXCRs(), Kvm::capXSave(), haveDebugRegs, haveXCRs, haveXSave, KvmVM::kvm, panic, useXSave, BaseKvmCPU::vm, and warn.

◆ ~X86KvmCPU()

X86KvmCPU::~X86KvmCPU ( )

virtual

Definition at line 551 of file x86_cpu.cc.

Member Function Documentation

◆ archIsDrained()

bool X86KvmCPU::archIsDrained ( ) const

overrideprotectedvirtual

Check if there are pending events in the vCPU that prevents it from being drained.

There are cases after interrupt injection where the interrupt is still pending in the guest. This method detects such cases and requests additional draining.

Returns: False if there are pending events in the guest, True otherwise.

Reimplemented from BaseKvmCPU.

Definition at line 1379 of file x86_cpu.cc.

References DPRINTF, and getVCpuEvents().

Referenced by kvmRunDrain().

◆ deliverInterrupts()

void X86KvmCPU::deliverInterrupts ( )

protected

Inject pending interrupts from gem5 into the virtual CPU.

Definition at line 1131 of file x86_cpu.cc.

References DPRINTF, X86ISA::X86FaultBase::getVector(), BaseCPU::interrupts, BaseKvmCPU::kvmInterrupt(), BaseKvmCPU::kvmNonMaskableInterrupt(), panic, SimpleThread::suspend(), BaseKvmCPU::syncThreadContext(), BaseKvmCPU::tc, BaseKvmCPU::thread, BaseKvmCPU::threadContextDirty, and updateKvmState().

Referenced by kvmRun().

◆ dump()

void X86KvmCPU::dump ( ) const

overridevirtual

Dump the internal state to the terminal.

Reimplemented from BaseKvmCPU.

Definition at line 570 of file x86_cpu.cc.

References dumpDebugRegs(), dumpFpuRegs(), dumpIntRegs(), dumpMSRs(), dumpSpecRegs(), dumpVCpuEvents(), dumpXCRs(), dumpXSave(), and useXSave.

Referenced by updateKvmState(), and updateThreadContext().

◆ dumpDebugRegs()

void X86KvmCPU::dumpDebugRegs ( ) const

Definition at line 609 of file x86_cpu.cc.

References dumpKvm(), getDebugRegisters(), haveDebugRegs, and inform.

Referenced by dump().

◆ dumpFpuRegs()

void X86KvmCPU::dumpFpuRegs ( ) const

Definition at line 585 of file x86_cpu.cc.

References dumpKvm(), and BaseKvmCPU::getFPUState().

Referenced by dump().

◆ dumpIntRegs()

void X86KvmCPU::dumpIntRegs ( ) const

Definition at line 593 of file x86_cpu.cc.

References dumpKvm(), and BaseKvmCPU::getRegisters().

Referenced by dump().

◆ dumpMSRs()

void X86KvmCPU::dumpMSRs ( ) const

Definition at line 655 of file x86_cpu.cc.

References dumpKvm(), ArmISA::e, getMSRs(), ArmISA::i, KvmVM::kvm, and BaseKvmCPU::vm.

Referenced by dump().

◆ dumpSpecRegs()

void X86KvmCPU::dumpSpecRegs ( ) const

Definition at line 601 of file x86_cpu.cc.

References dumpKvm(), and BaseKvmCPU::getSpecialRegisters().

Referenced by dump().

◆ dumpVCpuEvents()

void X86KvmCPU::dumpVCpuEvents ( ) const

Definition at line 647 of file x86_cpu.cc.

References dumpKvm(), and getVCpuEvents().

Referenced by dump().

◆ dumpXCRs()

void X86KvmCPU::dumpXCRs ( ) const

Definition at line 623 of file x86_cpu.cc.

References dumpKvm(), getXCRs(), haveXCRs, and inform.

Referenced by dump().

◆ dumpXSave()

void X86KvmCPU::dumpXSave ( ) const

Definition at line 635 of file x86_cpu.cc.

References dumpKvm(), getXSave(), haveXSave, and inform.

Referenced by dump().

◆ getDebugRegisters()

void X86KvmCPU::getDebugRegisters ( struct kvm_debugregs & regs ) const

protected

Wrappers around KVM's state transfer methods.

Definition at line 1561 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by dumpDebugRegs().

◆ getHostCycles()

uint64_t X86KvmCPU::getHostCycles ( ) const

overrideprotectedvirtual

Get the value of the hardware cycle counter in the guest.

This method is supposed to return the total number of cycles executed in hardware mode relative to some arbitrary point in the past. It's mainly used when estimating the number of cycles actually executed by the CPU in kvmRun(). The default behavior of this method is to use the cycles performance counter, but some architectures may want to use internal registers instead.

Returns: Number of host cycles executed relative to an undefined point in the past.

Reimplemented from BaseKvmCPU.

Definition at line 1276 of file x86_cpu.cc.

References getMSR(), and MSR_TSC.

◆ getMSR()

uint64_t X86KvmCPU::getMSR ( uint32_t index ) const

protected

Definition at line 1524 of file x86_cpu.cc.

References getMSRs(), and MipsISA::index.

Referenced by getHostCycles().

◆ getMsrIntersection()

const Kvm::MSRIndexVector & X86KvmCPU::getMsrIntersection ( ) const

protected

Get a list of MSRs supported by both gem5 and KVM.

Note: This method uses an internal cache and only generates the MSR list once.

Returns: reference to a list of msr indices

Definition at line 1540 of file x86_cpu.cc.

References cachedMsrIntersection, DPRINTF, KvmVM::kvm, X86ISA::msrMap, BaseKvmCPU::vm, and warn.

Referenced by updateKvmStateMSRs(), and updateThreadContextMSRs().

◆ getMSRs()

void X86KvmCPU::getMSRs ( struct kvm_msrs & msrs ) const

protected

Definition at line 1500 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by dumpMSRs(), getMSR(), and updateThreadContextMSRs().

◆ getVCpuEvents()

void X86KvmCPU::getVCpuEvents ( struct kvm_vcpu_events & events ) const

protected

Definition at line 1612 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by archIsDrained(), and dumpVCpuEvents().

◆ getXCRs()

void X86KvmCPU::getXCRs ( struct kvm_xcrs & regs ) const

protected

Definition at line 1583 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by dumpXCRs().

◆ getXSave()

void X86KvmCPU::getXSave ( struct kvm_xsave & xsave ) const

protected

Definition at line 1597 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by dumpXSave(), and updateThreadContext().

◆ handleIOMiscReg32()

void X86KvmCPU::handleIOMiscReg32 ( int miscreg )

private

Handle a 32-bit IO access that should be mapped to a MiscReg.

Note: This method can only be called on when handling IO after a KVM_EXIT_IO.

Parameters

miscreg Register to map the current IO access to.

Definition at line 1282 of file x86_cpu.cc.

References data, BaseKvmCPU::getGuestData(), BaseKvmCPU::getKvmRunState(), panic, ThreadContext::readMiscRegNoEffect(), ThreadContext::setMiscReg(), and BaseKvmCPU::tc.

Referenced by handleKvmExitIO().

◆ handleKvmExitIO()

Tick X86KvmCPU::handleKvmExitIO ( )

overrideprotectedvirtual

Handle x86 legacy IO (in/out)

Reimplemented from BaseKvmCPU.

Definition at line 1307 of file x86_cpu.cc.

References ThreadContext::contextId(), X86ISA::count, BaseKvmCPU::dataPort, BaseCPU::dataRequestorId(), Packet::dataStatic(), BaseKvmCPU::deviceEventQueue(), DPRINTF, BaseKvmCPU::getGuestData(), BaseKvmCPU::getKvmRunState(), handleIOMiscReg32(), ArmISA::i, IO_PCI_CONF_ADDR, IO_PCI_CONF_DATA_BASE, X86ISA::MISCREG_PCI_CONFIG_ADDRESS, ThreadContext::readMiscRegNoEffect(), MemCmd::ReadReq, BaseKvmCPU::KVMCpuPort::submitIO(), BaseKvmCPU::tc, Request::UNCACHEABLE, MemCmd::WriteReq, X86ISA::x86IOAddress(), and X86ISA::x86PciConfigAddress().

◆ handleKvmExitIRQWindowOpen()

Tick X86KvmCPU::handleKvmExitIRQWindowOpen ( )

overrideprotectedvirtual

The guest exited because an interrupt window was requested.

The guest exited because an interrupt window was requested (request_interrupt_window in the kvm_run structure was set to 1 before calling kvmRun) and it is now ready to receive

Returns: Number of ticks spent servicing the IRQ

Reimplemented from BaseKvmCPU.

Definition at line 1370 of file x86_cpu.cc.

◆ kvmRun()

Tick X86KvmCPU::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

ticks Number of ticks to execute, set to 0 to exit immediately after finishing pending operations.

Returns: Number of ticks executed (see note)

Reimplemented from BaseKvmCPU.

Definition at line 1184 of file x86_cpu.cc.

References BaseKvmCPU::_status, deliverInterrupts(), DPRINTF, BaseKvmCPU::getKvmRunState(), BaseKvmCPU::Idle, BaseCPU::interrupts, kvmRunWrapper(), and BaseKvmCPU::syncThreadContext().

◆ kvmRunDrain()

Tick X86KvmCPU::kvmRunDrain ( )

overrideprotectedvirtual

Run the virtual CPU until draining completes.

In addition to the base functionality provided by BaseKvmCPU::kvmRunDrain(), this method handles x86-specific cases where there are pending interrupt events in the virtual CPU. These are handled by requesting an interrupt window if interrupts are pending (causing the vCPU to execute until interrupts can be delivered again).

See also: BaseKvmCPU::kvmRunDrain(); archIsDrained()

Returns: Number of ticks executed

Reimplemented from BaseKvmCPU.

Definition at line 1232 of file x86_cpu.cc.

References archIsDrained(), DPRINTF, BaseKvmCPU::getKvmRunState(), kvmRunWrapper(), and SimClock::Float::ms.

◆ kvmRunWrapper()

Tick X86KvmCPU::kvmRunWrapper ( Tick ticks )

protected

Wrapper that synchronizes state in kvm_run.

Definition at line 1257 of file x86_cpu.cc.

References BaseKvmCPU::getKvmRunState(), BaseKvmCPU::kvmRun(), X86ISA::MISCREG_APIC_BASE, X86ISA::MISCREG_CR8, ThreadContext::readMiscReg(), ThreadContext::setMiscReg(), and BaseKvmCPU::tc.

Referenced by kvmRun(), and kvmRunDrain().

◆ setCPUID() [1/2]

void X86KvmCPU::setCPUID ( const Kvm::CPUIDVector & cpuid )

protected

Definition at line 1468 of file x86_cpu.cc.

References MipsISA::cpuid, and setCPUID().

◆ setCPUID() [2/2]

void X86KvmCPU::setCPUID ( const struct kvm_cpuid2 & cpuid )

protected

Methods to access CPUID information using the extended API.

Only available if Kvm::capExtendedCPUID() is true.

Definition at line 1460 of file x86_cpu.cc.

References MipsISA::cpuid, BaseKvmCPU::ioctl(), and panic.

Referenced by setCPUID(), and updateCPUID().

◆ setDebugRegisters()

void X86KvmCPU::setDebugRegisters ( const struct kvm_debugregs & regs )

protected

Definition at line 1572 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

◆ setMSR()

void X86KvmCPU::setMSR	(	uint32_t	index,
		uint64_t	value
	)

protected

Definition at line 1509 of file x86_cpu.cc.

References MipsISA::index, and setMSRs().

◆ setMSRs() [1/2]

void X86KvmCPU::setMSRs ( const KvmMSRVector & msrs )

protected

Definition at line 1488 of file x86_cpu.cc.

References setMSRs().

◆ setMSRs() [2/2]

void X86KvmCPU::setMSRs ( const struct kvm_msrs & msrs )

protected

Methods to access MSRs in the guest.

Definition at line 1480 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by setMSR(), setMSRs(), and updateKvmStateMSRs().

◆ setVCpuEvents()

void X86KvmCPU::setVCpuEvents ( const struct kvm_vcpu_events & events )

protected

Definition at line 1619 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

◆ setXCRs()

void X86KvmCPU::setXCRs ( const struct kvm_xcrs & regs )

protected

Definition at line 1590 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

◆ setXSave()

void X86KvmCPU::setXSave ( const struct kvm_xsave & xsave )

protected

Definition at line 1604 of file x86_cpu.cc.

References BaseKvmCPU::ioctl(), and panic.

Referenced by updateKvmStateFPUXSave().

◆ startup()

void X86KvmCPU::startup ( )

override

Definition at line 556 of file x86_cpu.cc.

References BaseKvmCPU::startup(), and updateCPUID().

◆ updateCPUID()

void X86KvmCPU::updateCPUID ( )

private

Transfer gem5's CPUID values into the virtual CPU.

Definition at line 1424 of file x86_cpu.cc.

References MipsISA::cpuid, X86ISA::doCpuid(), makeKvmCpuid(), X86ISA::CpuidResult::rax, setCPUID(), and BaseKvmCPU::tc.

Referenced by startup().

◆ updateKvmState()

void X86KvmCPU::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 675 of file x86_cpu.cc.

References DPRINTF, DTRACE, dump(), updateKvmStateFPU(), updateKvmStateMSRs(), updateKvmStateRegs(), and updateKvmStateSRegs().

Referenced by deliverInterrupts().

◆ updateKvmStateFPU()

void X86KvmCPU::updateKvmStateFPU ( )

private

Update FPU and SIMD registers.

This method uses the appropriate (depending on availability and user configuration) kernel API by calling updateKvmStateFPULegacy() or updateKvmStateFPUXSave().

See also: updateKvmStateFPULegacy(); updateKvmStateFPUXSave()

Definition at line 907 of file x86_cpu.cc.

References updateKvmStateFPULegacy(), updateKvmStateFPUXSave(), and useXSave.

Referenced by updateKvmState().

◆ updateKvmStateFPULegacy()

void X86KvmCPU::updateKvmStateFPULegacy ( )

private

Update FPU and SIMD registers using the legacy API.

Note: This method should normally only be called by updateKvmStateFPU() which automatically chooses between available APIs.

Definition at line 858 of file x86_cpu.cc.

References X86ISA::MISCREG_FIOFF, X86ISA::MISCREG_FISEG, X86ISA::MISCREG_FOOFF, X86ISA::MISCREG_FOSEG, ThreadContext::readMiscRegNoEffect(), BaseKvmCPU::setFPUState(), BaseKvmCPU::tc, updateKvmStateFPUCommon(), and warn_once.

Referenced by updateKvmStateFPU().

◆ updateKvmStateFPUXSave()

void X86KvmCPU::updateKvmStateFPUXSave ( )

private

Update FPU and SIMD registers using the XSave API.

Note: This method should normally only be called by updateKvmStateFPU() which automatically chooses between available APIs.

Definition at line 882 of file x86_cpu.cc.

References X86ISA::MISCREG_FIOFF, X86ISA::MISCREG_FISEG, X86ISA::MISCREG_FOOFF, X86ISA::MISCREG_FOSEG, ThreadContext::readMiscRegNoEffect(), setXSave(), BaseKvmCPU::tc, updateKvmStateFPUCommon(), and warn_once.

Referenced by updateKvmStateFPU().

◆ updateKvmStateMSRs()

void X86KvmCPU::updateKvmStateMSRs ( )

private

Update MSR registers.

Definition at line 916 of file x86_cpu.cc.

References DPRINTF, ArmISA::e, getMsrIntersection(), X86ISA::msrMap, ThreadContext::readMiscReg(), setMSRs(), and BaseKvmCPU::tc.

Referenced by updateKvmState().

◆ updateKvmStateRegs()

void X86KvmCPU::updateKvmStateRegs ( )

private

Support routines to update the state of the KVM CPU from gem5's state representation.

Update integer registers

Definition at line 688 of file x86_cpu.cc.

References FOREACH_IREG, X86ISA::getRFlags(), ThreadContext::instAddr(), X86ISA::MISCREG_CS_BASE, ThreadContext::readMiscReg(), BaseKvmCPU::setRegisters(), and BaseKvmCPU::tc.

Referenced by updateKvmState().

◆ updateKvmStateSRegs()

void X86KvmCPU::updateKvmStateSRegs ( )

private

Update control registers (CRx, segments, etc.)

Definition at line 755 of file x86_cpu.cc.

References forceSegAccessed(), FOREACH_DTABLE, FOREACH_SEGMENT, FOREACH_SREG, hack, X86ISA::MISCREG_RFLAGS, ThreadContext::readMiscReg(), SEG_CS_TYPE_ACCESSED, SEG_CS_TYPE_READ_ACCESSED, SEG_SYS_TYPE_TSS_AVAILABLE, SEG_SYS_TYPE_TSS_BUSY, BaseKvmCPU::setSpecialRegisters(), and BaseKvmCPU::tc.

Referenced by updateKvmState().

◆ updateThreadContext()

void X86KvmCPU::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 938 of file x86_cpu.cc.

References DPRINTF, DTRACE, dump(), BaseKvmCPU::getFPUState(), BaseKvmCPU::getRegisters(), BaseKvmCPU::getSpecialRegisters(), getXSave(), X86ISA::MISCREG_M5_REG, ThreadContext::setMiscReg(), BaseKvmCPU::tc, updateThreadContextFPU(), updateThreadContextMSRs(), updateThreadContextRegs(), updateThreadContextSRegs(), updateThreadContextXSave(), and useXSave.

◆ updateThreadContextFPU()

void X86KvmCPU::updateThreadContextFPU ( const struct kvm_fpu & fpu )

private

Update FPU and SIMD registers using the legacy API.

Definition at line 1077 of file x86_cpu.cc.

References X86ISA::MISCREG_FIOFF, X86ISA::MISCREG_FISEG, X86ISA::MISCREG_FOOFF, X86ISA::MISCREG_FOSEG, ThreadContext::setMiscRegNoEffect(), BaseKvmCPU::tc, and updateThreadContextFPUCommon().

Referenced by updateThreadContext().

◆ updateThreadContextMSRs()

void X86KvmCPU::updateThreadContextMSRs ( )

private

Update MSR registers.

Definition at line 1101 of file x86_cpu.cc.

References ArmISA::at, DPRINTF, getMsrIntersection(), getMSRs(), ArmISA::i, X86ISA::msrMap, ThreadContext::setMiscReg(), and BaseKvmCPU::tc.

Referenced by updateThreadContext().

◆ updateThreadContextRegs()

void X86KvmCPU::updateThreadContextRegs	(	const struct kvm_regs &	regs,
		const struct kvm_sregs &	sregs
	)

private

Support routines to update the state of gem5's thread context from KVM's state representation.

Update integer registers

Definition at line 972 of file x86_cpu.cc.

References FOREACH_IREG, ThreadContext::pcState(), X86ISA::setRFlags(), and BaseKvmCPU::tc.

Referenced by updateThreadContext().

◆ updateThreadContextSRegs()

void X86KvmCPU::updateThreadContextSRegs ( const struct kvm_sregs & sregs )

private

Update control registers (CRx, segments, etc.)

Definition at line 1026 of file x86_cpu.cc.

References FOREACH_DTABLE, FOREACH_SEGMENT, FOREACH_SREG, and BaseKvmCPU::getKvmRunState().

Referenced by updateThreadContext().

◆ updateThreadContextXSave()

void X86KvmCPU::updateThreadContextXSave ( const struct kvm_xsave & kxsave )

private

Update FPU and SIMD registers using the XSave API.

Definition at line 1088 of file x86_cpu.cc.

References FXSave::ctrl64, X86ISA::MISCREG_FIOFF, X86ISA::MISCREG_FISEG, X86ISA::MISCREG_FOOFF, X86ISA::MISCREG_FOSEG, ThreadContext::setMiscRegNoEffect(), BaseKvmCPU::tc, and updateThreadContextFPUCommon().

Referenced by updateThreadContext().

Member Data Documentation

◆ cachedMsrIntersection

Kvm::MSRIndexVector X86KvmCPU::cachedMsrIntersection

mutableprivate

Cached intersection of supported MSRs.

Definition at line 236 of file x86_cpu.hh.

Referenced by getMsrIntersection().

◆ haveDebugRegs

bool X86KvmCPU::haveDebugRegs

private

Kvm::capDebugRegs() available?

Definition at line 240 of file x86_cpu.hh.

Referenced by dumpDebugRegs(), and X86KvmCPU().

◆ haveXCRs

bool X86KvmCPU::haveXCRs

private

Kvm::capXCRs() available?

Definition at line 249 of file x86_cpu.hh.

Referenced by dumpXCRs(), and X86KvmCPU().

◆ haveXSave

bool X86KvmCPU::haveXSave

private

Kvm::capXSave() available?

Definition at line 242 of file x86_cpu.hh.

Referenced by dumpXSave(), and X86KvmCPU().

◆ useXSave

bool X86KvmCPU::useXSave

private

Should the XSave interface be used to sync the FPU and SIMD registers?

Definition at line 247 of file x86_cpu.hh.

Referenced by dump(), updateKvmStateFPU(), updateThreadContext(), and X86KvmCPU().

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

cpu/kvm/x86_cpu.hh
cpu/kvm/x86_cpu.cc

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ KvmMSRVector

Constructor & Destructor Documentation

◆ X86KvmCPU()

◆ ~X86KvmCPU()

Member Function Documentation

◆ archIsDrained()

◆ deliverInterrupts()

◆ dump()

◆ dumpDebugRegs()

◆ dumpFpuRegs()

◆ dumpIntRegs()

◆ dumpMSRs()

◆ dumpSpecRegs()

◆ dumpVCpuEvents()

◆ dumpXCRs()

◆ dumpXSave()

◆ getDebugRegisters()

◆ getHostCycles()

◆ getMSR()

◆ getMsrIntersection()

◆ getMSRs()

◆ getVCpuEvents()

◆ getXCRs()

◆ getXSave()

◆ handleIOMiscReg32()

◆ handleKvmExitIO()

◆ handleKvmExitIRQWindowOpen()

◆ kvmRun()

◆ kvmRunDrain()

◆ kvmRunWrapper()

◆ setCPUID() [1/2]

◆ setCPUID() [2/2]

◆ setDebugRegisters()

◆ setMSR()

◆ setMSRs() [1/2]

◆ setMSRs() [2/2]

◆ setVCpuEvents()

◆ setXCRs()

◆ setXSave()

◆ startup()

◆ updateCPUID()

◆ updateKvmState()

◆ updateKvmStateFPU()

◆ updateKvmStateFPULegacy()

◆ updateKvmStateFPUXSave()

◆ updateKvmStateMSRs()

◆ updateKvmStateRegs()

◆ updateKvmStateSRegs()

◆ updateThreadContext()

◆ updateThreadContextFPU()

◆ updateThreadContextMSRs()

◆ updateThreadContextRegs()

◆ updateThreadContextSRegs()

◆ updateThreadContextXSave()

Member Data Documentation

◆ cachedMsrIntersection

◆ haveDebugRegs

◆ haveXCRs

◆ haveXSave

◆ useXSave