[lldb] Rename lldb_assert -> _lldb_assert (NFC)

[JDevlieghere]

Rename lldb_assert to _lldb_assert to make it more obvious that you shouldn't be using this function directly. Instead, you should use the lldbassert macro which becomes a regular assert in a debug/asserts build.

[JDevlieghere]

FWIW this in response to seeing lldb_assert being used directly in the Swift fork.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Jonas Devlieghere (JDevlieghere)

Changes

Rename lldb_assert to _lldb_assert to make it more obvious that you shouldn't be using this function directly. Instead, you should use the lldbassert macro which becomes a regular assert in a debug/asserts build.

---

Full diff: https://github.com/llvm/llvm-project/pull/123225.diff

2 Files Affected:

• (modified) lldb/include/lldb/Utility/LLDBAssert.h (+2-2)
• (modified) lldb/source/Utility/LLDBAssert.cpp (+3-4)

diff --git a/lldb/include/lldb/Utility/LLDBAssert.h b/lldb/include/lldb/Utility/LLDBAssert.h
index aeef3e51e20a87..5bfbef3c4f85b9 100644
--- a/lldb/include/lldb/Utility/LLDBAssert.h
+++ b/lldb/include/lldb/Utility/LLDBAssert.h
@@ -29,8 +29,8 @@
 #endif
 
 namespace lldb_private {
-void lldb_assert(bool expression, const char *expr_text, const char *func,
-                 const char *file, unsigned int line);
+void _lldb_assert(bool expression, const char *expr_text, const char *func,
+                  const char *file, unsigned int line);
 
 typedef void (*LLDBAssertCallback)(llvm::StringRef message,
                                    llvm::StringRef backtrace,
diff --git a/lldb/source/Utility/LLDBAssert.cpp b/lldb/source/Utility/LLDBAssert.cpp
index b0c39a284910b1..014eb3d83bec80 100644
--- a/lldb/source/Utility/LLDBAssert.cpp
+++ b/lldb/source/Utility/LLDBAssert.cpp
@@ -20,6 +20,7 @@
 
 namespace lldb_private {
 
+/// The default callback prints to stderr.
 static void DefaultAssertCallback(llvm::StringRef message,
                                   llvm::StringRef backtrace,
                                   llvm::StringRef prompt) {
@@ -31,7 +32,7 @@ static void DefaultAssertCallback(llvm::StringRef message,
 static std::atomic<LLDBAssertCallback> g_lldb_assert_callback =
     &DefaultAssertCallback;
 
-void lldb_assert(bool expression, const char *expr_text, const char *func,
+void _lldb_assert(bool expression, const char *expr_text, const char *func,
                  const char *file, unsigned int line) {
   if (LLVM_LIKELY(expression))
     return;
@@ -44,8 +45,6 @@ void lldb_assert(bool expression, const char *expr_text, const char *func,
   }
 #endif
 
-  // Print a warning and encourage the user to file a bug report, similar to
-  // LLVM’s crash handler, and then return execution.
   std::string buffer;
   llvm::raw_string_ostream backtrace(buffer);
   llvm::sys::PrintStackTrace(backtrace);
@@ -54,7 +53,7 @@ void lldb_assert(bool expression, const char *expr_text, const char *func,
       llvm::formatv("Assertion failed: ({0}), function {1}, file {2}, line {3}",
                     expr_text, func, file, line)
           .str(),
-      buffer,
+      backtrace.str(),
       "Please file a bug report against lldb reporting this failure log, and "
       "as many details as possible");
 }

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[augusto2112]

Maybe you can also add a doxygen comment explaining that it shouldn't be used directly and use the lldbassert macro instead?