Skip to content

[mlir] Add dialect hooks for registering custom type and attribute alias printers #173091

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

Open
fabianmcg wants to merge 1 commit into
base: main
Choose a base branch
from
+310 −4
Open

[mlir] Add dialect hooks for registering custom type and attribute alias printers #173091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions mlir/include/mlir/IR/OpImplementation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
#include "mlir/IR/DialectInterface.h"
#include "mlir/IR/OpAsmSupport.h"
#include "mlir/IR/OpDefinition.h"
#include "mlir/Support/LLVM.h"
#include "mlir/Support/TypeID.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/SMLoc.h"
#include <optional>
Expand Down Expand Up @@ -169,6 +171,9 @@ class AsmPrinter {
if (succeeded(printAlias(attrOrType)))
return;

if (succeeded(printDialectAlias(attrOrType, /*printStripped=*/true)))
return;

raw_ostream &os = getStream();
uint64_t posPrior = os.tell();
attrOrType.print(*this);
Expand Down Expand Up @@ -218,6 +223,14 @@ class AsmPrinter {
/// be printed.
virtual LogicalResult printAlias(Type type);

/// Print the alias for the given attribute, return failure if no alias could
/// be printed.
virtual LogicalResult printDialectAlias(Attribute attr, bool printStripped);

/// Print the alias for the given type, return failure if no alias could
/// be printed.
virtual LogicalResult printDialectAlias(Type type, bool printStripped);

/// Print the given string as a keyword, or a quoted and escaped string if it
/// has any special or non-printable characters in it.
virtual void printKeywordOrString(StringRef keyword);
Expand Down Expand Up @@ -1799,6 +1812,30 @@ class OpAsmDialectInterface
return AliasResult::NoAlias;
}

/// Hooks for registering alias printers for types and attributes. These
/// printers are invoked when printing types or attributes of the given
/// TypeID. Printers are invoked in the order they are registered, and the
/// first one to print an alias is used.
/// The precedence of these printers is as follow:
/// 1. The type and attribute aliases returned by `getAlias`.
/// 2. Dialect-specific alias printers registered here.
/// 3. The type and attribute printers.
/// The boolean argument to the printer indicates whether the stripped form
/// of the type or attribute is being printed.
/// NOTE: This mechanism caches the printed object, therefore the printer
/// must always produce the same output for the same input.
using AttributeAliasPrinter =
llvm::function_ref<void(Attribute, AsmPrinter &, bool)>;
using InsertAttrAliasPrinter =
llvm::function_ref<void(TypeID, AttributeAliasPrinter)>;
virtual void registerAttrAliasPrinter(InsertAttrAliasPrinter insertFn) const {
}
using TypeAliasPrinter = llvm::function_ref<void(Type, AsmPrinter &, bool)>;
using InsertTypeAliasPrinter =
llvm::function_ref<void(TypeID, TypeAliasPrinter)>;
virtual void registerTypeAliasPrinter(InsertTypeAliasPrinter insertFn) const {
}
Comment on lines +1815 to +1837
Copy link
Contributor Author

@fabianmcg fabianmcg Dec 20, 2025

Choose a reason for hiding this comment

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

@joker-eph answering here, the functions are part of OpAsmDialectInterface. The way it works is, the printer collects this hooks, and then invokes them.

Copy link
Collaborator

@joker-eph joker-eph Dec 20, 2025

Choose a reason for hiding this comment

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

Sure but what I'm describing is sticking to the pattern of

if (auto *interface = dyn_cast<OpAsmDialectInterface>(typeOrAtr->getDialect())) {
  if (interface->tryPrintAlias(typeOrAttr))
   return;
}
...

Each dialect their own entities.

Copy link
Contributor Author

@fabianmcg fabianmcg Dec 20, 2025

Choose a reason for hiding this comment

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

Note, that the current mechanism https://github.com/llvm/llvm-project/blob/main/mlir/lib/IR/AsmPrinter.cpp#L1223-L1233 is not scoped to its own entities.

The pattern you describe can be included, but it wouldn't help the ptr situation. So perhaps it makes more sense to settle the !llvm.ptr discussion first, and then comeback to this.


//===--------------------------------------------------------------------===//
// Resources
//===--------------------------------------------------------------------===//
Expand Down
Loading