Merge pull request #41452 from al45tair/eng/PR-89139049

[Demangler] Make Node::addChild(NULL, ...) always assert.

Author: al45tair

CMakeLists.txt

@@ -327,9 +327,15 @@ option(SWIFT_EMBED_BITCODE_SECTION_HIDE_SYMBOLS
   "If non-empty, when embedding the LLVM bitcode binary sections into the relevant binaries, pass in -bitcode_hide_symbols. Does nothing if SWIFT_EMBED_BITCODE_SECTION is set to false."
   FALSE)
 
+if("${SWIFT_HOST_VARIANT_SDK}" MATCHES "(OSX|IOS*|TVOS*|WATCHOS*)")
+  set(SWIFT_RUNTIME_CRASH_REPORTER_CLIENT_default TRUE)
+else()
+  set(SWIFT_RUNTIME_CRASH_REPORTER_CLIENT_default FALSE)
+endif()
+
 option(SWIFT_RUNTIME_CRASH_REPORTER_CLIENT
     "Whether to enable CrashReporter integration"
-    FALSE)
+    "${SWIFT_RUNTIME_CRASH_REPORTER_CLIENT_default}")
 
 set(SWIFT_DARWIN_XCRUN_TOOLCHAIN "XcodeDefault" CACHE STRING
     "The name of the toolchain to pass to 'xcrun'")

include/swift/Demangling/Demangle.h

@@ -19,6 +19,7 @@
 #ifndef SWIFT_DEMANGLING_DEMANGLE_H
 #define SWIFT_DEMANGLING_DEMANGLE_H
 
+#include "swift/Demangling/Errors.h"
 #include "swift/Demangling/NamespaceMacros.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/Compiler.h"

include/swift/Demangling/Errors.h

@@ -0,0 +1,63 @@
+//===--- Errors.h - Demangling library error handling -----------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// This file exists because not every client links to libswiftCore (the
+// runtime), so calling swift::fatalError() or swift::warning() from within
+// the demangler is not an option.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_DEMANGLING_ERRORS_H
+#define SWIFT_DEMANGLING_ERRORS_H
+
+#include "../../../stdlib/public/SwiftShims/Visibility.h"
+#include "swift/Demangling/NamespaceMacros.h"
+#include <inttypes.h>
+#include <stdarg.h>
+
+#ifndef SWIFT_FORMAT
+// SWIFT_FORMAT(fmt,first) marks a function as taking a format string argument
+// at argument `fmt`, with the first argument for the format string as `first`.
+#if __has_attribute(format)
+#define SWIFT_FORMAT(fmt, first) __attribute__((format(printf, fmt, first)))
+#else
+#define SWIFT_FORMAT(fmt, first)
+#endif
+#endif
+
+#ifndef SWIFT_VFORMAT
+// SWIFT_VFORMAT(fmt) marks a function as taking a format string argument at
+// argument `fmt`, with the arguments in a `va_list`.
+#if __has_attribute(format)
+#define SWIFT_VFORMAT(fmt) __attribute__((format(printf, fmt, 0)))
+#else
+#define SWIFT_VFORMAT(fmt)
+#endif
+#endif
+
+namespace swift {
+namespace Demangle {
+SWIFT_BEGIN_INLINE_NAMESPACE
+
+SWIFT_NORETURN SWIFT_FORMAT(2, 3) void fatal(uint32_t flags, const char *format,
+                                             ...);
+SWIFT_FORMAT(2, 3) void warn(uint32_t flags, const char *format, ...);
+
+SWIFT_NORETURN SWIFT_VFORMAT(2) void fatalv(uint32_t flags, const char *format,
+                                            va_list val);
+SWIFT_VFORMAT(2) void warnv(uint32_t flags, const char *format, va_list val);
+
+SWIFT_END_INLINE_NAMESPACE
+} // end namespace Demangle
+} // end namespace swift
+
+#endif // SWIFT_DEMANGLING_DEMANGLE_H

include/swift/Runtime/Debug.h

@@ -82,7 +82,13 @@ static inline void crash(const char *message) {
   swift_unreachable("Expected compiler to crash.");
 }
 
-// swift::fatalError() halts with a crash log message, 
+// swift::fatalErrorv() halts with a crash log message,
+// but makes no attempt to preserve register state.
+SWIFT_RUNTIME_ATTRIBUTE_NORETURN
+SWIFT_VFORMAT(2)
+extern void fatalErrorv(uint32_t flags, const char *format, va_list args);
+
+// swift::fatalError() halts with a crash log message,
 // but makes no attempt to preserve register state.
 SWIFT_RUNTIME_ATTRIBUTE_NORETURN
 SWIFT_FORMAT(2, 3)

lib/Demangling/CMakeLists.txt

@@ -1,3 +1,13 @@
+set(swift_demangling_compile_flags
+  LLVM_DISABLE_ABI_BREAKING_CHECKS_ENFORCING=1
+  SWIFT_SUPPORT_OLD_MANGLING=1
+  SWIFT_STDLIB_HAS_TYPE_PRINTING=1)
+
+if(SWIFT_RUNTIME_CRASH_REPORTER_CLIENT)
+  list(APPEND swift_demangling_compile_flags
+      "-DSWIFT_HAVE_CRASHREPORTERCLIENT=1")
+endif()
+
 add_swift_host_library(swiftDemangling STATIC
   Demangler.cpp
   Context.cpp
@@ -7,11 +17,10 @@ add_swift_host_library(swiftDemangling STATIC
   OldDemangler.cpp
   OldRemangler.cpp
   Punycode.cpp
-  Remangler.cpp)
+  Remangler.cpp
+  Errors.cpp)
 target_compile_definitions(swiftDemangling PRIVATE
-  LLVM_DISABLE_ABI_BREAKING_CHECKS_ENFORCING=1
-  SWIFT_SUPPORT_OLD_MANGLING=1
-  SWIFT_STDLIB_HAS_TYPE_PRINTING=1)
+  ${swift_demangling_compile_flags})
 
 # NOTE: Runtime libraries that depend on swiftDemangling should define
 # SWIFT_INLINE_NAMESPACE to specify the identifier that will be used for an

lib/Demangling/Demangler.cpp

@@ -93,9 +93,12 @@ static bool isRequirement(Node::Kind kind) {
 
 void swift::Demangle::failAssert(const char *file, unsigned line,
                                  NodePointer node, const char *expr) {
-  fprintf(stderr, "%s:%u: assertion failed for Node %p: %s", file, line, node,
-          expr);
-  abort();
+  std::string treeStr = getNodeTreeAsString(node);
+
+  fatal(0,
+        "%s:%u: assertion failed for Node %p: %s\n"
+        "%s:%u: Node %p is:\n%s\n",
+        file, line, node, expr, file, line, node, treeStr.c_str());
 }
 
 bool swift::Demangle::isContext(Node::Kind kind) {
@@ -338,7 +341,7 @@ Node::iterator Node::end() const {
 }
 
 void Node::addChild(NodePointer Child, NodeFactory &Factory) {
-  assert(Child);
+  DEMANGLER_ALWAYS_ASSERT(Child, this);
   switch (NodePayloadKind) {
     case PayloadKind::None:
       InlineChildren[0] = Child;
@@ -748,7 +751,7 @@ NodePointer Demangler::demangleSymbolicReference(unsigned char rawKind) {
   NodePointer resolved = nullptr;
   if (SymbolicReferenceResolver)
     resolved = SymbolicReferenceResolver(kind, direct, value, at);
-    
+
   // With no resolver, or a resolver that failed, refuse to demangle further.
   if (!resolved)
     return nullptr;

lib/Demangling/DemanglerAssert.h

@@ -42,6 +42,13 @@
 
 #endif // SWIFT_RUNTIME || defined(NDEBUG)
 
+// DEMANGLER_ALWAYS_ASSERT() *always* fails the program, even in the runtime
+#define DEMANGLER_ALWAYS_ASSERT(expr, node)                                    \
+  do {                                                                         \
+    if (!(expr))                                                               \
+      swift::Demangle::failAssert(__FILE__, __LINE__, node, #expr);            \
+  } while (0)
+
 namespace swift {
 namespace Demangle {
 SWIFT_BEGIN_INLINE_NAMESPACE