Skip to content

[llvm][mlir] Adding instrument function entry and instrument function exit attributes #137856

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
merged 1 commit into from
Apr 30, 2025
Merged
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
2 changes: 2 additions & 0 deletions mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
Original file line number Diff line number Diff line change
@@ -1826,6 +1826,8 @@ def LLVM_LLVMFuncOp : LLVM_Op<"func", [
OptionalAttr<StrAttr>:$denormal_fp_math,
OptionalAttr<StrAttr>:$denormal_fp_math_f32,
OptionalAttr<StrAttr>:$fp_contract,
OptionalAttr<StrAttr>:$instrument_function_entry,
OptionalAttr<StrAttr>:$instrument_function_exit,
OptionalAttr<UnitAttr>:$no_inline,
OptionalAttr<UnitAttr>:$always_inline,
OptionalAttr<UnitAttr>:$no_unwind,
12 changes: 12 additions & 0 deletions mlir/lib/Target/LLVMIR/ModuleImport.cpp
Original file line number Diff line number Diff line change
@@ -2066,6 +2066,8 @@ static constexpr std::array kExplicitAttributes{
StringLiteral("denormal-fp-math-f32"),
StringLiteral("fp-contract"),
StringLiteral("frame-pointer"),
StringLiteral("instrument-function-entry"),
StringLiteral("instrument-function-exit"),
StringLiteral("no-infs-fp-math"),
StringLiteral("no-nans-fp-math"),
StringLiteral("no-signed-zeros-fp-math"),
@@ -2220,6 +2222,16 @@ void ModuleImport::processFunctionAttributes(llvm::Function *func,
attr.isStringAttribute())
funcOp.setApproxFuncFpMath(attr.getValueAsBool());

if (llvm::Attribute attr = func->getFnAttribute("instrument-function-entry");
attr.isStringAttribute())
funcOp.setInstrumentFunctionEntry(
StringAttr::get(context, attr.getValueAsString()));

if (llvm::Attribute attr = func->getFnAttribute("instrument-function-exit");
attr.isStringAttribute())
funcOp.setInstrumentFunctionExit(
StringAttr::get(context, attr.getValueAsString()));

if (llvm::Attribute attr = func->getFnAttribute("no-signed-zeros-fp-math");
attr.isStringAttribute())
funcOp.setNoSignedZerosFpMath(attr.getValueAsBool());
6 changes: 6 additions & 0 deletions mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
Original file line number Diff line number Diff line change
@@ -1525,6 +1525,12 @@ LogicalResult ModuleTranslation::convertOneFunction(LLVMFuncOp func) {
if (auto fpContract = func.getFpContract())
llvmFunc->addFnAttr("fp-contract", *fpContract);

if (auto instrumentFunctionEntry = func.getInstrumentFunctionEntry())
llvmFunc->addFnAttr("instrument-function-entry", *instrumentFunctionEntry);

if (auto instrumentFunctionExit = func.getInstrumentFunctionExit())
llvmFunc->addFnAttr("instrument-function-exit", *instrumentFunctionExit);

// First, create all blocks so we can jump to them.
llvm::LLVMContext &llvmContext = llvmFunc->getContext();
for (auto &bb : func) {
12 changes: 12 additions & 0 deletions mlir/test/Dialect/LLVMIR/func.mlir
Original file line number Diff line number Diff line change
@@ -312,6 +312,18 @@ module {
llvm.return
}

llvm.func @instrument_function_entry_function() attributes {instrument_function_entry = "__cyg_profile_func_enter"} {
// CHECK: @instrument_function_entry_function
// CHECK-SAME: attributes {instrument_function_entry = "__cyg_profile_func_enter"}
llvm.return
}

llvm.func @instrument_function_exit_function() attributes {instrument_function_exit = "__cyg_profile_func_exit"} {
// CHECK: @instrument_function_exit_function
// CHECK-SAME: attributes {instrument_function_exit = "__cyg_profile_func_exit"}
llvm.return
}

llvm.func @nounwind_function() attributes {no_unwind} {
// CHECK: @nounwind_function
// CHECK-SAME: attributes {no_unwind}
12 changes: 12 additions & 0 deletions mlir/test/Target/LLVMIR/Import/function-attributes.ll
Original file line number Diff line number Diff line change
@@ -381,6 +381,18 @@ declare void @func_attr_fp_contract_fast() "fp-contract"="fast"

// -----

; CHECK-LABEL: @func_attr_instrument_function_entry
; CHECK-SAME: attributes {instrument_function_entry = "__cyg_profile_func_enter"}
declare void @func_attr_instrument_function_entry() "instrument-function-entry"="__cyg_profile_func_enter"

// -----

; CHECK-LABEL: @func_attr_instrument_function_exit
; CHECK-SAME: attributes {instrument_function_exit = "__cyg_profile_func_exit"}
declare void @func_attr_instrument_function_exit() "instrument-function-exit"="__cyg_profile_func_exit"

// -----

; CHECK-LABEL: @noinline_attribute
; CHECK-SAME: attributes {no_inline}
declare void @noinline_attribute() noinline
18 changes: 18 additions & 0 deletions mlir/test/Target/LLVMIR/llvmir.mlir
Original file line number Diff line number Diff line change
@@ -2559,6 +2559,24 @@ llvm.func @convergent() attributes { convergent } {

// -----

// CHECK-LABEL: define void @function_entry_instrument_test()
// CHECK-SAME: #[[ATTRS:[0-9]+]]
llvm.func @function_entry_instrument_test() attributes {instrument_function_entry = "__cyg_profile_func_enter"} {
llvm.return
}
// CHECK: attributes #[[ATTRS]] = { "instrument-function-entry"="__cyg_profile_func_enter" }

// -----

// CHECK-LABEL: define void @function_exit_instrument_test()
// CHECK-SAME: #[[ATTRS:[0-9]+]]
llvm.func @function_exit_instrument_test() attributes {instrument_function_exit = "__cyg_profile_func_exit"} {
llvm.return
}
// CHECK: attributes #[[ATTRS]] = { "instrument-function-exit"="__cyg_profile_func_exit" }

// -----

// CHECK-LABEL: @nounwind
// CHECK-SAME: #[[ATTRS:[0-9]+]]
llvm.func @nounwind() attributes { no_unwind } {