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

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:
gem5::DmaDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 PARAMS (LupioBLK)
 
 LupioBLK (const Params &params)
 
AddrRangeList getAddrRanges () const override
 Implement BasicPioDevice virtual functions. More...
 
Tick read (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
- 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, uint32_t sid, 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, uint32_t sid, 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. More...
 
unsigned int cacheBlockSize () const
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- 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. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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 regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. 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 gem5::EventManager
EventQueueeventQueue () 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. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 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. 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 gem5::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 gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &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. 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 Member Functions

void dmaEventDone ()
 
- Protected Member Functions inherited from gem5::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 gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (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...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 

Protected Attributes

const ByteOrder byteOrder = ByteOrder::little
 
Platformplatform
 
EventFunctionWrapper dmaEvent
 
Addr pioAddr
 
Tick pioDelay
 
Addr pioSize
 
DiskImageimage
 
int lupioBLKIntID
 
- Protected Attributes inherited from gem5::DmaDevice
DmaPort dmaPort
 
- Protected Attributes inherited from gem5::PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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. More...
 
void lupioBLKWrite (const uint8_t addr, uint64_t val64)
 Function to write to registers containing data pertaining to block transfers. More...
 
void lupioBLKCmd (void)
 Function to initiate and direct the transfer of data by the DMA device. More...
 

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. More...
 
- 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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

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 dmaEventDone().

Member Function Documentation

◆ dmaEventDone()

void gem5::LupioBLK::dmaEventDone ( )
protected

◆ 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, gem5::DiskImage::read(), 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, lupioBLKIntID, mem, nbBlocks, nblk, panic, platform, gem5::VegaISA::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, lupioBLKCmd(), mem, nblk, panic, gem5::X86ISA::val, and writeOp.

Referenced by write().

◆ PARAMS()

gem5::LupioBLK::PARAMS ( LupioBLK  )

◆ 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
pktPacket 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(), 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
pktPacket 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(), 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 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(), 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:

Generated on Thu Jul 28 2022 13:33:06 for gem5 by doxygen 1.8.17