esi::BundlePort Class Reference

Services provide connections to 'bundles' – collections of named, unidirectional communication channels. More...

#include <Ports.h>

Inheritance diagram for esi::BundlePort:

Collaboration diagram for esi::BundlePort:

Public Member Functions
	BundlePort (AppID id, const BundleType *type, PortMap channels)
	Construct a port.
virtual	~BundlePort ()=default
AppID	getID () const
	Get the ID of the port.
WriteChannelPort &	getRawWrite (const std::string &name) const
	Get access to the raw byte streams of a channel.
ReadChannelPort &	getRawRead (const std::string &name) const
const PortMap &	getChannels () const
template<typename T>
T *	getAs () const
	Cast this Bundle port to a subclass which is actually useful.
bool	poll ()
	Calls poll on all channels in the bundle and returns true if any of them returned true.

Static Public Member Functions
static bool	isWrite (BundleType::Direction bundleDir)
	Compute the direction of a channel given the bundle direction and the bundle port's direction.

Protected Attributes
AppID	id
const BundleType *	type
PortMap	channels

Detailed Description

Services provide connections to 'bundles' – collections of named, unidirectional communication channels.

This class provides access to those ChannelPorts.

Definition at line 637 of file Ports.h.

Constructor & Destructor Documentation

BundlePort()

BundlePort::BundlePort	(	AppID	id,
		const BundleType *	type,
		PortMap	channels )

Construct a port.

Definition at line 39 of file Ports.cpp.

References channels, id, and type.

~BundlePort()

virtual esi::BundlePort::~BundlePort ( )

virtualdefault

Member Function Documentation

getAs()

template<typename T>

T * esi::BundlePort::getAs ( ) const

inline

Cast this Bundle port to a subclass which is actually useful.

Returns nullptr if the cast fails.

Definition at line 665 of file Ports.h.

Referenced by aggregateHostmemBandwidthTest(), bandwidthWriteTest(), esi::findPortAsOrThrow(), hostmemReadBandwidthTest(), and hostmemWriteBandwidthTest().

getChannels()

const PortMap & esi::BundlePort::getChannels ( ) const

inline

Definition at line 658 of file Ports.h.

References channels.

Referenced by NB_MODULE().

getID()

AppID esi::BundlePort::getID ( ) const

inline

Get the ID of the port.

Definition at line 650 of file Ports.h.

References id.

Referenced by NB_MODULE().

getRawRead()

ReadChannelPort & BundlePort::getRawRead

(

const std::string &

name

)

const

Definition at line 52 of file Ports.cpp.

References channels.

Referenced by esi::services::CallService::Callback::connect(), esi::services::ChannelService::ToHost::connect(), esi::services::FuncService::Function::connect(), and NB_MODULE().

getRawWrite()

WriteChannelPort & BundlePort::getRawWrite

(

const std::string &

name

)

const

Get access to the raw byte streams of a channel.

Intended for internal usage and binding to other languages (e.g. Python) which have their own message serialization code. Exposed publicly as an escape hatch, but ordinary users should not use. You have been warned.

Definition at line 42 of file Ports.cpp.

References channels.

Referenced by esi::services::CallService::Callback::connect(), esi::services::ChannelService::FromHost::connect(), esi::services::FuncService::Function::connect(), and NB_MODULE().

isWrite()

bool esi::BundlePort::isWrite ( BundleType::Direction bundleDir )

inlinestatic

Compute the direction of a channel given the bundle direction and the bundle port's direction.

Definition at line 641 of file Ports.h.

References esi::BundleType::To.

Referenced by esi::backends::cosim::CosimEngine::createPort().

poll()

bool esi::BundlePort::poll ( )

inline

Calls poll on all channels in the bundle and returns true if any of them returned true.

Definition at line 671 of file Ports.h.

References channels.

Member Data Documentation

channels

PortMap esi::BundlePort::channels

protected

Definition at line 681 of file Ports.h.

Referenced by BundlePort(), esi::services::CallService::Callback::Callback(), esi::services::CallService::Callback::CallService, esi::services::CallService::Callback::connect(), esi::services::ChannelService::FromHost::connect(), esi::services::ChannelService::ToHost::connect(), esi::services::FuncService::Function::connect(), getChannels(), getRawRead(), getRawWrite(), esi::services::TelemetryService::Metric::Metric(), poll(), and esi::services::TelemetryService::Metric::TelemetryService.

id

AppID esi::BundlePort::id

protected

Definition at line 679 of file Ports.h.

Referenced by esiaccel.types.ESIType::__eq__(), BundlePort(), esi::services::CallService::Callback::Callback(), getID(), esi::services::TelemetryService::Metric::Metric(), and esi::services::MMIO::MMIORegion::MMIORegion().

type

const BundleType* esi::BundlePort::type

protected

Definition at line 680 of file Ports.h.

Referenced by esiaccel.types.WritePort::__serialize_msg(), BundlePort(), esi::services::CallService::Callback::Callback(), esi::services::CallService::Callback::CallService, esi::services::ChannelService::FromHost::ChannelService, esi::services::ChannelService::ToHost::ChannelService, esiaccel.types.Port::connect(), esi::services::FuncService::Function::FuncService, esi::services::CallService::Callback::get(), esi::services::ChannelService::FromHost::get(), esi::services::ChannelService::ToHost::get(), esi::services::FuncService::Function::get(), esi::services::CallService::Callback::getArgType(), esi::services::FuncService::Function::getArgType(), esi::services::CallService::Callback::getResultType(), esi::services::FuncService::Function::getResultType(), hw.HWModuleOp::input_indices(), fsm.MachineOp::instantiate(), esi::services::TelemetryService::Metric::Metric(), hw.HWModuleOp::outputs(), esiaccel.types.ReadPort::read(), esi::services::TelemetryService::Metric::TelemetryService, esi::services::ChannelService::FromHost::toString(), esi::services::ChannelService::ToHost::toString(), and esi::services::TelemetryService::Metric::toString().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Ports.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Ports.cpp