#include <decoder.hh>

Inheritance diagram for gem5::InstDecoder:

Public Member Functions
template<typename MoreBytesType >
	InstDecoder (const InstDecoderParams &params, MoreBytesType *mb_buf)

virtual StaticInstPtr	fetchRomMicroop (MicroPC micropc, StaticInstPtr curMacroop)

virtual void	reset ()

template<class Type >
Type &	as ()

template<class Type >
const Type &	as () const

virtual void	takeOverFrom (InstDecoder *old)
	Take over the state from an old decoder when switching CPUs.

void *	moreBytesPtr () const

size_t	moreBytesSize () const

Addr	pcMask () const

bool	instReady () const
	Is an instruction ready to be decoded?

bool	needMoreBytes () const
	Can the decoder accept more data?

virtual void	moreBytes (const PCStateBase &pc, Addr fetchPC)=0
	Feed data to the decoder.

virtual StaticInstPtr	decode (PCStateBase &pc)=0
	Decode an instruction or fetch it from the code cache.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Attributes
void *	_moreBytesPtr

size_t	_moreBytesSize

Addr	_pcMask

bool	instDone = false

bool	outOfBytes = true

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Detailed Description

Definition at line 42 of file decoder.hh.

Constructor & Destructor Documentation

◆ InstDecoder()

template<typename MoreBytesType >

gem5::InstDecoder::InstDecoder	(	const InstDecoderParams &	params,
		MoreBytesType *	mb_buf )

inline

Definition at line 54 of file decoder.hh.

Member Function Documentation

◆ as() [1/2]

template<class Type >

Type & gem5::InstDecoder::as ( )

inline

Definition at line 71 of file decoder.hh.

Referenced by gem5::ArmISA::ISA::setMiscReg(), gem5::SparcISA::ISA::setMiscReg(), gem5::X86ISA::ISA::setThreadContext(), and gem5::X86ISA::ISA::updateHandyM5Reg().

◆ as() [2/2]

template<class Type >

const Type & gem5::InstDecoder::as ( ) const

inline

Definition at line 78 of file decoder.hh.

◆ decode()

virtual StaticInstPtr gem5::InstDecoder::decode ( PCStateBase & pc )

pure virtual

Decode an instruction or fetch it from the code cache.

This method decodes the currently pending pre-decoded instruction. Data must be fed to the decoder using moreBytes() until instReady() is true before calling this method.

Parameters

pc	Instruction pointer that we are decoding.

Returns: A pointer to a static instruction or NULL if the decoder isn't ready (see instReady()).

Implemented in gem5::ArmISA::Decoder, gem5::MipsISA::Decoder, gem5::PowerISA::Decoder, gem5::RiscvISA::Decoder, gem5::SparcISA::Decoder, and gem5::X86ISA::Decoder.

◆ fetchRomMicroop()

StaticInstPtr gem5::InstDecoder::fetchRomMicroop	(	MicroPC	micropc,
		StaticInstPtr	curMacroop )

virtual

Reimplemented in gem5::X86ISA::Decoder.

Definition at line 36 of file decoder.cc.

References panic.

◆ instReady()

bool gem5::InstDecoder::instReady ( ) const

inline

Is an instruction ready to be decoded?

CPU models call this method to determine if decode() will return a new instruction on the next call. It typically only returns false if the decoder hasn't received enough data to decode a full instruction.

Definition at line 107 of file decoder.hh.

References instDone.

◆ moreBytes()

virtual void gem5::InstDecoder::moreBytes	(	const PCStateBase &	pc,
		Addr	fetchPC )

pure virtual

Feed data to the decoder.

A CPU model uses this interface to load instruction data into the decoder. Once enough data has been loaded (check with instReady()), a decoded instruction can be retrieved using decode(PCStateBase &).

This method is intended to support both fixed-length and variable-length instructions. Instruction data is fetch in MachInst blocks (which correspond to the size of a typical insturction). The method might need to be called multiple times if the instruction spans multiple blocks, in that case needMoreBytes() will return true and instReady() will return false.

The fetchPC parameter is used to indicate where in memory the instruction was fetched from. This is should be the same address as the pc. If fetching multiple blocks, it indicates where subsequent blocks are fetched from (pc + n * sizeof(MachInst)).

Parameters

pc	Instruction pointer that we are decoding.
fetchPC	The address this chunk was fetched from.

Implemented in gem5::ArmISA::Decoder, gem5::MipsISA::Decoder, gem5::PowerISA::Decoder, gem5::RiscvISA::Decoder, gem5::SparcISA::Decoder, and gem5::X86ISA::Decoder.

Referenced by gem5::o3::Fetch::fetch().

◆ moreBytesPtr()

void * gem5::InstDecoder::moreBytesPtr ( ) const

inline

Definition at line 95 of file decoder.hh.

References _moreBytesPtr.

◆ moreBytesSize()

size_t gem5::InstDecoder::moreBytesSize ( ) const

inline

Definition at line 96 of file decoder.hh.

References _moreBytesSize.

Referenced by gem5::o3::Fetch::Fetch().

◆ needMoreBytes()

bool gem5::InstDecoder::needMoreBytes ( ) const

inline

Can the decoder accept more data?

A CPU model uses this method to determine if the decoder can accept more data. Note that an instruction can be ready (see instReady() even if this method returns true.

Definition at line 116 of file decoder.hh.

References outOfBytes.

◆ pcMask()

Addr gem5::InstDecoder::pcMask ( ) const

inline

Definition at line 97 of file decoder.hh.

References _pcMask.

Referenced by gem5::o3::Fetch::fetch().

◆ reset()

virtual void gem5::InstDecoder::reset ( )

inlinevirtual

Reimplemented in gem5::ArmISA::Decoder, gem5::RiscvISA::Decoder, and gem5::X86ISA::Decoder.

Definition at line 63 of file decoder.hh.

References instDone, and outOfBytes.

Referenced by gem5::BaseSimpleCPU::advancePC(), gem5::BaseSimpleCPU::checkForInterrupts(), gem5::o3::Fetch::doSquash(), gem5::o3::Fetch::Fetch(), gem5::GenericHtmFailureFault::invoke(), gem5::ArmISA::Decoder::reset(), and gem5::X86ISA::Decoder::reset().

◆ takeOverFrom()

virtual void gem5::InstDecoder::takeOverFrom ( InstDecoder * old )

inlinevirtual

Take over the state from an old decoder when switching CPUs.

Parameters

old	Decoder used in old CPU

Reimplemented in gem5::X86ISA::Decoder.

Definition at line 89 of file decoder.hh.

References instDone, and outOfBytes.

Referenced by gem5::o3::ThreadContext::takeOverFrom(), gem5::SimpleThread::takeOverFrom(), and gem5::X86ISA::Decoder::takeOverFrom().

Member Data Documentation

◆ _moreBytesPtr

void* gem5::InstDecoder::_moreBytesPtr

protected

Definition at line 45 of file decoder.hh.

Referenced by moreBytesPtr().

◆ _moreBytesSize

size_t gem5::InstDecoder::_moreBytesSize

protected

Definition at line 46 of file decoder.hh.

Referenced by moreBytesSize().

◆ _pcMask

Addr gem5::InstDecoder::_pcMask

protected

Definition at line 47 of file decoder.hh.

Referenced by pcMask().

◆ instDone

bool gem5::InstDecoder::instDone = false

protected

◆ outOfBytes

bool gem5::InstDecoder::outOfBytes = true

protected

Definition at line 50 of file decoder.hh.

Referenced by gem5::ArmISA::Decoder::consumeBytes(), gem5::X86ISA::Decoder::doFromCacheState(), gem5::ArmISA::Decoder::moreBytes(), gem5::RiscvISA::Decoder::moreBytes(), gem5::X86ISA::Decoder::moreBytes(), needMoreBytes(), gem5::X86ISA::Decoder::process(), reset(), takeOverFrom(), and gem5::X86ISA::Decoder::updateOffsetState().

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

arch/generic/decoder.hh
arch/generic/decoder.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InstDecoder()

Member Function Documentation

◆ as() [1/2]

◆ as() [2/2]

◆ decode()

◆ fetchRomMicroop()

◆ instReady()

◆ moreBytes()

◆ moreBytesPtr()

◆ moreBytesSize()

◆ needMoreBytes()

◆ pcMask()

◆ reset()

◆ takeOverFrom()

Member Data Documentation

◆ _moreBytesPtr

◆ _moreBytesSize

◆ _pcMask

◆ instDone

◆ outOfBytes