Add hasProperty method to targetModel (#1929)

Author: erwei-xilinx

include/aie/Dialect/AIE/IR/AIETargetModel.h

@@ -71,6 +71,20 @@ class AIETargetModel {
     TK_AIE2_Last = TK_AIE2_NPU2_Last,
   };
 
+  // One-hot encoded list of target model properties.
+  enum ModelProperty {
+    // Device uses semaphore locks.
+    UsesSemaphoreLocks = 1U << 0,
+    // Device is an NPU-based device.
+    // There are several special cases for handling the NPU at the moment.
+    IsNPU = 1U << 1,
+    // Device model is virtualized.
+    // This is used during CDO code generation to configure aie-rt properly.
+    IsVirtualized = 1U << 2,
+    // Device uses multi-dimensional buffer descriptors.
+    UsesMultiDimensionalBDs = 1U << 3,
+  };
+
 private:
   const TargetModelKind kind;
 
@@ -232,9 +246,11 @@ class AIETargetModel {
   // Run consistency checks on the target model.
   void validate() const;
 
-  // Return true if this is an NPU-based device
-  // There are several special cases for handling the NPU at the moment.
-  virtual bool isNPU() const { return false; }
+  // Return true if this device has a given property.
+  uint32_t ModelProperties = 0;
+  bool hasProperty(ModelProperty Prop) const {
+    return (ModelProperties & Prop) == Prop;
+  }
 
   // Return the bit offset of the column within a tile address.
   // This is used to compute the control address of a tile from it's column
@@ -318,7 +334,11 @@ class AIE1TargetModel : public AIETargetModel {
 
 class AIE2TargetModel : public AIETargetModel {
 public:
-  AIE2TargetModel(TargetModelKind k) : AIETargetModel(k) {}
+  AIE2TargetModel(TargetModelKind k) : AIETargetModel(k) {
+    // Device properties initialization
+    ModelProperties |= AIETargetModel::UsesSemaphoreLocks;
+    ModelProperties |= AIETargetModel::UsesMultiDimensionalBDs;
+  }
 
   AIEArch getTargetArch() const override;
 
@@ -502,7 +522,10 @@ class VE2802TargetModel : public AIE2TargetModel {
 
 class BaseNPUTargetModel : public AIE2TargetModel {
 public:
-  BaseNPUTargetModel(TargetModelKind k) : AIE2TargetModel(k) {}
+  BaseNPUTargetModel(TargetModelKind k) : AIE2TargetModel(k) {
+    // Device properties initialization
+    ModelProperties |= AIETargetModel::IsNPU;
+  }
 
   int rows() const override {
     return 6; /* 1 Shim row, 1 memtile row, and 4 Core rows. */
@@ -521,12 +544,6 @@ class BaseNPUTargetModel : public AIE2TargetModel {
 
   uint32_t getNumMemTileRows() const override { return 1; }
 
-  // Return true if the device model is virtualized.  This is used
-  // during CDO code generation to configure aie-rt properly.
-  virtual bool isVirtualized() const = 0;
-
-  virtual bool isNPU() const override { return true; }
-
   static bool classof(const AIETargetModel *model) {
     return model->getKind() >= TK_AIE2_NPU1 &&
            model->getKind() < TK_AIE2_NPU2_Last;
@@ -549,8 +566,6 @@ class NPUTargetModel : public BaseNPUTargetModel {
     return row == 0 && col == 0;
   }
 
-  bool isVirtualized() const override { return false; }
-
   static bool classof(const AIETargetModel *model) {
     return model->getKind() == TK_AIE2_NPU1;
   }
@@ -565,16 +580,17 @@ class VirtualizedNPUTargetModel : public BaseNPUTargetModel {
       : BaseNPUTargetModel(static_cast<TargetModelKind>(
             static_cast<std::underlying_type_t<TargetModelKind>>(TK_AIE2_NPU1) +
             _cols)),
-        cols(_cols) {}
+        cols(_cols) {
+    // Device properties initialization
+    ModelProperties |= AIETargetModel::IsVirtualized;
+  }
 
   uint32_t getAddressGenGranularity() const override { return 32; }
 
   int columns() const override { return cols; }
 
   bool isShimNOCTile(int col, int row) const override { return row == 0; }
 
-  bool isVirtualized() const override { return true; }
-
   static bool classof(const AIETargetModel *model) {
     return model->getKind() >= TK_AIE2_NPU1_1Col &&
            model->getKind() < TK_AIE2_NPU1_Last;
@@ -594,8 +610,6 @@ class NPU2TargetModel : public BaseNPUTargetModel {
 
   bool isShimPLTile(int col, int row) const override { return false; }
 
-  bool isVirtualized() const override { return false; }
-
   static bool classof(const AIETargetModel *model) {
     return model->getKind() == TK_AIE2_NPU2;
   }

lib/CAPI/TargetModel.cpp

@@ -155,7 +155,7 @@ uint32_t aieTargetModelGetNumBanks(AieTargetModel targetModel, int col,
 }
 
 bool aieTargetModelIsNPU(AieTargetModel targetModel) {
-  return unwrap(targetModel).isNPU();
+  return unwrap(targetModel).hasProperty(xilinx::AIE::AIETargetModel::IsNPU);
 }
 
 uint32_t aieTargetModelGetColumnShift(AieTargetModel targetModel) {

lib/Conversion/AIEToConfiguration/AIEToConfiguration.cpp

@@ -449,7 +449,7 @@ static LogicalResult convertAIEToConfiguration(AIE::DeviceOp device,
   const BaseNPUTargetModel &targetModel =
       (const BaseNPUTargetModel &)device.getTargetModel();
 
-  if (!targetModel.isNPU())
+  if (!targetModel.hasProperty(AIETargetModel::IsNPU))
     return failure();
 
   bool aieSim = false;

lib/Dialect/AIE/Transforms/AIEObjectFifoStatefulTransform.cpp

@@ -1222,7 +1222,7 @@ struct AIEObjectFifoStatefulTransformPass
         target = objFifoLinks[*linkOp];
 
     auto dev = op->getParentOfType<DeviceOp>();
-    if (isa<AIE1TargetModel>(dev.getTargetModel())) {
+    if (!dev.getTargetModel().hasProperty(AIETargetModel::UsesSemaphoreLocks)) {
 
       if (locksPerFifo[target].size() == 0) {
         for (int i = 0; i < numLocks; i++) {

lib/Targets/AIERT.cpp

@@ -57,7 +57,8 @@ AIERTControl::AIERTControl(const AIE::BaseNPUTargetModel &tm)
     : targetModel(tm) {
   // The first column in the NPU lacks a shim tile.  AIE-RT exposes some of
   // the internals about how this is modeled in a somewhat awkward way.
-  size_t partitionStartCol = tm.isVirtualized() ? 1 : 0;
+  size_t partitionStartCol =
+      tm.hasProperty(AIETargetModel::IsVirtualized) ? 1 : 0;
   size_t partitionNumCols = tm.columns();
   size_t deviceRows = tm.rows();
   size_t deviceCols = tm.columns() + partitionStartCol;
@@ -470,7 +471,8 @@ LogicalResult AIERTControl::configureSwitches(DeviceOp &targetOp) {
     int32_t col = switchboxOp.colIndex();
     int32_t row = switchboxOp.rowIndex();
     XAie_LocType tileLoc = XAie_TileLoc(col, row);
-    assert(targetModel.isNPU() && "Only NPU currently supported");
+    assert(targetModel.hasProperty(AIETargetModel::IsNPU) &&
+           "Only NPU currently supported");
 
     Block &b = switchboxOp.getConnections().front();
     for (auto connectOp : b.getOps<ConnectOp>())

lib/Targets/AIETargetCDODirect.cpp

@@ -142,7 +142,8 @@ translateToCDODirect(ModuleOp m, llvm::StringRef workDirPath,
 
   // things like XAIE_MEM_TILE_ROW_START and the missing
   // shim dma on tile (0,0) are hard-coded assumptions about NPU...
-  assert(targetModel.isNPU() && "Only NPU currently supported");
+  assert(targetModel.hasProperty(AIETargetModel::IsNPU) &&
+         "Only NPU currently supported");
 
   AIERTControl ctl(targetModel);
   if (failed(ctl.setIOBackend(aieSim, xaieDebug)))

lib/Targets/AIETargetXAIEV2.cpp

@@ -125,7 +125,7 @@ mlir::LogicalResult generateDMAConfig(OpType memOp, raw_ostream &output,
     }
 
     if (0 != ndims)
-      if (isa<AIE1TargetModel>(targetModel))
+      if (!targetModel.hasProperty(AIETargetModel::UsesMultiDimensionalBDs))
         return memOp.emitOpError("DMA contains at least one multi-dimensional "
                                  "buffer descriptor. This is currently only "
                                  "supported for AIE-ML and later devices.");

test/CppTests/CMakeLists.txt

@@ -6,16 +6,22 @@ set(CMAKE_CXX_STANDARD 17)
 
 include(CTest)
 
+add_executable(target_model  target_model.cpp)
 add_executable(target_model_rtti  target_model_rtti.cpp)
+add_test(NAME TargetModel COMMAND target_model)
 add_test(NAME TargetModelRtti COMMAND target_model_rtti)
 
-add_custom_target(check-aie-cpp COMMAND ${CMAKE_CTEST_COMMAND} DEPENDS target_model_rtti)
-
 get_property(dialect_libs GLOBAL PROPERTY MLIR_DIALECT_LIBS)
 
-target_link_libraries(target_model_rtti
-                      PUBLIC
-                      AIE
-                      ${dialect_libs})
+set(EXECUTABLES target_model target_model_rtti)
+
+add_custom_target(check-aie-cpp COMMAND ${CMAKE_CTEST_COMMAND} DEPENDS ${EXECUTABLES})
+
+foreach(executable ${EXECUTABLES})
+    target_link_libraries(${executable}
+                        PUBLIC
+                        AIE
+                        ${dialect_libs})
+endforeach()
 
 add_dependencies(check-aie check-aie-cpp)