LupioBLK: A virtual block device which aims to provide a disk-like interface for second-level storage. More...

#include <lupio_blk.hh>

Inheritance diagram for gem5::LupioBLK:

Public Member Functions
	PARAMS (LupioBLK)

	LupioBLK (const Params &params)

AddrRangeList	getAddrRanges () const override
	Implement BasicPioDevice virtual functions.

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

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

Public Member Functions inherited from gem5::DmaDevice
	DmaDevice (const Params &p)

virtual	~DmaDevice ()=default

void	dmaWrite (Addr addr, int size, Event event, uint8_t data, std::optional< uint32_t > sid, std::optional< uint32_t > ssid, Tick delay=0)

void	dmaWrite (Addr addr, int size, Event event, uint8_t data, Tick delay=0)

void	dmaRead (Addr addr, int size, Event event, uint8_t data, std::optional< uint32_t > sid, std::optional< uint32_t > ssid, Tick delay=0)

void	dmaRead (Addr addr, int size, Event event, uint8_t data, Tick delay=0)

bool	dmaPending () const

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

Addr	cacheBlockSize () const

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

Public Member Functions inherited from gem5::PioDevice
	PioDevice (const Params &p)

virtual	~PioDevice ()

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

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

Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)

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

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

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

	SimObject (const Params &p)

virtual	~SimObject ()

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 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 (std::string_view name_)

virtual	~Named ()=default

virtual std::string	name () const

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

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.

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

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.

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Member Functions
void	dmaEventDone ()

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.

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

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance.

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

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Protected Attributes
const ByteOrder	byteOrder = ByteOrder::little

Platform *	platform

EventFunctionWrapper	dmaEvent

Addr	pioAddr

Tick	pioDelay

Addr	pioSize

DiskImage &	image

int	lupioBLKIntID

Protected Attributes inherited from gem5::DmaDevice
DmaPort	dmaPort

Protected Attributes inherited from gem5::PioDevice
System *	sys

PioPort< PioDevice >	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees.

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.

Private Types
enum	{ LUPIO_BLK_CONF , LUPIO_BLK_NBLK , LUPIO_BLK_BLKA , LUPIO_BLK_MEMA , LUPIO_BLK_CTRL , LUPIO_BLK_STAT }

Private Member Functions
uint64_t	lupioBLKRead (const uint8_t addr)
	Function to return data pertaining to blocks being transferred.

void	lupioBLKWrite (const uint8_t addr, uint64_t val64)
	Function to write to registers containing data pertaining to block transfers.

void	lupioBLKCmd (void)
	Function to initiate and direct the transfer of data by the DMA device.

Private Attributes
int	reqLen = 0

uint8_t *	reqData = nullptr

uint64_t	nbBlocks = 0

uint32_t	nblk = 0

uint32_t	lba = 0

Addr	mem = 0

bool	writeOp = false

bool	err = false

bool	busy = false

Additional Inherited Members
Public Types inherited from gem5::DmaDevice
typedef DmaDeviceParams	Params

Public Types inherited from gem5::PioDevice
using	Params = PioDeviceParams

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.

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.

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Detailed Description

LupioBLK: A virtual block device which aims to provide a disk-like interface for second-level storage.

It enables the transfer of blocks from the block device to the system's main memory, and vice-versa.

Definition at line 50 of file lupio_blk.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
LUPIO_BLK_CONF
LUPIO_BLK_NBLK
LUPIO_BLK_BLKA
LUPIO_BLK_MEMA
LUPIO_BLK_CTRL
LUPIO_BLK_STAT

Definition at line 66 of file lupio_blk.hh.

Constructor & Destructor Documentation

◆ LupioBLK()

gem5::LupioBLK::LupioBLK ( const Params & params )

Definition at line 53 of file lupio_blk.cc.

References gem5::DmaDevice::DmaDevice(), dmaEvent, dmaEventDone(), gem5::SimObject::params(), and platform.

Referenced by dmaEventDone(), lupioBLKRead(), lupioBLKWrite(), PARAMS(), read(), and write().

Member Function Documentation

◆ dmaEventDone()

void gem5::LupioBLK::dmaEventDone ( )

protected

Definition at line 71 of file lupio_blk.cc.

References busy, DPRINTF, gem5::ArmISA::i, image, lba, LupioBLK(), lupioBLKIntID, platform, reqData, reqLen, SECTOR_SIZE, and writeOp.

Referenced by LupioBLK().

◆ getAddrRanges()

AddrRangeList gem5::LupioBLK::getAddrRanges ( ) const

overridevirtual

Implement BasicPioDevice virtual functions.

Implements gem5::PioDevice.

Definition at line 200 of file lupio_blk.cc.

References pioAddr, pioSize, and gem5::RangeSize().

◆ lupioBLKCmd()

void gem5::LupioBLK::lupioBLKCmd ( void )

private

Function to initiate and direct the transfer of data by the DMA device.

Definition at line 172 of file lupio_blk.cc.

References busy, dmaEvent, gem5::DmaDevice::dmaRead(), gem5::DmaDevice::dmaWrite(), gem5::ArmISA::i, image, lba, mem, nbBlocks, nblk, panic, reqData, reqLen, SECTOR_SIZE, and writeOp.

Referenced by lupioBLKWrite().

◆ lupioBLKRead()

uint64_t gem5::LupioBLK::lupioBLKRead ( const uint8_t addr )

private

Function to return data pertaining to blocks being transferred.

Definition at line 88 of file lupio_blk.cc.

References gem5::X86ISA::addr, busy, DPRINTF, err, gem5::floorLog2(), lba, LUPIO_BLK_BLKA, LUPIO_BLK_CONF, LUPIO_BLK_ERRR, LUPIO_BLK_MEMA, LUPIO_BLK_NBLK, LUPIO_BLK_STAT, LUPIO_BLK_TYPE, LupioBLK(), lupioBLKIntID, mem, nbBlocks, nblk, panic, platform, gem5::MipsISA::r, SECTOR_BITS, and writeOp.

Referenced by read().

◆ lupioBLKWrite()

void gem5::LupioBLK::lupioBLKWrite	(	const uint8_t	addr,
		uint64_t	val64 )

private

Function to write to registers containing data pertaining to block transfers.

Definition at line 134 of file lupio_blk.cc.

References gem5::X86ISA::addr, busy, DPRINTF, err, lba, LUPIO_BLK_BLKA, LUPIO_BLK_CTRL, LUPIO_BLK_MEMA, LUPIO_BLK_NBLK, LUPIO_BLK_TYPE, LupioBLK(), lupioBLKCmd(), mem, nblk, panic, gem5::X86ISA::val, and writeOp.

Referenced by write().

◆ PARAMS()

gem5::LupioBLK::PARAMS ( LupioBLK )

References LupioBLK(), and gem5::SimObject::params().

◆ read()

Tick gem5::LupioBLK::read ( PacketPtr pkt )

overridevirtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 207 of file lupio_blk.cc.

References gem5::X86ISA::addr, byteOrder, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), LupioBLK(), lupioBLKRead(), gem5::Packet::makeResponse(), pioAddr, pioDelay, and gem5::Packet::setUintX().

◆ write()

Tick gem5::LupioBLK::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 gem5::PioDevice.

Definition at line 223 of file lupio_blk.cc.

References byteOrder, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getUintX(), LupioBLK(), lupioBLKWrite(), gem5::Packet::makeResponse(), pioAddr, and pioDelay.

Member Data Documentation

◆ busy

bool gem5::LupioBLK::busy = false

private

Definition at line 88 of file lupio_blk.hh.

Referenced by dmaEventDone(), lupioBLKCmd(), lupioBLKRead(), and lupioBLKWrite().

◆ byteOrder

const ByteOrder gem5::LupioBLK::byteOrder = ByteOrder::little

protected

Definition at line 53 of file lupio_blk.hh.

Referenced by read(), and write().

◆ dmaEvent

EventFunctionWrapper gem5::LupioBLK::dmaEvent

protected

Definition at line 55 of file lupio_blk.hh.

Referenced by LupioBLK(), and lupioBLKCmd().

◆ err

bool gem5::LupioBLK::err = false

private

Definition at line 87 of file lupio_blk.hh.

Referenced by lupioBLKRead(), and lupioBLKWrite().

◆ image

DiskImage& gem5::LupioBLK::image

protected

Definition at line 59 of file lupio_blk.hh.

Referenced by dmaEventDone(), and lupioBLKCmd().

◆ lba

uint32_t gem5::LupioBLK::lba = 0

private

Definition at line 83 of file lupio_blk.hh.

Referenced by dmaEventDone(), lupioBLKCmd(), lupioBLKRead(), and lupioBLKWrite().

◆ lupioBLKIntID

int gem5::LupioBLK::lupioBLKIntID

protected

Definition at line 60 of file lupio_blk.hh.

Referenced by dmaEventDone(), and lupioBLKRead().

◆ mem

Addr gem5::LupioBLK::mem = 0

private

Definition at line 84 of file lupio_blk.hh.

Referenced by lupioBLKCmd(), lupioBLKRead(), and lupioBLKWrite().

◆ nbBlocks

uint64_t gem5::LupioBLK::nbBlocks = 0

private

Definition at line 81 of file lupio_blk.hh.

Referenced by lupioBLKCmd(), and lupioBLKRead().

◆ nblk

uint32_t gem5::LupioBLK::nblk = 0

private

Definition at line 82 of file lupio_blk.hh.

Referenced by lupioBLKCmd(), lupioBLKRead(), and lupioBLKWrite().

◆ pioAddr

Addr gem5::LupioBLK::pioAddr

protected

Definition at line 56 of file lupio_blk.hh.

Referenced by getAddrRanges(), read(), and write().

◆ pioDelay

Tick gem5::LupioBLK::pioDelay

protected

Definition at line 57 of file lupio_blk.hh.

Referenced by read(), and write().

◆ pioSize

Addr gem5::LupioBLK::pioSize

protected

Definition at line 58 of file lupio_blk.hh.

Referenced by getAddrRanges().

◆ platform

Platform* gem5::LupioBLK::platform

protected

Definition at line 54 of file lupio_blk.hh.

Referenced by dmaEventDone(), LupioBLK(), and lupioBLKRead().

◆ reqData

uint8_t* gem5::LupioBLK::reqData = nullptr

private

Definition at line 79 of file lupio_blk.hh.

Referenced by dmaEventDone(), and lupioBLKCmd().

◆ reqLen

int gem5::LupioBLK::reqLen = 0

private

Definition at line 78 of file lupio_blk.hh.

Referenced by dmaEventDone(), and lupioBLKCmd().

◆ writeOp

bool gem5::LupioBLK::writeOp = false

private

Definition at line 86 of file lupio_blk.hh.

Referenced by dmaEventDone(), lupioBLKCmd(), lupioBLKRead(), and lupioBLKWrite().

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

dev/lupio/lupio_blk.hh
dev/lupio/lupio_blk.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ LupioBLK()

Member Function Documentation

◆ dmaEventDone()

◆ getAddrRanges()

◆ lupioBLKCmd()

◆ lupioBLKRead()

◆ lupioBLKWrite()

◆ PARAMS()

◆ read()

◆ write()

Member Data Documentation

◆ busy

◆ byteOrder

◆ dmaEvent

◆ err

◆ image

◆ lba

◆ lupioBLKIntID

◆ mem

◆ nbBlocks

◆ nblk

◆ pioAddr

◆ pioDelay

◆ pioSize

◆ platform

◆ reqData

◆ reqLen

◆ writeOp