Skip to content

[mlir] Add existing callback functions to GpuModuleToBinary pass #117694

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

Closed
wants to merge 1 commit into from
Closed

[mlir] Add existing callback functions to GpuModuleToBinary pass #117694

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
14 changes: 13 additions & 1 deletion mlir/include/mlir/Dialect/GPU/Transforms/Passes.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,19 @@ def GpuModuleToBinaryPass
Option<"cmdOptions", "opts", "std::string", [{""}],
"Command line options to pass to the tools.">,
Option<"compilationTarget", "format", "std::string", [{"fatbin"}],
"The target representation of the compilation process.">
"The target representation of the compilation process.">,
Option<"initialLlvmIRCallback", "initialLlvmIRCallback",
"llvm::function_ref<void(llvm::Module &)>", "nullptr",
"Callback invoked with the initial LLVM IR for the device module.">,
Option<"linkedLlvmIRCallback", "linkedLlvmIRCallback",
"llvm::function_ref<void(llvm::Module &)>", "nullptr",
"Callback invoked with LLVM IR for the device module after linking the device libraries.">,
Option<"optimizedLlvmIRCallback", "optimizedLlvmIRCallback",
"llvm::function_ref<void(llvm::Module &)>", "nullptr",
"Callback invoked with LLVM IR for the device module after LLVM optimizations but before codegen.">,
Option<"isaCallback", "isaCallback",
"llvm::function_ref<void(llvm::StringRef)>", "nullptr",
"Callback invoked with the target ISA for the device, for example PTX assembly.">
Copy link
Collaborator

Choose a reason for hiding this comment

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

That seems problematic to me, because passes options are supposed to round-trip to text.
What is printed in this case if we print the pass-manager?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi, do you mean:

  std::string ss;
  llvm::raw_string_ostream rso(ss);
  pm.printAsTextualPipeline(rso);
  llvm::outs() << ss << "\n";

I got:

===unknown data value for option
UNREACHABLE executed at ./llvm-solid/mlir/include/mlir/Pass/PassOptions.h:168!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes that was indeed my concern.
So in general we just don't expose that kind of things as pass options. Instead we make it so that the pass body is extracted as a utility, and the pass is a very thin wrapper. That way people can build their own pass downstream.

What we could do upstream though is add a "isaCallbackDumpPath" option and use this to let users provide a way to save to a file. That may not be enough for what you want to do, but you can adjust downstream with your own pass.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it. Thanks!
So if I understand correctly, it's difficult to pass pointers or references in options, is it right?

If right, I think it's better to use serializer directly, and I will persuade others to believe it. (because the main reason others want me to use pass but not serializer now is to eliminate code duplication, but maybe it's difficult to write a new pass and achieve this.)

Copy link
Collaborator

Choose a reason for hiding this comment

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

There is no reason that you can't use the pass I believe, ping me offline if you need to.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, thanks!

];
}

Expand Down
6 changes: 4 additions & 2 deletions mlir/lib/Dialect/GPU/Transforms/ModuleToBinary.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,10 @@ void GpuModuleToBinaryPass::runOnOperation() {
return &parentTable.value();
};

TargetOptions targetOptions(toolkitPath, linkFiles, cmdOptions, *targetFormat,
lazyTableBuilder);
TargetOptions targetOptions(
toolkitPath, linkFiles, cmdOptions, *targetFormat, lazyTableBuilder,
initialLlvmIRCallback.getValue(), linkedLlvmIRCallback.getValue(),
optimizedLlvmIRCallback.getValue(), isaCallback.getValue());
if (failed(transformGpuModulesToBinaries(
getOperation(), OffloadingLLVMTranslationAttrInterface(nullptr),
targetOptions)))
Expand Down
Loading