Merge pull request #71614 from tshortli/unavailable-decl-optimization-application-extensions

tshortli · web-flow · commit 9bb2744df104 · 2024-02-15T09:41:27.000-08:00
AST: Don't optimize decls that are unavailable in extensions
diff --git a/include/swift/AST/Attr.h b/include/swift/AST/Attr.h
@@ -2655,7 +2655,8 @@ class DeclAttributes {
   /// Finds the most-specific platform-specific attribute that is
   /// active for the current platform.
   const AvailableAttr *
-  findMostSpecificActivePlatform(const ASTContext &ctx) const;
+  findMostSpecificActivePlatform(const ASTContext &ctx,
+                                 bool ignoreAppExtensions = false) const;
 
   /// Returns the first @available attribute that indicates
   /// a declaration is unavailable, or the first one that indicates it's
@@ -2664,7 +2665,8 @@ class DeclAttributes {
 
   /// Returns the first @available attribute that indicates
   /// a declaration is unavailable, or null otherwise.
-  const AvailableAttr *getUnavailable(const ASTContext &ctx) const;
+  const AvailableAttr *getUnavailable(const ASTContext &ctx,
+                                      bool ignoreAppExtensions = false) const;
 
   /// Returns the first @available attribute that indicates
   /// a declaration is deprecated on all deployment targets, or null otherwise.
diff --git a/include/swift/AST/Decl.h b/include/swift/AST/Decl.h
@@ -1289,7 +1289,8 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl> {
   getSemanticAvailableRangeAttr() const;
 
   /// Retrieve the @available attribute that makes this declaration unavailable,
-  /// if any.
+  /// if any. If \p ignoreAppExtensions is true then attributes for app
+  /// extension platforms are ignored.
   ///
   /// This attribute may come from an enclosing decl since availability is
   /// inherited. The second member of the returned pair is the decl that owns
@@ -1298,7 +1299,7 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl> {
   /// Note that this notion of unavailability is broader than that which is
   /// checked by \c AvailableAttr::isUnavailable.
   llvm::Optional<std::pair<const AvailableAttr *, const Decl *>>
-  getSemanticUnavailableAttr() const;
+  getSemanticUnavailableAttr(bool ignoreAppExtensions = false) const;
 
   /// Returns true if this declaration should be considered available during
   /// SIL/IR lowering. A declaration would not be available during lowering if,
diff --git a/include/swift/AST/PlatformKind.h b/include/swift/AST/PlatformKind.h
@@ -57,6 +57,12 @@ StringRef prettyPlatformString(PlatformKind platform);
 llvm::Optional<PlatformKind>
 basePlatformForExtensionPlatform(PlatformKind Platform);
 
+/// Returns true if \p Platform represents and application extension platform,
+/// e.g. `iOSApplicationExtension`.
+inline bool isApplicationExtensionPlatform(PlatformKind Platform) {
+  return basePlatformForExtensionPlatform(Platform).has_value();
+}
+
 /// Returns whether the passed-in platform is active, given the language
 /// options. A platform is active if either it is the target platform or its
 /// AppExtension variant is the target platform. For example, OS X is
diff --git a/include/swift/AST/TypeCheckRequests.h b/include/swift/AST/TypeCheckRequests.h
@@ -3985,16 +3985,18 @@ class SemanticAvailableRangeAttrRequest
 
 class SemanticUnavailableAttrRequest
     : public SimpleRequest<SemanticUnavailableAttrRequest,
-                           llvm::Optional<AvailableAttrDeclPair>(const Decl *),
+                           llvm::Optional<AvailableAttrDeclPair>(
+                               const Decl *decl, bool ignoreAppExtensions),
                            RequestFlags::Cached> {
 public:
   using SimpleRequest::SimpleRequest;
 
 private:
   friend SimpleRequest;
 
-  llvm::Optional<AvailableAttrDeclPair> evaluate(Evaluator &evaluator,
-                                                 const Decl *decl) const;
+  llvm::Optional<AvailableAttrDeclPair>
+  evaluate(Evaluator &evaluator, const Decl *decl,
+           bool ignoreAppExtensions) const;
 
 public:
   bool isCached() const { return true; }
diff --git a/lib/AST/Attr.cpp b/lib/AST/Attr.cpp
@@ -337,7 +337,8 @@ DeclAttributes::isUnavailableInSwiftVersion(
 }
 
 const AvailableAttr *
-DeclAttributes::findMostSpecificActivePlatform(const ASTContext &ctx) const{
+DeclAttributes::findMostSpecificActivePlatform(const ASTContext &ctx,
+                                               bool ignoreAppExtensions) const {
   const AvailableAttr *bestAttr = nullptr;
 
   for (auto attr : *this) {
@@ -354,6 +355,9 @@ DeclAttributes::findMostSpecificActivePlatform(const ASTContext &ctx) const{
     if (!avAttr->isActivePlatform(ctx))
       continue;
 
+    if (ignoreAppExtensions && isApplicationExtensionPlatform(avAttr->Platform))
+      continue;
+
     // We have an attribute that is active for the platform, but
     // is it more specific than our current best?
     if (!bestAttr || inheritsAvailabilityFromPlatform(avAttr->Platform,
@@ -407,10 +411,12 @@ DeclAttributes::getPotentiallyUnavailable(const ASTContext &ctx) const {
   return potential;
 }
 
-const AvailableAttr *DeclAttributes::getUnavailable(
-                          const ASTContext &ctx) const {
+const AvailableAttr *
+DeclAttributes::getUnavailable(const ASTContext &ctx,
+                               bool ignoreAppExtensions) const {
   const AvailableAttr *conditional = nullptr;
-  const AvailableAttr *bestActive = findMostSpecificActivePlatform(ctx);
+  const AvailableAttr *bestActive =
+      findMostSpecificActivePlatform(ctx, ignoreAppExtensions);
 
   for (auto Attr : *this)
     if (auto AvAttr = dyn_cast<AvailableAttr>(Attr)) {
@@ -429,6 +435,10 @@ const AvailableAttr *DeclAttributes::getUnavailable(
           !AvAttr->isPackageDescriptionVersionSpecific())
         continue;
 
+      if (ignoreAppExtensions &&
+          isApplicationExtensionPlatform(AvAttr->Platform))
+        continue;
+
       // Unconditional unavailable.
       if (AvAttr->isUnconditionallyUnavailable())
         return AvAttr;
diff --git a/lib/AST/Availability.cpp b/lib/AST/Availability.cpp
@@ -302,30 +302,47 @@ bool Decl::isAvailableAsSPI() const {
 }
 
 llvm::Optional<AvailableAttrDeclPair>
-SemanticUnavailableAttrRequest::evaluate(Evaluator &evaluator,
-                                         const Decl *decl) const {
+SemanticUnavailableAttrRequest::evaluate(Evaluator &evaluator, const Decl *decl,
+                                         bool ignoreAppExtensions) const {
   // Directly marked unavailable.
-  if (auto attr = decl->getAttrs().getUnavailable(decl->getASTContext()))
+  if (auto attr = decl->getAttrs().getUnavailable(decl->getASTContext(),
+                                                  ignoreAppExtensions))
     return std::make_pair(attr, decl);
 
   if (auto *parent =
           AvailabilityInference::parentDeclForInferredAvailability(decl))
-    return parent->getSemanticUnavailableAttr();
+    return parent->getSemanticUnavailableAttr(ignoreAppExtensions);
 
   return llvm::None;
 }
 
-llvm::Optional<AvailableAttrDeclPair> Decl::getSemanticUnavailableAttr() const {
+llvm::Optional<AvailableAttrDeclPair>
+Decl::getSemanticUnavailableAttr(bool ignoreAppExtensions) const {
   auto &eval = getASTContext().evaluator;
-  return evaluateOrDefault(eval, SemanticUnavailableAttrRequest{this},
-                           llvm::None);
+  return evaluateOrDefault(
+      eval, SemanticUnavailableAttrRequest{this, ignoreAppExtensions},
+      llvm::None);
 }
 
-static bool isUnconditionallyUnavailable(const Decl *D) {
-  if (auto unavailableAttrAndDecl = D->getSemanticUnavailableAttr())
-    return unavailableAttrAndDecl->first->isUnconditionallyUnavailable();
+static bool shouldStubOrSkipUnavailableDecl(const Decl *D) {
+  // Don't trust unavailability on declarations from clang modules.
+  if (isa<ClangModuleUnit>(D->getDeclContext()->getModuleScopeContext()))
+    return false;
+
+  auto unavailableAttrAndDecl =
+      D->getSemanticUnavailableAttr(/*ignoreAppExtensions=*/true);
+  if (!unavailableAttrAndDecl)
+    return false;
 
-  return false;
+  // getSemanticUnavailableAttr() can return an @available attribute that makes
+  // its declaration unavailable conditionally due to deployment target. Only
+  // stub or skip a declaration that is unavailable regardless of deployment
+  // target.
+  auto *unavailableAttr = unavailableAttrAndDecl->first;
+  if (!unavailableAttr->isUnconditionallyUnavailable())
+    return false;
+
+  return true;
 }
 
 static UnavailableDeclOptimization
@@ -343,10 +360,7 @@ bool Decl::isAvailableDuringLowering() const {
       UnavailableDeclOptimization::Complete)
     return true;
 
-  if (isa<ClangModuleUnit>(getDeclContext()->getModuleScopeContext()))
-    return true;
-
-  return !isUnconditionallyUnavailable(this);
+  return !shouldStubOrSkipUnavailableDecl(this);
 }
 
 bool Decl::requiresUnavailableDeclABICompatibilityStubs() const {
@@ -356,10 +370,7 @@ bool Decl::requiresUnavailableDeclABICompatibilityStubs() const {
       UnavailableDeclOptimization::Stub)
     return false;
 
-  if (isa<ClangModuleUnit>(getDeclContext()->getModuleScopeContext()))
-    return false;
-
-  return isUnconditionallyUnavailable(this);
+  return shouldStubOrSkipUnavailableDecl(this);
 }
 
 bool UnavailabilityReason::requiresDeploymentTargetOrEarlier(
diff --git a/lib/AST/PlatformKind.cpp b/lib/AST/PlatformKind.cpp
@@ -109,10 +109,6 @@ swift::basePlatformForExtensionPlatform(PlatformKind Platform) {
   llvm_unreachable("bad PlatformKind");
 }
 
-static bool isApplicationExtensionPlatform(PlatformKind Platform) {
-  return basePlatformForExtensionPlatform(Platform).has_value();
-}
-
 static bool isPlatformActiveForTarget(PlatformKind Platform,
                                       const llvm::Triple &Target,
                                       bool EnableAppExtensionRestrictions) {
diff --git a/test/SILGen/unavailable_decl_optimization_stub_macos.swift b/test/SILGen/unavailable_decl_optimization_stub_macos.swift
@@ -1,5 +1,7 @@
-// RUN: %target-swift-emit-silgen -target %target-swift-abi-5.8-triple -module-name Test -parse-as-library %s -verify -unavailable-decl-optimization=stub | %FileCheck %s --check-prefixes=CHECK-SWIFT5_8
-// RUN: %target-swift-emit-silgen -target %target-swift-abi-5.9-triple -module-name Test -parse-as-library %s -verify -unavailable-decl-optimization=stub | %FileCheck %s --check-prefixes=CHECK-SWIFT5_9
+// RUN: %target-swift-emit-silgen -target %target-swift-abi-5.8-triple -module-name Test -parse-as-library %s -verify -unavailable-decl-optimization=stub | %FileCheck %s --check-prefixes=CHECK,CHECK-SWIFT5_8
+// RUN: %target-swift-emit-silgen -target %target-swift-abi-5.8-triple -module-name Test -parse-as-library %s -verify -unavailable-decl-optimization=stub -application-extension | %FileCheck %s --check-prefixes=CHECK,CHECK-SWIFT5_8
+// RUN: %target-swift-emit-silgen -target %target-swift-abi-5.9-triple -module-name Test -parse-as-library %s -verify -unavailable-decl-optimization=stub | %FileCheck %s --check-prefixes=CHECK,CHECK-SWIFT5_9
+// RUN: %target-swift-emit-silgen -target %target-swift-abi-5.9-triple -module-name Test -parse-as-library %s -verify -unavailable-decl-optimization=stub -application-extension | %FileCheck %s --check-prefixes=CHECK,CHECK-SWIFT5_9
 
 // REQUIRES: OS=macosx
 
@@ -19,3 +21,31 @@ public func unavailableFunc() {}
 @available(*, unavailable)
 @inlinable public func unavailableInlinableFunc() {}
 
+// CHECK-LABEL:     sil{{.*}}@$s4Test22unavailableOnMacOSFuncyyF
+// CHECK-SWIFT5_8:    [[FNREF:%.*]] = function_ref @$ss36_diagnoseUnavailableCodeReached_aeics5NeverOyF : $@convention(thin) () -> Never
+// CHECK-SWIFT5_9:    [[FNREF:%.*]] = function_ref @$ss31_diagnoseUnavailableCodeReacheds5NeverOyF : $@convention(thin) () -> Never
+// CHECK-NEXT:        [[APPLY:%.*]] = apply [[FNREF]]()
+// CHECK:           } // end sil function '$s4Test22unavailableOnMacOSFuncyyF'
+@available(macOS, unavailable)
+public func unavailableOnMacOSFunc() {}
+
+// CHECK-LABEL:     sil{{.*}}@$s4Test31unavailableOnMacOSExtensionFuncyyF
+// CHECK-NOT:         function_ref @$ss36_diagnoseUnavailableCodeReached{{.*}} : $@convention(thin) () -> Never
+// CHECK:           } // end sil function '$s4Test31unavailableOnMacOSExtensionFuncyyF'
+@available(macOSApplicationExtension, unavailable)
+public func unavailableOnMacOSExtensionFunc() {}
+
+// CHECK-LABEL:     sil{{.*}}@$s4Test021unavailableOnMacOSAndD15OSExtensionFuncyyF
+// CHECK-SWIFT5_8:    [[FNREF:%.*]] = function_ref @$ss36_diagnoseUnavailableCodeReached_aeics5NeverOyF : $@convention(thin) () -> Never
+// CHECK-SWIFT5_9:    [[FNREF:%.*]] = function_ref @$ss31_diagnoseUnavailableCodeReacheds5NeverOyF : $@convention(thin) () -> Never
+// CHECK-NEXT:        [[APPLY:%.*]] = apply [[FNREF]]()
+// CHECK:           } // end sil function '$s4Test021unavailableOnMacOSAndD15OSExtensionFuncyyF'
+@available(macOS, unavailable)
+@available(macOSApplicationExtension, unavailable) // FIXME: Seems like this should be diagnosed as redundant
+public func unavailableOnMacOSAndMacOSExtensionFunc() {}
+
+// CHECK-LABEL:     sil{{.*}}@$s4Test20unavailableOniOSFuncyyF
+// CHECK-NOT:         function_ref @$ss36_diagnoseUnavailableCodeReached{{.*}} : $@convention(thin) () -> Never
+// CHECK:           } // end sil function '$s4Test20unavailableOniOSFuncyyF'
+@available(iOS, unavailable)
+public func unavailableOniOSFunc() {}
