gem5::VirtIO9PSocket Class Reference

VirtIO 9p proxy that communicates with a 9p server over tcp sockets. More...

#include <fs9p.hh>

Inheritance diagram for gem5::VirtIO9PSocket:

Classes
class	SocketDataEvent

Public Types
typedef VirtIO9PSocketParams	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.
typedef uint16_t	DeviceId
	Device Type (sometimes known as subsystem ID)
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	VirtIO9PSocket (const Params &params)
virtual	~VirtIO9PSocket ()
void	startup ()
	startup() is the final initialization call before simulation.
Public Member Functions inherited from gem5::VirtIO9PProxy
	VirtIO9PProxy (const Params &params)
virtual	~VirtIO9PProxy ()
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
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.
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.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
virtual void	writeConfig (PacketPtr pkt, Addr cfgOffset)
	Write to the configuration space of a device.
virtual void	reset ()
	Driver-request device reset.
void	registerKickCallback (const std::function< void()> &callback)
	Register a callback to kick the guest through the transport interface.
void	onNotify (QueueID index)
	Driver is requesting service.
void	setQueueSelect (QueueID idx)
	Change currently active queue.
QueueID	getQueueSelect () const
	Get the currently active queue.
void	setQueueAddress (uint32_t address)
	Change the host physical address of the currently active queue.
uint32_t	getQueueAddress () const
	Get the host physical address of the currently active queue.
uint16_t	getQueueSize () const
	Get the size (descriptors) of the currently active queue.
void	setDeviceStatus (DeviceStatus status)
	Update device status and optionally reset device.
DeviceStatus	getDeviceStatus () const
	Retrieve the device status.
void	setGuestFeatures (FeatureBits features)
	Set feature bits accepted by the guest driver.
FeatureBits	getGuestFeatures () const
	Get features accepted by the guest driver.
Public Member Functions inherited from gem5::SimObject
const Params &	params () 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.
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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.
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 ()
virtual void	serialize (CheckpointOut &cp) const =0
	Serialize an object.
virtual void	unserialize (CheckpointIn &cp)=0
	Unserialize an object.
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 (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

Protected Member Functions
void	connectSocket ()
	Try to resolve the server name and connect to the 9p server.
void	socketDisconnect ()
	9p server disconnect notification
ssize_t	read (uint8_t *data, size_t len)
	Read data from the server behind the proxy.
ssize_t	write (const uint8_t *data, size_t len)
	Write data to the server behind the proxy.
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.
void	serverDataReady ()
	Notification of pending data from server.
virtual ssize_t	read (uint8_t *data, size_t len)=0
	Read data from the server behind the proxy.
virtual ssize_t	write (const uint8_t *data, size_t len)=0
	Write data to the server behind the proxy.
void	readAll (uint8_t *data, size_t len)
	Convenience function that reads exactly len bytes.
void	writeAll (const uint8_t *data, size_t len)
	Convenience function that writes exactly len bytes.
Protected Member Functions inherited from gem5::VirtIO9PBase
virtual void	recvTMsg (const P9MsgHeader &header, const uint8_t *data, size_t size)=0
	Handle incoming 9p RPC message.
void	sendRMsg (const P9MsgHeader &header, const uint8_t *data, size_t size)
	Send a 9p RPC message reply.
void	dumpMsg (const P9MsgHeader &header, const uint8_t *data, size_t size)
	Dump a 9p RPC message on the debug output.
Protected Member Functions inherited from gem5::VirtIODeviceBase
void	kick ()
	Inform the guest of available buffers.
void	registerQueue (VirtQueue &queue)
	Register a new VirtQueue with the device model.
void	readConfigBlob (PacketPtr pkt, Addr cfgOffset, const uint8_t *cfg)
	Read configuration data from a device structure.
void	writeConfigBlob (PacketPtr pkt, Addr cfgOffset, uint8_t *cfg)
	Write configuration data to a device structure.
Protected Member Functions inherited from gem5::Drainable
	Drainable ()
virtual	~Drainable ()
virtual DrainState	drain ()=0
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.
virtual void	drainResume ()
	Resume execution after a successful drain.
void	signalDrainDone () const
	Signal that an object is drained.

Private Attributes
int	fdSocket
	Socket connected to the 9p server.
std::unique_ptr< SocketDataEvent >	dataEvent

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

Detailed Description

VirtIO 9p proxy that communicates with a 9p server over tcp sockets.

Definition at line 349 of file fs9p.hh.

Member Typedef Documentation

Params

typedef VirtIO9PSocketParams gem5::VirtIO9PSocket::Params

Definition at line 352 of file fs9p.hh.

Constructor & Destructor Documentation

VirtIO9PSocket()

gem5::VirtIO9PSocket::VirtIO9PSocket

(

const Params &

params

)

Definition at line 475 of file fs9p.cc.

~VirtIO9PSocket()

gem5::VirtIO9PSocket::~VirtIO9PSocket ( )

virtual

Definition at line 480 of file fs9p.cc.

Member Function Documentation

connectSocket()

void gem5::VirtIO9PSocket::connectSocket ( )

protected

Try to resolve the server name and connect to the 9p server.

Definition at line 493 of file fs9p.cc.

References DPRINTF, fdSocket, gem5::MipsISA::p, panic, and gem5::SimObject::params().

Referenced by startup().

read()

ssize_t gem5::VirtIO9PSocket::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

data	Memory location to store results in.
len	Maximum length to read.

Returns

Number of bytes read, -errno on failure.

Implements gem5::VirtIO9PProxy.

Definition at line 536 of file fs9p.cc.

References data, fdSocket, gem5::ArmISA::len, and socketDisconnect().

socketDisconnect()

void gem5::VirtIO9PSocket::socketDisconnect ( )

protected

9p server disconnect notification

Definition at line 530 of file fs9p.cc.

References panic.

Referenced by read().

startup()

void gem5::VirtIO9PSocket::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 485 of file fs9p.cc.

References connectSocket(), dataEvent, fdSocket, gem5::pollQueue, and gem5::PollQueue::schedule().

write()

ssize_t gem5::VirtIO9PSocket::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

data	Pointer to data to write.
len	Maximum length to write.

Returns

Number of bytes written, -errno on failure.

Implements gem5::VirtIO9PProxy.

Definition at line 549 of file fs9p.cc.

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

Member Data Documentation

dataEvent

std::unique_ptr<SocketDataEvent> gem5::VirtIO9PSocket::dataEvent

private

Definition at line 388 of file fs9p.hh.

Referenced by startup().

fdSocket

int gem5::VirtIO9PSocket::fdSocket

private

Socket connected to the 9p server.

Definition at line 386 of file fs9p.hh.

Referenced by connectSocket(), read(), startup(), and write().

---

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

• dev/virtio/fs9p.hh
• dev/virtio/fs9p.cc