13#include "mlir/Dialect/Func/IR/FuncOps.h"
14#include "mlir/Tools/mlir-translate/MlirTranslateMain.h"
16#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/StringSet.h"
18#include "llvm/ADT/TypeSwitch.h"
19#include "llvm/Support/CommandLine.h"
20#include "llvm/Support/FileSystem.h"
21#include "llvm/Support/Format.h"
22#include "llvm/Support/Path.h"
43void emitNop(CertNopOp op, std::string &text) { text +=
" NOP\n"; }
46void emitMaskWrite32(CertMaskWrite32Op op, std::string &text) {
48 llvm::raw_string_ostream ss(s);
49 ss <<
" MASK_WRITE_32 ";
50 ss << llvm::format(
"0x%08x, ", op.getAddress());
51 ss << llvm::format(
"0x%08x, ", op.getMask());
52 ss << llvm::format(
"0x%08x\n", op.getValue());
56void emitMaskPoll32(CertMaskPoll32Op op, std::string &text) {
58 llvm::raw_string_ostream ss(s);
59 ss <<
" MASK_POLL_32 ";
60 ss << llvm::format(
"0x%08x, ", op.getAddress());
61 ss << llvm::format(
"0x%08x, ", op.getMask());
62 ss << llvm::format(
"0x%08x\n", op.getValue());
67void emitWrite32(CertWrite32Op op, std::string &text) {
69 llvm::raw_string_ostream ss(s);
71 ss << llvm::format(
"0x%08x, ", op.getAddress());
72 ss << llvm::format(
"0x%08x\n", op.getValue());
77void emitUcDmaWriteDesSync(CertUcDmaWriteDesSyncOp op, std::string &text) {
78 text +=
" uC_DMA_WRITE_DES_SYNC ";
79 text +=
"@" + op.getSymbol().str() +
"\n";
83void emitRead32(CertRead32Op op, std::string &text) {
85 llvm::raw_string_ostream ss(s);
86 ss <<
" READ_32 $r" << op.getValue() <<
", ";
87 ss << llvm::format(
"0x%08x\n", op.getAddress());
92void emitRead32D(CertRead32DOp op, std::string &text) {
93 text +=
" READ_32_D $r" + std::to_string(op.getAddress()) +
94 ", $r" + std::to_string(op.getValue()) +
"\n";
100void emitWrite32D(CertWrite32DOp op, std::string &text) {
102 (op.getAddressIsReg() ? 1 : 0) | (op.getValueIsReg() ? 2 : 0);
104 llvm::raw_string_ostream ss(s);
105 ss <<
" WRITE_32_D " << flags <<
", ";
106 ss << llvm::format(
"0x%08x, ", op.getAddress());
107 ss << llvm::format(
"0x%08x\n", op.getValue());
112void emitSaveTimestamps(CertSaveTimestampsOp op, std::string &text) {
113 text +=
" SAVE_TIMESTAMPS " + std::to_string(op.getUnqId()) +
"\n";
117void emitSaveRegister(CertSaveRegisterOp op, std::string &text) {
119 llvm::raw_string_ostream ss(s);
120 ss <<
" SAVE_REGISTER ";
121 ss << llvm::format(
"0x%08x, ", op.getAddress());
122 ss << op.getUnqId() <<
"\n";
127void emitUcDmaWriteDes(CertUcDmaWriteDesOp op, std::string &text) {
128 text +=
" UC_DMA_WRITE_DES $r" + std::to_string(op.getWaitHandle()) +
129 ", @" + op.getSymbol().str() +
"\n";
133void emitWaitUcDma(CertWaitUcDmaOp op, std::string &text) {
135 " WAIT_UC_DMA $r" + std::to_string(op.getWaitHandle()) +
"\n";
139void emitWaitTCTS(CertWaitTCTSOp op, std::string &text) {
140 uint32_t tileId = op.getTileId();
141 uint32_t channelId = op.getChannelId();
142 text +=
" WAIT_TCTS ";
143 text += std::to_string(tileId) +
", ";
144 text += std::to_string(channelId) +
", ";
145 text += std::to_string(op.getTargetTcts()) +
"\n";
149void emitApplyOffset57(CertApplyOffset57Op op, std::string &text) {
150 uint16_t num_entries = op.getNumEntries();
151 uint16_t offset = op.getOffset();
153 llvm::raw_string_ostream ss(s);
154 ss <<
" APPLY_OFFSET_57 ";
155 ss <<
"@" << op.getSymbol().str() <<
", ";
156 ss << num_entries <<
", ";
157 ss << offset <<
"\n";
162void emitLocalBarrier(CertLocalBarrierOp op, std::string &text) {
163 text +=
" LOCAL_BARRIER ";
165 "$" + stringifyCertLocalBarrierId(op.getLocalBarrierId()).str() +
", ";
166 text += std::to_string(op.getNumParticipants()) +
"\n";
170void emitRemoteBarrier(CertRemoteBarrierOp op, std::string &text) {
171 text +=
" REMOTE_BARRIER ";
173 "$" + stringifyCertRemoteBarrierId(op.getRemoteBarrierId()).str() +
", ";
174 text += std::to_string(op.getPartyMask()) +
"\n";
178void emitRelAcqSync(CertRelAcqSyncOp op, std::string &text) {
180 llvm::raw_string_ostream ss(s);
181 ss <<
" REL_ACQ_SYNC ";
182 ss << llvm::format(
"0x%08x, ", op.getRelAddress());
183 ss << llvm::format(
"0x%08x\n", op.getAcqAddress());
188void emitLoadPdi(CertLoadPdiOp op, std::string &text) {
189 text +=
" LOAD_PDI ";
190 text += std::to_string(op.getPdiId()) +
", ";
191 text +=
"@" + op.getSymbol().str() +
"\n";
195void emitPreempt(CertPreemptOp op, std::string &text) {
197 llvm::raw_string_ostream ss(s);
199 ss << llvm::format(
"0x%04x, ", op.getId());
200 ss <<
"@" << op.getSaveSection().str() <<
", ";
201 ss <<
"@" << op.getRestoreSection().str() <<
"\n";
208LogicalResult emitJob(CertJobOp jobOp, std::string &text, std::string &data) {
209 LogicalResult result = success();
211 text +=
"START_JOB ";
212 text += std::to_string(jobOp.getJobId()) +
"\n";
214 for (
auto &o : jobOp.getBody().front()) {
215 llvm::TypeSwitch<Operation *>(&o)
216 .Case<CertApplyOffset57Op>(
217 [&](
auto op) { emitApplyOffset57(op, text); })
218 .Case<CertLocalBarrierOp>([&](
auto op) { emitLocalBarrier(op, text); })
219 .Case<CertLoadPdiOp>([&](
auto op) { emitLoadPdi(op, text); })
220 .Case<CertPreemptOp>([&](
auto op) { emitPreempt(op, text); })
221 .Case<CertRemoteBarrierOp>(
222 [&](
auto op) { emitRemoteBarrier(op, text); })
223 .Case<CertRelAcqSyncOp>([&](
auto op) { emitRelAcqSync(op, text); })
224 .Case<CertMaskWrite32Op>([&](
auto op) { emitMaskWrite32(op, text); })
225 .Case<CertMaskPoll32Op>([&](
auto op) { emitMaskPoll32(op, text); })
226 .Case<CertNopOp>([&](
auto op) { emitNop(op, text); })
227 .Case<CertUcDmaWriteDesSyncOp>(
228 [&](
auto op) { emitUcDmaWriteDesSync(op, text); })
229 .Case<CertUcDmaWriteDesOp>(
230 [&](
auto op) { emitUcDmaWriteDes(op, text); })
231 .Case<CertWaitUcDmaOp>([&](
auto op) { emitWaitUcDma(op, text); })
232 .Case<CertRead32Op>([&](
auto op) { emitRead32(op, text); })
233 .Case<CertRead32DOp>([&](
auto op) { emitRead32D(op, text); })
234 .Case<CertWrite32DOp>([&](
auto op) { emitWrite32D(op, text); })
235 .Case<CertSaveTimestampsOp>(
236 [&](
auto op) { emitSaveTimestamps(op, text); })
237 .Case<CertSaveRegisterOp>([&](
auto op) { emitSaveRegister(op, text); })
238 .Case<CertWaitTCTSOp>([&](
auto op) { emitWaitTCTS(op, text); })
239 .Case<CertWrite32Op>([&](
auto op) { emitWrite32(op, text); })
240 .Case<AIE::EndOp>([](
auto) { })
241 .Default([&](Operation *op) {
242 op->emitError(
"Unsupported operation in CertJobOp");
247 text +=
"END_JOB\n\n";
251LogicalResult emitJobs(llvm::SmallVector<CertJobOp> &jobs, std::string &text,
253 LogicalResult result = success();
258 for (
auto job : jobs) {
259 if (failed(emitJob(job, text, data)))
269LogicalResult emitPage(CertPageOp pageOp, std::string &text,
271 LogicalResult result = success();
272 text +=
".align 16\n";
277 for (
auto job : pageOp.getBody().getOps<CertJobOp>()) {
278 if (failed(emitJob(job, text, data)))
291LogicalResult emitUcDmaChain(CertUcDmaChainOp op, std::string &chains,
293 llvm::StringSet<> &emittedGlobals,
294 const SymbolTable &symbolTable);
295LogicalResult emitGlobalData(Operation *op, StringRef dataSymbol,
297 llvm::StringSet<> &emittedGlobals,
298 const SymbolTable &symbolTable);
300StringRef referencedChain(Operation *op) {
301 if (
auto write = dyn_cast<CertUcDmaWriteDesSyncOp>(op))
302 return write.getSymbol();
303 if (
auto write = dyn_cast<CertUcDmaWriteDesOp>(op))
304 return write.getSymbol();
308LogicalResult emitSection(CertSectionOp sectionOp, llvm::StringRef outputPath,
309 const SymbolTable &symbolTable) {
310 LogicalResult result = success();
311 std::string sectionName = sectionOp.getSymName().str();
312 std::string sectionFileName = sectionName +
".asm";
315 std::string sectionText;
316 std::string sectionData;
317 std::string sectionChains;
318 llvm::StringSet<> emittedChains;
319 llvm::StringSet<> emittedGlobals;
323 sectionOp.walk([&](Operation *op) {
324 if (
auto patch = dyn_cast<CertApplyOffset57Op>(op)) {
325 if (failed(emitGlobalData(op, patch.getSymbol(), sectionData,
326 emittedGlobals, symbolTable)))
330 StringRef name = referencedChain(op);
331 if (name.empty() || !emittedChains.insert(name).second)
333 auto chain = symbolTable.lookup<CertUcDmaChainOp>(name);
335 op->emitError(
"uC DMA chain symbol not found: ") << name;
337 }
else if (failed(emitUcDmaChain(chain, sectionChains, sectionData,
338 emittedGlobals, symbolTable))) {
346 for (
auto page : sectionOp.getBody().getOps<CertPageOp>()) {
347 if (failed(emitPage(page, sectionText, sectionData)))
353 llvm::to_vector_of<CertJobOp>(sectionOp.getBody().getOps<CertJobOp>());
354 for (
auto job : jobs) {
355 if (failed(emitJob(job, sectionText, sectionData)))
357 sectionText +=
".eop\n\n";
361 std::string sectionFilePath;
362 if (!outputPath.empty()) {
363 llvm::SmallString<128> path(outputPath);
364 llvm::sys::path::remove_filename(path);
365 llvm::sys::path::append(path, sectionFileName);
366 sectionFilePath = path.str().str();
368 sectionFilePath = sectionFileName;
372 llvm::raw_fd_ostream sectionFile(sectionFilePath, EC);
375 return sectionOp.emitError(
"failed to open section file '")
376 << sectionFilePath <<
"': " << EC.message();
380 if (!sectionText.empty()) {
381 sectionFile <<
";\n;text\n;\n";
382 sectionFile << sectionText;
386 sectionFile <<
"EOF\n\n";
387 sectionFile << sectionChains;
390 if (!sectionData.empty()) {
391 sectionFile <<
";\n;data\n;\n";
392 sectionFile << sectionData;
396 if (sectionFile.has_error()) {
397 std::error_code writeEC = sectionFile.error();
399 sectionFile.clear_error();
400 return sectionOp.emitError(
"failed to write section file '")
401 << sectionFilePath <<
"': " << writeEC.message();
407void emitSectionStub(CertSectionOp sectionOp, std::string &text) {
408 std::string sectionName = sectionOp.getSymName().str();
409 text += sectionName +
":\n";
410 text +=
".include " + sectionName +
".asm\n";
411 text +=
".endl " + sectionName +
"\n\n";
414LogicalResult emitAttachToGroupOp(CertAttachToGroupOp groupOp,
415 std::string &text, std::string &data,
416 StringRef sectionStubs) {
417 LogicalResult result = success();
419 if (groupOp.getGroupId())
420 text +=
".attach_to_group " + std::to_string(groupOp.getGroupId()) +
"\n\n";
421 text += sectionStubs;
424 for (
auto page : groupOp.getBody().getOps<CertPageOp>()) {
425 if (failed(emitPage(page, text, data)))
431 llvm::to_vector_of<CertJobOp>(groupOp.getBody().getOps<CertJobOp>());
432 if (failed(emitJobs(jobs, text, data)))
437LogicalResult emitGlobalData(Operation *op, StringRef dataSymbol,
439 llvm::StringSet<> &emittedGlobals,
440 const SymbolTable &symbolTable) {
441 if (emittedGlobals.contains(dataSymbol))
444 auto global = symbolTable.lookup<memref::GlobalOp>(dataSymbol);
446 return op->emitError(
"Global symbol not found");
449 auto initVal = global.getInitialValue();
451 return op->emitError(
"Global symbol has no initial value");
454 auto initData = dyn_cast<DenseIntElementsAttr>(*initVal);
456 return op->emitError(
457 "Global symbol initial value is not a dense int array");
463 llvm::raw_string_ostream ss(s);
464 ss <<
" .align 16\n";
465 ss << dataSymbol.str() <<
":\n";
466 for (
auto d : initData)
467 ss << llvm::format(
" .long 0x%08x\n", d.getZExtValue());
469 emittedGlobals.insert(dataSymbol);
474LogicalResult emitUcDmaBd(CertUcDmaBdOp op, std::string &chains,
475 std::string &data, llvm::StringSet<> &emittedGlobals,
476 const SymbolTable &symbolTable) {
478 llvm::raw_string_ostream ss(s);
479 ss <<
" UC_DMA_BD 0, ";
480 ss << llvm::format(
"0x%08x, ", op.getLocalAddress());
481 ss <<
"@" + op.getRemoteAddress().str() +
", ";
482 ss << op.getLength() <<
", ";
484 ss << (op.getNextBd() ?
"1\n" :
"0\n");
486 return emitGlobalData(op, op.getRemoteAddress(), data, emittedGlobals,
493LogicalResult emitUcDmaChain(CertUcDmaChainOp op, std::string &chains,
495 llvm::StringSet<> &emittedGlobals,
496 const SymbolTable &symbolTable) {
497 chains +=
" .align 16\n";
498 chains += op.getName().str() +
":\n";
499 for (
auto &o : op.getBody().front()) {
500 if (
auto bd = dyn_cast<CertUcDmaBdOp>(&o))
501 if (failed(emitUcDmaBd(bd, chains, data, emittedGlobals, symbolTable)))
510 std::string &assembly,
511 llvm::StringRef outputPath) {
513 DeviceOp deviceOp = *
module.getOps<DeviceOp>().begin();
516 SymbolTable symbolTable(deviceOp);
518 std::vector<std::string> text;
519 std::vector<std::string> data;
520 std::vector<std::string> chains;
521 std::map<uint32_t, llvm::StringSet<>> emittedGlobals;
523 text.emplace_back(
"\n;\n; Code\n;\n\n");
524 data.emplace_back(
"\n;\n; Data\n;\n\n");
525 chains.emplace_back(
"\n;\n; Data (chains)\n;\n\n");
527 auto &tm = deviceOp.getTargetModel();
528 text[0] +=
".partition " + std::to_string(tm.columns()) +
"column\n";
531 text[0] +=
".attach_to_group 0\n\n";
533 LogicalResult result = success();
539 std::map<uint32_t, size_t> groupIdToBlock;
540 groupIdToBlock[0] = 0;
541 auto blockFor = [&](uint32_t gid) ->
size_t {
542 auto it = groupIdToBlock.find(gid);
543 if (it != groupIdToBlock.end())
545 text.emplace_back(
"\n;\n; Code\n;\n\n");
546 data.emplace_back(
"\n;\n; Data\n;\n\n");
547 chains.emplace_back(
"\n;\n; Data (chains)\n;\n\n");
548 size_t block = text.size() - 1;
549 groupIdToBlock[gid] = block;
555 llvm::StringSet<> sectionReferences;
556 std::map<std::string, std::set<uint32_t>> chainUsers;
557 deviceOp.walk([&](Operation *op) {
558 StringRef name = referencedChain(op);
559 auto patch = dyn_cast<CertApplyOffset57Op>(op);
560 if (name.empty() && !patch)
562 if (op->getParentOfType<CertSectionOp>()) {
564 sectionReferences.insert(name);
567 auto group = op->getParentOfType<CertAttachToGroupOp>();
568 uint32_t groupId = group ? group.getGroupId() : 0;
570 size_t block = blockFor(groupId);
571 if (failed(emitGlobalData(op, patch.getSymbol(), data[block],
572 emittedGlobals[groupId], symbolTable)))
576 if (!symbolTable.lookup<CertUcDmaChainOp>(name)) {
577 op->emitError(
"uC DMA chain symbol not found: ") << name;
581 chainUsers[name.str()].insert(groupId);
588 llvm::StringMap<std::set<uint32_t>> sectionUsers;
589 llvm::StringMap<llvm::SmallVector<StringRef>> nestedLoads;
590 auto addSectionReference = [&](Operation *op, StringRef symbol) {
591 if (
auto outer = op->getParentOfType<CertSectionOp>()) {
592 nestedLoads[outer.getSymName()].push_back(symbol);
595 auto group = op->getParentOfType<CertAttachToGroupOp>();
596 sectionUsers[symbol].insert(group ? group.getGroupId() : 0);
598 deviceOp.walk([&](Operation *op) {
599 if (
auto load = dyn_cast<CertLoadPdiOp>(op)) {
600 addSectionReference(op, load.getSymbol());
601 }
else if (
auto preempt = dyn_cast<CertPreemptOp>(op)) {
602 addSectionReference(op, preempt.getSaveSection());
603 addSectionReference(op, preempt.getRestoreSection());
606 llvm::SmallVector<StringRef> worklist;
607 for (
auto &entry : sectionUsers)
608 worklist.push_back(entry.getKey());
609 while (!worklist.empty()) {
610 StringRef outer = worklist.pop_back_val();
611 std::set<uint32_t> groups = sectionUsers.lookup(outer);
612 for (StringRef inner : nestedLoads.lookup(outer)) {
613 std::set<uint32_t> &innerGroups = sectionUsers[inner];
614 size_t before = innerGroups.size();
615 innerGroups.insert(groups.begin(), groups.end());
616 if (innerGroups.size() != before)
617 worklist.push_back(inner);
626 std::map<uint32_t, std::string> groupSectionStubs;
627 for (
auto section : deviceOp.getBody()->getOps<CertSectionOp>()) {
628 if (failed(emitSection(section, outputPath, symbolTable))) {
632 emitSectionStub(section, text[0]);
633 for (uint32_t groupId : sectionUsers.lookup(section.getSymName()))
635 emitSectionStub(section, groupSectionStubs[groupId]);
640 for (Operation &op : *deviceOp.getBody()) {
641 if (
auto page = dyn_cast<CertPageOp>(&op)) {
642 if (failed(emitPage(page, text[0], data[0])))
644 }
else if (
auto job = dyn_cast<CertJobOp>(&op)) {
645 if (failed(emitJob(job, text[0], data[0])))
647 }
else if (
auto grp = dyn_cast<CertAttachToGroupOp>(&op)) {
648 size_t block = blockFor(grp.getGroupId());
651 auto it = groupSectionStubs.find(grp.getGroupId());
652 if (it != groupSectionStubs.end()) {
653 stubs = std::move(it->second);
654 groupSectionStubs.erase(it);
656 if (failed(emitAttachToGroupOp(grp, text[block], data[block], stubs)))
658 }
else if (
auto chain = dyn_cast<CertUcDmaChainOp>(&op)) {
659 std::set<uint32_t> users = {0};
660 auto it = chainUsers.find(chain.getName().str());
661 if (it != chainUsers.end())
663 else if (sectionReferences.contains(chain.getName()))
665 for (uint32_t groupId : users) {
666 size_t block = blockFor(groupId);
667 if (failed(emitUcDmaChain(chain, chains[block], data[block],
668 emittedGlobals[groupId], symbolTable)))
679 for (
auto const &entry : groupIdToBlock) {
680 size_t block = entry.second;
681 if (!text[block].empty()) {
682 assembly += text[block];
686 if (!chains[block].empty())
687 assembly += chains[block];
688 if (!data[block].empty())
689 assembly +=
"\n" + data[block];
696static llvm::cl::opt<std::string>
697 certSectionDir(
"cert-section-dir",
698 llvm::cl::desc(
"Directory for aiex.cert.section .asm files "
699 "(default: current directory)"),
703 raw_ostream &output) {
704 std::string assembly;
706 llvm::SmallString<128> outputPath;
707 if (!certSectionDir.empty()) {
708 outputPath = StringRef(certSectionDir);
709 llvm::sys::path::append(outputPath,
"main.asm");
mlir::LogicalResult AIETranslateToUcDma(mlir::ModuleOp module, llvm::raw_ostream &output)