gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
gem5::VirtIO9PBase Class Referenceabstract

This class implements a VirtIO transport layer for the 9p network file system. More...

#include <fs9p.hh>

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

Classes

struct  Config
 VirtIO 9p configuration structure. More...
 
class  FSQueue
 Virtqueue for 9p requests. More...
 

Public Types

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

 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 ()
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
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

virtual void recvTMsg (const P9MsgHeader &header, const uint8_t *data, size_t size)=0
 Handle incoming 9p RPC message. More...
 
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

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

static const DeviceId ID_9P = 0x09
 VirtIO device ID. More...
 
Feature bits
static const FeatureBits F_MOUNT_TAG = 0x01
 Device provides a name of the resource in its configuration. More...
 

Private Attributes

std::map< P9Tag, VirtDescriptor * > pendingTransactions
 Map between 9p transaction tags and descriptors where they appeared. 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...
 

Detailed Description

This class implements a VirtIO transport layer for the 9p network file system.

The 9p VirtIO transport uses the following queues:

  1. 9p requests and replies

Each 9p request and response is sent in its own descriptor chain. The guest initiates a transaction by packing a T message (see the 9p spec) into the first part of a descriptor chain. After the T message, the guest reserves space for the reply (R message) by including one or more writable descriptors. The server replies by writing an R message into the writable descriptors and putting the chain in the used ring (VirtQueue::produceDescriptor()).

See also
https://github.com/rustyrussell/virtio-spec
https://github.com/ericvh/9p-rfc
https://code.google.com/p/diod/wiki/protocol

Definition at line 112 of file fs9p.hh.

Member Typedef Documentation

◆ Params

typedef VirtIO9PBaseParams gem5::VirtIO9PBase::Params

Definition at line 115 of file fs9p.hh.

Constructor & Destructor Documentation

◆ VirtIO9PBase()

gem5::VirtIO9PBase::VirtIO9PBase ( const Params params)

◆ ~VirtIO9PBase()

gem5::VirtIO9PBase::~VirtIO9PBase ( )
virtual

Definition at line 136 of file fs9p.cc.

Member Function Documentation

◆ dumpMsg()

void gem5::VirtIO9PBase::dumpMsg ( const P9MsgHeader header,
const uint8_t *  data,
size_t  size 
)
protected

Dump a 9p RPC message on the debug output.

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

Definition at line 198 of file fs9p.cc.

References data, DDUMP, DPRINTF, header, gem5::P9MsgInfo::name, and gem5::p9_msg_info.

Referenced by gem5::VirtIO9PBase::FSQueue::onNotifyDescriptor(), and sendRMsg().

◆ readConfig()

void gem5::VirtIO9PBase::readConfig ( PacketPtr  pkt,
Addr  cfgOffset 
)
virtual

Read from the configuration space of a device.

This method is called by the transport interface to read data from a device model's configuration space. The device model should use the cfgOffset parameter as the offset into its configuration space.

Warning
The address in the packet should not be used to determine the offset into a device's configuration space.
Parameters
pktRead request packet.
cfgOffsetOffset into the device's configuration space.

Reimplemented from gem5::VirtIODeviceBase.

Definition at line 141 of file fs9p.cc.

References config, and gem5::VirtIODeviceBase::readConfigBlob().

◆ recvTMsg()

virtual void gem5::VirtIO9PBase::recvTMsg ( const P9MsgHeader header,
const uint8_t *  data,
size_t  size 
)
protectedpure virtual

Handle incoming 9p RPC message.

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

Implemented in gem5::VirtIO9PProxy.

Referenced by gem5::VirtIO9PBase::FSQueue::onNotifyDescriptor().

◆ sendRMsg()

void gem5::VirtIO9PBase::sendRMsg ( const P9MsgHeader header,
const uint8_t *  data,
size_t  size 
)
protected

Send a 9p RPC message reply.

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

Definition at line 170 of file fs9p.cc.

References gem5::VirtDescriptor::chainWrite(), data, DPRINTF, dumpMsg(), header, gem5::htop9(), gem5::VirtDescriptor::isOutgoing(), gem5::VirtIODeviceBase::kick(), gem5::P9MsgHeader::len, gem5::VirtDescriptor::next(), panic, pendingTransactions, gem5::VirtQueue::produceDescriptor(), and queue.

Referenced by gem5::VirtIO9PProxy::serverDataReady().

Member Data Documentation

◆ config

std::unique_ptr<Config> gem5::VirtIO9PBase::config
protected

Currently active configuration (host byte order)

Definition at line 135 of file fs9p.hh.

Referenced by readConfig(), and VirtIO9PBase().

◆ F_MOUNT_TAG

const FeatureBits gem5::VirtIO9PBase::F_MOUNT_TAG = 0x01
staticprotected

Device provides a name of the resource in its configuration.

Definition at line 144 of file fs9p.hh.

◆ ID_9P

const DeviceId gem5::VirtIO9PBase::ID_9P = 0x09
staticprotected

VirtIO device ID.

Definition at line 138 of file fs9p.hh.

◆ pendingTransactions

std::map<P9Tag, VirtDescriptor *> gem5::VirtIO9PBase::pendingTransactions
private

Map between 9p transaction tags and descriptors where they appeared.

When handling asynchronous requests, we need to ensure that replies are posted in the same descriptor as queries. The 9p RPC protocol uses the tag field in the header to match requests and replies, which we use here to find the relevant descriptor.

Definition at line 206 of file fs9p.hh.

Referenced by gem5::VirtIO9PBase::FSQueue::onNotifyDescriptor(), and sendRMsg().

◆ queue

FSQueue gem5::VirtIO9PBase::queue
protected

Definition at line 167 of file fs9p.hh.

Referenced by sendRMsg(), and VirtIO9PBase().


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