doxygen/html/AIERoutingDiagnostics_8h_source.html

//===- AIERoutingDiagnostics.h ----------------------------------*- C++ -*-===//

//

// Copyright (C) 2026 Advanced Micro Devices, Inc.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

//

// How the router names ports and flows in its diagnostics.

//

//===----------------------------------------------------------------------===//


#ifndef AIE_DIALECT_AIE_TRANSFORMS_AIEROUTINGDIAGNOSTICS_H

#define AIE_DIALECT_AIE_TRANSFORMS_AIEROUTINGDIAGNOSTICS_H


#include "aie/Dialect/AIE/IR/AIEDialect.h"


#include "llvm/ADT/ArrayRef.h"


#include <string>


namespace xilinx::AIE {


/// Names a port the way diagnostics do, e.g. "DMA:1".

std::string describePort(Port port);


/// Names a tile port the way diagnostics do, e.g. "(0, 2) DMA:1".

std::string describeTilePort(TileID tile, Port port);


/// Lists `names` as "A, B and C", the first `shown` of them followed by

/// "N more" if there are more.

std::string joinNames(llvm::ArrayRef<std::string> names, size_t shown = 4);


/// Says that the packet flows from `sources` keep the route they take alone,

/// as a control-packet reload of a design they are prioritized in asks.

std::string describePrioritized(llvm::ArrayRef<std::string> sources);


} // namespace xilinx::AIE


#endif // AIE_DIALECT_AIE_TRANSFORMS_AIEROUTINGDIAGNOSTICS_H

AIEDialect.h

xilinx::AIE
Definition AIEToConfiguration.h:19

xilinx::AIE::joinNames
std::string joinNames(llvm::ArrayRef< std::string > names, size_t shown=4)
Lists names as "A, B and C", the first shown of them followed by "N more" if there are more.
Definition AIERoutingDiagnostics.cpp:24

xilinx::AIE::describePrioritized
std::string describePrioritized(llvm::ArrayRef< std::string > sources)
Says that the packet flows from sources keep the route they take alone, as a control-packet reload of...
Definition AIERoutingDiagnostics.cpp:38

xilinx::AIE::TileID
struct TileID { friend std::ostream &operator<<(std::ostream &os, const TileID &s) { os<< "TileID("<< s.col<< ", "<< s.row<< ")"; return os; } friend std::string to_string(const TileID &s) { std::ostringstream ss; ss<< s; return ss.str(); } friend llvm::raw_ostream &operator<<(llvm::raw_ostream &os, const TileID &s) { os<< to_string(s); return os; } inline bool operator<(const TileID &rhs) const { return std::tie(col, row)< std::tie(rhs.col, rhs.row); } bool operator==(const TileID &rhs) const { return std::tie(col, row)==std::tie(rhs.col, rhs.row); } bool operator!=(const TileID &rhs) const { return !(*this==rhs);} int col, row;} TileID
Definition AIETargetModel.h:23

xilinx::AIE::describeTilePort
std::string describeTilePort(TileID tile, Port port)
Names a tile port the way diagnostics do, e.g. "(0, 2) DMA:1".
Definition AIERoutingDiagnostics.cpp:19

xilinx::AIE::Port
struct Port { WireBundle bundle; int channel; bool operator==(const Port &rhs) const { return std::tie(bundle, channel)==std::tie(rhs.bundle, rhs.channel); } bool operator!=(const Port &rhs) const { return !(*this==rhs);} bool operator<(const Port &rhs) const { return std::tie(bundle, channel)< std::tie(rhs.bundle, rhs.channel); } friend std::ostream &operator<<(std::ostream &os, const Port &port) { os<< "("; os<< stringifyWireBundle(port.bundle).str(); os<< ": "<< std::to_string(port.channel)<< ")"; return os; } friend llvm::raw_ostream &operator<<(llvm::raw_ostream &os, const Port &port) { os<< to_string(port); return os; } } Port
Definition AIEDialect.h:265

xilinx::AIE::describePort
std::string describePort(Port port)
Names a port the way diagnostics do, e.g. "DMA:1".
Definition AIERoutingDiagnostics.cpp:14