Skip to content

[lldb][windows] use OutputDebugStringA instead of c to log events #156474

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 2 commits into from
Sep 2, 2025
Merged

[lldb][windows] use OutputDebugStringA instead of c to log events #156474

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec30830
[lldb][windows] use OutputDebugStringA instead of ReportEventW to log…
charles-zablit Sep 2, 2025
be11dc3
fixup! [lldb][windows] use OutputDebugStringA instead of ReportEventW…
charles-zablit Sep 2, 2025
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
44 changes: 7 additions & 37 deletions lldb/source/Host/windows/Host.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@
#include "lldb/Utility/StreamString.h"
#include "lldb/Utility/StructuredData.h"

#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/ConvertUTF.h"
#include "llvm/Support/ManagedStatic.h"

// Windows includes
#include <tlhelp32.h>
Expand Down Expand Up @@ -308,52 +306,24 @@ Environment Host::GetEnvironment() {
return env;
}

/// Manages the lifecycle of a Windows Event's Source.
/// The destructor will call DeregisterEventSource.
/// This class is meant to be used with \ref llvm::ManagedStatic.
class WindowsEventLog {
public:
WindowsEventLog() : handle(RegisterEventSource(nullptr, L"lldb")) {}

~WindowsEventLog() {
if (handle)
DeregisterEventSource(handle);
}

HANDLE GetHandle() const { return handle; }

private:
HANDLE handle;
};

static llvm::ManagedStatic<WindowsEventLog> event_log;

void Host::SystemLog(Severity severity, llvm::StringRef message) {
if (message.empty())
return;

HANDLE h = event_log->GetHandle();
if (!h)
return;

llvm::SmallVector<wchar_t, 1> argsUTF16;
if (UTF8ToUTF16(message.str(), argsUTF16))
return;

WORD event_type;
std::string log_prefix;
switch (severity) {
case lldb::eSeverityWarning:
event_type = EVENTLOG_WARNING_TYPE;
log_prefix = "[Warning] ";
break;
case lldb::eSeverityError:
event_type = EVENTLOG_ERROR_TYPE;
log_prefix = "[Error] ";
break;
case lldb::eSeverityInfo:
default:
event_type = EVENTLOG_INFORMATION_TYPE;
log_prefix = "[Info] ";
break;
}

LPCWSTR messages[1] = {argsUTF16.data()};
ReportEventW(h, event_type, 0, 0, nullptr, std::size(messages), 0, messages,
nullptr);
std::string final_message = log_prefix + message.str();
OutputDebugStringA(final_message.c_str());
Copy link
Member

@compnerd compnerd Sep 2, 2025

Choose a reason for hiding this comment

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

I'm half tempted to say that this should be (Twine{log_prefix} + message).str().c_str() instead of the std::string and then calling OutputDebugStringA.

Copy link
Collaborator

@adrian-prantl adrian-prantl Sep 2, 2025

Choose a reason for hiding this comment

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

llvm::raw_string_ostream would maybe look nicer.

Copy link
Contributor Author

@charles-zablit charles-zablit Sep 2, 2025

Choose a reason for hiding this comment

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

Went with the llvm::raw_string_ostream approach

}
Loading