Skip to content

Always run the name generators passed to TraceMe on debug builds to help catch bugs #3480

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
copybara-service merged 1 commit into from
Feb 3, 2026
Merged

Always run the name generators passed to TraceMe on debug builds to help catch bugs #3480

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
34 changes: 28 additions & 6 deletions tsl/profiler/lib/traceme.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,12 @@ class TraceMe {
TraceMeRecorder::CheckFilter(filter_mask))) {
name_.Emplace(std::forward<NameGeneratorT>(name_generator)());
start_time_ = GetCurrentTimeNanos();
} else {
#ifndef NDEBUG
// Always invoke the name generator on debug builds to catch bugs in name
// generators that would otherwise only be caught when tracing is enabled.
std::forward<NameGeneratorT>(name_generator)();
#endif
}
#endif
}
Expand Down Expand Up @@ -212,12 +218,16 @@ class TraceMe {
std::enable_if_t<std::is_invocable_v<MetadataGeneratorT>, bool> = true>
void AppendMetadata(MetadataGeneratorT&& metadata_generator) {
#if !defined(IS_MOBILE_PLATFORM)
if (TF_PREDICT_FALSE(start_time_ != kUntracedActivity)) {
if (TF_PREDICT_TRUE(TraceMeRecorder::Active())) {
traceme_internal::AppendMetadata(
&name_.value,
std::forward<MetadataGeneratorT>(metadata_generator)());
}
if (TF_PREDICT_FALSE(start_time_ != kUntracedActivity) &&
TF_PREDICT_TRUE(TraceMeRecorder::Active())) {
traceme_internal::AppendMetadata(
&name_.value, std::forward<MetadataGeneratorT>(metadata_generator)());
} else {
#ifndef NDEBUG
// Always invoke the name generator on debug builds to catch bugs in name
// generators that would otherwise only be caught when tracing is enabled.
std::forward<MetadataGeneratorT>(metadata_generator)();
#endif
}
#endif
}
Expand All @@ -239,6 +249,12 @@ class TraceMe {
TraceMeRecorder::Record({std::forward<NameGeneratorT>(name_generator)(),
GetCurrentTimeNanos(), -activity_id});
return activity_id;
} else {
#ifndef NDEBUG
// Always invoke the name generator on debug builds to catch bugs in name
// generators that would otherwise only be caught when tracing is enabled.
std::forward<NameGeneratorT>(name_generator)();
#endif
}
#endif
return kUntracedActivity;
Expand Down Expand Up @@ -300,6 +316,12 @@ class TraceMe {
int64_t now = GetCurrentTimeNanos();
TraceMeRecorder::Record({std::forward<NameGeneratorT>(name_generator)(),
/*start_time=*/now, /*end_time=*/now});
} else {
#ifndef NDEBUG
// Always invoke the name generator on debug builds to catch bugs in name
// generators that would otherwise only be caught when tracing is enabled.
std::forward<NameGeneratorT>(name_generator)();
#endif
}
#endif
}
Expand Down
Loading