Merge pull request #70547 from tshortli/diagnose-unreachable-cant-back-deploy

AST/SILGen: Use @_alwaysEmitIntoClient diagnostic helper in unavailable code

Author: tshortli

include/swift/AST/ASTContext.h

@@ -1526,6 +1526,10 @@ class ASTContext final {
   /// The declared interface type of Builtin.TheTupleType.
   BuiltinTupleType *getBuiltinTupleType();
 
+  /// The declaration for the `_diagnoseUnavailableCodeReached()` declaration
+  /// that ought to be used for the configured deployment target.
+  FuncDecl *getDiagnoseUnavailableCodeReachedDecl();
+
   Type getNamedSwiftType(ModuleDecl *module, StringRef name);
 
   /// Set the plugin loader.

include/swift/AST/KnownDecls.def

@@ -70,6 +70,7 @@ FUNC_DECL(DiagnoseUnexpectedNilOptional, "_diagnoseUnexpectedNilOptional")
 FUNC_DECL(DiagnoseUnexpectedEnumCase, "_diagnoseUnexpectedEnumCase")
 FUNC_DECL(DiagnoseUnexpectedEnumCaseValue, "_diagnoseUnexpectedEnumCaseValue")
 FUNC_DECL(DiagnoseUnavailableCodeReached, "_diagnoseUnavailableCodeReached")
+FUNC_DECL(DiagnoseUnavailableCodeReachedAEIC, "_diagnoseUnavailableCodeReached_aeic")
 
 FUNC_DECL(GetErrorEmbeddedNSError, "_getErrorEmbeddedNSError")
 

lib/AST/ASTContext.cpp

@@ -6312,6 +6312,14 @@ BuiltinTupleType *ASTContext::getBuiltinTupleType() {
   return result;
 }
 
+FuncDecl *ASTContext::getDiagnoseUnavailableCodeReachedDecl() {
+  // FIXME: Remove this with rdar://119892482
+  if (AvailabilityContext::forDeploymentTarget(*this).isContainedIn(
+      getSwift59Availability()))
+    return getDiagnoseUnavailableCodeReached();
+  return getDiagnoseUnavailableCodeReachedAEIC();
+}
+
 void ASTContext::setPluginLoader(std::unique_ptr<PluginLoader> loader) {
   getImpl().Plugins = std::move(loader);
 }

lib/SILGen/SILGenApply.cpp

@@ -6115,7 +6115,7 @@ void SILGenFunction::emitApplyOfUnavailableCodeReached() {
     return;
 
   auto loc = RegularLocation::getAutoGeneratedLocation(F.getLocation());
-  FuncDecl *fd = getASTContext().getDiagnoseUnavailableCodeReached();
+  FuncDecl *fd = getASTContext().getDiagnoseUnavailableCodeReachedDecl();
 
   if (!fd) {
     // Broken stdlib?

lib/Sema/DerivedConformances.cpp

@@ -495,7 +495,7 @@ DerivedConformance::createBuiltinCall(ASTContext &ctx,
 
 CallExpr *DerivedConformance::createDiagnoseUnavailableCodeReachedCallExpr(
     ASTContext &ctx) {
-  FuncDecl *diagnoseDecl = ctx.getDiagnoseUnavailableCodeReached();
+  FuncDecl *diagnoseDecl = ctx.getDiagnoseUnavailableCodeReachedDecl();
   auto diagnoseDeclRefExpr =
       new (ctx) DeclRefExpr(diagnoseDecl, DeclNameLoc(), true);
   diagnoseDeclRefExpr->setType(diagnoseDecl->getInterfaceType());

stdlib/public/core/AssertCommon.swift

@@ -329,6 +329,17 @@ internal func _diagnoseUnexpectedEnumCase<SwitchedValue>(
 @_semantics("unavailable_code_reached")
 @usableFromInline // COMPILER_INTRINSIC
 internal func _diagnoseUnavailableCodeReached() -> Never {
+  _diagnoseUnavailableCodeReached_aeic()
+}
+
+// FIXME: Remove this with rdar://119892482
+/// An `@_alwaysEmitIntoClient` variant of `_diagnoseUnavailableCodeReached()`.
+/// This is temporarily needed by the compiler to reference from back deployed
+/// clients.
+@_alwaysEmitIntoClient
+@inline(never)
+@_semantics("unavailable_code_reached")
+internal func _diagnoseUnavailableCodeReached_aeic() -> Never {
   _assertionFailure(
     "Fatal error", "Unavailable code reached", flags: _fatalErrorFlags())
 }

test/SILGen/unavailable_clang_enum_typedef.swift

@@ -19,5 +19,5 @@ typedef MyOptions MyOptionsTypedef;
 let _ = MyOptionsTypedef(rawValue: 1)
 
 // CHECK-LABEL: sil shared [transparent] [serialized]{{.*}} @$sSo9MyOptionsa8rawValueABs5Int32V_tcfC : $@convention(method) (Int32, @thin MyOptions.Type) -> MyOptions {
-// CHECK-NOT:     ss31_diagnoseUnavailableCodeReacheds5NeverOyFTwb
+// CHECK-NOT:     _diagnoseUnavailableCodeReached
 // CHECK:       } // end sil function '$sSo9MyOptionsa8rawValueABs5Int32V_tcfC'

test/SILGen/unavailable_decl_optimization_stub.swift

@@ -3,7 +3,7 @@
 public struct S {}
 
 // CHECK-LABEL: sil{{.*}}@$s4Test15unavailableFuncAA1SVyF
-// CHECK:         [[FNREF:%.*]] = function_ref @$[[DIAGNOSEFN:ss31_diagnoseUnavailableCodeReacheds5NeverOy(FTwb|F)]] : $@convention(thin) () -> Never
+// CHECK:         [[FNREF:%.*]] = function_ref @$[[DIAGNOSEFN:(ss36_diagnoseUnavailableCodeReached_aeics5NeverOyF|ss31_diagnoseUnavailableCodeReacheds5NeverOyF)]] : $@convention(thin) () -> Never
 // CHECK-NEXT:    [[APPLY:%.*]] = apply [[FNREF]]()
 // CHECK:         function_ref @$s4Test1SVACycfC
 // CHECK:       } // end sil function '$s4Test15unavailableFuncAA1SVyF'

test/SILGen/unavailable_decl_optimization_stub_class.swift

@@ -7,7 +7,7 @@ func foo() {}
 public class ExplicitInitClass {
   // ExplicitInitClass.s.getter
   // CHECK-LABEL: sil{{.*}}@$s4Test17ExplicitInitClassC1sAA1SVvg
-  // CHECK:         [[FNREF:%.*]] = function_ref @$[[DIAGNOSEFN:ss31_diagnoseUnavailableCodeReacheds5NeverOy(FTwb|F)]] : $@convention(thin) () -> Never
+  // CHECK:         [[FNREF:%.*]] = function_ref @$[[DIAGNOSEFN:(ss36_diagnoseUnavailableCodeReached_aeics5NeverOyF|ss31_diagnoseUnavailableCodeReacheds5NeverOyF)]] : $@convention(thin) () -> Never
   // CHECK-NEXT:    [[APPLY:%.*]] = apply [[FNREF]]()
   // CHECK:         load
   // CHECK:       } // end sil function '$s4Test17ExplicitInitClassC1sAA1SVvg'

test/SILGen/unavailable_decl_optimization_stub_objc.swift

@@ -10,7 +10,7 @@ func foo() {}
 @objc public class C: NSObject {
   // C.__allocating_init()
   // CHECK-LABEL: sil{{.*}}@$s4Test1CCACycfC
-  // CHECK:         [[FNREF:%.*]] = function_ref @$[[DIAGNOSEFN:ss31_diagnoseUnavailableCodeReacheds5NeverOy(FTwb|F)]] : $@convention(thin) () -> Never
+  // CHECK:         [[FNREF:%.*]] = function_ref @$[[DIAGNOSEFN:(ss36_diagnoseUnavailableCodeReached_aeics5NeverOyF|ss31_diagnoseUnavailableCodeReacheds5NeverOyF)]] : $@convention(thin) () -> Never
   // CHECK-NEXT:    [[APPLY:%.*]] = apply [[FNREF]]()
   // CHECK:         {{%.*}} = function_ref @$s4Test1CCACycfcTD
   // CHECK:       } // end sil function '$s4Test1CCACycfC'