21#include "cosim.grpc.pb.h"
24#include <grpcpp/channel.h>
25#include <grpcpp/client_context.h>
26#include <grpcpp/create_channel.h>
27#include <grpcpp/security/credentials.h>
39using grpc::ClientContext;
40using grpc::ClientReader;
41using grpc::ClientReaderWriter;
42using grpc::ClientWriter;
47 throw std::runtime_error(msg +
". Code " + to_string(s.error_code()) +
48 ": " + s.error_message() +
" (" +
49 s.error_details() +
")");
56 std::unique_ptr<ChannelServer::Stub>
stub;
60 esi::cosim::ChannelDesc &desc);
68std::unique_ptr<AcceleratorConnection>
71 std::string host =
"localhost";
74 if ((colon = connectionString.find(
':')) != std::string::npos) {
75 portStr = connectionString.substr(colon + 1);
76 host = connectionString.substr(0, colon);
77 }
else if (connectionString.ends_with(
"cosim.cfg")) {
78 std::ifstream cfg(connectionString);
79 std::string line, key, value;
81 while (getline(cfg, line))
82 if ((colon = line.find(
":")) != std::string::npos) {
83 key = line.substr(0, colon);
84 value = line.substr(colon + 1);
87 else if (key ==
"host")
91 if (portStr.size() == 0)
92 throw std::runtime_error(
"port line not found in file");
93 }
else if (connectionString ==
"env") {
94 char *hostEnv = getenv(
"ESI_COSIM_HOST");
99 char *portEnv = getenv(
"ESI_COSIM_PORT");
103 throw std::runtime_error(
"ESI_COSIM_PORT environment variable not set");
105 throw std::runtime_error(
"Invalid connection std::string '" +
106 connectionString +
"'");
108 uint16_t port = stoul(portStr);
109 auto conn = make_unique<CosimAccelerator>(
ctxt, host, port);
125 auto channel = grpc::CreateChannel(hostname +
":" + std::to_string(port),
126 grpc::InsecureChannelCredentials());
137class CosimSysInfo :
public SysInfo {
140 :
SysInfo(conn), rpcClient(rpcClient) {}
142 uint32_t getEsiVersion()
const override {
143 ::esi::cosim::Manifest response = getManifest();
144 return response.esi_version();
147 std::vector<uint8_t> getCompressedManifest()
const override {
148 ::esi::cosim::Manifest response = getManifest();
149 std::string compressedManifestStr = response.compressed_manifest();
150 return std::vector<uint8_t>(compressedManifestStr.begin(),
151 compressedManifestStr.end());
155 ::esi::cosim::Manifest getManifest()
const {
156 ::esi::cosim::Manifest response;
160 ClientContext context;
162 Status s = rpcClient->GetManifest(&context, arg, &response);
164 std::this_thread::sleep_for(std::chrono::milliseconds(10));
165 }
while (response.esi_version() < 0);
169 esi::cosim::ChannelServer::Stub *rpcClient;
177 WriteCosimChannelPort(ChannelServer::Stub *rpcClient,
const ChannelDesc &desc,
178 const Type *type, std::string name)
180 ~WriteCosimChannelPort() =
default;
182 void connectImpl(std::optional<unsigned> bufferSize)
override {
183 if (desc.type() != getType()->getID())
184 throw std::runtime_error(
"Channel '" + name +
185 "' has wrong type. Expected " +
186 getType()->getID() +
", got " + desc.type());
187 if (desc.dir() != ChannelDesc::Direction::ChannelDesc_Direction_TO_SERVER)
188 throw std::runtime_error(
"Channel '" + name +
189 "' is not a to server channel");
190 assert(desc.name() == name);
195 ClientContext context;
196 AddressedMessage msg;
197 msg.set_channel_name(name);
198 msg.mutable_message()->set_data(
data.getBytes(),
data.getSize());
199 VoidMessage response;
200 grpc::Status sendStatus = rpcClient->SendToServer(&context, msg, &response);
201 if (!sendStatus.ok())
202 throw std::runtime_error(
"Failed to write to channel '" + name +
203 "': " + std::to_string(sendStatus.error_code()) +
204 " " + sendStatus.error_message() +
205 ". Details: " + sendStatus.error_details());
214 ChannelServer::Stub *rpcClient;
225class ReadCosimChannelPort
227 public grpc::ClientReadReactor<esi::cosim::Message> {
229 ReadCosimChannelPort(ChannelServer::Stub *rpcClient,
const ChannelDesc &desc,
230 const Type *type, std::string name)
233 virtual ~ReadCosimChannelPort() { disconnect(); }
235 void connectImpl(std::optional<unsigned> bufferSize)
override {
237 if (desc.type() != getType()->getID())
238 throw std::runtime_error(
"Channel '" + name +
239 "' has wrong type. Expected " +
240 getType()->getID() +
", got " + desc.type());
241 if (desc.dir() != ChannelDesc::Direction::ChannelDesc_Direction_TO_CLIENT)
242 throw std::runtime_error(
"Channel '" + name +
243 "' is not a to client channel");
244 assert(desc.name() == name);
247 context = std::make_unique<ClientContext>();
248 rpcClient->async()->ConnectToClientChannel(context.get(), &desc,
this);
250 StartRead(&incomingMessage);
255 void OnReadDone(
bool ok)
override {
261 const std::string &messageString = incomingMessage.data();
262 MessageData data(
reinterpret_cast<const uint8_t *
>(messageString.data()),
263 messageString.size());
264 while (!callback(data))
267 std::this_thread::sleep_for(std::chrono::milliseconds(10));
270 StartRead(&incomingMessage);
274 void disconnect()
override {
277 context->TryCancel();
283 ChannelServer::Stub *rpcClient;
289 std::unique_ptr<ClientContext> context;
291 esi::cosim::Message incomingMessage;
301 ClientContext context;
303 ListOfChannels response;
304 Status s = stub->ListChannels(&context, arg, &response);
306 for (
const auto &channel : response.channels())
307 if (channel.name() == channelName) {
315class CosimMMIO :
public MMIO {
319 :
MMIO(conn, clients) {
322 ChannelDesc cmdArg, cmdResp;
323 if (!rpcClient->
getChannelDesc(
"__cosim_mmio_read_write.arg", cmdArg) ||
324 !rpcClient->
getChannelDesc(
"__cosim_mmio_read_write.result", cmdResp))
325 throw std::runtime_error(
"Could not find MMIO channels");
330 {{
"write", new BitsType(
"i1", 1)},
331 {
"offset", new UIntType(
"ui32", 32)},
332 {
"data", new BitsType(
"i64", 64)}}));
335 cmdArgPort = std::make_unique<WriteCosimChannelPort>(
336 rpcClient->
stub.get(), cmdArg, cmdType,
"__cosim_mmio_read_write.arg");
337 cmdRespPort = std::make_unique<ReadCosimChannelPort>(
338 rpcClient->
stub.get(), cmdResp, i64Type,
339 "__cosim_mmio_read_write.result");
341 "cosimMMIO", {{
"arg", BundleType::Direction::To, cmdType},
342 {
"result", BundleType::Direction::From, i64Type}});
344 *cmdArgPort, *cmdRespPort));
357 uint64_t read(uint32_t addr)
const override {
358 MMIOCmd cmd{.offset =
addr, .write =
false};
360 std::future<MessageData> result = cmdMMIO->call(arg);
362 return *result.get().as<uint64_t>();
365 void write(uint32_t addr, uint64_t data)
override {
366 MMIOCmd cmd{.data =
data, .offset =
addr, .write =
true};
368 std::future<MessageData> result = cmdMMIO->call(arg);
374 if (
auto t =
ctxt.getType(type->
getID())) {
378 ctxt.registerType(type);
381 std::unique_ptr<WriteCosimChannelPort> cmdArgPort;
382 std::unique_ptr<ReadCosimChannelPort> cmdRespPort;
383 std::unique_ptr<FuncService::Function> cmdMMIO;
387struct HostMemReadReq {
393struct HostMemReadResp {
398struct HostMemWriteReq {
405using HostMemWriteResp = uint8_t;
408class CosimHostMem :
public HostMem {
414 void start()
override {
422 ChannelDesc readArg, readResp;
423 if (!rpcClient->
getChannelDesc(
"__cosim_hostmem_read_req.data", readArg) ||
424 !rpcClient->
getChannelDesc(
"__cosim_hostmem_read_resp.data", readResp))
425 throw std::runtime_error(
"Could not find HostMem read channels");
429 {{
"tag", new UIntType(
"ui8", 8)},
430 {
"data", new BitsType(
"i64", 64)}}));
433 {{
"address", new UIntType(
"ui64", 64)},
434 {
"length", new UIntType(
"ui32", 32)},
435 {
"tag", new UIntType(
"ui8", 8)}}));
439 readRespPort = std::make_unique<WriteCosimChannelPort>(
440 rpcClient->
stub.get(), readResp, readRespType,
441 "__cosim_hostmem_read_resp.data");
442 readReqPort = std::make_unique<ReadCosimChannelPort>(
443 rpcClient->
stub.get(), readArg, readReqType,
444 "__cosim_hostmem_read_req.data");
445 readReqPort->connect(
446 [
this](
const MessageData &req) {
return serviceRead(req); });
449 ChannelDesc writeArg, writeResp;
450 if (!rpcClient->
getChannelDesc(
"__cosim_hostmem_write.arg", writeArg) ||
451 !rpcClient->
getChannelDesc(
"__cosim_hostmem_write.result", writeResp))
452 throw std::runtime_error(
"Could not find HostMem write channels");
455 getType(ctxt,
new UIntType(writeResp.type(), 8));
458 {{
"address", new UIntType(
"ui64", 64)},
459 {
"tag", new UIntType(
"ui8", 8)},
460 {
"data", new BitsType(
"i64", 64)}}));
463 writeRespPort = std::make_unique<WriteCosimChannelPort>(
464 rpcClient->
stub.get(), writeResp, writeRespType,
465 "__cosim_hostmem_write.result");
466 writeReqPort = std::make_unique<ReadCosimChannelPort>(
467 rpcClient->
stub.get(), writeArg, writeReqType,
468 "__cosim_hostmem_write.arg");
474 bundleType, *writeRespPort,
476 write->connect([
this](
const MessageData &req) {
return serviceWrite(req); },
483 const HostMemReadReq *req = reqBytes.
as<HostMemReadReq>();
484 acc.getLogger().debug(
485 [&](std::string &subsystem, std::string &msg,
486 std::unique_ptr<std::map<std::string, std::any>> &details) {
487 subsystem =
"HostMem";
488 msg =
"Read request: addr=0x" +
toHex(req->address) +
489 " len=" + std::to_string(req->length) +
490 " tag=" + std::to_string(req->tag);
493 uint64_t *dataPtr =
reinterpret_cast<uint64_t *
>(req->address);
494 for (uint32_t i = 0, e = (req->length + 7) / 8; i < e; ++i) {
495 HostMemReadResp resp{.data = dataPtr[i], .tag = req->tag};
496 acc.getLogger().debug(
497 [&](std::string &subsystem, std::string &msg,
498 std::unique_ptr<std::map<std::string, std::any>> &details) {
499 subsystem =
"HostMem";
500 msg =
"Read result: data=0x" +
toHex(resp.data) +
501 " tag=" + std::to_string(resp.tag);
511 const HostMemWriteReq *req = reqBytes.
as<HostMemWriteReq>();
512 acc.getLogger().debug(
513 [&](std::string &subsystem, std::string &msg,
514 std::unique_ptr<std::map<std::string, std::any>> &details) {
515 subsystem =
"HostMem";
516 msg =
"Write request: addr=0x" +
toHex(req->address) +
" data=0x" +
518 " valid_bytes=" + std::to_string(req->valid_bytes) +
519 " tag=" + std::to_string(req->tag);
521 uint8_t *dataPtr =
reinterpret_cast<uint8_t *
>(req->address);
522 for (uint8_t i = 0; i < req->valid_bytes; ++i)
523 dataPtr[i] = (req->data >> (i * 8)) & 0xFF;
524 HostMemWriteResp resp = req->tag;
528 struct CosimHostMemRegion :
public HostMemRegion {
529 CosimHostMemRegion(std::size_t size) {
533 virtual ~CosimHostMemRegion() { free(ptr); }
534 virtual void *getPtr()
const override {
return ptr; }
535 virtual std::size_t getSize()
const override {
return size; }
542 virtual std::unique_ptr<HostMemRegion>
544 return std::unique_ptr<HostMemRegion>(
new CosimHostMemRegion(size));
546 virtual bool mapMemory(
void *ptr, std::size_t size,
550 virtual void unmapMemory(
void *ptr)
const override {}
554 if (
auto t =
ctxt.getType(type->
getID())) {
558 ctxt.registerType(type);
564 std::unique_ptr<WriteCosimChannelPort> readRespPort;
565 std::unique_ptr<ReadCosimChannelPort> readReqPort;
566 std::unique_ptr<CallService::Callback> read;
567 std::unique_ptr<WriteCosimChannelPort> writeRespPort;
568 std::unique_ptr<ReadCosimChannelPort> writeReqPort;
569 std::unique_ptr<CallService::Callback> write;
582 if (prefix.size() > 0)
585 for (
auto client : clients) {
586 AppIDPath fullClientPath = prefix + client.relPath;
587 std::map<std::string, std::string> channelAssignments;
588 for (
auto assignment : client.channelAssignments)
589 if (assignment.second.type ==
"cosim")
590 channelAssignments[assignment.first] = std::any_cast<std::string>(
591 assignment.second.implOptions.at(
"name"));
597 const std::string &channelName,
599 const Type *type)
override;
603 std::map<AppIDPath, std::map<std::string, std::string>>
608std::unique_ptr<ChannelPort>
615 throw std::runtime_error(
"Could not find port for '" + idPath.
toStr() +
616 "." + channelName +
"'");
617 const std::map<std::string, std::string> &channelAssignments = f->second;
618 auto cosimChannelNameIter = channelAssignments.find(channelName);
619 if (cosimChannelNameIter == channelAssignments.end())
620 throw std::runtime_error(
"Could not find channel '" + idPath.
toStr() +
"." +
621 channelName +
"' in cosimulation");
627 throw std::runtime_error(
"Could not find channel '" + idPath.
toStr() +
"." +
628 channelName +
"' in cosimulation");
630 std::unique_ptr<ChannelPort> port;
631 std::string fullChannelName = idPath.
toStr() +
"." + channelName;
633 port = std::make_unique<WriteCosimChannelPort>(
636 port = std::make_unique<ReadCosimChannelPort>(
646 std::unique_ptr<Engine> engine =
nullptr;
647 if (engineTypeName ==
"cosim")
648 engine = std::make_unique<CosimEngine>(*
this, idPath, details, clients);
662 }
else if (svcType ==
typeid(
SysInfo)) {
667 return new MMIOSysInfo(getService<services::MMIO>());
#define REGISTER_ACCELERATOR(Name, TAccelerator)
assert(baseType &&"element must be base type")
static void checkStatus(Status s, const std::string &msg)
Abstract class representing a connection to an accelerator.
virtual void disconnect()
Disconnect from the accelerator cleanly.
Context & getCtxt() const
Context & ctxt
ESI accelerator context.
void registerEngine(AppIDPath idPath, std::unique_ptr< Engine > engine, const HWClientDetails &clients)
If createEngine is overridden, this method should be called to register the engine and all of the cha...
std::string toStr() const
static bool isWrite(BundleType::Direction bundleDir)
Compute the direction of a channel given the bundle direction and the bundle port's direction.
Bundles represent a collection of channels.
AcceleratorConnections, Accelerators, and Manifests must all share a context.
Engines implement the actual channel communication between the host and the accelerator.
A logical chunk of data representing serialized data.
const T * as() const
Cast to a type.
static MessageData from(T &t)
Cast from a type to its raw bytes.
A ChannelPort which reads data from the accelerator.
virtual void disconnect() override
Structs are an ordered collection of fields, each with a name and a type.
Root class of the ESI type system.
A ChannelPort which sends data to the accelerator.
Connect to an ESI simulation.
void createEngine(const std::string &engineTypeName, AppIDPath idPath, const ServiceImplDetails &details, const HWClientDetails &clients) override
Create a new engine for channel communication with the accelerator.
void setManifestMethod(ManifestMethod method)
static std::unique_ptr< AcceleratorConnection > connect(Context &, std::string connectionString)
Parse the connection std::string and instantiate the accelerator.
virtual Service * createService(Service::Type service, AppIDPath path, std::string implName, const ServiceImplDetails &details, const HWClientDetails &clients) override
Called by getServiceImpl exclusively.
ManifestMethod manifestMethod
CosimAccelerator(Context &, std::string hostname, uint16_t port)
Construct and connect to a cosim server.
std::set< std::unique_ptr< ChannelPort > > channels
StubContainer * rpcClient
Implement the magic cosim channel communication.
CosimEngine(CosimAccelerator &conn, AppIDPath idPath, const ServiceImplDetails &details, const HWClientDetails &clients)
std::map< AppIDPath, std::map< std::string, std::string > > clientChannelAssignments
std::unique_ptr< ChannelPort > createPort(AppIDPath idPath, const std::string &channelName, BundleType::Direction dir, const Type *type) override
Each engine needs to know how to create a ports.
static Callback * get(AcceleratorConnection &acc, AppID id, BundleType *type, WriteChannelPort &result, ReadChannelPort &arg)
static Function * get(AppID id, BundleType *type, WriteChannelPort &arg, ReadChannelPort &result)
Implement the SysInfo API for a standard MMIO protocol.
Parent class of all APIs modeled as 'services'.
const std::type_info & Type
Information about the Accelerator system.
std::unique_ptr< Engine > createEngine(AcceleratorConnection &conn, const std::string &dmaEngineName, AppIDPath idPath, const ServiceImplDetails &details, const HWClientDetails &clients)
Create an engine by name.
std::map< std::string, std::any > ServiceImplDetails
std::string toHex(void *val)
std::vector< HWClientDetail > HWClientDetails
Hack around C++ not having a way to forward declare a nested class.
std::unique_ptr< ChannelServer::Stub > stub
bool getChannelDesc(const std::string &channelName, esi::cosim::ChannelDesc &desc)
Get the type ID for a channel name.
StubContainer(std::unique_ptr< ChannelServer::Stub > stub)
Options for allocating host memory.