gem5  v21.1.0.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gem5::VirtIO9PProxy Class Referenceabstract

VirtIO 9p proxy base class. More...

#include <fs9p.hh>

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

Public Types

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

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

Protected Member Functions

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...
 
virtual ssize_t read (uint8_t *data, size_t len)=0
 Read data from the server behind the proxy. More...
 
virtual ssize_t write (const uint8_t *data, size_t len)=0
 Write data to the server behind the proxy. 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...
 

Protected Attributes

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

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

This base class provides basic functionality shared by different 9p proxy implementations.

Definition at line 217 of file fs9p.hh.

Member Typedef Documentation

◆ Params

typedef VirtIO9PProxyParams gem5::VirtIO9PProxy::Params

Definition at line 220 of file fs9p.hh.

Constructor & Destructor Documentation

◆ VirtIO9PProxy()

gem5::VirtIO9PProxy::VirtIO9PProxy ( const Params params)

Definition at line 218 of file fs9p.cc.

◆ ~VirtIO9PProxy()

gem5::VirtIO9PProxy::~VirtIO9PProxy ( )
virtual

Definition at line 223 of file fs9p.cc.

Member Function Documentation

◆ read()

virtual ssize_t gem5::VirtIO9PProxy::read ( uint8_t *  data,
size_t  len 
)
protectedpure virtual

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.

Implemented in gem5::VirtIO9PSocket, and gem5::VirtIO9PDiod.

Referenced by readAll().

◆ readAll()

void gem5::VirtIO9PProxy::readAll ( uint8_t *  data,
size_t  len 
)
protected

Convenience function that reads exactly len bytes.

This method calls read until exactly len number of bytes has been read. A read() call is retried if the underlying syscall was interrupted.

Parameters
dataMemory location to store results in.
lenNumber of bytes to read.

Definition at line 288 of file fs9p.cc.

References data, gem5::ArmISA::len, panic, and read().

Referenced by serverDataReady().

◆ recvTMsg()

void gem5::VirtIO9PProxy::recvTMsg ( const P9MsgHeader header,
const uint8_t *  data,
size_t  size 
)
overrideprotectedvirtual

Handle incoming 9p RPC message.

Parameters
header9p message header.
dataPointer to data in message.
sizeSize of data (excluding header)

Implements gem5::VirtIO9PBase.

Definition at line 256 of file fs9p.cc.

References data, deviceUsed, header, gem5::htop9(), and writeAll().

◆ serialize()

void gem5::VirtIO9PProxy::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Reimplemented from gem5::VirtIODeviceBase.

Definition at line 229 of file fs9p.cc.

References deviceUsed, gem5::VirtIODeviceBase::serialize(), SERIALIZE_SCALAR, and warn.

◆ serverDataReady()

void gem5::VirtIO9PProxy::serverDataReady ( )
protected

Notification of pending data from server.

Definition at line 271 of file fs9p.cc.

References data, header, gem5::p9toh(), panic, readAll(), and gem5::VirtIO9PBase::sendRMsg().

Referenced by gem5::VirtIO9PDiod::DiodDataEvent::process(), and gem5::VirtIO9PSocket::SocketDataEvent::process().

◆ unserialize()

void gem5::VirtIO9PProxy::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Reimplemented from gem5::VirtIODeviceBase.

Definition at line 242 of file fs9p.cc.

References deviceUsed, gem5::VirtIODeviceBase::unserialize(), UNSERIALIZE_SCALAR, and warn.

◆ write()

virtual ssize_t gem5::VirtIO9PProxy::write ( const uint8_t *  data,
size_t  len 
)
protectedpure virtual

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.

Implemented in gem5::VirtIO9PSocket, and gem5::VirtIO9PDiod.

Referenced by writeAll().

◆ writeAll()

void gem5::VirtIO9PProxy::writeAll ( const uint8_t *  data,
size_t  len 
)
protected

Convenience function that writes exactly len bytes.

This method calls write until exactly len number of bytes has been written. A write() call is retried if the underlying syscall was interrupted.

Parameters
dataData to write.
lenNumber of bytes to write.

Definition at line 303 of file fs9p.cc.

References data, gem5::ArmISA::len, panic, and write().

Referenced by recvTMsg().

Member Data Documentation

◆ deviceUsed

bool gem5::VirtIO9PProxy::deviceUsed
protected

Bool to track if the device has been used or not.

We need to keep track of if the device has been used as we are unable to checkpoint the device in the event that the device has been mounted in the guest system. This is due to the fact that we do not, and cannot, track the complete state across host and guest.

Definition at line 287 of file fs9p.hh.

Referenced by recvTMsg(), serialize(), and unserialize().


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