Skip to content

Disable backtrace capturing in Embedded Swift. #1339

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.

Sign up for GitHub

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 1 commit into from
Sep 25, 2025
Merged

Disable backtrace capturing in Embedded Swift. #1339

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 15 additions & 1 deletion Sources/Testing/SourceAttribution/Backtrace.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ extension Backtrace: Codable {
// MARK: - Backtraces for thrown errors

extension Backtrace {
#if !hasFeature(Embedded)
// MARK: - Error cache keys

/// A type used as a cache key that uniquely identifies error existential
Expand Down Expand Up @@ -321,6 +322,7 @@ extension Backtrace {
}
forward(errorType)
}
#endif

/// Whether or not Foundation provides a function that triggers the capture of
/// backtaces when instances of `NSError` or `CFError` are created.
Expand All @@ -336,7 +338,7 @@ extension Backtrace {
/// - Note: The underlying Foundation function is called (if present) the
/// first time the value of this property is read.
static let isFoundationCaptureEnabled = {
#if _runtime(_ObjC) && !SWT_NO_DYNAMIC_LINKING
#if !hasFeature(Embedded) && _runtime(_ObjC) && !SWT_NO_DYNAMIC_LINKING
if Environment.flag(named: "SWT_FOUNDATION_ERROR_BACKTRACING_ENABLED") == true {
let _CFErrorSetCallStackCaptureEnabled = symbol(named: "_CFErrorSetCallStackCaptureEnabled").map {
castCFunction(at: $0, to: (@convention(c) (DarwinBoolean) -> DarwinBoolean).self)
Expand All @@ -348,6 +350,7 @@ extension Backtrace {
return false
}()

#if !hasFeature(Embedded)
/// The implementation of ``Backtrace/startCachingForThrownErrors()``, run
/// only once.
///
Expand All @@ -373,6 +376,7 @@ extension Backtrace {
}
}
}()
#endif

/// Configure the Swift runtime to allow capturing backtraces when errors are
/// thrown.
Expand All @@ -381,17 +385,21 @@ extension Backtrace {
/// developer-supplied code to ensure that thrown errors' backtraces are
/// always captured.
static func startCachingForThrownErrors() {
#if !hasFeature(Embedded)
__SWIFT_TESTING_IS_CAPTURING_A_BACKTRACE_FOR_A_THROWN_ERROR__
#endif
}

/// Flush stale entries from the error-mapping cache.
///
/// Call this function periodically to ensure that errors do not continue to
/// take up space in the cache after they have been deinitialized.
static func flushThrownErrorCache() {
#if !hasFeature(Embedded)
_errorMappingCache.withLock { cache in
cache = cache.filter { $0.value.errorObject != nil }
}
#endif
}

/// Initialize an instance of this type with the previously-cached backtrace
Expand All @@ -411,6 +419,7 @@ extension Backtrace {
/// initializer cannot be made an instance method or property of `Error`
/// because doing so will cause Swift-native errors to be unboxed into
/// existential containers with different addresses.
#if !hasFeature(Embedded)
@inline(never)
init?(forFirstThrowOf error: any Error, checkFoundation: Bool = true) {
if checkFoundation && Self.isFoundationCaptureEnabled,
Expand All @@ -430,4 +439,9 @@ extension Backtrace {
return nil
}
}
#else
init?(forFirstThrowOf error: some Error, checkFoundation: Bool = true) {
return nil
}
#endif
}