Memory mapped interface to the system console. More...

#include <backdoor.hh>

Inheritance diagram for AlphaBackdoor:

Classes
struct	Access

Public Types
typedef AlphaBackdoorParams	Params

Public Types inherited from BasicPioDevice
typedef BasicPioDeviceParams	Params

Public Types inherited from PioDevice
typedef PioDeviceParams	Params

Public Types inherited from MemObject
typedef MemObjectParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	AlphaBackdoor (const Params *p)

const Params *	params () const

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

Tick	read (PacketPtr pkt) override
	memory mapped reads and writes More...

Tick	write (PacketPtr pkt) override
	Pure virtual function that the device must implement. More...

void	serialize (CheckpointOut &cp) const override
	standard serialization routines for checkpointing More...

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

Public Member Functions inherited from BasicPioDevice
	BasicPioDevice (const Params *p, Addr size)

const Params *	params () const

virtual AddrRangeList	getAddrRanges () const
	Determine the address ranges that this device responds to. More...

Public Member Functions inherited from PioDevice
	PioDevice (const Params *p)

virtual	~PioDevice ()

const Params *	params () const

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

virtual BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a slave port with a given name and index. More...

Public Member Functions inherited from MemObject
const Params *	params () const

	MemObject (const Params *params)

virtual BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a master port with a given name and index. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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

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

virtual void	resetStats ()
	Reset statistics associated with this object. More...

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

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

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

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

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

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

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

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

Public Member Functions inherited from EventManager
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

Public Member Functions inherited from Serializable
	Serializable ()

virtual	~Serializable ()

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

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

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

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

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

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

Public Member Functions inherited from Clocked
void	updateClockPeriod () const
	Update the tick to the current tick. More...

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge. More...

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Attributes
union {
Access * alphaAccess

uint8_t * consoleData

};

SimpleDisk *	disk
	the disk must be accessed from the console More...

Terminal *	terminal
	the system console (the terminal) is accessable from the console More...

AlphaSystem *	system
	a pointer to the system we are running in More...

BaseCPU *	cpu
	a pointer to the CPU boot cpu More...

Protected Attributes inherited from BasicPioDevice
Addr	pioAddr
	Address that the device listens to. More...

Addr	pioSize
	Size that the device's address range. More...

Tick	pioDelay
	Delay that the device experinces on an access. More...

Protected Attributes inherited from PioDevice
System *	sys

PioPort	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees. More...

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

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

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

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

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

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

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

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

Protected Member Functions inherited from Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

void	resetClock () const
	Reset the object's clock using the current global tick value. More...

Detailed Description

Memory mapped interface to the system console.

This device represents a shared data region between the OS Kernel and the System Console Backdoor.

The system console is a small standalone program that is initially run when the system boots. It contains the necessary code to access the boot disk, to read/write from the console, and to pass boot parameters to the kernel.

This version of the system console is very different from the one that would be found in a real system. Many of the functions use some sort of backdoor to get their job done. For example, reading from the boot device on a real system would require a minimal device driver to access the disk controller, but since we have a simulator here, we are able to bypass the disk controller and access the disk image directly. There are also some things like reading the kernel off the disk image into memory that are normally taken care of by the console that are now taken care of by the simulator.

These shortcuts are acceptable since the system console is primarily used doing boot before the kernel has loaded its device drivers.

Definition at line 74 of file backdoor.hh.

Member Typedef Documentation

typedef AlphaBackdoorParams AlphaBackdoor::Params

Definition at line 101 of file backdoor.hh.

Constructor & Destructor Documentation

AlphaBackdoor::AlphaBackdoor ( const Params * p )

Definition at line 65 of file backdoor.cc.

References ALPHA_ACCESS_VERSION, alphaAccess, AlphaAccess::cpuStack, AlphaAccess::diskBlock, AlphaAccess::diskCount, AlphaAccess::diskOperation, AlphaAccess::diskPAddr, AlphaAccess::diskUnit, AlphaAccess::inputChar, AlphaAccess::last_offset, AlphaAccess::outputChar, BasicPioDevice::pioSize, and AlphaAccess::version.

Member Function Documentation

const Params* AlphaBackdoor::params ( ) const

inline

Definition at line 105 of file backdoor.hh.

References SimObject::_params.

Referenced by startup().

Tick AlphaBackdoor::read ( PacketPtr pkt )

overridevirtual

memory mapped reads and writes

XXX Do we want to push the addr munging to a bus brige or something? So the device has it's physical address and then the bridge adds on whatever machine dependent address swizzle is required?

Implements PioDevice.

Definition at line 103 of file backdoor.cc.

References alphaAccess, Terminal::console_in(), AlphaAccess::cpuClock, AlphaAccess::cpuStack, AlphaAccess::diskBlock, AlphaAccess::diskCount, AlphaAccess::diskOperation, AlphaAccess::diskPAddr, AlphaAccess::diskUnit, DPRINTF, AlphaAccess::entryPoint, Packet::get(), Packet::getAddr(), Packet::getSize(), AlphaAccess::intrClockFrequency, AlphaAccess::kernEnd, AlphaAccess::kernStart, AlphaAccess::last_offset, Packet::makeAtomicResponse(), AlphaAccess::mem_size, AlphaAccess::numCPUs, ArmISA::numCPUs, AlphaAccess::outputChar, panic, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, Packet::set(), Packet::setBadAddress(), terminal, and AlphaAccess::version.

void AlphaBackdoor::serialize ( CheckpointOut & cp ) const

overridevirtual

standard serialization routines for checkpointing

Implements Serializable.

Definition at line 300 of file backdoor.cc.

References alphaAccess, and AlphaBackdoor::Access::serialize().

void AlphaBackdoor::startup ( )

overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from SimObject.

Definition at line 87 of file backdoor.cc.

References alphaAccess, cpu, AlphaAccess::cpuClock, AlphaAccess::entryPoint, fatal, TsunamiIO::frequency(), System::getKernelEnd(), System::getKernelEntry(), System::getKernelStart(), AlphaAccess::intrClockFrequency, Tsunami::io, AlphaAccess::kernEnd, AlphaAccess::kernStart, AlphaAccess::mem_size, System::memSize(), System::numContexts(), AlphaAccess::numCPUs, params(), BasicPioDevice::pioAddr, AlphaSystem::setAlphaAccess(), and system.

void AlphaBackdoor::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 306 of file backdoor.cc.

References alphaAccess, and AlphaBackdoor::Access::unserialize().

Tick AlphaBackdoor::write ( PacketPtr pkt )

overridevirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements PioDevice.

Definition at line 201 of file backdoor.cc.

References alphaAccess, AlphaAccess::cpuStack, curTick(), disk, AlphaAccess::diskBlock, AlphaAccess::diskCount, AlphaAccess::diskPAddr, AlphaAccess::diskUnit, Packet::get(), Packet::getAddr(), Packet::getSize(), inform, Packet::makeAtomicResponse(), Terminal::out(), panic, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, SimpleDisk::read(), terminal, and X86ISA::val.

Member Data Documentation

union { ... }

Access* AlphaBackdoor::alphaAccess

Definition at line 84 of file backdoor.hh.

Referenced by AlphaBackdoor(), read(), serialize(), startup(), unserialize(), and write().

uint8_t* AlphaBackdoor::consoleData

Definition at line 85 of file backdoor.hh.

BaseCPU* AlphaBackdoor::cpu

protected

a pointer to the CPU boot cpu

Definition at line 98 of file backdoor.hh.

Referenced by startup().

SimpleDisk* AlphaBackdoor::disk

protected

the disk must be accessed from the console

Definition at line 89 of file backdoor.hh.

Referenced by write().

AlphaSystem* AlphaBackdoor::system

protected

a pointer to the system we are running in

Definition at line 95 of file backdoor.hh.

Referenced by startup().

Terminal* AlphaBackdoor::terminal

protected

the system console (the terminal) is accessable from the console

Definition at line 92 of file backdoor.hh.

Referenced by read(), and write().

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

dev/alpha/backdoor.hh
dev/alpha/backdoor.cc

Classes

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation