Skip to content

LogExecution: optionally take a module name for the logger function #6629

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 6 commits into from
May 31, 2024
Merged

LogExecution: optionally take a module name for the logger function #6629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
860ec96
LogExecution: optionally take a module name for the logger function
yamt May 30, 2024
954e268
LogExecution: fix a crash on modules w/o imports
yamt May 30, 2024
50021da
LogExecution: add a comment as suggested by @kripken
yamt May 31, 2024
8556a7e
LogExecution: add a test as suggested by @kripken
yamt May 31, 2024
f172d59
LogExecution: rename a member
yamt May 31, 2024
719d3ad
log-execution_arg.wast: reduce the duplicate with log-execution.wast
yamt May 31, 2024
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
42 changes: 30 additions & 12 deletions src/passes/LogExecution.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,18 @@ namespace wasm {
Name LOGGER("log_execution");

struct LogExecution : public WalkerPass<PostWalker<LogExecution>> {
// The module name the logger function is imported from.
IString loggerModule;

// Adds calls to new imports.
bool addsEffects() override { return true; }

void run(Module* module) override {
auto& options = getPassOptions();
loggerModule = options.getArgumentOrDefault("log-execution", "");
super::run(module);
}

void visitLoop(Loop* curr) { curr->body = makeLogCall(curr->body); }

void visitReturn(Return* curr) { replaceCurrent(makeLogCall(curr)); }
Expand All @@ -63,23 +72,32 @@ struct LogExecution : public WalkerPass<PostWalker<LogExecution>> {
auto import =
Builder::makeFunction(LOGGER, Signature(Type::i32, Type::none), {});

// Import the log function from import "env" if the module
// imports other functions from that name.
for (auto& func : curr->functions) {
if (func->imported() && func->module == ENV) {
import->module = func->module;
break;
}
}

// If not, then pick the import name of the first function we find.
if (!import->module) {
if (loggerModule != "") {
import->module = loggerModule;
} else {
// Import the log function from import "env" if the module
// imports other functions from that name.
for (auto& func : curr->functions) {
if (func->imported()) {
if (func->imported() && func->module == ENV) {
import->module = func->module;
break;
}
}

// If not, then pick the import name of the first function we find.
if (!import->module) {
for (auto& func : curr->functions) {
if (func->imported()) {
import->module = func->module;
break;
}
}
}

// If no function was found, use ENV.
if (!import->module) {
import->module = ENV;
}
}

import->base = LOGGER;
Expand Down
24 changes: 24 additions & 0 deletions test/lit/passes/log-execution_arg.wast
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
;; NOTE: Assertions have been generated by update_lit_checks.py --all-items and should not be edited.
;; Test the option to provide the module name as an argument.
;; RUN: foreach %s %t wasm-opt --log-execution=foo -S -o - | filecheck %s

(module
;; CHECK: (type $0 (func))

;; CHECK: (type $1 (func (param i32)))

;; CHECK: (import "env" "func" (func $import))
(import "env" "func" (func $import))
;; CHECK: (import "foo" "log_execution" (func $log_execution (param i32)))

;; CHECK: (func $nopp
;; CHECK-NEXT: (call $log_execution
;; CHECK-NEXT: (i32.const 0)
;; CHECK-NEXT: )
;; CHECK-NEXT: (nop)
;; CHECK-NEXT: )
(func $nopp
(nop)
)
)