Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TargetModel in python bindings #1500

Merged
merged 7 commits into from
May 21, 2024
Merged

TargetModel in python bindings #1500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d4417ad
TargetModel in python
fifield May 17, 2024
4f76d57
refactor
fifield May 20, 2024
a5228b9
add is_npu, format
fifield May 20, 2024
90e1a52
missing commit
fifield May 20, 2024
616c019
black format
fifield May 20, 2024
d922337
clang-format
fifield May 20, 2024
4ef51b6
add more of the api boilerplate
fifield May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions include/aie-c/TargetModel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
//===- TargetModel.h --------------------------------------------*- C++ -*-===//
//
// This file is licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
// (c) Copyright 2024 Advanced Micro Devices, Inc.
//
//===----------------------------------------------------------------------===//

#ifndef AIE_C_TARGETMODEL_H
#define AIE_C_TARGETMODEL_H

#include "mlir-c/IR.h"

#ifdef __cplusplus
extern "C" {
#endif

//===----------------------------------------------------------------------===//
// Opaque type declarations.
//
// Types are exposed to C bindings as structs containing opaque pointers. They
// are not supposed to be inspected from C. This allows the underlying
// representation to change without affecting the API users. The use of structs
// instead of typedefs enables some type safety as structs are not implicitly
// convertible to each other.
//
// Instances of these types may or may not own the underlying object. The
// ownership semantics is defined by how an instance of the type was obtained.
//===----------------------------------------------------------------------===//

#define DEFINE_C_API_STRUCT(name, storage) \
struct name { \
storage d; \
}; \
typedef struct name name

DEFINE_C_API_STRUCT(AieTargetModel, uint32_t);

#undef DEFINE_C_API_STRUCT

MLIR_CAPI_EXPORTED AieTargetModel aieGetTargetModel(uint32_t device);

/// Returns the number of columns in the target model.
MLIR_CAPI_EXPORTED int aieTargetModelColumns(AieTargetModel targetModel);

/// Returns the number of rows in the target model.
MLIR_CAPI_EXPORTED int aieTargetModelRows(AieTargetModel targetModel);

/// Returns true if this is an NPU target model.
MLIR_CAPI_EXPORTED bool aieTargetModelIsNPU(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED bool aieTargetModelIsCoreTile(AieTargetModel targetModel,
int col, int row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsMemTile(AieTargetModel targetModel,
int col, int row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsShimNOCTile(AieTargetModel targetModel,
int col, int row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsShimPLTile(AieTargetModel targetModel,
int col, int row);

MLIR_CAPI_EXPORTED bool
aieTargetModelIsShimNOCorPLTile(AieTargetModel targetModel, int col, int row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsInternal(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsWest(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsEast(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsNorth(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsSouth(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsMemWest(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsMemEast(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsMemNorth(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool aieTargetModelIsMemSouth(AieTargetModel targetModel,
int src_col, int src_row,
int dst_col, int dst_row);

MLIR_CAPI_EXPORTED bool
aieTargetModelIsLegalMemAffinity(AieTargetModel targetModel, int src_col,
int src_row, int dst_col, int dst_row);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetMemSouthBaseAddress(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetMemNorthBaseAddress(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetMemEastBaseAddress(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetMemWestBaseAddress(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetLocalMemorySize(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetNumLocks(AieTargetModel targetModel, int col, int row);

MLIR_CAPI_EXPORTED uint32_t aieTargetModelGetNumBDs(AieTargetModel targetModel,
int col, int row);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetNumMemTileRows(AieTargetModel targetModel);

MLIR_CAPI_EXPORTED uint32_t
aieTargetModelGetMemTileSize(AieTargetModel targetModel);

/// Returns true if this is an NPU target model.
MLIR_CAPI_EXPORTED bool aieTargetModelIsNPU(AieTargetModel targetModel);

#ifdef __cplusplus
}
#endif

#endif // AIE_C_TARGETMODEL_H
1 change: 1 addition & 0 deletions include/aie/Dialect/AIE/IR/AIEDialect.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ typedef struct DMAChannel {
} DMAChannel;

const AIETargetModel &getTargetModel(mlir::Operation *op);
const AIETargetModel &getTargetModel(AIEDevice device);

mlir::ParseResult
parseObjectFifoProducerTile(mlir::OpAsmParser &parser,
Expand Down
25 changes: 16 additions & 9 deletions include/aie/Dialect/AIE/IR/AIETargetModel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ using TileID = struct TileID {

class AIETargetModel {
public:
AIETargetModel() = default;
AIETargetModel(AIEDevice device) : device(device) {}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is not a good idea... My intention with the TargetModel is that it's a singleton pattern, which is independent of the MLIR. an AIEDevice is the device of a particular design. And a Device is not actually necessary, only a container object that implements the right interface. It's unclear to me why you need to walk from the TargetModel back to a device anyway?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was convenient for wrapping/unwrapping to keep only the enum around, and this helped with that. https://github.com/Xilinx/mlir-aie/pull/1500/files#diff-3f51e6951752378031f1f22e2616b9d3c77de3a54fcbb31cdc6ab6bd34d109dbR18-R24. But I can probably refactor to avoid the change to TargetModel


virtual ~AIETargetModel();

Expand Down Expand Up @@ -204,11 +204,17 @@ class AIETargetModel {
// 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 the AIEDevice for this target model
AIEDevice getDevice() const { return device; }

private:
AIEDevice device;
};

class AIE1TargetModel : public AIETargetModel {
public:
AIE1TargetModel() = default;
AIE1TargetModel(AIEDevice device) : AIETargetModel(device) {}

bool isCoreTile(int col, int row) const override { return row > 0; }
bool isMemTile(int col, int row) const override { return false; }
Expand Down Expand Up @@ -272,7 +278,7 @@ class AIE1TargetModel : public AIETargetModel {

class AIE2TargetModel : public AIETargetModel {
public:
AIE2TargetModel() = default;
AIE2TargetModel(AIEDevice device) : AIETargetModel(device) {}

AIEArch getTargetArch() const override;

Expand Down Expand Up @@ -329,7 +335,7 @@ class VC1902TargetModel : public AIE1TargetModel {
2, 3, 6, 7, 10, 11, 18, 19, 26, 27, 34, 35, 42, 43, 46, 47};

public:
VC1902TargetModel() = default;
VC1902TargetModel(AIEDevice device) : AIE1TargetModel(device) {}

int columns() const override { return 50; }

Expand All @@ -352,7 +358,7 @@ class VE2302TargetModel : public AIE2TargetModel {
llvm::SmallDenseSet<unsigned, 8> nocColumns = {2, 3, 6, 7, 10, 11};

public:
VE2302TargetModel() = default;
VE2302TargetModel(AIEDevice device) : AIE2TargetModel(device) {}

int columns() const override { return 17; }

Expand Down Expand Up @@ -404,7 +410,7 @@ class VE2802TargetModel : public AIE2TargetModel {
22, 23, 30, 31, 34, 35};

public:
VE2802TargetModel() = default;
VE2802TargetModel(AIEDevice device) : AIE2TargetModel(device) {}

int columns() const override { return 38; }

Expand Down Expand Up @@ -456,7 +462,7 @@ class VE2802TargetModel : public AIE2TargetModel {

class BaseNPUTargetModel : public AIE2TargetModel {
public:
BaseNPUTargetModel() = default;
BaseNPUTargetModel(AIEDevice device) : AIE2TargetModel(device) {}

int rows() const override {
return 6; /* 1 Shim row, 1 memtile row, and 4 Core rows. */
Expand Down Expand Up @@ -488,7 +494,7 @@ class BaseNPUTargetModel : public AIE2TargetModel {
// The full Phoenix NPU
class NPUTargetModel : public BaseNPUTargetModel {
public:
NPUTargetModel() = default;
NPUTargetModel(AIEDevice device) : BaseNPUTargetModel(device) {}

int columns() const override { return 5; }

Expand All @@ -509,7 +515,8 @@ class VirtualizedNPUTargetModel : public BaseNPUTargetModel {
int cols;

public:
VirtualizedNPUTargetModel(int _cols) : BaseNPUTargetModel(), cols(_cols) {}
VirtualizedNPUTargetModel(AIEDevice device, int _cols)
: BaseNPUTargetModel(device), cols(_cols) {}

int columns() const override { return cols; }

Expand Down
1 change: 1 addition & 0 deletions lib/CAPI/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
add_mlir_public_c_api_library(AIECAPI
Dialects.cpp
Registration.cpp
TargetModel.cpp
Translation.cpp

LINK_LIBS PUBLIC
Expand Down
Loading
Loading