Skip to content

🍒 [windows][lldb] implement system logging on Windows (#150213) #11096

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

Open
wants to merge 1 commit into
base: swift/release/6.2
Choose a base branch
from
Open
Show file tree
Hide file tree
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
16 changes: 1 addition & 15 deletions lldb/source/Host/common/Host.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ int __pthread_fchdir(int fildes);
using namespace lldb;
using namespace lldb_private;

#if !defined(__APPLE__)
#if !defined(_WIN32)
#if !defined(__APPLE__) && !defined(_WIN32)
#include <syslog.h>
void Host::SystemLog(Severity severity, llvm::StringRef message) {
static llvm::once_flag g_openlog_once;
Expand All @@ -110,19 +109,6 @@ void Host::SystemLog(Severity severity, llvm::StringRef message) {
}
syslog(level, "%s", message.data());
}
#else
void Host::SystemLog(Severity severity, llvm::StringRef message) {
switch (severity) {
case lldb::eSeverityInfo:
case lldb::eSeverityWarning:
llvm::outs() << message;
break;
case lldb::eSeverityError:
llvm::errs() << message;
break;
}
}
#endif
#endif

#if !defined(__APPLE__) && !defined(_WIN32)
Expand Down
63 changes: 63 additions & 0 deletions lldb/source/Host/windows/Host.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
#include "lldb/Utility/StreamString.h"
#include "lldb/Utility/StructuredData.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 @@ -302,3 +304,64 @@ 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;

static std::wstring AnsiToUtf16(const std::string &ansi) {
if (ansi.empty())
return {};

const int unicode_length =
MultiByteToWideChar(CP_ACP, 0, ansi.c_str(), -1, nullptr, 0);
if (unicode_length == 0)
return {};

std::wstring unicode(unicode_length, L'\0');
MultiByteToWideChar(CP_ACP, 0, ansi.c_str(), -1, &unicode[0], unicode_length);
return unicode;
}

void Host::SystemLog(Severity severity, llvm::StringRef message) {
HANDLE h = event_log->GetHandle();
if (!h)
return;

std::wstring wide_message = AnsiToUtf16(message.str());
if (wide_message.empty())
return;

LPCWSTR msg_ptr = wide_message.c_str();

WORD event_type;
switch (severity) {
case lldb::eSeverityWarning:
event_type = EVENTLOG_WARNING_TYPE;
break;
case lldb::eSeverityError:
event_type = EVENTLOG_ERROR_TYPE;
break;
case lldb::eSeverityInfo:
default:
event_type = EVENTLOG_INFORMATION_TYPE;
}

ReportEventW(h, event_type, 0, 0, nullptr, 1, 0, &msg_ptr, nullptr);
}