Skip to content

[ETW] Fix infinite loop in ETWProvider::close #3827

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
marcalff merged 3 commits into from
Jan 23, 2026
Merged

[ETW] Fix infinite loop in ETWProvider::close #3827

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62119e1
[ETW] Fix infinite loop in ETWProvider::close
ThomsonTan Jan 23, 2026
c0dacca
Merge branch 'main' into fix_etw_loop
lalitb Jan 23, 2026
525198c
Add changelog and test
ThomsonTan Jan 23, 2026
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
6 changes: 6 additions & 0 deletions exporters/etw/include/opentelemetry/exporters/etw/etw_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,11 @@ class ETWProvider
auto &data = it->second;
unsigned long result = STATUS_OK;

if (data.refCount == 0)
{
return STATUS_ERROR;
}

data.refCount--;
if (data.refCount == 0)
{
Expand All @@ -232,6 +237,7 @@ class ETWProvider
}
return result;
}
++it;
}
return STATUS_ERROR;
}
Expand Down
14 changes: 14 additions & 0 deletions exporters/etw/test/etw_provider_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,18 @@ TEST(ETWProvider, CheckCloseSuccess)
ASSERT_FALSE(etw.is_registered(providerName));
}

TEST(ETWProvider, CheckCloseInfiniteLoop)
{
std::string providerName1 = "Provider1";
std::string providerName2 = "Provider2";

static ETWProvider etw;
auto handle1 = etw.open(providerName1.c_str());
auto handle2 = etw.open(providerName2.c_str());

// This should not hang
etw.close(handle2);
etw.close(handle1);
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

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

The test should include assertions to verify that the close operations succeeded. Currently, the test only verifies that it doesn't hang, but doesn't check if the operations completed successfully. Consider adding assertions to check the return values and provider registration status.

Copilot uses AI. Check for mistakes.
}
Comment on lines +64 to +94
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

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

The test doesn't cover the refCount underflow scenario mentioned in the issue. The fix added a check at lines 213-216 to prevent underflow when close is called too many times on the same handle, but this behavior is not tested. Consider adding a test case that calls close multiple times on the same handle and verifies it returns STATUS_ERROR on subsequent calls.

Copilot uses AI. Check for mistakes.

#endif
Loading