IRGen: Add code to support building fragile resilient protocol witnesses

aschwaighofer · aschwaighofer · commit ea70aea43cc1 · 2024-03-10T09:14:08.000-07:00
We don't currently support building resilient relative protocol witness tables.
One might want to build with relative witness tables but not need
resilient protocols. Allow for that scenario.

Add a test configuration to test library-evolution + fragile resilient
protocols + relative protocol witness tables.
diff --git a/include/swift/AST/IRGenOptions.h b/include/swift/AST/IRGenOptions.h
@@ -467,6 +467,8 @@ class IRGenOptions {
   /// Use relative (and constant) protocol witness tables.
   unsigned UseRelativeProtocolWitnessTables : 1;
 
+  unsigned UseFragileResilientProtocolWitnesses : 1;
+
   /// The number of threads for multi-threaded code generation.
   unsigned NumThreads = 0;
 
@@ -555,6 +557,7 @@ class IRGenOptions {
         EmitGenericRODatas(false), NoPreallocatedInstantiationCaches(false),
         DisableReadonlyStaticObjects(false), CollocatedMetadataFunctions(false),
         ColocateTypeDescriptors(true), UseRelativeProtocolWitnessTables(false),
+        UseFragileResilientProtocolWitnesses(false),
         CmdArgs(), SanitizeCoverage(llvm::SanitizerCoverageOptions()),
         TypeInfoFilter(TypeInfoDumpFilter::All),
         PlatformCCallingConvention(llvm::CallingConv::C), UseCASBackend(false),
diff --git a/include/swift/Option/FrontendOptions.td b/include/swift/Option/FrontendOptions.td
@@ -1260,6 +1260,12 @@ def enable_relative_protocol_witness_tables :
 def disable_relative_protocol_witness_tables :
   Flag<["-"], "disable-relative-protocol-witness-tables">,
   HelpText<"Disable relative protocol witness tables">;
+def enable_fragile_resilient_protocol_witnesses :
+  Flag<["-"], "enable-fragile-relative-protocol-tables">,
+  HelpText<"Enable relative protocol witness tables">;
+def disable_fragile_resilient_protocol_witnesses :
+  Flag<["-"], "disable-fragile-relative-protocol-tables">,
+  HelpText<"Disable relative protocol witness tables">;
 
 def enable_new_llvm_pass_manager :
   Flag<["-"], "enable-new-llvm-pass-manager">,
diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp
@@ -3042,6 +3042,10 @@ static bool ParseIRGenArgs(IRGenOptions &Opts, ArgList &Args,
     Args.hasFlag(OPT_enable_relative_protocol_witness_tables,
                  OPT_disable_relative_protocol_witness_tables,
                  Opts.UseRelativeProtocolWitnessTables);
+  Opts.UseFragileResilientProtocolWitnesses =
+    Args.hasFlag(OPT_enable_fragile_resilient_protocol_witnesses,
+                 OPT_disable_fragile_resilient_protocol_witnesses,
+                 Opts.UseFragileResilientProtocolWitnesses);
   Opts.EnableLargeLoadableTypesReg2Mem =
       Args.hasFlag(OPT_enable_large_loadable_types_reg2mem,
                    OPT_disable_large_loadable_types_reg2mem,
diff --git a/lib/IRGen/GenDecl.cpp b/lib/IRGen/GenDecl.cpp
@@ -6015,6 +6015,11 @@ bool IRGenModule::isResilient(NominalTypeDecl *D,
                               ClassDecl *asViewedFromRootClass) {
   assert(!asViewedFromRootClass || isa<ClassDecl>(D));
 
+  // Ignore resilient protocols if requested.
+  if (isa<ProtocolDecl>(D) && IRGen.Opts.UseFragileResilientProtocolWitnesses) {
+    return false;
+  }
+
   if (D->getModuleContext()->getBypassResilience())
     return false;
   if (expansion == ResilienceExpansion::Maximal &&
diff --git a/lib/IRGen/GenProto.cpp b/lib/IRGen/GenProto.cpp
@@ -953,7 +953,10 @@ bool IRGenModule::isResilientConformance(
     const NormalProtocolConformance *conformance) {
   // If the protocol is not resilient, the conformance is not resilient
   // either.
-  if (!conformance->getProtocol()->isResilient())
+  bool shouldTreatProtocolNonResilient =
+    IRGen.Opts.UseFragileResilientProtocolWitnesses;
+  if (!conformance->getProtocol()->isResilient() ||
+      shouldTreatProtocolNonResilient)
     return false;
 
   auto *conformanceModule = conformance->getDeclContext()->getParentModule();
@@ -2156,6 +2159,7 @@ namespace {
     void addResilientWitnesses() {
       if (Description.resilientWitnesses.empty())
         return;
+      assert(!IGM.IRGen.Opts.UseFragileResilientProtocolWitnesses);
 
       Flags = Flags.withHasResilientWitnesses(true);
 
@@ -2528,6 +2532,16 @@ void IRGenModule::emitSILWitnessTable(SILWitnessTable *wt) {
   bool isResilient = isResilientConformance(conf);
   bool useRelativeProtocolWitnessTable =
     IRGen.Opts.UseRelativeProtocolWitnessTables;
+  if (useRelativeProtocolWitnessTable &&
+      !conf->getConditionalRequirements().empty()) {
+    auto nominal = conf->getType()->getAnyNominal();
+    auto sig = nominal->getGenericSignatureOfContext();
+    sig->forEachParam([&](GenericTypeParamType *param, bool canonical) {
+                      if (param->isParameterPack()) {
+                        wt->dump();
+                        llvm::report_fatal_error("use of relative protcol witness tables not supported");
+                      }});
+  }
   if (!isResilient) {
     // Build the witness table.
     ConstantInitBuilder builder(*this);
diff --git a/stdlib/cmake/modules/AddSwiftStdlib.cmake b/stdlib/cmake/modules/AddSwiftStdlib.cmake
@@ -453,6 +453,10 @@ function(_add_target_variant_c_compile_flags)
     list(APPEND result "-DSWIFT_STDLIB_USE_RELATIVE_PROTOCOL_WITNESS_TABLES")
   endif()
 
+  if(SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES)
+    list(APPEND result "-DSWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES")
+  endif()
+
   if(SWIFT_STDLIB_OVERRIDABLE_RETAIN_RELEASE)
     list(APPEND result "-DSWIFT_STDLIB_OVERRIDABLE_RETAIN_RELEASE")
   endif()
diff --git a/stdlib/cmake/modules/StdlibOptions.cmake b/stdlib/cmake/modules/StdlibOptions.cmake
@@ -270,6 +270,10 @@ option(SWIFT_STDLIB_USE_RELATIVE_PROTOCOL_WITNESS_TABLES
        "Use relative protocol witness tables"
        FALSE)
 
+option(SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES
+       "Use fragile protocol witness tables for resilient protocols"
+       FALSE)
+
 if("${SWIFT_HOST_VARIANT_SDK}" IN_LIST SWIFT_DARWIN_PLATFORMS)
   set(SWIFT_STDLIB_INSTALL_PARENT_MODULE_FOR_SHIMS_default TRUE)
 else()
diff --git a/stdlib/cmake/modules/SwiftSource.cmake b/stdlib/cmake/modules/SwiftSource.cmake
@@ -626,6 +626,12 @@ function(_compile_swift_files
     list(APPEND swift_flags "-Xfrontend" "-swift-async-frame-pointer=never")
   endif()
 
+  if (SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES)
+    list(APPEND swift_flags "-Xfrontend" "-validate-tbd-against-ir=none")
+    list(APPEND swift_flags "-Xfrontend" "-enable-fragile-relative-protocol-tables")
+    list(APPEND swift_flags "-enable-library-evolution")
+  endif()
+
   if(SWIFT_STDLIB_DISABLE_INSTANTIATION_CACHES)
     list(APPEND swift_flags "-Xfrontend" "-disable-preallocated-instantiation-caches")
   endif()
diff --git a/test/IRGen/relative_protocol_witness_table.swift b/test/IRGen/relative_protocol_witness_table.swift
@@ -1,7 +1,21 @@
 // RUN: %target-swift-frontend -enable-relative-protocol-witness-tables -module-name A -primary-file %s -emit-ir | %FileCheck %s --check-prefix=CHECK-%target-cpu --check-prefix=CHECK
 
+// Test with resilience enabled.
+// In this mode we still assume protocols to be "fragile"/non changeable.
+// RUN: %target-swift-frontend -enable-resilience -enable-fragile-relative-protocol-tables  -enable-relative-protocol-witness-tables -module-name A -primary-file %s -I %t -emit-ir | %FileCheck %s --check-prefix=CHECK-%target-cpu --check-prefix=CHECK
+// RUN: %empty-directory(%t)
+// RUN: %target-swift-frontend -emit-module -enable-fragile-relative-protocol-tables -enable-library-evolution -enable-relative-protocol-witness-tables -emit-module-path=%t/resilient.swiftmodule -module-name=resilient %S/Inputs/relative_protocol_witness_tables2.swift
+// Inputs/relative_protocol_witness_tables2.swift
+// RUN: %target-swift-frontend -enable-fragile-relative-protocol-tables -enable-relative-protocol-witness-tables -module-name A -primary-file %s -I %t -emit-ir -DWITH_RESILIENCE | %FileCheck %s --check-prefix=CHECK-%target-cpu --check-prefix=CHECK
+// RUN: %target-swift-frontend -enable-fragile-relative-protocol-tables -enable-relative-protocol-witness-tables -module-name A -primary-file %s -I %t -emit-ir -DWITH_RESILIENCE | %FileCheck %s --check-prefix=EVO
+// RUN: not --crash %target-swift-frontend -enable-fragile-relative-protocol-tables -enable-relative-protocol-witness-tables -module-name A -primary-file %s -I %t -emit-ir -DWITH_RESILIENCE -DEXPECT_CRASH 2>&1 | %FileCheck %s --check-prefix=CRASH
+
 // REQUIRES: CPU=x86_64 || CPU=arm64 || CPU=arm64e
 
+#if WITH_RESILIENCE
+import resilient
+#endif
+
 func testVWT<T>(_ t: T) {
   var local = t
 }
@@ -323,3 +337,30 @@ func instantiate_conditional_conformance_2nd<T>(_ t : T)  where T: Sub, T.S == T
 // CHECK:   [[T26:%.*]] = call ptr @swift_getWitnessTableRelative({{.*}}@"$s1A1XVyxGAA4BaseA2aERzlMc{{.*}}, ptr {{.*}}, ptr [[T24]])
 // CHECK:   [[T28:%.*]] = getelementptr inbounds ptr, ptr [[C0]], i32 1
 // CHECK:   store ptr [[T26]], ptr [[T28]]
+
+#if WITH_RESILIENCE
+public func requireFormallyResilientWitness<T: ResilientProto> (_ t: T) {
+  t.impl()
+}
+
+// EVO: define{{.*}} swiftcc void @"$s1A27useFormallyResilientWitnessyyF"()
+// EVO: call swiftcc void @"$s1A31requireFormallyResilientWitnessyyx9resilient0C5ProtoRzlF"(ptr noalias %4, ptr %1, ptr @"$s9resilient15ResilientStructVyxGAA0B5ProtoAAWP")
+public func useFormallyResilientWitness() {
+  requireFormallyResilientWitness(ResilientStruct(1))
+}
+#endif
+
+#if EXPECT_CRASH
+protocol P {
+  func p()
+}
+
+@available(SwiftStdlib 5.9, *)
+struct G<each T> {}
+
+@available(SwiftStdlib 5.9, *)
+extension G: P where repeat each T: P {
+    func p() {}
+}
+// CRASH: not supported
+#endif
diff --git a/test/lit.cfg b/test/lit.cfg
@@ -1174,7 +1174,7 @@ if run_vendor == 'apple':
 
         # TODO: consider making the addition of these flags dependent on the CMake
         # setting for hermetic seal at link
-        if not config.swift_freestanding_is_darwin:
+        if not config.swift_freestanding_is_darwin and not config.swift_stdlib_use_use_fragile_resilient_protocol_witness_tables:
             swift_execution_tests_extra_flags += ' -experimental-hermetic-seal-at-link -lto=llvm-full'
 
         if not config.swift_freestanding_is_darwin:
@@ -1186,6 +1186,9 @@ if run_vendor == 'apple':
         if config.swift_stdlib_use_relative_protocol_witness_tables:
             swift_execution_tests_extra_flags += ' -Xfrontend -enable-relative-protocol-witness-tables -Xfrontend -swift-async-frame-pointer=never'
 
+        if config.swift_stdlib_use_use_fragile_resilient_protocol_witness_tables:
+            swift_execution_tests_extra_flags += ' -Xfrontend -validate-tbd-against-ir=none -Xfrontend -enable-fragile-relative-protocol-tables'
+
         # Build a resource dir for freestanding tests.
         new_resource_dir = os.path.join(config.test_exec_root, "resource_dir")
         if not os.path.exists(new_resource_dir): os.mkdir(new_resource_dir)
diff --git a/test/lit.site.cfg.in b/test/lit.site.cfg.in
@@ -160,6 +160,7 @@ if "@SWIFT_ENABLE_SYNCHRONIZATION@" == "TRUE":
 
 config.swift_freestanding_is_darwin = "@SWIFT_FREESTANDING_IS_DARWIN@" == "TRUE"
 config.swift_stdlib_use_relative_protocol_witness_tables = "@SWIFT_STDLIB_USE_RELATIVE_PROTOCOL_WITNESS_TABLES@" == "TRUE"
+config.swift_stdlib_use_use_fragile_resilient_protocol_witness_tables = "@SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES@" == "TRUE"
 config.swift_enable_dispatch = "@SWIFT_ENABLE_DISPATCH@" == "TRUE"
 config.swift_stdlib_enable_objc_interop = "@SWIFT_STDLIB_ENABLE_OBJC_INTEROP@" == "TRUE"
 # Configured in DarwinSDKs.cmake
diff --git a/utils/build-presets.ini b/utils/build-presets.ini
@@ -2741,6 +2741,42 @@ swift-stdlib-use-relative-protocol-witness-tables=1
 test
 validation-test
 
+[preset: stdlib_S_standalone_minimal_macho_arm64_relative_resilient_protocol_witness_table,build,test]
+mixin-preset=
+    stdlib_base_standalone
+    mixin_stdlib_minimal
+
+build-subdir=stdlib_S_standalone
+min-size-release
+assertions
+swift-stdlib-enable-assertions=false
+
+verbose-build
+
+swift-primary-variant-sdk=FREESTANDING
+swift-primary-variant-arch=arm64
+swift-freestanding-flavor=apple
+swift-freestanding-sdk=macosx
+stdlib-deployment-targets=freestanding-arm64
+
+# For now, until clang/swiftc works correctly with "none-macho" as the OS part of target triple.
+swift-freestanding-triple-name=macosx11.0
+swift-freestanding-module-name=macos
+swift-freestanding-archs=arm64
+
+# For lit tests, we are producing dynamic executables with statically linked stdlib into the executable.
+swift-runtime-static-image-inspection=0
+
+swift-stdlib-experimental-hermetic-seal-at-link=0
+swift-stdlib-lto=
+swift-enable-runtime-function-counters=0
+swift-stdlib-use-relative-protocol-witness-tables=1
+swift-stdlib-use-fragile-resilient-protocol-witness-tables=1
+
+test
+validation-test
+only-non-executable-test
+
 [preset: stdlib_S_standalone_darwin_x86_64,build]
 mixin-preset=
     stdlib_S_standalone,build
diff --git a/utils/build-script-impl b/utils/build-script-impl
@@ -227,6 +227,7 @@ KNOWN_SETTINGS=(
     swift-stdlib-tracing                          ""                "whether to enable tracing signposts for the stdlib; default is 1 on Darwin platforms, 0 otherwise"
     swift-stdlib-concurrency-tracing              ""                "whether to enable tracing signposts for concurrency; default is 1 on Darwin platforms, 0 otherwise"
     swift-stdlib-use-relative-protocol-witness-tables "0"            "whether to use relative protocol witness table"
+    swift-stdlib-use-fragile-resilient-protocol-witness-tables "0"            "whether to use fragile resilient protocol witness table"
     swift-enable-runtime-function-counters        ""                "whether to enable runtime function counters"
     swift-stdlib-os-versioning                    "1"               "whether to build stdlib with availability based on OS versions (Darwin only)"
     swift-stdlib-has-commandline                  "1"               "whether to build stdlib with the CommandLine enum and support for argv/argc"
@@ -2003,6 +2004,13 @@ for host in "${ALL_HOSTS[@]}"; do
                     )
                 fi
 
+                if [[ "${SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES}" ]] ; then
+                    cmake_options=(
+                        "${cmake_options[@]}"
+                        -DSWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES:BOOL=$(true_false "${SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES}")
+                    )
+                fi
+
                 if [[ "${SWIFT_RUNTIME_FIXED_BACKTRACER_PATH}" ]] ; then
                     cmake_options=(
                         "${cmake_options[@]}"
diff --git a/validation-test/lit.site.cfg.in b/validation-test/lit.site.cfg.in
@@ -139,6 +139,7 @@ if "@SWIFT_STDLIB_ENABLE_DEBUG_PRECONDITIONS_IN_RELEASE@" == "TRUE":
 
 config.swift_freestanding_is_darwin = "@SWIFT_FREESTANDING_IS_DARWIN@" == "TRUE"
 config.swift_stdlib_use_relative_protocol_witness_tables = "@SWIFT_STDLIB_USE_RELATIVE_PROTOCOL_WITNESS_TABLES@" == "TRUE"
+config.swift_stdlib_use_use_fragile_resilient_protocol_witness_tables = "@SWIFT_STDLIB_USE_FRAGILE_RESILIENT_PROTOCOL_WITNESS_TABLES@" == "TRUE"
 config.swift_enable_dispatch = "@SWIFT_ENABLE_DISPATCH@" == "TRUE"
 config.swift_stdlib_enable_objc_interop = "@SWIFT_STDLIB_ENABLE_OBJC_INTEROP@" == "TRUE"
 # Configured in DarwinSDKs.cmake
