Skip to content

IRGen: Weakly link symbols for unavailable declarations #64353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions lib/AST/Decl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1126,6 +1126,14 @@ bool Decl::isAlwaysWeakImported() const {
if (getAttrs().hasAttribute<WeakLinkedAttr>())
return true;

// Declarations that are unavailable should be weak linked since they are
// meant to be unreachable at runtime and their removal should not affect
// clients. However, make an exception for unavailable declarations with
// explicit introduction versions, which are considered required ABI.
if (getSemanticUnavailableAttr() &&
getAvailabilityForLinkage().isAlwaysAvailable())
return true;

if (auto *accessor = dyn_cast<AccessorDecl>(this))
return accessor->getStorage()->isAlwaysWeakImported();

Expand Down
30 changes: 29 additions & 1 deletion test/IRGen/Inputs/weak_import_availability_helper.swift
Original file line number Diff line number Diff line change
@@ -1,27 +1,55 @@
@available(macOS 10.50, *)
public func conditionallyAvailableFunction() {}

@available(macOS, unavailable)
public func unavailableFunction() {}

@available(macOS 10.50, *)
@available(macOS, unavailable)
public func unavailableButIntroducedFunction() {}

@available(macOS 10.50, *)
public var conditionallyAvailableGlobal: Int {
get {return 0}
set {}
}

@available(macOS, unavailable)
public var unavailableGlobal: Int {
get {return 0}
set {}
}

@available(macOS 10.50, *)
public struct ConditionallyAvailableStruct {
public func conditionallyAvailableMethod() {}
}

extension ConditionallyAvailableStruct {
public struct NestedStruct {}
}

@available(macOS, unavailable)
public struct UnvailableStruct {
public func unavailableMethod() {}
}

public protocol AlwaysAvailableProtocol {}

public struct AlwaysAvailableStruct {}

@available(macOS 10.50, *)
extension AlwaysAvailableStruct : AlwaysAvailableProtocol {}

@available(macOS, unavailable)
public protocol UnavailableProtocol {}

@available(macOS, unavailable)
extension AlwaysAvailableStruct : UnavailableProtocol {}

public enum AlwaysAvailableEnum {
case alwaysAvailableCase

@available(macOS 10.50, *)
case conditionallyAvailableCase
}
}
76 changes: 70 additions & 6 deletions test/IRGen/weak_import_availability.swift
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
// RUN: %empty-directory(%t)
// RUN: %target-swift-frontend -emit-module -emit-module-path %t/weak_import_availability_helper.swiftmodule -parse-as-library %S/Inputs/weak_import_availability_helper.swift -enable-library-evolution
// RUN: %target-swift-frontend -target %target-cpu-apple-macosx10.50 -emit-module -emit-module-path %t/weak_import_availability_helper.swiftmodule -parse-as-library %S/Inputs/weak_import_availability_helper.swift -enable-library-evolution
//
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir | %FileCheck %s --check-prefix=CHECK-OLD
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.50 | %FileCheck %s --check-prefix=CHECK-NEW
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.60 | %FileCheck %s --check-prefix=CHECK-NEW
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir | %FileCheck %s --check-prefixes=CHECK,CHECK-OLD
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.50 | %FileCheck %s --check-prefixes=CHECK,CHECK-NEW
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.60 | %FileCheck %s --check-prefixes=CHECK,CHECK-NEW

// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.50 -weak-link-at-target | %FileCheck %s --check-prefix=CHECK-OLD
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.60 -weak-link-at-target | %FileCheck %s --check-prefix=CHECK-NEW
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.50 -weak-link-at-target | %FileCheck %s --check-prefixes=CHECK,CHECK-OLD
// RUN: %target-swift-frontend -primary-file %s -I %t -emit-ir -target %target-cpu-apple-macosx10.60 -weak-link-at-target | %FileCheck %s --check-prefixes=CHECK,CHECK-NEW

// REQUIRES: OS=macosx

Expand Down Expand Up @@ -35,6 +35,16 @@ public func useConditionallyAvailableConformance() {
// CHECK-OLD-LABEL: @"$s31weak_import_availability_helper21AlwaysAvailableStructVAA0eF8ProtocolAAWP" = extern_weak global i8*
// CHECK-NEW-LABEL: @"$s31weak_import_availability_helper21AlwaysAvailableStructVAA0eF8ProtocolAAWP" = external global i8*

@available(macOS, unavailable)
func useUnavailableConformance<T : UnavailableProtocol>(_: T.Type) {}

@available(macOS, unavailable)
public func useUnavailableConformance() {
useUnavailableConformance(AlwaysAvailableStruct.self)
}

// CHECK-LABEL: @"$s31weak_import_availability_helper21AlwaysAvailableStructVAA19UnavailableProtocolAAWP" = extern_weak global i8*, align 8

@available(macOS 10.50, *)
public func callConditionallyAvailableFunction() {
conditionallyAvailableFunction()
Expand All @@ -43,6 +53,21 @@ public func callConditionallyAvailableFunction() {
// CHECK-OLD-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper30conditionallyAvailableFunctionyyF"()
// CHECK-NEW-LABEL: declare swiftcc void @"$s31weak_import_availability_helper30conditionallyAvailableFunctionyyF"()

@available(macOS, unavailable)
public func callUnavailableFunction() {
unavailableFunction()
}

// CHECK-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper19unavailableFunctionyyF"()

@available(macOS, unavailable)
public func callUnavailableButIntroducedFunction() {
unavailableButIntroducedFunction()
}

// CHECK-OLD-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper32unavailableButIntroducedFunctionyyF"()
// CHECK-NEW-LABEL: declare swiftcc void @"$s31weak_import_availability_helper32unavailableButIntroducedFunctionyyF"()

@available(macOS 10.50, *)
public func useConditionallyAvailableGlobal() {
_ = conditionallyAvailableGlobal
Expand All @@ -56,17 +81,56 @@ public func useConditionallyAvailableGlobal() {
// CHECK-OLD-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper28conditionallyAvailableGlobalSivs"(i64)
// CHECK-NEW-LABEL: declare swiftcc void @"$s31weak_import_availability_helper28conditionallyAvailableGlobalSivs"(i64)

// CHECK-OLD-LABEL: declare extern_weak swiftcc { i8*, %TSi* } @"$s31weak_import_availability_helper28conditionallyAvailableGlobalSivM"(i8* noalias dereferenceable(32))
// CHECK-NEW-LABEL: declare swiftcc { i8*, %TSi* } @"$s31weak_import_availability_helper28conditionallyAvailableGlobalSivM"(i8* noalias dereferenceable(32))

@available(macOS, unavailable)
public func useUnavailableGlobal() {
_ = unavailableGlobal
unavailableGlobal = 0
unavailableGlobal += 1
}

// CHECK-LABEL: declare extern_weak swiftcc i64 @"$s31weak_import_availability_helper17unavailableGlobalSivg"()
// CHECK-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper17unavailableGlobalSivs"(i64)
// CHECK-LABEL: declare extern_weak swiftcc { i8*, %TSi* } @"$s31weak_import_availability_helper17unavailableGlobalSivM"(i8* noalias dereferenceable(32))

func blackHole<T>(_: T) {}

@available(macOS 10.50, *)
public func useConditionallyAvailableStruct() {
blackHole(ConditionallyAvailableStruct.self)
}

// CHECK-OLD-LABEL: declare extern_weak swiftcc %swift.metadata_response @"$s31weak_import_availability_helper28ConditionallyAvailableStructVMa"(i64)
// CHECK-NEW-LABEL: declare swiftcc %swift.metadata_response @"$s31weak_import_availability_helper28ConditionallyAvailableStructVMa"(i64)

@available(macOS 10.50, *)
public func useNestedConditionallyAvailableStruct() {
blackHole(ConditionallyAvailableStruct.NestedStruct.self)
}

// CHECK-OLD-LABEL: declare extern_weak swiftcc %swift.metadata_response @"$s31weak_import_availability_helper28ConditionallyAvailableStructV06NestedG0VMa"(i64)
// CHECK-NEW-LABEL: declare swiftcc %swift.metadata_response @"$s31weak_import_availability_helper28ConditionallyAvailableStructV06NestedG0VMa"(i64)

@available(macOS 10.50, *)
public func useConditionallyAvailableMethod(s: ConditionallyAvailableStruct) {
s.conditionallyAvailableMethod()
}

// CHECK-OLD-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper28ConditionallyAvailableStructV013conditionallyF6MethodyyF"(%swift.opaque* noalias nocapture swiftself)
// CHECK-NEW-LABEL: declare swiftcc void @"$s31weak_import_availability_helper28ConditionallyAvailableStructV013conditionallyF6MethodyyF"(%swift.opaque* noalias nocapture swiftself)

@available(macOS, unavailable)
public func useUnavailableStruct() {
blackHole(UnvailableStruct.self)
}

// CHECK-LABEL: declare extern_weak swiftcc %swift.metadata_response @"$s31weak_import_availability_helper16UnvailableStructVMa"(i64)

@available(macOS, unavailable)
public func useUnavailableMethod(s: UnvailableStruct) {
s.unavailableMethod()
}

// CHECK-LABEL: declare extern_weak swiftcc void @"$s31weak_import_availability_helper16UnvailableStructV17unavailableMethodyyF"(%swift.opaque* noalias nocapture swiftself)
3 changes: 2 additions & 1 deletion test/SILGen/objc_init_unavailable.swift
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
// RUN: %target-swift-emit-silgen(mock-sdk: %clang-importer-sdk) -enable-objc-interop -import-objc-header %S/Inputs/objc_init_unavailable.h %s | %FileCheck %s
// REQUIRES: objc_interop
// REQUIRES: OS=macosx

@available(macOS, unavailable)
public func callUnavailableInit(name: String) -> ClassWithUnavailableInit {
return ClassWithUnavailableInit(bundleID: name)
}

// CHECK-LABEL: sil [ossa] @$s21objc_init_unavailable19callUnavailableInit4nameSo09ClassWitheF0CSS_tF : $@convention(thin) (@guaranteed String) -> @owned ClassWithUnavailableInit {
// CHECK-LABEL: sil [weak_imported] [ossa] @$s21objc_init_unavailable19callUnavailableInit4nameSo09ClassWitheF0CSS_tF : $@convention(thin) (@guaranteed String) -> @owned ClassWithUnavailableInit {
// CHECK: function_ref @$sSo24ClassWithUnavailableInitC8bundleIDABSgSSSg_tcfC : $@convention(method) (@owned Optional<String>, @thick ClassWithUnavailableInit.Type) -> @owned Optional<ClassWithUnavailableInit>
// CHECK: return

Expand Down