Merge pull request #9849 from swiftlang/lldb-assert-swift

Fix lldb_assert usage in the Swift fork

Author: adrian-prantl

lldb/include/lldb/Utility/LLDBAssert.h

@@ -19,24 +19,30 @@
 // __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__)
+  lldb_private::_lldb_assert(static_cast<bool>(x), #x, __FUNCTION__,           \
+                             __FILE_NAME__, __LINE__)
 #else
 #define lldbassert(x)                                                          \
-  lldb_private::lldb_assert(static_cast<bool>(x), #x, __FUNCTION__, __FILE__,  \
-                            __LINE__)
+  lldb_private::_lldb_assert(static_cast<bool>(x), #x, __FUNCTION__, __FILE__, \
+                             __LINE__)
 #endif
 #endif
 
 namespace lldb_private {
-void lldb_assert(bool expression, const char *expr_text, const char *func,
-                 const char *file, unsigned int line);
 
+/// 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);
+
+/// The default LLDB assert callback, which prints to stderr.
 typedef void (*LLDBAssertCallback)(llvm::StringRef message,
                                    llvm::StringRef backtrace,
                                    llvm::StringRef prompt);
 
+/// Replace the LLDB assert callback.
 void SetLLDBAssertCallback(LLDBAssertCallback callback);
+
 } // namespace lldb_private
 
 #endif // LLDB_UTILITY_LLDBASSERT_H

lldb/source/Plugins/Language/Swift/SwiftUnsafeTypes.cpp

@@ -546,8 +546,7 @@ lldb_private::formatters::swift::UnsafeTypeSyntheticFrontEnd::
 
   m_unsafe_ptr = ::SwiftUnsafeType::Create(*valobj_sp.get());
 
-  lldb_assert(m_unsafe_ptr != nullptr, "Could not create Swift Unsafe Type",
-              __FUNCTION__, __FILE__, __LINE__);
+  lldbassert(m_unsafe_ptr != nullptr && "Could not create Swift Unsafe Type");
 
   if (valobj_sp)
     Update();

lldb/source/Plugins/LanguageRuntime/Swift/LLDBMemoryReader.cpp

@@ -297,8 +297,8 @@ LLDBMemoryReader::resolvePointer(swift::remote::RemoteAddress address,
   swift::remote::RemoteAbsolutePointer tagged_pointer("", tagged_address);
   if (tagged_address !=
       (uint64_t)signedPointerStripper(tagged_pointer).getOffset()) {
-    lldb_assert(false, "Tagged pointer runs into pointer authentication mask!",
-                __FUNCTION__, __FILE__, __LINE__);
+    lldbassert(false &&
+               "Tagged pointer runs into pointer authentication mask!");
     return process_pointer;
   }
 
@@ -531,10 +531,9 @@ LLDBMemoryReader::addModuleToAddressMap(ModuleSP module,
       (uint64_t)signedPointerStripper(
           swift::remote::RemoteAbsolutePointer("", module_end_address))
           .getOffset()) {
-    lldb_assert(false,
-                "LLDBMemoryReader module to address map ran into pointer "
-                "authentication mask!",
-                __FUNCTION__, __FILE__, __LINE__);
+    lldbassert(false &&
+               "LLDBMemoryReader module to address map ran into pointer "
+               "authentication mask!");
     return {};
   }
   // The address for the next image is the next pointer aligned address

lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.cpp

@@ -1927,10 +1927,8 @@ UserExpression *TypeSystemSwiftTypeRefForExpressions::GetUserExpression(
   if (!target_sp)
     return nullptr;
   if (ctx_obj != nullptr) {
-    lldb_assert(0,
-                "Swift doesn't support 'evaluate in the context"
-                " of an object'.",
-                __FUNCTION__, __FILE__, __LINE__);
+    lldbassert(false &&
+               "Swift doesn't support 'evaluate in the context of an object'.");
     return nullptr;
   }
 

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,8 +32,8 @@ 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,
-                 const char *file, unsigned int line) {
+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(),
-      backtrace.str(),
+      buffer,
       "Please file a bug report against lldb reporting this failure log, and "
       "as many details as possible");
 }