Merge pull request #38746 from al45tair/objc-getclass-test

[Demangler][Tests] Add an explicit test for getObjCClassByMangledName.

Author: al45tair

include/swift/Demangling/TypeLookupError.h

@@ -207,7 +207,10 @@ template <typename... Args>
 static TypeLookupError TypeLookupErrorImpl(const char *fmt, Args... args) {
   return TypeLookupError([=] {
     char *str;
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wformat-security"
     swift_asprintf(&str, fmt, args...);
+#pragma clang diagnostic pop
     return str;
   });
 }

include/swift/Reflection/TypeRefBuilder.h

@@ -24,7 +24,6 @@
 #include "swift/Reflection/TypeLowering.h"
 #include "swift/Reflection/TypeRef.h"
 #include "llvm/ADT/Optional.h"
-
 #include <vector>
 #include <unordered_map>
 

lib/Demangling/Remangler.cpp

@@ -441,9 +441,11 @@ std::pair<int, Node *> Remangler::mangleConstrainedType(Node *node,
     Chain.push_back(node->getChild(1), Factory);
     node = getChildOfType(node->getFirstChild());
   }
-  
+
   if (node->getKind() != Node::Kind::DependentGenericParamType) {
     mangle(node, depth + 1);
+    if (!Chain.size())
+      return {-1, nullptr};
     node = nullptr;
   }
 

stdlib/public/runtime/Metadata.cpp

@@ -3490,13 +3490,17 @@ swift::swift_getExistentialMetatypeMetadata(const Metadata *instanceMetadata) {
 ExistentialMetatypeCacheEntry::ExistentialMetatypeCacheEntry(
                                             const Metadata *instanceMetadata) {
   ExistentialTypeFlags flags;
-  if (instanceMetadata->getKind() == MetadataKind::Existential) {
+  switch (instanceMetadata->getKind()) {
+  case MetadataKind::Existential:
     flags = static_cast<const ExistentialTypeMetadata*>(instanceMetadata)
       ->Flags;
-  } else {
-    assert(instanceMetadata->getKind() == MetadataKind::ExistentialMetatype);
+    break;
+  case MetadataKind::ExistentialMetatype:
     flags = static_cast<const ExistentialMetatypeMetadata*>(instanceMetadata)
       ->Flags;
+    break;
+  default:
+    assert(false && "expected existential metadata");
   }
 
   Data.setKind(MetadataKind::ExistentialMetatype);

stdlib/public/runtime/MetadataLookup.cpp

@@ -1446,6 +1446,12 @@ class DecodedMetadataBuilder {
   TypeLookupErrorOr<BuiltType> createExistentialMetatypeType(
       BuiltType instance,
       llvm::Optional<Demangle::ImplMetatypeRepresentation> repr = None) const {
+    if (instance->getKind() != MetadataKind::Existential
+        && instance->getKind() != MetadataKind::ExistentialMetatype) {
+      return TYPE_LOOKUP_ERROR_FMT("Tried to build an existential metatype from "
+                                   "a type that was neither an existential nor "
+                                   "an existential metatype");
+    }
     return swift_getExistentialMetatypeMetadata(instance);
   }
 

test/Demangle/Inputs/objc-getclass.txt

@@ -0,0 +1,28 @@
+# These were found by fuzzing getObjCClassByMangledName
+
+# rdar://63485806
+# This results in an abort(), whereas it should be an error; rdar://79725187
+# covers improving error handling; until that's done, disable this test case
+
+# 3…KySSyGSkySySSGiG3(KˇˇˇˇˇˇˇˇˇˇˇˇˇˇCwKySSiKySS
+# SSmSySyySGGSGyGSyySyySySSGGSGyS78iSLccSGSyySSySSGGccLcV1yVS~^§!zzzzzzzzzzzzhzzzzzSLzSEzzzzzzzzzzzzzzzzzxxxxx8K_S0ttnIx4_
+# ˇyySySyySySyGnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnSgZ1laSgSg
+# SSx3…KySyySGSSG_S2ItLHPˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇMd7KLPlKSSFTc•OSgS
+# 3…KySSiGSeySySSGiGSiySySSGiG3(KˇˇˇˇˇˇˇˇˇˇˇˇˇˇCwKySSiKySS
+# 3…KySSiGSyySySSGiG3(KˇˇˇˇˇˇˇˇˇˇˇˇˇˇCwKySSiKySS
+# SyySyySSySyyGSyySyyGGSGyGSyySySyySySSGGSGGˇˇˇˇˇS4S_SmˇˇAGmmmmmmmmmtLHPL(LHPTVdLHV
+
+# rdar://63488139
+1_SxSt_S4KSgS9OSgRSLAPALÂ
+
+# rdar://63496478
+BwXp
+1TSpXpBOXp
+SJSJSFSrSJSKSKSKSKm_tmcXpXpStmcXpXpSE_tmcXpXpmcXpXpStmcXpXpSE_tmcXpBpXp!E_tXpXpStmcXpZpSE_tmcXpXpSE_tmc3
+x_xSx_SxTd_SySyyS6dyGˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇˇBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBˇˇˇˇˇˇˇˇˇˇXpXpXpf:8–VSBP0
+
+# rdar://63410196
+SlSIxip6/XXS*”PLEPÓd}}}}}}}
+
+# rdar://68449341
+ySfmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmf%mmmmmmmmmmmmmf%w

test/Demangle/lit.local.cfg

@@ -1,2 +1,3 @@
 # suffixes: A list of file extensions to treat as test files.
 config.suffixes.add('.test')
+config.suffixes.add('.cpp')

test/Demangle/objc-getclass.cpp

@@ -0,0 +1,84 @@
+// RUN: %empty-directory(%t)
+// RUN: %target-clang %s -isysroot %sdk -L%swift_obj_root/lib/swift/%target-os-abi -lswiftCore -o %t/objc-getclass
+// RUN: %target-codesign %t/objc-getclass
+// RUN: %target-run %t/objc-getclass %S/Inputs/objc-getclass.txt
+
+// REQUIRES: executable_test
+// REQUIRES: objc_interop
+
+#include <objc/runtime.h>
+#include <dlfcn.h>
+#include <stdio.h>
+#include <ctype.h>
+#include <errno.h>
+#include <string.h>
+
+static BOOL dummyHook(const char * _Nonnull name,
+                      Class _Nullable * _Nonnull outClass) {
+  return NO;
+}
+
+int main(int argc, char **argv) {
+  if (argc != 2) {
+    fprintf(stderr, "usage: objc-getclass <input.txt>\n"
+            "\n"
+            "Test demangling class names to get classes.\n");
+    return 0;
+  }
+
+  // Find the class-by-mangled-name hook
+  objc_hook_getClass getObjCClassByMangledName = NULL;
+
+  if (__builtin_available(macOS 10.14.4, iOS 12.2, tvOS 12.2, watchOS 5.2, *)) {
+    objc_hook_getClass dummy = NULL;
+    objc_setHook_getClass(dummyHook, &getObjCClassByMangledName);
+    objc_setHook_getClass(getObjCClassByMangledName, &dummy);
+  } else {
+    fprintf(stderr, "objc-getclass: macOS version is too old\n");
+    return 1;
+  }
+
+  // Open the input file
+  FILE *fp = fopen(argv[1], "rt");
+  if (!fp) {
+    fprintf(stderr, "objc-getclass: unable to open \"%s\" - %s\n",
+            argv[1], strerror(errno));
+  }
+
+  // Input file is a list of manglings; we don't really care what classes they
+  // resolve to here; this test is about whether or not they actually crash or
+  // assert.
+  char *line = NULL;
+  size_t linecap = 0;
+  ssize_t linelen = 0;
+
+  while ((linelen = getline(&line, &linecap, fp)) > 0) {
+    char *mangling = line;
+
+    // Trim whitespace
+    while (isspace(*mangling))
+      ++mangling;
+
+    char *end = line + linelen;
+    while (end > line && isspace(end[-1]))
+      --end;
+    *end = '\0';
+
+    // Skip comments and blank lines
+    if (*mangling == '#' || !*mangling)
+      continue;
+
+    // Try to get a class
+    Class outClass = nil;
+    BOOL result = getObjCClassByMangledName(mangling, &outClass);
+
+    if (result)
+      printf("%s -> %s\n", mangling, class_getName(outClass));
+    else
+      printf("%s not found\n", mangling);
+  }
+
+  fclose(fp);
+
+  return 0;
+}