Skip to content

Commit 6cadff8

Browse files
zhiczhongzhiczhong
authored
Centralize target description query through DLTI and add verifier pass (#210)
* Add target description query and verifier pass * replace the sysDesc in fusion pass
1 parent 3be8dec commit 6cadff8

File tree

15 files changed

+421
-82
lines changed

15 files changed

+421
-82
lines changed

‎include/gc/Analysis/TargetDescriptionAnalysis.h‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
//===-- TargetDescriptionAnalysis.h - target description class --*- C++ -*-===//
2+
//
3+
// This file is licensed 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+
#ifndef MLIR_ANALYSIS_TARGETDESCRIPTIONANALYSIS_H
10+
#define MLIR_ANALYSIS_TARGETDESCRIPTIONANALYSIS_H
11+
12+
#include "gc/Dialect/Linalgx/LinalgxOps.h"
13+
#include "mlir/Dialect/DLTI/DLTI.h"
14+
#include "mlir/Dialect/Linalg/IR/Linalg.h"
15+
#include "mlir/Interfaces/DataLayoutInterfaces.h"
16+
#include "llvm/ADT/StringRef.h"
17+
18+
namespace mlir {
19+
namespace gc {
20+
21+
using namespace mlir;
22+
23+
enum DeviceType { CPU = 0 };
24+
25+
class TargetDescriptionAnalysisBase {
26+
public:
27+
TargetDescriptionAnalysisBase(Operation *op, DeviceType device)
28+
: ctx(op->getContext()), device(device),
29+
layout(isa<ModuleOp>(op) ? dyn_cast<ModuleOp>(op)
30+
: op->getParentOfType<ModuleOp>()),
31+
loc(op->getLoc()) {}
32+
33+
// get the device ID
34+
DeviceType getDevice() { return device; }
35+
36+
// get the MLIR context
37+
MLIRContext *getContext() { return ctx; }
38+
39+
// get the data layout
40+
DataLayout getLayout() { return layout; }
41+
42+
// get the property value by key
43+
std::optional<Attribute> getPropertyValue(StringRef key);
44+
45+
// get the location
46+
Location getLocation() { return loc; }
47+
48+
// check if the property exists
49+
bool hasProperty(StringRef key) { return getPropertyValue(key).has_value(); }
50+
51+
// emit warning if the property is not found
52+
template <typename T>
53+
void emitNotFoundWarning(Location loc, StringRef key, T value);
54+
55+
// the map from device type to device string
56+
static llvm::DenseMap<DeviceType, std::string> DeviceKeyMap;
57+
58+
private:
59+
MLIRContext *ctx;
60+
DeviceType device;
61+
DataLayout layout;
62+
Location loc;
63+
};
64+
65+
class CPUTargetDescriptionAnalysis : public TargetDescriptionAnalysisBase {
66+
public:
67+
static constexpr StringLiteral kL1CacheSize = "L1_cache_size_in_bytes";
68+
static constexpr StringLiteral kL2CacheSize = "L2_cache_size_in_bytes";
69+
static constexpr StringLiteral kL3CacheSize = "L3_cache_size_in_bytes";
70+
static constexpr StringLiteral kMaxVectorWidth = "max_vector_width";
71+
static constexpr StringLiteral kNumThreads = "num_threads";
72+
73+
// get runtime OMP_NUM_THREADS
74+
unsigned getNumThreads();
75+
76+
// get cache size by cacheLevel
77+
unsigned getCacheSize(uint8_t cacheLevel);
78+
79+
// get the maximum vector length in bits
80+
unsigned getMaxVectorWidth();
81+
82+
CPUTargetDescriptionAnalysis(Operation *op)
83+
: TargetDescriptionAnalysisBase(op, DeviceType::CPU) {}
84+
};
85+
86+
} // namespace gc
87+
} // namespace mlir
88+
89+
#endif

‎include/gc/Transforms/Passes.td‎

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,30 @@ def TileLinalgNamed : Pass<"tile-named-linalg", "func::FuncOp"> {
1919

2020
#ifdef GC_HAS_ONEDNN_DIALECT
2121
def ConvertOneDNNGraphToLinalg : Pass<"convert-onednn-graph-to-linalg"> {
22-
let summary = "Lower the operations from the oneDNN Graph dialect into Linalg";
23-
let description = [{
24-
Lowers the `onednn_graph` ops to `linalg` ops.
25-
}];
22+
let summary =
23+
"Lower the operations from the oneDNN Graph dialect into Linalg";
24+
let description = [{Lowers the `onednn_graph` ops to `linalg` ops.}];
2625
let dependentDialects = [
27-
"func::FuncDialect",
28-
"math::MathDialect",
29-
"arith::ArithDialect",
30-
"tensor::TensorDialect",
31-
"linalg::LinalgDialect",
32-
"linalgx::LinalgxDialect"
26+
"func::FuncDialect", "math::MathDialect", "arith::ArithDialect",
27+
"tensor::TensorDialect", "linalg::LinalgDialect", "linalgx::LinalgxDialect"
3328
];
3429
}
3530
#endif
3631

3732
#ifdef GC_USE_IMEX
3833
def LinalgToXeGPU : Pass<"linalg-to-xegpu", "func::FuncOp"> {
3934
let summary = "Convert linalg dialect to XeGPU dialect.";
40-
let description = [{
41-
Lower linalg ops to XeGPU dialect.
42-
}];
43-
let dependentDialects = ["linalg::LinalgDialect",
44-
"gpu::GPUDialect",
45-
"xegpu::XeGPUDialect",
46-
"scf::SCFDialect",
47-
"memref::MemRefDialect",
48-
"arith::ArithDialect",
49-
"math::MathDialect",
50-
"vector::VectorDialect"];
35+
let description = [{Lower linalg ops to XeGPU dialect.}];
36+
let dependentDialects = [
37+
"linalg::LinalgDialect", "gpu::GPUDialect", "xegpu::XeGPUDialect",
38+
"scf::SCFDialect", "memref::MemRefDialect", "arith::ArithDialect",
39+
"math::MathDialect", "vector::VectorDialect"
40+
];
5141
let options = [
5242
Option<"kTile", "k-tile", "int64_t",
53-
/*default=*/"32",
54-
"GEMM tile size for reduction dimension.">,
43+
/*default=*/"32", "GEMM tile size for reduction dimension.">,
5544
Option<"stages", "stages", "int64_t",
56-
/*default=*/"1",
57-
"Number of cooperative prefetch stages.">,
45+
/*default=*/"1", "Number of cooperative prefetch stages.">,
5846
ListOption<"dpasTile", "dpas-tile", "int64_t",
5947
"DPAS register block sizes MxNxK">,
6048
];
@@ -93,4 +81,17 @@ def IterativeTilingAndFusion : Pass<"iterative-tiling-and-fusion",
9381
];
9482
}
9583

84+
def VerifyTargetDescription : Pass<"verify-target-description", "ModuleOp"> {
85+
let summary = "Verify the target description from ModuleOp DLTI attribute.";
86+
let description = [{
87+
Verify the target description from ModuleOp DLTI attribute. Raise error for unexpected input(such as a negative number of num_threads), and raise warn for missing fields, and provide a default value(such as 32K for L1_cache_size).
88+
}];
89+
let dependentDialects = ["DLTIDialect"];
90+
let options = [
91+
Option<"device", "device", "std::string",
92+
/*default=*/"\"CPU\"",
93+
"The device to verify. Supported device: CPU, ">,
94+
];
95+
}
96+
9697
#endif // GC_DIALECT_GC_PASSES

‎lib/gc/Analysis/CMakeLists.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
gc_set_mlir_link_components(MLIR_LINK_COMPONENTS
2+
MLIRIR
3+
MLIRSupport)
4+
5+
gc_add_mlir_library(GcAnalysis
6+
TargetDescriptionAnalysis.cpp
7+
8+
DEPENDS
9+
GraphCompilerPassIncGen
10+
11+
LINK_LIBS PUBLIC
12+
${mlir_dialect_libs}
13+
${MLIR_LINK_COMPONENTS}
14+
GcInterface
15+
)

‎lib/gc/Analysis/TargetDescriptionAnalysis.cpp‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
//===-- TargetDescriptionAnalysis.cpp - target description impl -*- C++ -*-===//
2+
//
3+
// This file is licensed 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+
#include "gc/Analysis/TargetDescriptionAnalysis.h"
10+
#include <limits>
11+
#include <llvm/Support/Debug.h>
12+
#include <regex>
13+
14+
namespace mlir {
15+
namespace gc {
16+
17+
#define DEBUG_TYPE "target-description-analysis"
18+
19+
llvm::DenseMap<DeviceType, std::string>
20+
TargetDescriptionAnalysisBase::DeviceKeyMap = {
21+
{CPU, "CPU"},
22+
};
23+
24+
template <typename T>
25+
void TargetDescriptionAnalysisBase::emitNotFoundWarning(Location loc,
26+
StringRef key,
27+
T value) {
28+
mlir::emitWarning(loc) << key << " not found, using default value " << value;
29+
}
30+
31+
static bool isIntegerNumber(const std::string &token) {
32+
return std::regex_match(token, std::regex(("(\\+|-)?[[:digit:]]+")));
33+
}
34+
35+
static int64_t getIntFromAttribute(Attribute attr) {
36+
if (auto intAttr = dyn_cast<IntegerAttr>(attr)) {
37+
if (intAttr.getType().isSignedInteger())
38+
return intAttr.getSInt();
39+
else if (intAttr.getType().isUnsignedInteger())
40+
return intAttr.getUInt();
41+
else
42+
return intAttr.getInt();
43+
} else if (auto strAttr = dyn_cast<StringAttr>(attr)) {
44+
std::string str = strAttr.getValue().str();
45+
if (isIntegerNumber(str))
46+
return std::stoll(str);
47+
}
48+
llvm_unreachable("Not an integer attribute or integer like string attribute");
49+
}
50+
51+
std::optional<Attribute>
52+
TargetDescriptionAnalysisBase::getPropertyValue(StringRef key) {
53+
return layout.getDevicePropertyValue(
54+
Builder(getContext())
55+
.getStringAttr(DeviceKeyMap[getDevice()] /* device ID*/),
56+
Builder(getContext()).getStringAttr(key));
57+
}
58+
59+
unsigned CPUTargetDescriptionAnalysis::getNumThreads() {
60+
static const unsigned defaultNumThreads = 1;
61+
std::optional<Attribute> numThreads = getPropertyValue(kNumThreads);
62+
63+
if (numThreads)
64+
return getIntFromAttribute(*numThreads);
65+
emitNotFoundWarning(getLocation(), kNumThreads, defaultNumThreads);
66+
return defaultNumThreads;
67+
}
68+
69+
unsigned CPUTargetDescriptionAnalysis::getCacheSize(uint8_t cacheLevel) {
70+
assert(cacheLevel > 0 && cacheLevel < 4 && "Invalid cache level");
71+
llvm::DenseMap<StringRef, unsigned> CPUTargetCacheSizeValueMap = {
72+
{CPUTargetDescriptionAnalysis::kL1CacheSize, 32 * 1024},
73+
{CPUTargetDescriptionAnalysis::kL2CacheSize, 1024 * 1024},
74+
{CPUTargetDescriptionAnalysis::kL3CacheSize, 32 * 1024 * 1024},
75+
};
76+
StringLiteral key = "";
77+
if (cacheLevel == 1)
78+
key = kL1CacheSize;
79+
else if (cacheLevel == 2)
80+
key = kL2CacheSize;
81+
else if (cacheLevel == 3)
82+
key = kL3CacheSize;
83+
84+
std::optional<Attribute> cacheSize = getPropertyValue(key);
85+
if (cacheSize)
86+
return getIntFromAttribute(*cacheSize);
87+
88+
emitNotFoundWarning(getLocation(), key, CPUTargetCacheSizeValueMap[key]);
89+
return CPUTargetCacheSizeValueMap[key];
90+
}
91+
92+
unsigned CPUTargetDescriptionAnalysis::getMaxVectorWidth() {
93+
static const unsigned defaultMaxVectorWidth = 512;
94+
std::optional<Attribute> maxVectorWidth = getPropertyValue(kMaxVectorWidth);
95+
if (maxVectorWidth)
96+
return getIntFromAttribute(*maxVectorWidth);
97+
emitNotFoundWarning(getLocation(), kMaxVectorWidth, defaultMaxVectorWidth);
98+
return defaultMaxVectorWidth;
99+
}
100+
101+
} // namespace gc
102+
} // namespace mlir

‎lib/gc/CAPI/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
set(GC_ALL_LIBS
22
${GC_ONEDNN_DIALECT_LIB_NAME}
33
GcPasses
4+
GcAnalysis
45
MLIRCPURuntimeTransforms)
56

67
if(GC_ENABLE_IMEX)

‎lib/gc/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
add_subdirectory(Analysis)
12
add_subdirectory(CAPI)
23
add_subdirectory(Dialect)
34
add_subdirectory(Transforms)

‎lib/gc/ExecutionEngine/Driver/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,5 @@ gc_add_mlir_library(GcJitWrapper
3939
${dialect_libs}
4040
${conversion_libs}
4141
${GC_PASSES}
42+
GcAnalysis
4243
)

‎lib/gc/Transforms/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ gc_add_mlir_library(GcPasses
1515
TileNamed.cpp
1616
IterativeTilingAndFusion.cpp
1717
TilingUsingInterfaceX.cpp
18+
VerifyTargetDescription.cpp
1819

1920
DEPENDS
2021
GraphCompilerPassIncGen

‎lib/gc/Transforms/IterativeTilingAndFusion.cpp‎

Lines changed: 3 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
//
77
//===----------------------------------------------------------------------===//
88

9+
#include "gc/Analysis/TargetDescriptionAnalysis.h"
910
#include "gc/Transforms/Passes.h"
1011
#include "mlir/Analysis/TopologicalSortUtils.h"
1112
#include "mlir/Dialect/DLTI/Traits.h"
@@ -579,62 +580,6 @@ static LogicalResult isSelfTiledOp(Operation *targetOp) {
579580
return success(walkResult.wasInterrupted());
580581
}
581582

582-
struct SystemDesc {
583-
// get runtime OMP_NUM_THREADS
584-
uint32_t getNumThreads() {
585-
std::optional<Attribute> numThreads = layout.getDevicePropertyValue(
586-
Builder(ctx).getStringAttr("CPU" /* device ID*/),
587-
Builder(ctx).getStringAttr("num_threads"));
588-
if (numThreads && isa<IntegerAttr>(*numThreads)) {
589-
return dyn_cast<IntegerAttr>(*numThreads).getInt();
590-
}
591-
return 1;
592-
}
593-
// get cache size by cacheLevel
594-
size_t getCacheSize(uint8_t cacheLevel) {
595-
if (cacheLevel == 1) {
596-
std::optional<Attribute> cacheSize = layout.getDevicePropertyValue(
597-
Builder(ctx).getStringAttr("CPU" /* device ID*/),
598-
Builder(ctx).getStringAttr("L1_cache_size_in_bytes"));
599-
if (cacheSize && isa<IntegerAttr>(*cacheSize)) {
600-
return dyn_cast<IntegerAttr>(*cacheSize).getInt();
601-
}
602-
} else if (cacheLevel == 2) {
603-
std::optional<Attribute> cacheSize = layout.getDevicePropertyValue(
604-
Builder(ctx).getStringAttr("CPU" /* device ID*/),
605-
Builder(ctx).getStringAttr("L2_cache_size_in_bytes"));
606-
if (cacheSize && isa<IntegerAttr>(*cacheSize)) {
607-
return dyn_cast<IntegerAttr>(*cacheSize).getInt();
608-
}
609-
} else if (cacheLevel == 3) {
610-
std::optional<Attribute> cacheSize = layout.getDevicePropertyValue(
611-
Builder(ctx).getStringAttr("CPU" /* device ID*/),
612-
Builder(ctx).getStringAttr("L3_cache_size_in_bytes"));
613-
if (cacheSize && isa<IntegerAttr>(*cacheSize)) {
614-
return dyn_cast<IntegerAttr>(*cacheSize).getInt();
615-
}
616-
}
617-
return 0;
618-
}
619-
620-
// get the maximum vector length in bits
621-
size_t getMaxVectorLength() {
622-
std::optional<Attribute> maxVectorLength = layout.getDevicePropertyValue(
623-
Builder(ctx).getStringAttr("CPU" /* device ID*/),
624-
Builder(ctx).getStringAttr("max_vector_width"));
625-
if (maxVectorLength && isa<IntegerAttr>(*maxVectorLength)) {
626-
return dyn_cast<IntegerAttr>(*maxVectorLength).getInt();
627-
}
628-
return 512;
629-
}
630-
631-
SystemDesc(ModuleOp m) : layout(m), ctx(m->getContext()) {}
632-
633-
private:
634-
DataLayout layout;
635-
MLIRContext *ctx;
636-
};
637-
638583
using OpTileSizeMap = std::unordered_map<std::string, SmallVector<int64_t>>;
639584

640585
template <typename OpTy>
@@ -806,7 +751,8 @@ struct IterativeTilingAndFusion
806751
// Get funcOp
807752
func::FuncOp func = getOperation();
808753
// Get system descriptor
809-
SystemDesc sysDesc(func->getParentOfType<ModuleOp>());
754+
CPUTargetDescriptionAnalysis sysDesc =
755+
getAnalysis<CPUTargetDescriptionAnalysis>();
810756
// Flexible options to control which candidate slice would be selected from
811757
// the view of both validity and performance.
812758
CandidateSliceOptions sliceOptions;

0 commit comments

Comments
 (0)