Opaque types require a newer Swift runtime.

Check the availability of decls that declare an opaque return type to ensure they deploy to a
runtime that supports opaque types.

rdar://problem/50731151

Author: jckarter

include/swift/AST/DiagnosticsSema.def

@@ -4055,6 +4055,10 @@ ERROR(availability_decl_only_version_newer, none,
       "%0 is only available in %1 %2 or newer",
       (DeclName, StringRef, llvm::VersionTuple))
 
+ERROR(availability_opaque_types_only_version_newer, none,
+      "'some' return types are only available in %0 %1 or newer",
+      (StringRef, llvm::VersionTuple))
+
 NOTE(availability_guard_with_version_check, none,
      "add 'if #available' version check", ())
 

include/swift/Basic/LangOptions.h

@@ -299,7 +299,7 @@ namespace swift {
 
     /// Enable the experimental opaque result types feature.
     bool EnableOpaqueResultTypes = true;
-
+    
     /// To mimic existing system, set to false.
     /// To experiment with including file-private and private dependency info,
     /// set to true.

lib/Sema/TypeCheckAvailability.cpp

@@ -1327,6 +1327,32 @@ static void fixAvailability(SourceRange ReferenceRange,
   }
 }
 
+void TypeChecker::diagnosePotentialOpaqueTypeUnavailability(
+    SourceRange ReferenceRange, const DeclContext *ReferenceDC,
+    const UnavailabilityReason &Reason) {
+  // We only emit diagnostics for API unavailability, not for explicitly
+  // weak-linked symbols.
+  if (Reason.getReasonKind() !=
+      UnavailabilityReason::Kind::RequiresOSVersionRange) {
+    return;
+  }
+
+  auto RequiredRange = Reason.getRequiredOSVersionRange();
+  {
+    auto Err =
+      diagnose(ReferenceRange.Start, diag::availability_opaque_types_only_version_newer,
+               prettyPlatformString(targetPlatform(Context.LangOpts)),
+               Reason.getRequiredOSVersionRange().getLowerEndpoint());
+
+    // Direct a fixit to the error if an existing guard is nearly-correct
+    if (fixAvailabilityByNarrowingNearbyVersionCheck(ReferenceRange,
+                                                     ReferenceDC,
+                                                     RequiredRange, *this, Err))
+      return;
+  }
+  fixAvailability(ReferenceRange, ReferenceDC, RequiredRange, *this);
+}
+
 void TypeChecker::diagnosePotentialUnavailability(
     const Decl *D, DeclName Name, SourceRange ReferenceRange,
     const DeclContext *ReferenceDC, const UnavailabilityReason &Reason) {

lib/Sema/TypeCheckGeneric.cpp

@@ -158,9 +158,26 @@ static void revertDependentTypeLoc(TypeLoc &tl) {
   tl.setType(Type());
 }
 
-///
-/// Generic functions
-///
+//
+// Generic functions
+//
+
+static AvailabilityContext getOpaqueTypeAvailability(ASTContext &Context) {
+  if (Context.LangOpts.DisableAvailabilityChecking)
+    return AvailabilityContext::alwaysAvailable();
+  
+  auto target = Context.LangOpts.Target;
+  
+  if (target.isMacOSX()
+      || target.isiOS()
+      || target.isWatchOS())
+    // TODO: Update with OS versions that ship with runtime support
+    return AvailabilityContext(
+                           VersionRange::allGTE(llvm::VersionTuple(9999,0,0)));
+  
+  
+  return AvailabilityContext::alwaysAvailable();
+}
 
 /// Get the opaque type representing the return type of a declaration, or
 /// create it if it does not yet exist.
@@ -172,6 +189,16 @@ Type TypeChecker::getOrCreateOpaqueResultType(TypeResolution resolution,
     return existingDecl->getDeclaredInterfaceType();
   }
 
+  // Check the availability of the opaque type runtime support.
+  auto runningOS = overApproximateAvailabilityAtLocation(repr->getLoc(),
+                                    originatingDecl->getInnermostDeclContext());
+  auto availability = getOpaqueTypeAvailability(Context);
+  if (!runningOS.isContainedIn(availability)) {
+    diagnosePotentialOpaqueTypeUnavailability(repr->getSourceRange(),
+       originatingDecl->getInnermostDeclContext(),
+       UnavailabilityReason::requiresVersionRange(availability.getOSVersion()));
+  }
+  
   // Try to resolve the constraint repr. It should be some kind of existential
   // type.
   TypeResolutionOptions options(TypeResolverContext::GenericRequirement);

lib/Sema/TypeChecker.h

@@ -1999,6 +1999,10 @@ class TypeChecker final : public LazyResolver {
                                        const DeclContext *ReferenceDC,
                                        const UnavailabilityReason &Reason);
 
+  void diagnosePotentialOpaqueTypeUnavailability(SourceRange ReferenceRange,
+                                           const DeclContext *ReferenceDC,
+                                           const UnavailabilityReason &Reason);
+  
   /// Emits a diagnostic for a reference to a storage accessor that is
   /// potentially unavailable.
   void diagnosePotentialAccessorUnavailability(

test/IRGen/dynamic_replaceable_opaque_return.swift

@@ -1,4 +1,4 @@
-// RUN: %target-swift-frontend -module-name A -swift-version 5 -primary-file %s -emit-ir | %FileCheck %s
+// RUN: %target-swift-frontend -disable-availability-checking -module-name A -swift-version 5 -primary-file %s -emit-ir | %FileCheck %s
 
 // REQUIRES: objc_interop
 

test/IRGen/lazy_opaque_result_type.swift

@@ -1,4 +1,4 @@
-// RUN: %target-swift-frontend -Xllvm -sil-disable-pass=OpaqueArchetypeSpecializer -parse-as-library -module-name=test -O -primary-file %s -emit-ir > %t.ll
+// RUN: %target-swift-frontend -disable-availability-checking -Xllvm -sil-disable-pass=OpaqueArchetypeSpecializer -parse-as-library -module-name=test -O -primary-file %s -emit-ir > %t.ll
 // RUN: %FileCheck %s < %t.ll
 
 protocol P { }

test/IRGen/opaque_result_type.swift

@@ -1,6 +1,6 @@
 // RUN: %empty-directory(%t)
 // RUN: %{python} %utils/chex.py < %s > %t/opaque_result_type.swift
-// RUN: %target-swift-frontend -emit-ir %t/opaque_result_type.swift | %FileCheck --check-prefix=CHECK --check-prefix=CHECK-NODEBUG %t/opaque_result_type.swift
+// RUN: %target-swift-frontend -disable-availability-checking -emit-ir %t/opaque_result_type.swift | %FileCheck --check-prefix=CHECK --check-prefix=CHECK-NODEBUG %t/opaque_result_type.swift
 
 public protocol O {
   func bar()

test/IRGen/opaque_result_type_access_path.swift

@@ -1,10 +1,10 @@
 // RUN: %empty-directory(%t) 
-// RUN: %target-build-swift -module-name=test %s -o %t/a.out
+// RUN: %target-build-swift -Xfrontend -disable-availability-checking -module-name=test %s -o %t/a.out
 // RUN: %target-run %t/a.out | %FileCheck %s
 // REQUIRES: executable_test
 // REQUIRES: CPU=arm64 || CPU=x86_64
 
-// Check that the IRGenMangler does not crashq when mangling a conformance
+// Check that the IRGenMangler does not crash when mangling a conformance
 // access path with an opaque result type as root.
 // As a bonus, also do a runtime test to check that there is no miscompile.
 

test/IRGen/opaque_result_type_debug.swift

@@ -1,4 +1,4 @@
-// RUN: %target-swift-frontend -g -emit-ir -enable-anonymous-context-mangled-names %s | %FileCheck %s
+// RUN: %target-swift-frontend -disable-availability-checking -g -emit-ir -enable-anonymous-context-mangled-names %s | %FileCheck %s
 
 public protocol P {}
 extension Int: P {} 

test/IRGen/opaque_result_type_global.swift

@@ -1,4 +1,4 @@
-// RUN: %target-swift-frontend -emit-ir -verify %s
+// RUN: %target-swift-frontend -disable-availability-checking -emit-ir -verify %s
 
 // rdar://problem/49818962
 func foo() -> some Collection {

test/Interpreter/Inputs/dynamic_replacement_opaque1.swift

@@ -9,15 +9,18 @@ extension Int: P {
 
 }
 
+@available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
 func bar(_ x: Int) -> some P {
   return x
 }
 
 struct Container {
+  @available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
   func bar(_ x: Int) -> some P {
     return x
   }
 
+  @available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
   var computedProperty : some P {
     get {
       return 2
@@ -27,6 +30,7 @@ struct Container {
     }
   }
 
+  @available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
   subscript(_ x: Int) -> some P {
     get {
       return 2

test/Interpreter/Inputs/dynamic_replacement_opaque2.swift

@@ -8,17 +8,20 @@ struct Pair : P {
   }
 }
 
+@available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
 @_dynamicReplacement(for:bar(_:))
 func _replacement_bar(y x: Int) -> some P {
   return Pair()
 }
 
 extension Container {
+  @available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
   @_dynamicReplacement(for:bar(_:))
   func _replacement_bar(y x: Int) -> some P {
     return Pair()
   }
 
+  @available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
   @_dynamicReplacement(for: computedProperty)
   var _replacement_computedProperty : some P {
      get {
@@ -28,6 +31,8 @@ extension Container {
       print("replacement \(newValue)")
      }
   }
+
+  @available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
   @_dynamicReplacement(for: subscript(_:))
   subscript(y x: Int) -> some P {
     get {

test/Interpreter/dynamic_replacement_opaque_result.swift

@@ -33,6 +33,7 @@ private func target_library_name(_ name: String) -> String {
 #endif
 }
 
+@available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
 func test() {
   print(MemoryLayout.size(ofValue: bar(5)))
   print(MemoryLayout.size(ofValue: Container().bar(5)))
@@ -52,7 +53,11 @@ func test() {
 // CHECK: 2
 // CHECK: 8
 // CHECK: 2
-test()
+if #available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *) {
+  test()
+} else {
+  print("8 8 5 5 8 2 8 2")
+}
 
 var executablePath = CommandLine.arguments[0]
 executablePath.removeLast(4)
@@ -73,4 +78,8 @@ executablePath.removeLast(4)
 // CHECK: 1
 // CHECK: 16
 // CHECK: 1
-test()
+if #available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *) {
+  test()
+} else {
+  print("16 16 1 1 16 1 16 1")
+}

test/ParseableInterface/Inputs/opaque-result-types-client.swift

@@ -13,6 +13,7 @@ func getAssocSubscriptType<T: AssocTypeInference>(_ x: T) -> T.AssocSubscript {
 struct MyFoo: Foo {}
 struct YourFoo: Foo {}
 
+@available(macOS 9999, iOS 9999, tvOS 9999, watchOS 9999, *)
 func someTypeIsTheSame() {
   var a = foo(0)
   a = foo(0)