Skip to content

Adopt _CFErrorCopyCallStackReturnAddresses(). #1344

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 3 commits into from
Sep 30, 2025
Merged

Adopt _CFErrorCopyCallStackReturnAddresses(). #1344

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac0fbda
Adopt `_CFErrorCopyCallStackReturnAddresses()`.
grynspan Sep 30, 2025
b596601
Oh right Linux
grynspan Sep 30, 2025
9dd9970
Fix comment
grynspan Sep 30, 2025
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
42 changes: 36 additions & 6 deletions Sources/Testing/SourceAttribution/Backtrace.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,24 @@ extension Backtrace {
}
#endif

#if !hasFeature(Embedded) && SWT_TARGET_OS_APPLE && !SWT_NO_DYNAMIC_LINKING
/// A function provided by Core Foundation that copies the captured backtrace
/// from storage inside `CFError` or `NSError`.
///
/// - Parameters:
/// - error: The error whose backtrace is desired.
///
/// - Returns: The backtrace (as an instance of `NSArray`) captured by `error`
/// when it was created, or `nil` if none was captured. The caller is
/// responsible for releasing this object when done.
///
/// This function was added in an internal Foundation PR and is not available
/// on older systems.
private static let _CFErrorCopyCallStackReturnAddresses = symbol(named: "_CFErrorCopyCallStackReturnAddresses").map {
castCFunction(at: $0, to: (@convention(c) (_ error: any Error) -> Unmanaged<AnyObject>?).self)
}
#endif

/// Whether or not Foundation provides a function that triggers the capture of
/// backtaces when instances of `NSError` or `CFError` are created.
///
Expand All @@ -339,7 +357,11 @@ extension Backtrace {
/// first time the value of this property is read.
static let isFoundationCaptureEnabled = {
#if !hasFeature(Embedded) && _runtime(_ObjC) && !SWT_NO_DYNAMIC_LINKING
if Environment.flag(named: "SWT_FOUNDATION_ERROR_BACKTRACING_ENABLED") == true {
// Check the environment variable; if it isn't set, enable if and only if
// the Core Foundation getter function is implemented.
let foundationBacktracesEnabled = Environment.flag(named: "SWT_FOUNDATION_ERROR_BACKTRACING_ENABLED")
?? (_CFErrorCopyCallStackReturnAddresses != nil)
if foundationBacktracesEnabled {
let _CFErrorSetCallStackCaptureEnabled = symbol(named: "_CFErrorSetCallStackCaptureEnabled").map {
castCFunction(at: $0, to: (@convention(c) (DarwinBoolean) -> DarwinBoolean).self)
}
Expand Down Expand Up @@ -422,11 +444,19 @@ extension Backtrace {
#if !hasFeature(Embedded)
@inline(never)
init?(forFirstThrowOf error: any Error, checkFoundation: Bool = true) {
if checkFoundation && Self.isFoundationCaptureEnabled,
let userInfo = error._userInfo as? [String: Any],
let addresses = userInfo["NSCallStackReturnAddresses"] as? [Address], !addresses.isEmpty {
self.init(addresses: addresses)
return
if checkFoundation && Self.isFoundationCaptureEnabled {
#if !hasFeature(Embedded) && SWT_TARGET_OS_APPLE && !SWT_NO_DYNAMIC_LINKING
if let addresses = Self._CFErrorCopyCallStackReturnAddresses?(error)?.takeRetainedValue() as? [Address] {
self.init(addresses: addresses)
return
}
#endif

if let userInfo = error._userInfo as? [String: Any],
let addresses = userInfo["NSCallStackReturnAddresses"] as? [Address], !addresses.isEmpty {
self.init(addresses: addresses)
return
}
}

let entry = Self._errorMappingCache.withLock { cache in
Expand Down