Skip to content

[mlir][IR] Improve error message when parsing incorrect type #134984

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

Merged
merged 2 commits into from
Apr 9, 2025
Merged

[mlir][IR] Improve error message when parsing incorrect type #134984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc2be40
[mlir][IR] Improve error message when parsing incorrect type
matthias-springer Apr 9, 2025
19d8e9f
address comments
matthias-springer Apr 9, 2025
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
40 changes: 34 additions & 6 deletions mlir/include/mlir/IR/OpImplementation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@
#include "llvm/Support/SMLoc.h"
#include <optional>

namespace {
// reference https://stackoverflow.com/a/16000226
template <typename T, typename = void>
struct HasStaticName : std::false_type {};

template <typename T>
struct HasStaticName<T,
Copy link
Member Author

@matthias-springer matthias-springer Apr 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

As an alternative to this, can we enforce that each type has a getTypeName method? Similar to how each operation class must have a getOperationName method?

edit: That won't be sufficient because type interfaces don't have this method.

typename std::enable_if<
std::is_same<::llvm::StringLiteral,
std::decay_t<decltype(T::name)>>::value,
void>::type> : std::true_type {};
} // namespace

namespace mlir {
class AsmParsedResourceEntry;
class AsmResourceBuilder;
Expand Down Expand Up @@ -1238,8 +1251,13 @@ class AsmParser {

// Check for the right kind of type.
result = llvm::dyn_cast<TypeT>(type);
if (!result)
return emitError(loc, "invalid kind of type specified");
if (!result) {
InFlightDiagnostic diag =
emitError(loc, "invalid kind of type specified");
if constexpr (HasStaticName<TypeT>::value)
diag << ": expected " << TypeT::name << ", but found " << type;
return diag;
}

return success();
}
Expand Down Expand Up @@ -1270,8 +1288,13 @@ class AsmParser {

// Check for the right kind of Type.
result = llvm::dyn_cast<TypeT>(type);
if (!result)
return emitError(loc, "invalid kind of Type specified");
if (!result) {
InFlightDiagnostic diag =
emitError(loc, "invalid kind of type specified");
if constexpr (HasStaticName<TypeT>::value)
diag << ": expected " << TypeT::name << ", but found " << type;
return diag;
}
return success();
}

Expand Down Expand Up @@ -1307,8 +1330,13 @@ class AsmParser {

// Check for the right kind of type.
result = llvm::dyn_cast<TypeType>(type);
if (!result)
return emitError(loc, "invalid kind of type specified");
if (!result) {
InFlightDiagnostic diag =
emitError(loc, "invalid kind of type specified");
if constexpr (HasStaticName<TypeType>::value)
diag << ": expected " << TypeType::name << ", but found " << type;
return diag;
}

return success();
}
Expand Down
2 changes: 1 addition & 1 deletion mlir/test/Dialect/EmitC/invalid_ops.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ func.func @test_assign_type_mismatch(%arg1: f32) {

func.func @test_assign_to_array(%arg1: !emitc.array<4xi32>) {
%v = "emitc.variable"() <{value = #emitc.opaque<"">}> : () -> !emitc.array<4xi32>
// expected-error @+1 {{invalid kind of Type specified}}
// expected-error @+1 {{invalid kind of type specified: expected emitc.lvalue, but found '!emitc.array<4xi32>'}}
emitc.assign %arg1 : !emitc.array<4xi32> to %v : !emitc.array<4xi32>
return
}
Expand Down
2 changes: 1 addition & 1 deletion mlir/test/Dialect/LLVMIR/invalid.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func.func @gep_missing_result_type(%pos : i64, %base : !llvm.ptr) {
// -----

func.func @gep_non_function_type(%pos : i64, %base : !llvm.ptr) {
// expected-error@+1 {{invalid kind of type specified}}
// expected-error@+1 {{invalid kind of type specified: expected builtin.function, but found '!llvm.ptr'}}
llvm.getelementptr %base[%pos] : !llvm.ptr
}

Expand Down
2 changes: 1 addition & 1 deletion mlir/test/Dialect/SparseTensor/invalid.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ func.func @sparse_wrong_arity_compression(%arg0: memref<?xf64>,
// -----

func.func @sparse_convert_unranked(%arg0: tensor<*xf32>) -> tensor<10xf32> {
// expected-error@+1 {{invalid kind of type specified}}
// expected-error@+1 {{invalid kind of type specified: expected builtin.tensor, but found 'tensor<*xf32>'}}
%0 = sparse_tensor.convert %arg0 : tensor<*xf32> to tensor<10xf32>
return %0 : tensor<10xf32>
}
Expand Down
4 changes: 2 additions & 2 deletions mlir/test/Dialect/Tensor/invalid.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func.func @insert_too_many_indices(%arg0: f32, %arg1: tensor<?xf32>) {
// -----

func.func @tensor.from_elements_wrong_result_type() {
// expected-error@+2 {{'tensor.from_elements' invalid kind of type specified}}
// expected-error@+2 {{'tensor.from_elements' invalid kind of type specified: expected builtin.tensor, but found 'tensor<*xi32>'}}
%c0 = arith.constant 0 : i32
%0 = tensor.from_elements %c0 : tensor<*xi32>
return
Expand Down Expand Up @@ -459,7 +459,7 @@ func.func @pad_yield_type(%arg0: tensor<?x4xi32>, %arg1: i8) -> tensor<?x9xi32>
// -----

func.func @invalid_splat(%v : f32) {
// expected-error@+1 {{invalid kind of type specified}}
// expected-error@+1 {{invalid kind of type specified: expected builtin.tensor, but found 'memref<8xf32>'}}
tensor.splat %v : memref<8xf32>
return
}
Expand Down
8 changes: 4 additions & 4 deletions mlir/test/Dialect/Vector/invalid.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// RUN: mlir-opt %s -split-input-file -verify-diagnostics

func.func @broadcast_to_scalar(%arg0: f32) -> f32 {
// expected-error@+1 {{custom op 'vector.broadcast' invalid kind of type specified}}
// expected-error@+1 {{custom op 'vector.broadcast' invalid kind of type specified: expected builtin.vector, but found 'f32'}}
%0 = vector.broadcast %arg0 : f32 to f32
}

Expand Down Expand Up @@ -144,7 +144,7 @@ func.func @extract_element(%arg0: vector<4x4xf32>) {
// -----

func.func @extract_vector_type(%arg0: index) {
// expected-error@+1 {{invalid kind of type specified}}
// expected-error@+1 {{invalid kind of type specified: expected builtin.vector, but found 'index'}}
%1 = vector.extract %arg0[] : index from index
}

Expand Down Expand Up @@ -1174,7 +1174,7 @@ func.func @shape_cast_scalability_flag_is_dropped(%arg0 : vector<2x[15]x[2]xf32>
// -----

func.func @bitcast_not_vector(%arg0 : vector<5x1x3x2xf32>) {
// expected-error@+1 {{'vector.bitcast' invalid kind of type specified}}
// expected-error@+1 {{'vector.bitcast' invalid kind of type specified: expected builtin.vector, but found 'f32'}}
%0 = vector.bitcast %arg0 : vector<5x1x3x2xf32> to f32
}

Expand Down Expand Up @@ -1628,7 +1628,7 @@ func.func @scan_unsupported_kind(%arg0: vector<2x3xf32>, %arg1: vector<3xf32>) -
// -----

func.func @invalid_splat(%v : f32) {
// expected-error@+1 {{invalid kind of type specified}}
// expected-error@+1 {{invalid kind of type specified: expected builtin.vector, but found 'memref<8xf32>'}}
vector.splat %v : memref<8xf32>
return
}
Expand Down
2 changes: 1 addition & 1 deletion mlir/test/Target/LLVMIR/llvmir-invalid.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ llvm.func @matrix_transpose_intr_wrong_type(%matrix : f32) -> vector<48xf32> {
// -----

llvm.func @active_lane_intr_wrong_type(%base : i64, %n : vector<7xi64>) -> vector<7xi1> {
// expected-error @below{{invalid kind of type specified}}
// expected-error @below{{invalid kind of type specified: expected builtin.integer, but found 'vector<7xi64>'}}
%0 = llvm.intr.get.active.lane.mask %base, %n : i64, vector<7xi64> to vector<7xi1>
llvm.return %0 : vector<7xi1>
}
Expand Down
2 changes: 1 addition & 1 deletion mlir/test/mlir-tblgen/attr-or-type-format.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ func.func private @test_verifier_fails() -> () attributes {
// -----

func.func private @test_attr_with_type_failed_to_parse_type() -> () attributes {
// expected-error@+2 {{invalid kind of type specified}}
// expected-error@+2 {{invalid kind of type specified: expected builtin.integer, but found 'vector<4xi32>'}}
// expected-error@+1 {{failed to parse TestAttrWithTypeParam parameter 'int_type'}}
attr = #test.attr_with_type<vector<4xi32>, vector<4xi32>>
}