CIRCT 21.0.0git
Loading...
Searching...
No Matches
Cosim.cpp
Go to the documentation of this file.
1//===- Cosim.cpp - Connection to ESI simulation via GRPC ------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// DO NOT EDIT!
10// This file is distributed as part of an ESI package. The source for this file
11// should always be modified within CIRCT
12// (lib/dialect/ESI/runtime/cpp/lib/backends/Cosim.cpp).
13//
14//===----------------------------------------------------------------------===//
15
16#include "esi/backends/Cosim.h"
17#include "esi/Engines.h"
18#include "esi/Services.h"
19#include "esi/Utils.h"
20
21#include "cosim.grpc.pb.h"
22
23#include <grpc/grpc.h>
24#include <grpcpp/channel.h>
25#include <grpcpp/client_context.h>
26#include <grpcpp/create_channel.h>
27#include <grpcpp/security/credentials.h>
28
29#include <fstream>
30#include <iostream>
31#include <set>
32
33using namespace esi;
34using namespace esi::cosim;
35using namespace esi::services;
36using namespace esi::backends::cosim;
37
38using grpc::Channel;
39using grpc::ClientContext;
40using grpc::ClientReader;
41using grpc::ClientReaderWriter;
42using grpc::ClientWriter;
43using grpc::Status;
44
45static void checkStatus(Status s, const std::string &msg) {
46 if (!s.ok())
47 throw std::runtime_error(msg + ". Code " + to_string(s.error_code()) +
48 ": " + s.error_message() + " (" +
49 s.error_details() + ")");
50}
51
52/// Hack around C++ not having a way to forward declare a nested class.
54 StubContainer(std::unique_ptr<ChannelServer::Stub> stub)
55 : stub(std::move(stub)) {}
56 std::unique_ptr<ChannelServer::Stub> stub;
57
58 /// Get the type ID for a channel name.
59 bool getChannelDesc(const std::string &channelName,
60 esi::cosim::ChannelDesc &desc);
61};
63
64/// Parse the connection std::string and instantiate the accelerator. Support
65/// the traditional 'host:port' syntax and a path to 'cosim.cfg' which is output
66/// by the cosimulation when it starts (which is useful when it chooses its own
67/// port).
68std::unique_ptr<AcceleratorConnection>
69CosimAccelerator::connect(Context &ctxt, std::string connectionString) {
70 std::string portStr;
71 std::string host = "localhost";
72
73 size_t colon;
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;
80
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);
85 if (key == "port")
86 portStr = value;
87 else if (key == "host")
88 host = value;
89 }
90
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");
95 if (hostEnv)
96 host = hostEnv;
97 else
98 host = "localhost";
99 char *portEnv = getenv("ESI_COSIM_PORT");
100 if (portEnv)
101 portStr = portEnv;
102 else
103 throw std::runtime_error("ESI_COSIM_PORT environment variable not set");
104 } else {
105 throw std::runtime_error("Invalid connection std::string '" +
106 connectionString + "'");
107 }
108 uint16_t port = stoul(portStr);
109 auto conn = make_unique<CosimAccelerator>(ctxt, host, port);
110
111 // Using the MMIO manifest method is really only for internal debugging, so it
112 // doesn't need to be part of the connection string.
113 char *manifestMethod = getenv("ESI_COSIM_MANIFEST_MMIO");
114 if (manifestMethod != nullptr)
115 conn->setManifestMethod(ManifestMethod::MMIO);
116
117 return conn;
118}
119
120/// Construct and connect to a cosim server.
121CosimAccelerator::CosimAccelerator(Context &ctxt, std::string hostname,
122 uint16_t port)
123 : AcceleratorConnection(ctxt) {
124 // Connect to the simulation.
125 auto channel = grpc::CreateChannel(hostname + ":" + std::to_string(port),
126 grpc::InsecureChannelCredentials());
127 rpcClient = new StubContainer(ChannelServer::NewStub(channel));
128}
130 disconnect();
131 if (rpcClient)
132 delete rpcClient;
133 channels.clear();
134}
135
136namespace {
137class CosimSysInfo : public SysInfo {
138public:
139 CosimSysInfo(CosimAccelerator &conn, ChannelServer::Stub *rpcClient)
140 : SysInfo(conn), rpcClient(rpcClient) {}
141
142 uint32_t getEsiVersion() const override {
143 ::esi::cosim::Manifest response = getManifest();
144 return response.esi_version();
145 }
146
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());
152 }
153
154private:
155 ::esi::cosim::Manifest getManifest() const {
156 ::esi::cosim::Manifest response;
157 // To get around the a race condition where the manifest may not be set yet,
158 // loop until it is. TODO: fix this with the DPI API change.
159 do {
160 ClientContext context;
161 VoidMessage arg;
162 Status s = rpcClient->GetManifest(&context, arg, &response);
163 checkStatus(s, "Failed to get manifest");
164 std::this_thread::sleep_for(std::chrono::milliseconds(10));
165 } while (response.esi_version() < 0);
166 return response;
167 }
168
169 esi::cosim::ChannelServer::Stub *rpcClient;
170};
171} // namespace
172
173namespace {
174/// Cosim client implementation of a write channel port.
175class WriteCosimChannelPort : public WriteChannelPort {
176public:
177 WriteCosimChannelPort(ChannelServer::Stub *rpcClient, const ChannelDesc &desc,
178 const Type *type, std::string name)
179 : WriteChannelPort(type), rpcClient(rpcClient), desc(desc), name(name) {}
180 ~WriteCosimChannelPort() = default;
181
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);
191 }
192
193 /// Send a write message to the server.
194 void write(const MessageData &data) override {
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());
206 }
207
208 bool tryWrite(const MessageData &data) override {
209 write(data);
210 return true;
211 }
212
213protected:
214 ChannelServer::Stub *rpcClient;
215 /// The channel description as provided by the server.
216 ChannelDesc desc;
217 /// The name of the channel from the manifest.
218 std::string name;
219};
220} // namespace
221
222namespace {
223/// Cosim client implementation of a read channel port. Since gRPC read protocol
224/// streams messages back, this implementation is quite complex.
225class ReadCosimChannelPort
226 : public ReadChannelPort,
227 public grpc::ClientReadReactor<esi::cosim::Message> {
228public:
229 ReadCosimChannelPort(ChannelServer::Stub *rpcClient, const ChannelDesc &desc,
230 const Type *type, std::string name)
231 : ReadChannelPort(type), rpcClient(rpcClient), desc(desc), name(name),
232 context(nullptr) {}
233 virtual ~ReadCosimChannelPort() { disconnect(); }
234
235 void connectImpl(std::optional<unsigned> bufferSize) override {
236 // Sanity checking.
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);
245
246 // Initiate a stream of messages from the server.
247 context = std::make_unique<ClientContext>();
248 rpcClient->async()->ConnectToClientChannel(context.get(), &desc, this);
249 StartCall();
250 StartRead(&incomingMessage);
251 }
252
253 /// Gets called when there's a new message from the server. It'll be stored in
254 /// `incomingMessage`.
255 void OnReadDone(bool ok) override {
256 if (!ok)
257 // This happens when we are disconnecting since we are canceling the call.
258 return;
259
260 // Read the delivered message and push it onto the queue.
261 const std::string &messageString = incomingMessage.data();
262 MessageData data(reinterpret_cast<const uint8_t *>(messageString.data()),
263 messageString.size());
264 while (!callback(data))
265 // Blocking here could cause deadlocks in specific situations.
266 // TODO: Implement a way to handle this better.
267 std::this_thread::sleep_for(std::chrono::milliseconds(10));
268
269 // Initiate the next read.
270 StartRead(&incomingMessage);
271 }
272
273 /// Disconnect this channel from the server.
274 void disconnect() override {
275 if (!context)
276 return;
277 context->TryCancel();
278 context.reset();
280 }
281
282protected:
283 ChannelServer::Stub *rpcClient;
284 /// The channel description as provided by the server.
285 ChannelDesc desc;
286 /// The name of the channel from the manifest.
287 std::string name;
288
289 std::unique_ptr<ClientContext> context;
290 /// Storage location for the incoming message.
291 esi::cosim::Message incomingMessage;
292};
293
294} // namespace
295
296/// Get the channel description for a channel name. Iterate through the list
297/// each time. Since this will only be called a small number of times on a small
298/// list, it's not worth doing anything fancy.
299bool StubContainer::getChannelDesc(const std::string &channelName,
300 ChannelDesc &desc) {
301 ClientContext context;
302 VoidMessage arg;
303 ListOfChannels response;
304 Status s = stub->ListChannels(&context, arg, &response);
305 checkStatus(s, "Failed to list channels");
306 for (const auto &channel : response.channels())
307 if (channel.name() == channelName) {
308 desc = channel;
309 return true;
310 }
311 return false;
312}
313
314namespace {
315class CosimMMIO : public MMIO {
316public:
317 CosimMMIO(CosimAccelerator &conn, Context &ctxt, StubContainer *rpcClient,
318 const HWClientDetails &clients)
319 : MMIO(conn, clients) {
320 // We have to locate the channels ourselves since this service might be used
321 // to retrieve the manifest.
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");
326
327 const esi::Type *i64Type = getType(ctxt, new UIntType(cmdResp.type(), 64));
328 const esi::Type *cmdType =
329 getType(ctxt, new StructType(cmdArg.type(),
330 {{"write", new BitsType("i1", 1)},
331 {"offset", new UIntType("ui32", 32)},
332 {"data", new BitsType("i64", 64)}}));
333
334 // Get ports, create the function, then connect to it.
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");
340 auto *bundleType = new BundleType(
341 "cosimMMIO", {{"arg", BundleType::Direction::To, cmdType},
342 {"result", BundleType::Direction::From, i64Type}});
343 cmdMMIO.reset(FuncService::Function::get(AppID("__cosim_mmio"), bundleType,
344 *cmdArgPort, *cmdRespPort));
345 cmdMMIO->connect();
346 }
347
348#pragma pack(push, 1)
349 struct MMIOCmd {
350 uint64_t data;
351 uint32_t offset;
352 bool write;
353 };
354#pragma pack(pop)
355
356 // Call the read function and wait for a response.
357 uint64_t read(uint32_t addr) const override {
358 MMIOCmd cmd{.offset = addr, .write = false};
359 auto arg = MessageData::from(cmd);
360 std::future<MessageData> result = cmdMMIO->call(arg);
361 result.wait();
362 return *result.get().as<uint64_t>();
363 }
364
365 void write(uint32_t addr, uint64_t data) override {
366 MMIOCmd cmd{.data = data, .offset = addr, .write = true};
367 auto arg = MessageData::from(cmd);
368 std::future<MessageData> result = cmdMMIO->call(arg);
369 result.wait();
370 }
371
372private:
373 const esi::Type *getType(Context &ctxt, esi::Type *type) {
374 if (auto t = ctxt.getType(type->getID())) {
375 delete type;
376 return *t;
377 }
378 ctxt.registerType(type);
379 return type;
380 }
381 std::unique_ptr<WriteCosimChannelPort> cmdArgPort;
382 std::unique_ptr<ReadCosimChannelPort> cmdRespPort;
383 std::unique_ptr<FuncService::Function> cmdMMIO;
384};
385
386#pragma pack(push, 1)
387struct HostMemReadReq {
388 uint8_t tag;
389 uint32_t length;
390 uint64_t address;
391};
392
393struct HostMemReadResp {
394 uint64_t data;
395 uint8_t tag;
396};
397
398struct HostMemWriteReq {
399 uint8_t valid_bytes;
400 uint64_t data;
401 uint8_t tag;
402 uint64_t address;
403};
404
405using HostMemWriteResp = uint8_t;
406#pragma pack(pop)
407
408class CosimHostMem : public HostMem {
409public:
410 CosimHostMem(AcceleratorConnection &acc, Context &ctxt,
411 StubContainer *rpcClient)
412 : HostMem(acc), acc(acc), ctxt(ctxt), rpcClient(rpcClient) {}
413
414 void start() override {
415 // We have to locate the channels ourselves since this service might be used
416 // to retrieve the manifest.
417
418 // TODO: The types here are WRONG. They need to be wrapped in Channels! Fix
419 // this in a subsequent PR.
420
421 // Setup the read side callback.
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");
426
427 const esi::Type *readRespType =
428 getType(ctxt, new StructType(readResp.type(),
429 {{"tag", new UIntType("ui8", 8)},
430 {"data", new BitsType("i64", 64)}}));
431 const esi::Type *readReqType =
432 getType(ctxt, new StructType(readArg.type(),
433 {{"address", new UIntType("ui64", 64)},
434 {"length", new UIntType("ui32", 32)},
435 {"tag", new UIntType("ui8", 8)}}));
436
437 // Get ports. Unfortunately, we can't model this as a callback since there
438 // will sometimes be multiple responses per request.
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); });
447
448 // Setup the write side callback.
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");
453
454 const esi::Type *writeRespType =
455 getType(ctxt, new UIntType(writeResp.type(), 8));
456 const esi::Type *writeReqType =
457 getType(ctxt, new StructType(writeArg.type(),
458 {{"address", new UIntType("ui64", 64)},
459 {"tag", new UIntType("ui8", 8)},
460 {"data", new BitsType("i64", 64)}}));
461
462 // Get ports, create the function, then connect to it.
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");
469 auto *bundleType = new BundleType(
470 "cosimHostMem",
471 {{"arg", BundleType::Direction::To, writeReqType},
472 {"result", BundleType::Direction::From, writeRespType}});
473 write.reset(CallService::Callback::get(acc, AppID("__cosim_hostmem_write"),
474 bundleType, *writeRespPort,
475 *writeReqPort));
476 write->connect([this](const MessageData &req) { return serviceWrite(req); },
477 true);
478 }
479
480 // Service the read request as a callback. Simply reads the data from the
481 // location specified. TODO: check that the memory has been mapped.
482 bool serviceRead(const MessageData &reqBytes) {
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);
491 });
492 // Send one response per 8 bytes.
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);
502 });
503 readRespPort->write(MessageData::from(resp));
504 }
505 return true;
506 }
507
508 // Service a write request as a callback. Simply write the data to the
509 // location specified. TODO: check that the memory has been mapped.
510 MessageData serviceWrite(const MessageData &reqBytes) {
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" +
517 toHex(req->data) +
518 " valid_bytes=" + std::to_string(req->valid_bytes) +
519 " tag=" + std::to_string(req->tag);
520 });
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;
525 return MessageData::from(resp);
526 }
527
528 struct CosimHostMemRegion : public HostMemRegion {
529 CosimHostMemRegion(std::size_t size) {
530 ptr = malloc(size);
531 this->size = size;
532 }
533 virtual ~CosimHostMemRegion() { free(ptr); }
534 virtual void *getPtr() const override { return ptr; }
535 virtual std::size_t getSize() const override { return size; }
536
537 private:
538 void *ptr;
539 std::size_t size;
540 };
541
542 virtual std::unique_ptr<HostMemRegion>
543 allocate(std::size_t size, HostMem::Options opts) const override {
544 return std::unique_ptr<HostMemRegion>(new CosimHostMemRegion(size));
545 }
546 virtual bool mapMemory(void *ptr, std::size_t size,
547 HostMem::Options opts) const override {
548 return true;
549 }
550 virtual void unmapMemory(void *ptr) const override {}
551
552private:
553 const esi::Type *getType(Context &ctxt, esi::Type *type) {
554 if (auto t = ctxt.getType(type->getID())) {
555 delete type;
556 return *t;
557 }
558 ctxt.registerType(type);
559 return type;
560 }
562 Context &ctxt;
563 StubContainer *rpcClient;
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;
570};
571} // namespace
572
573namespace esi::backends::cosim {
574/// Implement the magic cosim channel communication.
575class CosimEngine : public Engine {
576public:
578 const ServiceImplDetails &details, const HWClientDetails &clients)
579 : conn(conn) {
580 // Compute our parents idPath path.
581 AppIDPath prefix = std::move(idPath);
582 if (prefix.size() > 0)
583 prefix.pop_back();
584
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"));
592 clientChannelAssignments[fullClientPath] = std::move(channelAssignments);
593 }
594 }
595
596 std::unique_ptr<ChannelPort> createPort(AppIDPath idPath,
597 const std::string &channelName,
599 const Type *type) override;
600
601private:
603 std::map<AppIDPath, std::map<std::string, std::string>>
605};
606} // namespace esi::backends::cosim
607
608std::unique_ptr<ChannelPort>
609CosimEngine::createPort(AppIDPath idPath, const std::string &channelName,
610 BundleType::Direction dir, const Type *type) {
611
612 // Find the client details for the port at 'fullPath'.
613 auto f = clientChannelAssignments.find(idPath);
614 if (f == clientChannelAssignments.end())
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");
622
623 // Get the endpoint, which may or may not exist. Construct the port.
624 // Everything is validated when the client calls 'connect()' on the port.
625 ChannelDesc chDesc;
626 if (!conn.rpcClient->getChannelDesc(cosimChannelNameIter->second, chDesc))
627 throw std::runtime_error("Could not find channel '" + idPath.toStr() + "." +
628 channelName + "' in cosimulation");
629
630 std::unique_ptr<ChannelPort> port;
631 std::string fullChannelName = idPath.toStr() + "." + channelName;
632 if (BundlePort::isWrite(dir))
633 port = std::make_unique<WriteCosimChannelPort>(
634 conn.rpcClient->stub.get(), chDesc, type, fullChannelName);
635 else
636 port = std::make_unique<ReadCosimChannelPort>(
637 conn.rpcClient->stub.get(), chDesc, type, fullChannelName);
638 return port;
639}
640
641void CosimAccelerator::createEngine(const std::string &engineTypeName,
642 AppIDPath idPath,
643 const ServiceImplDetails &details,
644 const HWClientDetails &clients) {
645
646 std::unique_ptr<Engine> engine = nullptr;
647 if (engineTypeName == "cosim")
648 engine = std::make_unique<CosimEngine>(*this, idPath, details, clients);
649 else
650 engine = ::esi::registry::createEngine(*this, engineTypeName, idPath,
651 details, clients);
652 registerEngine(idPath, std::move(engine), clients);
653}
655 AppIDPath idPath, std::string implName,
656 const ServiceImplDetails &details,
657 const HWClientDetails &clients) {
658 if (svcType == typeid(services::MMIO)) {
659 return new CosimMMIO(*this, getCtxt(), rpcClient, clients);
660 } else if (svcType == typeid(services::HostMem)) {
661 return new CosimHostMem(*this, getCtxt(), rpcClient);
662 } else if (svcType == typeid(SysInfo)) {
663 switch (manifestMethod) {
665 return new CosimSysInfo(*this, rpcClient->stub.get());
667 return new MMIOSysInfo(getService<services::MMIO>());
668 }
669 }
670 return nullptr;
671}
672
676
#define REGISTER_ACCELERATOR(Name, TAccelerator)
assert(baseType &&"element must be base type")
static void checkStatus(Status s, const std::string &msg)
Definition Cosim.cpp:45
Abstract class representing a connection to an accelerator.
Definition Accelerator.h:79
virtual void disconnect()
Disconnect from the accelerator cleanly.
Context & getCtxt() const
Definition Accelerator.h:83
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
Definition Manifest.cpp:731
static bool isWrite(BundleType::Direction bundleDir)
Compute the direction of a channel given the bundle direction and the bundle port's direction.
Definition Ports.h:230
Bundles represent a collection of channels.
Definition Types.h:44
AcceleratorConnections, Accelerators, and Manifests must all share a context.
Definition Context.h:31
Engines implement the actual channel communication between the host and the accelerator.
Definition Engines.h:41
A logical chunk of data representing serialized data.
Definition Common.h:103
const T * as() const
Cast to a type.
Definition Common.h:119
static MessageData from(T &t)
Cast from a type to its raw bytes.
Definition Common.h:129
A ChannelPort which reads data from the accelerator.
Definition Ports.h:124
virtual void disconnect() override
Definition Ports.h:129
Structs are an ordered collection of fields, each with a name and a type.
Definition Types.h:137
Root class of the ESI type system.
Definition Types.h:27
ID getID() const
Definition Types.h:33
Unsigned integer.
Definition Types.h:131
A ChannelPort which sends data to the accelerator.
Definition Ports.h:77
Connect to an ESI simulation.
Definition Cosim.h:38
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.
Definition Cosim.cpp:641
void setManifestMethod(ManifestMethod method)
Definition Cosim.cpp:673
static std::unique_ptr< AcceleratorConnection > connect(Context &, std::string connectionString)
Parse the connection std::string and instantiate the accelerator.
Definition Cosim.cpp:69
virtual Service * createService(Service::Type service, AppIDPath path, std::string implName, const ServiceImplDetails &details, const HWClientDetails &clients) override
Called by getServiceImpl exclusively.
Definition Cosim.cpp:654
CosimAccelerator(Context &, std::string hostname, uint16_t port)
Construct and connect to a cosim server.
Definition Cosim.cpp:121
std::set< std::unique_ptr< ChannelPort > > channels
Definition Cosim.h:76
Implement the magic cosim channel communication.
Definition Cosim.cpp:575
CosimEngine(CosimAccelerator &conn, AppIDPath idPath, const ServiceImplDetails &details, const HWClientDetails &clients)
Definition Cosim.cpp:577
std::map< AppIDPath, std::map< std::string, std::string > > clientChannelAssignments
Definition Cosim.cpp:604
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.
Definition Cosim.cpp:609
static Callback * get(AcceleratorConnection &acc, AppID id, BundleType *type, WriteChannelPort &result, ReadChannelPort &arg)
Definition Services.cpp:237
static Function * get(AppID id, BundleType *type, WriteChannelPort &arg, ReadChannelPort &result)
Definition Services.cpp:194
Implement the SysInfo API for a standard MMIO protocol.
Definition Services.h:184
Parent class of all APIs modeled as 'services'.
Definition Services.h:46
const std::type_info & Type
Definition Services.h:48
Information about the Accelerator system.
Definition Services.h:100
std::unique_ptr< Engine > createEngine(AcceleratorConnection &conn, const std::string &dmaEngineName, AppIDPath idPath, const ServiceImplDetails &details, const HWClientDetails &clients)
Create an engine by name.
Definition Engines.cpp:100
Definition esi.py:1
std::map< std::string, std::any > ServiceImplDetails
Definition Common.h:98
std::string toHex(void *val)
Definition Common.cpp:37
std::vector< HWClientDetail > HWClientDetails
Definition Common.h:97
Hack around C++ not having a way to forward declare a nested class.
Definition Cosim.cpp:53
std::unique_ptr< ChannelServer::Stub > stub
Definition Cosim.cpp:56
bool getChannelDesc(const std::string &channelName, esi::cosim::ChannelDesc &desc)
Get the type ID for a channel name.
Definition Cosim.cpp:299
StubContainer(std::unique_ptr< ChannelServer::Stub > stub)
Definition Cosim.cpp:54
Options for allocating host memory.
Definition Services.h:226