Skip to content
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

[🍒 stable/20240723] [lldb] Make lldbassert fire only once per instance (#134343) #10433

Open
wants to merge 4 commits into
base: stable/20240723
Choose a base branch
from
+34 −21
Open

[🍒 stable/20240723] [lldb] Make lldbassert fire only once per instance (#134343) #10433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbca171
[lldb] Include the version in the lldbassert error message (#133740)
JDevlieghere Mar 31, 2025
9e348e3
[lldb] Make lldbassert fire only once per instance (#134343)
JDevlieghere Apr 4, 2025
6f977e9
[lldb] Fix missing semicolon in lldbassert macro
JDevlieghere Apr 4, 2025
f112d6c
Include lldb/Version/Version.h
JDevlieghere Apr 4, 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
11 changes: 8 additions & 3 deletions lldb/include/lldb/Utility/LLDBAssert.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#define LLDB_UTILITY_LLDBASSERT_H

#include "llvm/ADT/StringRef.h"
#include <mutex>

#ifndef NDEBUG
#define lldbassert(x) assert(x)
Expand All @@ -19,8 +20,11 @@
// __FILE__ but only renders the last path component (the filename) instead of
// an invocation dependent full path to that file.
#define lldbassert(x) \
lldb_private::_lldb_assert(static_cast<bool>(x), #x, __FUNCTION__, \
__FILE_NAME__, __LINE__)
do { \
static std::once_flag _once_flag; \
lldb_private::_lldb_assert(static_cast<bool>(x), #x, __FUNCTION__, \
__FILE_NAME__, __LINE__, _once_flag); \
} while (0)
#else
#define lldbassert(x) \
lldb_private::_lldb_assert(static_cast<bool>(x), #x, __FUNCTION__, __FILE__, \
Expand All @@ -33,7 +37,8 @@ namespace lldb_private {
/// Don't use _lldb_assert directly. Use the lldbassert macro instead so that
/// LLDB asserts become regular asserts in NDEBUG builds.
void _lldb_assert(bool expression, const char *expr_text, const char *func,
const char *file, unsigned int line);
const char *file, unsigned int line,
std::once_flag &once_flag);

/// The default LLDB assert callback, which prints to stderr.
typedef void (*LLDBAssertCallback)(llvm::StringRef message,
Expand Down
1 change: 1 addition & 0 deletions lldb/source/Core/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ add_lldb_library(lldbCore
lldbTarget
lldbUtility
lldbValueObject
lldbVersion
lldbPluginCPlusPlusLanguage
lldbPluginObjCLanguage
${LLDB_CURSES_LIBS}
Expand Down
6 changes: 4 additions & 2 deletions lldb/source/Core/Debugger.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
#include "lldb/Utility/State.h"
#include "lldb/Utility/Stream.h"
#include "lldb/Utility/StreamString.h"
#include "lldb/Version/Version.h"
#include "lldb/lldb-enumerations.h"

#if defined(_WIN32)
Expand Down Expand Up @@ -1546,8 +1547,9 @@ bool Debugger::FormatDisassemblerAddress(const FormatEntity::Entry *format,
void Debugger::AssertCallback(llvm::StringRef message,
llvm::StringRef backtrace,
llvm::StringRef prompt) {
Debugger::ReportError(
llvm::formatv("{0}\n{1}{2}", message, backtrace, prompt).str());
Debugger::ReportError(llvm::formatv("{0}\n{1}{2}\n{3}", message, backtrace,
GetVersion(), prompt)
.str());
}

void Debugger::SetLoggingCallback(lldb::LogOutputCallback log_callback,
Expand Down
37 changes: 21 additions & 16 deletions lldb/source/Utility/LLDBAssert.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/raw_ostream.h"
#include <mutex>

#if LLVM_SUPPORT_XCODE_SIGNPOSTS
#include <os/log.h>
Expand All @@ -33,29 +34,33 @@ static std::atomic<LLDBAssertCallback> g_lldb_assert_callback =
&DefaultAssertCallback;

void _lldb_assert(bool expression, const char *expr_text, const char *func,
const char *file, unsigned int line) {
const char *file, unsigned int line,
std::once_flag &once_flag) {
if (LLVM_LIKELY(expression))
return;

std::call_once(once_flag, [&]() {
#if LLVM_SUPPORT_XCODE_SIGNPOSTS
if (__builtin_available(macos 10.12, iOS 10, tvOS 10, watchOS 3, *)) {
os_log_fault(OS_LOG_DEFAULT,
"Assertion failed: (%s), function %s, file %s, line %u\n",
expr_text, func, file, line);
}
if (__builtin_available(macos 10.12, iOS 10, tvOS 10, watchOS 3, *)) {
os_log_fault(OS_LOG_DEFAULT,
"Assertion failed: (%s), function %s, file %s, line %u\n",
expr_text, func, file, line);
}
#endif

std::string buffer;
llvm::raw_string_ostream backtrace(buffer);
llvm::sys::PrintStackTrace(backtrace);
std::string buffer;
llvm::raw_string_ostream backtrace(buffer);
llvm::sys::PrintStackTrace(backtrace);

(*g_lldb_assert_callback.load())(
llvm::formatv("Assertion failed: ({0}), function {1}, file {2}, line {3}",
expr_text, func, file, line)
.str(),
buffer,
"Please file a bug report against lldb reporting this failure log, and "
"as many details as possible");
(*g_lldb_assert_callback.load())(
llvm::formatv(
"Assertion failed: ({0}), function {1}, file {2}, line {3}",
expr_text, func, file, line)
.str(),
buffer,
"Please file a bug report against lldb and include the backtrace, the "
"version and as many details as possible.");
});
}

void SetLLDBAssertCallback(LLDBAssertCallback callback) {
Expand Down