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

LupioRNG: A Random Number Generator virtual device that returns either a random value, or a seed that can be configured by the user. More...

#include <lupio_rng.hh>

Inheritance diagram for gem5::LupioRNG:
gem5::BasicPioDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 PARAMS (LupioRNG)
 
 LupioRNG (const Params &params)
 
Tick read (PacketPtr pkt) override
 Implement BasicPioDevice virtual functions. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
- Public Member Functions inherited from gem5::BasicPioDevice
 PARAMS (BasicPioDevice)
 
 BasicPioDevice (const Params &p, Addr size)
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. 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 Attributes

const ByteOrder byteOrder = ByteOrder::little
 
- Protected Attributes inherited from gem5::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 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_RNG_RAND , LUPIO_RNG_SEED , LUPIO_RNG_CTRL , LUPIO_RNG_STAT }
 

Private Member Functions

uint64_t lupioRNGRead (const uint8_t addr)
 Function to return a random number, the current seed, or the device status. More...
 
void lupioRNGWrite (const uint8_t addr, const uint64_t val64)
 Function to allow the user to change the current seed, and configure the device using interrupts. More...
 

Private Attributes

std::mt19937 mt
 
uint64_t user_seed
 
bool interrupt_enable = false
 

Additional Inherited Members

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

Detailed Description

LupioRNG: A Random Number Generator virtual device that returns either a random value, or a seed that can be configured by the user.

Definition at line 47 of file lupio_rng.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
LUPIO_RNG_RAND 
LUPIO_RNG_SEED 
LUPIO_RNG_CTRL 
LUPIO_RNG_STAT 

Definition at line 54 of file lupio_rng.hh.

Constructor & Destructor Documentation

◆ LupioRNG()

gem5::LupioRNG::LupioRNG ( const Params params)

Definition at line 45 of file lupio_rng.cc.

References DPRINTF, mt, and user_seed.

Member Function Documentation

◆ lupioRNGRead()

uint64_t gem5::LupioRNG::lupioRNGRead ( const uint8_t  addr)
private

Function to return a random number, the current seed, or the device status.

Definition at line 54 of file lupio_rng.cc.

References gem5::X86ISA::addr, DPRINTF, LUPIO_RNG_RAND, LUPIO_RNG_SEED, LUPIO_RNG_STAT, mt, panic, gem5::VegaISA::r, and user_seed.

Referenced by read().

◆ lupioRNGWrite()

void gem5::LupioRNG::lupioRNGWrite ( const uint8_t  addr,
const uint64_t  val64 
)
private

Function to allow the user to change the current seed, and configure the device using interrupts.

Definition at line 85 of file lupio_rng.cc.

References gem5::X86ISA::addr, DPRINTF, interrupt_enable, LUPIO_RNG_CTRL, LUPIO_RNG_IRQE, LUPIO_RNG_SEED, mt, panic, and user_seed.

Referenced by write().

◆ PARAMS()

gem5::LupioRNG::PARAMS ( LupioRNG  )

◆ read()

Tick gem5::LupioRNG::read ( PacketPtr  pkt)
overridevirtual

◆ write()

Tick gem5::LupioRNG::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 123 of file lupio_rng.cc.

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

Member Data Documentation

◆ byteOrder

const ByteOrder gem5::LupioRNG::byteOrder = ByteOrder::little
protected

Definition at line 50 of file lupio_rng.hh.

Referenced by read(), and write().

◆ interrupt_enable

bool gem5::LupioRNG::interrupt_enable = false
private

Definition at line 64 of file lupio_rng.hh.

Referenced by lupioRNGWrite().

◆ mt

std::mt19937 gem5::LupioRNG::mt
private

Definition at line 62 of file lupio_rng.hh.

Referenced by LupioRNG(), lupioRNGRead(), and lupioRNGWrite().

◆ user_seed

uint64_t gem5::LupioRNG::user_seed
private

Definition at line 63 of file lupio_rng.hh.

Referenced by LupioRNG(), lupioRNGRead(), and lupioRNGWrite().


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

Generated on Wed Dec 21 2022 10:23:19 for gem5 by doxygen 1.9.1