IRGen: Always use symbolic references in mangled names (on Mach-O platforms)

jckarter · jckarter · commit c39a2aeb0a91 · 2019-10-01T12:36:55.000-07:00
Now that `swift-reflection-dump` correctly handles pointer values and unresolved
cross-image references (for Mach-O, at least), we can safely unconditionally use
symbolic references in runtime mangled names without regressing offline reflection
support.
diff --git a/lib/IRGen/IRGenMangler.cpp b/lib/IRGen/IRGenMangler.cpp
@@ -93,26 +93,43 @@ IRGenMangler::withSymbolicReferences(IRGenModule &IGM,
   AllowSymbolicReferences = true;
   CanSymbolicReference = [&IGM](SymbolicReferent s) -> bool {
     if (auto type = s.dyn_cast<const NominalTypeDecl *>()) {
-      // FIXME: Sometimes we fail to emit metadata for Clang imported types
-      // even after noting use of their type descriptor or metadata. Work
-      // around by not symbolic-referencing imported types for now.
-      if (type->hasClangNode())
-        return false;
-      
-      // TODO: We ought to be able to use indirect symbolic references even
-      // when the referent may be in another file, once the on-disk
-      // ObjectMemoryReader can handle them.
-      // Private entities are known to be accessible.
-      auto formalAccessScope = type->getFormalAccessScope(nullptr, true);
-      if ((formalAccessScope.isPublic() || formalAccessScope.isInternal()) &&
-          (!IGM.CurSourceFile ||
-           IGM.CurSourceFile != type->getParentSourceFile()))
+      // The short-substitution types in the standard library have compact
+      // manglings already, and the runtime ought to have a lookup table for
+      // them. Symbolic referencing would be wasteful.
+      if (type->getModuleContext()->isStdlibModule()
+          && Mangle::getStandardTypeSubst(type->getName().str())) {
         return false;
+      }
       
-      // @objc protocols don't have descriptors.
-      if (auto proto = dyn_cast<ProtocolDecl>(type))
-        if (proto->isObjC())
+      // TODO: We could assign a symbolic reference discriminator to refer
+      // to objc protocol refs.
+      if (auto proto = dyn_cast<ProtocolDecl>(type)) {
+        if (proto->isObjC()) {
+          return false;
+        }
+      }
+
+      // Classes defined in Objective-C don't have descriptors.
+      // TODO: We could assign a symbolic reference discriminator to refer
+      // to objc class refs.
+      if (auto clas = dyn_cast<ClassDecl>(type)) {
+        if (clas->hasClangNode()
+            && clas->getForeignClassKind() != ClassDecl::ForeignKind::CFType) {
           return false;
+        }
+      }
+
+      // TODO: ObjectMemoryReader for ELF and PE platforms still does not
+      // implement symbol relocations. For now, on non-Mach-O platforms,
+      // only symbolic reference things in the same module.
+      if (IGM.TargetInfo.OutputObjectFormat != llvm::Triple::MachO) {
+        auto formalAccessScope = type->getFormalAccessScope(nullptr, true);
+        if ((formalAccessScope.isPublic() || formalAccessScope.isInternal()) &&
+            (!IGM.CurSourceFile ||
+             IGM.CurSourceFile != type->getParentSourceFile())) {
+          return false;
+        }
+      }
       
       return true;
     } else if (auto opaque = s.dyn_cast<const OpaqueTypeDecl *>()) {
diff --git a/test/IRGen/access_type_metadata_by_mangled_name.swift b/test/IRGen/access_type_metadata_by_mangled_name.swift
@@ -2,11 +2,11 @@
 
 // CHECK: @"$s36access_type_metadata_by_mangled_name3FooCyAA3BarCyAA3ZimCyAA4ZangCGGGMD" = linkonce_odr hidden global { i32, i32 }
 
-// CHECK-little-SAME: @"symbolic 36access_type_metadata_by_mangled_name3FooCyAA3BarCyAA3ZimCyAA4ZangCGGG"
-// CHECK-little-SAME: i32 -71
+// CHECK-little-SAME: @"symbolic{{.*}}36access_type_metadata_by_mangled_name3FooC{{.*}}AA3BarC{{.*}}AA3ZimC{{.*}}AA4ZangC{{.*}}"
+// CHECK-little-SAME: i32 -{{[0-9]+}}
 
-// CHECK-big-SAME:    i32 -71
-// CHECK-big-SAME:    @"symbolic 36access_type_metadata_by_mangled_name3FooCyAA3BarCyAA3ZimCyAA4ZangCGGG"
+// CHECK-big-SAME:    i32 -{{[0-9]+}}
+// CHECK-big-SAME:    @"symbolic{{.*}}36access_type_metadata_by_mangled_name3FooC{{.*}}AA3BarC{{.*}}AA3ZimCyAA4ZangC{{.*}}"
 
 // CHECK-SAME: align 8
 
diff --git a/test/IRGen/associated_type_witness.swift b/test/IRGen/associated_type_witness.swift
@@ -41,7 +41,7 @@ protocol HasThreeAssocTypes {
 // GLOBAL-SAME:    @"$s23associated_type_witness13WithUniversalVAA8AssockedAAMc"
 // GLOBAL-SAME:    @"associated conformance 23associated_type_witness13WithUniversalVAA8AssockedAA5AssocAaDP_AA1P",
 // GLOBAL-SAME:    @"associated conformance 23associated_type_witness13WithUniversalVAA8AssockedAA5AssocAaDP_AA1Q"
-// GLOBAL-SAME:    i64 add (i64 ptrtoint (<{ [36 x i8], i8 }>* @"symbolic 23associated_type_witness9UniversalV" to i64), i64 1) to i8*)
+// GLOBAL-SAME:    i64 add (i64 ptrtoint (<{ {{.*}} }>* @"symbolic{{.*}}23associated_type_witness9UniversalV" to i64), i64 1) to i8*)
 // GLOBAL-SAME:  ]
 struct WithUniversal : Assocked {
   typealias Assoc = Universal
@@ -52,7 +52,7 @@ struct WithUniversal : Assocked {
 // GLOBAL-SAME:    @"$s23associated_type_witness20GenericWithUniversalVyxGAA8AssockedAAMc"
 // GLOBAL-SAME:    @"associated conformance 23associated_type_witness20GenericWithUniversalVyxGAA8AssockedAA5Assoc_AA1P"
 // GLOBAL-SAME:    @"associated conformance 23associated_type_witness20GenericWithUniversalVyxGAA8AssockedAA5Assoc_AA1Q"
-// GLOBAL-SAME:    @"symbolic 23associated_type_witness9UniversalV"
+// GLOBAL-SAME:    @"symbolic{{.*}}23associated_type_witness9UniversalV"
 // GLOBAL-SAME:  ]
 struct GenericWithUniversal<T> : Assocked {
   typealias Assoc = Universal
@@ -90,7 +90,7 @@ struct Pair<T, U> : P, Q {}
 // GLOBAL-SAME:    @"$s23associated_type_witness8ComputedVyxq_GAA8AssockedAAMc"
 // GLOBAL-SAME:    @"associated conformance 23associated_type_witness8ComputedVyxq_GAA8AssockedAA5Assoc_AA1P"
 // GLOBAL-SAME:    @"associated conformance 23associated_type_witness8ComputedVyxq_GAA8AssockedAA5Assoc_AA1Q"
-// GLOBAL-SAME:    @"symbolic 23associated_type_witness4PairVyxq_G"
+// GLOBAL-SAME:    @"symbolic{{.*}}23associated_type_witness4PairV{{.*}}"
 // GLOBAL-SAME:  ]
 
 struct Computed<T, U> : Assocked {
diff --git a/test/IRGen/class_update_callback_with_stub.swift b/test/IRGen/class_update_callback_with_stub.swift
@@ -29,7 +29,7 @@ import resilient_objc_class
 // -- field descriptor
 // CHECK-SAME: @"$s31class_update_callback_with_stub17ResilientSubclassCMF"
 // -- superclass
-// CHECK-SAME: @"symbolic 15resilient_class22ResilientOutsideParentC"
+// CHECK-SAME: @"symbolic{{[^"]*}}15resilient_class22ResilientOutsideParentC"
 // -- metadata bounds
 // CHECK-SAME: @"$s31class_update_callback_with_stub17ResilientSubclassCMo"
 // -- extra class flags -- has Objective-C resilient class stub
diff --git a/test/IRGen/keypaths.sil b/test/IRGen/keypaths.sil
@@ -61,7 +61,7 @@ sil_vtable C2 {}
 // -- %a: S.x
 // CHECK: [[KP_A:@keypath(\..*)?]] = private global <{ {{.*}} }> <{
 // CHECK-SAME: [[WORD]]* @keypath_once
-// CHECK-SAME: @"symbolic 8keypaths1SV"
+// CHECK-SAME: @"symbolic{{.*}}8keypaths1SV"
 // CHECK-SAME: @"symbolic Si
 //               -- instantiable in-line, size 4
 // CHECK-SAME: <i32 0x8000_0004>,
@@ -71,7 +71,7 @@ sil_vtable C2 {}
 // -- %b: S.y
 // CHECK: [[KP_B:@keypath(\..*)?]] = private global <{ {{.*}} }> <{
 // CHECK-SAME: [[WORD]]* @keypath_once
-// CHECK-SAME: @"symbolic 8keypaths1SV
+// CHECK-SAME: @"symbolic{{.*}}8keypaths1SV
 // CHECK-SAME: @"symbolic SS
 //               -- instantiable in-line, size 4
 // CHECK-SAME: <i32 0x8000_0004>,
@@ -82,8 +82,8 @@ sil_vtable C2 {}
 // -- %c: S.z
 // CHECK: [[KP_C:@keypath(\..*)?]] = private global <{ {{.*}} }> <{
 // CHECK-SAME: [[WORD]]* @keypath_once
-// CHECK-SAME: @"symbolic 8keypaths1SV
-// CHECK-SAME: @"symbolic 8keypaths1CC
+// CHECK-SAME: @"symbolic{{.*}}8keypaths1SV
+// CHECK-SAME: @"symbolic{{.*}}8keypaths1CC
 //               -- instantiable in-line, size 4
 // CHECK-SAME: <i32 0x8000_0004>,
 // -- offset of S.z, mutable
@@ -237,7 +237,7 @@ sil_vtable C2 {}
 // CHECK: [[KP_I:@keypath(\..*)?]] = private global <{ {{.*}} }> <{
 // CHECK-SAME: i32 0
 // CHECK-SAME: @"generic environment l"
-// CHECK-SAME: @"symbolic 8keypaths3GenVyxxG"
+// CHECK-SAME: @"symbolic{{[^"]*}}8keypaths3GenV{{[^"]*}}"
 // CHECK-SAME: @"symbolic x"
 //             -- size 8
 // CHECK-SAME: i32 8,
@@ -250,7 +250,7 @@ sil_vtable C2 {}
 // CHECK: [[KP_J:@keypath(\..*)?]] = private global <{ {{.*}} }> <{
 // CHECK-SAME: i32 0
 // CHECK-SAME: @"generic environment l"
-// CHECK-SAME: @"symbolic 8keypaths3GenVyxxG"
+// CHECK-SAME: @"symbolic{{[^"]*}}8keypaths3GenV{{[^"]*}}"
 // CHECK-SAME: @"symbolic x"
 //             -- size 8
 // CHECK-SAME: i32 8,
@@ -305,7 +305,7 @@ sil_vtable C2 {}
 // -- %gcx: GC<T>.x
 // CHECK: [[KP_GCX:@keypath(\..*)?]] = private global <{ {{.*}} }> <{
 // CHECK-SAME: @"generic environment l"
-// CHECK-SAME: @"symbolic 8keypaths2GCCyxG"
+// CHECK-SAME: @"symbolic{{[^"]*}}8keypaths2GCC{{[^"]*}}"
 // CHECK-SAME: @"symbolic x"
 //             -- class with runtime-resolved offset, mutable
 // CHECK-SAME: <i32 0x3fffffe>
diff --git a/test/IRGen/nested_generics.swift b/test/IRGen/nested_generics.swift
@@ -156,10 +156,10 @@ extension Container.Conformancy3: HasAssoc where T == Outer {
 }
 
 // CHECK-CONSTANTS-LABEL: @"$s15nested_generics9ContainerO12Conformancy3Vyx_GAA8HasAssocA2A5OuterORszrlWP" =
-// CHECK-CONSTANTS-SAME: @"symbolic 15nested_generics5OuterO"
+// CHECK-CONSTANTS-SAME: @"symbolic{{.*}}15nested_generics5OuterO"
 
 // CHECK-CONSTANTS-LABEL: @"$s15nested_generics9ContainerO12Conformancy2Vyx_qd__GAA8HasAssocA2A5OuterORszrlWP" =
-// CHECK-CONSTANTS-SAME: @"symbolic 15nested_generics5OuterO"
+// CHECK-CONSTANTS-SAME: @"symbolic{{.*}}15nested_generics5OuterO"
 
 // CHECK-CONSTANTS-LABEL: @"$s15nested_generics9ContainerO11ConformancyVyx_qd__GAA8HasAssocAAWP" =
-// CHECK-CONSTANTS-SAME: @"symbolic 15nested_generics5OuterO"
+// CHECK-CONSTANTS-SAME: @"symbolic{{.*}}15nested_generics5OuterO"
diff --git a/test/IRGen/sil_witness_tables.swift b/test/IRGen/sil_witness_tables.swift
@@ -43,7 +43,7 @@ struct Conformer: Q, QQ {
 // CHECK: ]
 // CHECK: [[CONFORMER_P_WITNESS_TABLE]] = hidden global [5 x i8*] [
 // CHECK:   @"associated conformance 18sil_witness_tables9ConformerVAA1PAA5AssocAaDP_AA1A"
-// CHECK:   "symbolic 18sil_witness_tables14AssocConformerV"
+// CHECK:   "symbolic{{.*}}18sil_witness_tables14AssocConformerV"
 // CHECK:   i8* bitcast (void (%swift.type*, %swift.type*, i8**)* @"$s18sil_witness_tables9ConformerVAA1PA2aDP12staticMethod{{[_0-9a-zA-Z]*}}FZTW" to i8*),
 // CHECK:   i8* bitcast (void (%T18sil_witness_tables9ConformerV*, %swift.type*, i8**)* @"$s18sil_witness_tables9ConformerVAA1PA2aDP14instanceMethod{{[_0-9a-zA-Z]*}}FTW" to i8*)
 // CHECK: ]
diff --git a/test/IRGen/witness_table_indirect_conformances.swift b/test/IRGen/witness_table_indirect_conformances.swift
@@ -33,7 +33,7 @@ struct Z: P2 {
 // CHECK: @"$s35witness_table_indirect_conformances1WVAA2P3AAWP" = hidden global [5 x i8*] [
 // CHECK-SAME: @"$s35witness_table_indirect_conformances1WVAA2P3AAMc"
 // CHECK-SAME: @"associated conformance 35witness_table_indirect_conformances1WVAA2P3AA05AssocE0AaDP_AA2P2"
-// CHECK-SAME: @"symbolic 35witness_table_indirect_conformances1ZV"
+// CHECK-SAME: @"symbolic{{.*}}35witness_table_indirect_conformances1ZV"
 // CHECK-SAME: i8* bitcast (void (%T35witness_table_indirect_conformances1ZV*, %T35witness_table_indirect_conformances1WV*, %swift.type*, i8**)* @"$s35witness_table_indirect_conformances1WVAA2P3A2aDP08getAssocE00gE0QzyFTW" to i8*)]
 struct W: P3 {
 	typealias AssocP3 = Z
diff --git a/test/IRGen/witness_table_objc_associated_type.swift b/test/IRGen/witness_table_objc_associated_type.swift
@@ -21,7 +21,7 @@ struct SB: B {
 }
 // CHECK-LABEL: @"$s34witness_table_objc_associated_type2SBVAA1BAAWP" = hidden global [4 x i8*] [
 // CHECK:         @"associated conformance 34witness_table_objc_associated_type2SBVAA1BAA2AAAaDP_AA1A"
-// CHECK:         @"symbolic 34witness_table_objc_associated_type2SAV"
+// CHECK:         @"symbolic{{.*}}34witness_table_objc_associated_type2SAV"
 // CHECK:         i8* bitcast {{.*}} @"$s34witness_table_objc_associated_type2SBVAA1BA2aDP3fooyyFTW"
 // CHECK:       ]
 
@@ -31,7 +31,7 @@ struct SO: C {
   func foo() {}
 }
 // CHECK-LABEL: @"$s34witness_table_objc_associated_type2SOVAA1CAAWP" = hidden global [3 x i8*] [
-// CHECK:         @"symbolic 34witness_table_objc_associated_type2COC"
+// CHECK:         @"symbolic{{.*}}34witness_table_objc_associated_type2COC"
 // CHECK:         i8* bitcast {{.*}} @"$s34witness_table_objc_associated_type2SOVAA1CA2aDP3fooyyFTW"
 // CHECK:       ]
 
