gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
gem5::VirtIO9PDiod Class Reference

VirtIO 9p proxy that communicates with the diod 9p server using pipes. More...

#include <fs9p.hh>

Inheritance diagram for gem5::VirtIO9PDiod:
gem5::VirtIO9PProxy gem5::VirtIO9PBase gem5::VirtIODeviceBase gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  DiodDataEvent
 

Public Types

typedef VirtIO9PDiodParams Params
 
- Public Types inherited from gem5::VirtIO9PProxy
typedef VirtIO9PProxyParams Params
 
- Public Types inherited from gem5::VirtIO9PBase
typedef VirtIO9PBaseParams Params
 
- Public Types inherited from gem5::VirtIODeviceBase
typedef uint16_t QueueID
 
typedef uint32_t FeatureBits
 
typedef uint16_t VirtAddress
 This is a VirtQueue address as exposed through the low-level interface. The address needs to be multiplied by the page size (seems to be hardcoded to 4096 in the spec) to get the real physical address. More...
 
typedef uint16_t DeviceId
 Device Type (sometimes known as subsystem ID) More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 VirtIO9PDiod (const Params &params)
 
virtual ~VirtIO9PDiod ()
 
void startup ()
 startup() is the final initialization call before simulation. More...
 
- Public Member Functions inherited from gem5::VirtIO9PProxy
 VirtIO9PProxy (const Params &params)
 
virtual ~VirtIO9PProxy ()
 
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::VirtIO9PBase
 VirtIO9PBase (const Params &params)
 
virtual ~VirtIO9PBase ()
 
void readConfig (PacketPtr pkt, Addr cfgOffset)
 Read from the configuration space of a device. More...
 
- Public Member Functions inherited from gem5::VirtIODeviceBase
 BitUnion8 (DeviceStatus) Bitfield< 7 > failed
 
 EndBitUnion (DeviceStatus) typedef VirtIODeviceBaseParams Params
 
 VirtIODeviceBase (const Params &params, DeviceId id, size_t config_size, FeatureBits features)
 
virtual ~VirtIODeviceBase ()
 
virtual void writeConfig (PacketPtr pkt, Addr cfgOffset)
 Write to the configuration space of a device. More...
 
virtual void reset ()
 Driver-request device reset. More...
 
void registerKickCallback (const std::function< void()> &callback)
 Register a callback to kick the guest through the transport interface. More...
 
void onNotify (QueueID index)
 Driver is requesting service. More...
 
void setQueueSelect (QueueID idx)
 Change currently active queue. More...
 
QueueID getQueueSelect () const
 Get the currently active queue. More...
 
void setQueueAddress (uint32_t address)
 Change the host physical address of the currently active queue. More...
 
uint32_t getQueueAddress () const
 Get the host physical address of the currently active queue. More...
 
uint16_t getQueueSize () const
 Get the size (descriptors) of the currently active queue. More...
 
void setDeviceStatus (DeviceStatus status)
 Update device status and optionally reset device. More...
 
DeviceStatus getDeviceStatus () const
 Retrieve the device status. More...
 
void setGuestFeatures (FeatureBits features)
 Set feature bits accepted by the guest driver. More...
 
FeatureBits getGuestFeatures () const
 Get features accepted by the guest driver. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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 PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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
 

Protected Member Functions

void startDiod ()
 Start diod and setup the communication pipes. More...
 
ssize_t read (uint8_t *data, size_t len)
 Read data from the server behind the proxy. More...
 
ssize_t write (const uint8_t *data, size_t len)
 Write data to the server behind the proxy. More...
 
void terminateDiod ()
 Kill the diod child process at the end of the simulation. More...
 
- Protected Member Functions inherited from gem5::VirtIO9PProxy
void recvTMsg (const P9MsgHeader &header, const uint8_t *data, size_t size) override
 Handle incoming 9p RPC message. More...
 
void serverDataReady ()
 Notification of pending data from server. More...
 
void readAll (uint8_t *data, size_t len)
 Convenience function that reads exactly len bytes. More...
 
void writeAll (const uint8_t *data, size_t len)
 Convenience function that writes exactly len bytes. More...
 
- Protected Member Functions inherited from gem5::VirtIO9PBase
void sendRMsg (const P9MsgHeader &header, const uint8_t *data, size_t size)
 Send a 9p RPC message reply. More...
 
void dumpMsg (const P9MsgHeader &header, const uint8_t *data, size_t size)
 Dump a 9p RPC message on the debug output. More...
 
- Protected Member Functions inherited from gem5::VirtIODeviceBase
void kick ()
 Inform the guest of available buffers. More...
 
void registerQueue (VirtQueue &queue)
 Register a new VirtQueue with the device model. More...
 
void readConfigBlob (PacketPtr pkt, Addr cfgOffset, const uint8_t *cfg)
 Read configuration data from a device structure. More...
 
void writeConfigBlob (PacketPtr pkt, Addr cfgOffset, uint8_t *cfg)
 Write configuration data to a device structure. More...
 
- 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...
 

Private Attributes

int fd_to_diod
 fd for data pipe going to diod (write end) More...
 
int fd_from_diod
 fd for data pipe coming from diod (read end) More...
 
std::unique_ptr< DiodDataEventdataEvent
 
int diod_pid
 PID of diod process. More...
 

Additional Inherited Members

- 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::VirtIODeviceBase
Bitfield< 2 > driver_ok
 
Bitfield< 1 > driver
 
Bitfield< 0 > acknowledge
 
const DeviceId deviceId
 Device ID (sometimes known as subsystem ID) More...
 
const size_t configSize
 Size of the device's configuration space. More...
 
const FeatureBits deviceFeatures
 Feature set offered by the device. More...
 
- Protected Attributes inherited from gem5::VirtIO9PProxy
bool deviceUsed
 Bool to track if the device has been used or not. More...
 
- Protected Attributes inherited from gem5::VirtIO9PBase
std::unique_ptr< Configconfig
 Currently active configuration (host byte order) More...
 
FSQueue queue
 
- Protected Attributes inherited from gem5::VirtIODeviceBase
FeatureBits guestFeatures
 Feature set accepted by the guest. More...
 
ByteOrder byteOrder
 The byte order of the queues, descriptors, etc. 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...
 
- Static Protected Attributes inherited from gem5::VirtIO9PBase
static const DeviceId ID_9P = 0x09
 VirtIO device ID. More...
 
static const FeatureBits F_MOUNT_TAG = 0x01
 Device provides a name of the resource in its configuration. More...
 

Detailed Description

VirtIO 9p proxy that communicates with the diod 9p server using pipes.

Definition at line 296 of file fs9p.hh.

Member Typedef Documentation

◆ Params

typedef VirtIO9PDiodParams gem5::VirtIO9PDiod::Params

Definition at line 299 of file fs9p.hh.

Constructor & Destructor Documentation

◆ VirtIO9PDiod()

gem5::VirtIO9PDiod::VirtIO9PDiod ( const Params params)

Definition at line 319 of file fs9p.cc.

References gem5::registerExitCallback(), and terminateDiod().

◆ ~VirtIO9PDiod()

gem5::VirtIO9PDiod::~VirtIO9PDiod ( )
virtual

Definition at line 327 of file fs9p.cc.

Member Function Documentation

◆ read()

ssize_t gem5::VirtIO9PDiod::read ( uint8_t *  data,
size_t  len 
)
protectedvirtual

Read data from the server behind the proxy.

Note
This method may return read fewer than len bytes.
Parameters
dataMemory location to store results in.
lenMaximum length to read.
Returns
Number of bytes read, -errno on failure.

Implements gem5::VirtIO9PProxy.

Definition at line 413 of file fs9p.cc.

References data, fd_from_diod, and gem5::ArmISA::len.

◆ startDiod()

void gem5::VirtIO9PDiod::startDiod ( )
protected

◆ startup()

void gem5::VirtIO9PDiod::startup ( )
virtual

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 gem5::SimObject.

Definition at line 332 of file fs9p.cc.

References dataEvent, fd_from_diod, gem5::pollQueue, gem5::PollQueue::schedule(), and startDiod().

◆ terminateDiod()

void gem5::VirtIO9PDiod::terminateDiod ( )
protected

Kill the diod child process at the end of the simulation.

Definition at line 435 of file fs9p.cc.

References diod_pid, DPRINTF, gem5::ArmISA::i, inform, and warn.

Referenced by VirtIO9PDiod().

◆ write()

ssize_t gem5::VirtIO9PDiod::write ( const uint8_t *  data,
size_t  len 
)
protectedvirtual

Write data to the server behind the proxy.

Note
This method may return write fewer than len bytes.
Parameters
dataPointer to data to write.
lenMaximum length to write.
Returns
Number of bytes written, -errno on failure.

Implements gem5::VirtIO9PProxy.

Definition at line 421 of file fs9p.cc.

References data, fd_to_diod, and gem5::ArmISA::len.

Member Data Documentation

◆ dataEvent

std::unique_ptr<DiodDataEvent> gem5::VirtIO9PDiod::dataEvent
private

Definition at line 336 of file fs9p.hh.

Referenced by startup().

◆ diod_pid

int gem5::VirtIO9PDiod::diod_pid
private

PID of diod process.

Definition at line 339 of file fs9p.hh.

Referenced by startDiod(), and terminateDiod().

◆ fd_from_diod

int gem5::VirtIO9PDiod::fd_from_diod
private

fd for data pipe coming from diod (read end)

Definition at line 334 of file fs9p.hh.

Referenced by read(), startDiod(), and startup().

◆ fd_to_diod

int gem5::VirtIO9PDiod::fd_to_diod
private

fd for data pipe going to diod (write end)

Definition at line 332 of file fs9p.hh.

Referenced by startDiod(), and write().


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

Generated on Tue Sep 21 2021 12:28:20 for gem5 by doxygen 1.8.17