Skip to content

[mlir] Integrate OpAsmTypeInterface with AsmPrinter #124700

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions mlir/lib/IR/AsmPrinter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1536,10 +1536,13 @@ StringRef maybeGetValueNameFromLoc(Value value, StringRef name) {
} // namespace

void SSANameState::numberValuesInRegion(Region &region) {
// Indicates whether OpAsmOpInterface set a name.
bool opAsmOpInterfaceUsed = false;
auto setBlockArgNameFn = [&](Value arg, StringRef name) {
assert(!valueIDs.count(arg) && "arg numbered multiple times");
assert(llvm::cast<BlockArgument>(arg).getOwner()->getParent() == &region &&
"arg not defined in current region");
opAsmOpInterfaceUsed = true;
if (LLVM_UNLIKELY(printerFlags.shouldUseNameLocAsPrefix()))
name = maybeGetValueNameFromLoc(arg, name);
setValueName(arg, name);
Expand All @@ -1549,6 +1552,15 @@ void SSANameState::numberValuesInRegion(Region &region) {
if (Operation *op = region.getParentOp()) {
if (auto asmInterface = dyn_cast<OpAsmOpInterface>(op))
asmInterface.getAsmBlockArgumentNames(region, setBlockArgNameFn);
// If the OpAsmOpInterface didn't set a name, get name from the type.
if (!opAsmOpInterfaceUsed) {
for (BlockArgument arg : region.getArguments()) {
if (auto interface = dyn_cast<OpAsmTypeInterface>(arg.getType())) {
interface.getAsmName(
[&](StringRef name) { setBlockArgNameFn(arg, name); });
}
}
}
}
}

Expand Down Expand Up @@ -1598,9 +1610,12 @@ void SSANameState::numberValuesInBlock(Block &block) {
void SSANameState::numberValuesInOp(Operation &op) {
// Function used to set the special result names for the operation.
SmallVector<int, 2> resultGroups(/*Size=*/1, /*Value=*/0);
// Indicates whether OpAsmOpInterface set a name.
bool opAsmOpInterfaceUsed = false;
auto setResultNameFn = [&](Value result, StringRef name) {
assert(!valueIDs.count(result) && "result numbered multiple times");
assert(result.getDefiningOp() == &op && "result not defined by 'op'");
opAsmOpInterfaceUsed = true;
if (LLVM_UNLIKELY(printerFlags.shouldUseNameLocAsPrefix()))
name = maybeGetValueNameFromLoc(result, name);
setValueName(result, name);
Expand Down Expand Up @@ -1630,6 +1645,21 @@ void SSANameState::numberValuesInOp(Operation &op) {
asmInterface.getAsmBlockNames(setBlockNameFn);
asmInterface.getAsmResultNames(setResultNameFn);
}
if (!opAsmOpInterfaceUsed) {
// If the OpAsmOpInterface didn't set a name, and all results have
// OpAsmTypeInterface, get names from types.
bool allHaveOpAsmTypeInterface =
llvm::all_of(op.getResultTypes(), [&](Type type) {
return isa<OpAsmTypeInterface>(type);
});
if (allHaveOpAsmTypeInterface) {
for (OpResult result : op.getResults()) {
auto interface = cast<OpAsmTypeInterface>(result.getType());
interface.getAsmName(
[&](StringRef name) { setResultNameFn(result, name); });
}
}
}
}

unsigned numResults = op.getNumResults();
Expand Down
36 changes: 36 additions & 0 deletions mlir/test/IR/op-asm-interface.mlir
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,39 @@ func.func @block_argument_name_from_op_asm_type_interface() {
}
return
}

// -----

//===----------------------------------------------------------------------===//
// Test OpAsmTypeInterface
//===----------------------------------------------------------------------===//

func.func @result_name_from_op_asm_type_interface_asmprinter() {
// CHECK-LABEL: @result_name_from_op_asm_type_interface_asmprinter
// CHECK: %op_asm_type_interface
%0 = "test.result_name_from_type_interface"() : () -> !test.op_asm_type_interface
return
}

// -----

// i1 does not have OpAsmTypeInterface, should not get named.
func.func @result_name_from_op_asm_type_interface_not_all() {
// CHECK-LABEL: @result_name_from_op_asm_type_interface_not_all
// CHECK-NOT: %op_asm_type_interface
// CHECK: %0:2
%0:2 = "test.result_name_from_type_interface"() : () -> (!test.op_asm_type_interface, i1)
return
}

// -----

func.func @block_argument_name_from_op_asm_type_interface_asmprinter() {
// CHECK-LABEL: @block_argument_name_from_op_asm_type_interface_asmprinter
// CHECK: ^bb0(%op_asm_type_interface
test.block_argument_name_from_type_interface {
^bb0(%arg0: !test.op_asm_type_interface):
"test.terminator"() : ()->()
}
return
}
19 changes: 19 additions & 0 deletions mlir/test/lib/Dialect/Test/TestOps.td
Original file line number Diff line number Diff line change
Expand Up @@ -955,6 +955,25 @@ def BlockArgumentNameFromTypeOp
let assemblyFormat = "regions attr-dict-with-keyword";
}

// This is used to test OpAsmTypeInterface::getAsmName's integration with AsmPrinter
// for op result name when OpAsmOpInterface::getAsmResultNames is the default implementation
// i.e. does nothing.
def ResultNameFromTypeInterfaceOp
: TEST_Op<"result_name_from_type_interface",
[OpAsmOpInterface]> {
let results = (outs Variadic<AnyType>:$r);
}

// This is used to test OpAsmTypeInterface::getAsmName's integration with AsmPrinter
// for block argument name when OpAsmOpInterface::getAsmBlockArgumentNames is the default implementation
// i.e. does nothing.
def BlockArgumentNameFromTypeInterfaceOp
: TEST_Op<"block_argument_name_from_type_interface",
[OpAsmOpInterface]> {
let regions = (region AnyRegion:$body);
let assemblyFormat = "regions attr-dict-with-keyword";
}

// This is used to test the OpAsmOpInterface::getDefaultDialect() feature:
// operations nested in a region under this op will drop the "test." dialect
// prefix.
Expand Down