esi::backends::trace::TraceAccelerator Class Reference

Connect to an ESI simulation. More...

#include <Trace.h>

Inheritance diagram for esi::backends::trace::TraceAccelerator:

Collaboration diagram for esi::backends::trace::TraceAccelerator:

Classes
struct	Impl

Public Types
enum	Mode { Write , Discard }
Public Types inherited from esi::AcceleratorConnection
using	ServiceTable = std::map< std::string, services::Service * >
using	Service = services::Service

Public Member Functions
	TraceAccelerator (Context &, Mode mode, std::filesystem::path manifestJson, std::filesystem::path traceFile)
	Create a trace-based accelerator backend. More...
	~TraceAccelerator () override
std::map< std::string, ChannelPort & >	requestChannelsFor (AppIDPath, const BundleType *, const ServiceTable &) override
	Request the host side channel ports for a particular instance (identified by the AppID path). More...
Public Member Functions inherited from esi::AcceleratorConnection
	AcceleratorConnection (Context &ctxt)
virtual	~AcceleratorConnection ()
Context &	getCtxt () const
Logger &	getLogger () const
virtual void	disconnect ()
	Disconnect from the accelerator cleanly. More...
AcceleratorServiceThread *	getServiceThread ()
	Return a pointer to the accelerator 'service' thread (or threads). More...
template<typename ServiceClass >
ServiceClass *	getService (AppIDPath id={}, std::string implName={}, ServiceImplDetails details={}, HWClientDetails clients={})
	Get a typed reference to a particular service type. More...
virtual Service *	getService (Service::Type service, AppIDPath id={}, std::string implName={}, ServiceImplDetails details={}, HWClientDetails clients={})
	Calls createService and caches the result. More...
Accelerator *	takeOwnership (std::unique_ptr< Accelerator > accel)
	Assume ownership of an accelerator object. More...

Static Public Member Functions
static std::unique_ptr< AcceleratorConnection >	connect (Context &, std::string connectionString)
	Parse the connection string and instantiate the accelerator. More...

Protected Member Functions
virtual Service *	createService (Service::Type service, AppIDPath idPath, std::string implName, const ServiceImplDetails &details, const HWClientDetails &clients) override
	Called by getServiceImpl exclusively. More...

Private Attributes
std::unique_ptr< Impl >	impl

Detailed Description

Connect to an ESI simulation.

Definition at line 35 of file Trace.h.

Member Enumeration Documentation

Mode

enum esi::backends::trace::TraceAccelerator::Mode

Enumerator
Write
Discard

Definition at line 37 of file Trace.h.

Constructor & Destructor Documentation

TraceAccelerator()

TraceAccelerator::TraceAccelerator	(	Context &	ctxt,
		Mode	mode,
		std::filesystem::path	manifestJson,
		std::filesystem::path	traceFile
	)

Create a trace-based accelerator backend.

Parameters

mode	The mode of operation. See Mode.
manifestJson	The path to the manifest JSON file.
traceFile	The path to the trace file. For 'Write' mode, this file is opened for writing. For 'Read' mode, this file is opened for reading.

Definition at line 141 of file Trace.cpp.

References impl.

~TraceAccelerator()

TraceAccelerator::~TraceAccelerator ( )

override

Definition at line 147 of file Trace.cpp.

References esi::AcceleratorConnection::disconnect().

Member Function Documentation

connect()

std::unique_ptr< AcceleratorConnection > TraceAccelerator::connect ( Context &  ctxt, std::string  connectionString  )

static

Parse the connection string and instantiate the accelerator.

Format is: "<mode>:<manifest path>[:<traceFile>]".

Definition at line 108 of file Trace.cpp.

References esiaccel.accelerator::ctxt.

createService()

Service * TraceAccelerator::createService ( Service::Type  service, AppIDPath  idPath, std::string  implName, const ServiceImplDetails &  details, const HWClientDetails &  clients  )

overrideprotectedvirtual

Called by getServiceImpl exclusively.

It wraps the pointer returned by this in a unique_ptr and caches it. Separate this from the wrapping/caching since wrapping/caching is an implementation detail.

Implements esi::AcceleratorConnection.

Definition at line 149 of file Trace.cpp.

References impl.

requestChannelsFor()

std::map< std::string, ChannelPort & > TraceAccelerator::requestChannelsFor ( AppIDPath  idPath, const BundleType *  bundleType, const ServiceTable &    )

overridevirtual

Request the host side channel ports for a particular instance (identified by the AppID path).

For convenience, provide the bundle type.

Implements esi::AcceleratorConnection.

Definition at line 260 of file Trace.cpp.

References impl.

Member Data Documentation

impl

std::unique_ptr<Impl> esi::backends::trace::TraceAccelerator::impl

private

Definition at line 81 of file Trace.h.

Referenced by TraceHostMem::allocate(), createService(), TraceHostMem::mapMemory(), TraceMMIO::read(), requestChannelsFor(), TraceAccelerator(), TraceHostMem::unmapMemory(), TraceMMIO::write(), and TraceHostMem::TraceHostMemRegion::~TraceHostMemRegion().

---

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/backends/Trace.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/backends/Trace.cpp