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:

Public Member Functions
	PARAMS (LupioRNG)

	LupioRNG (const Params &params)

Tick	read (PacketPtr pkt) override
	Implement BasicPioDevice virtual functions.

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

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.

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

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 Attributes
const ByteOrder	byteOrder = ByteOrder::little

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

Addr	pioSize
	Size that the device's address range.

Tick	pioDelay
	Delay that the device experinces on an access.

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

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.

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.

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

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.

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::MipsISA::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

Implement BasicPioDevice virtual functions.

Implements gem5::PioDevice.

Definition at line 107 of file lupio_rng.cc.

References byteOrder, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), lupioRNGRead(), gem5::Packet::makeResponse(), gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, and gem5::Packet::setUintX().

◆ 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

pkt	Packet 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:

dev/lupio/lupio_rng.hh
dev/lupio/lupio_rng.cc

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ LupioRNG()

Member Function Documentation

◆ lupioRNGRead()

◆ lupioRNGWrite()

◆ PARAMS()

◆ read()

◆ write()

Member Data Documentation

◆ byteOrder

◆ interrupt_enable

◆ mt

◆ user_seed