File: Library.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (119 lines) | stat: -rw-r--r-- 4,435 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import SWBCLibc
public import SWBLibc

#if canImport(System)
import System
#else
import SystemPackage
#endif

public enum Library: Sendable {
    /// Loads the dynamic library at the given `path`, returning a handle
    /// suitable for symbol lookups.
    ///
    /// - note: This function is and  **must** be `@_alwaysEmitIntoClient` due to the
    ///         behavior of `dlopen` on Apple platforms (and possibly other platforms).
    ///         `dlopen` searches the runpath search paths of the caller's image and the
    ///         main executable. This means that runpath search path resolution is
    ///         _incorrect_ if not emitted into the client (i.e. the image containing the
    ///         caller of this function) because it would otherwise use `SWBUtil`'s
    ///         runpath search paths instead of the caller's.
    @_alwaysEmitIntoClient
    public static func open(_ path: Path) throws -> LibraryHandle {
        #if os(Windows)
        guard let handle = try path.withPlatformString({ p in try p.withCanonicalPathRepresentation({ LoadLibraryW($0) }) }) else {
            throw LibraryOpenError(message: Win32Error(GetLastError()).description)
        }
        return LibraryHandle(rawValue: handle)
        #else
        #if canImport(Darwin)
        let flags = RTLD_LAZY | RTLD_FIRST
        #else
        let flags = RTLD_LAZY
        #endif
        guard let handle = path.withPlatformString({ (p: UnsafePointer<CChar>) in dlopen(p, flags) }) else {
            #if os(Android)
            throw LibraryOpenError(message: String(cString: dlerror()!))
            #else
            throw LibraryOpenError(message: String(cString: dlerror()))
            #endif
        }
        return LibraryHandle(rawValue: handle)
        #endif
    }

    public static func lookup<T>(_ handle: LibraryHandle, _ symbol: String) -> T? {
        #if os(Windows)
        guard let ptr = GetProcAddress(handle.rawValue, symbol) else { return nil }
        #else
        guard let ptr = dlsym(handle.rawValue, symbol) else { return nil }
        #endif
        return unsafeBitCast(ptr, to: T.self)
    }

    public static func locate<T>(_ pointer: T.Type) -> Path {
        #if os(Windows)
        var handle: HMODULE?
        guard GetModuleHandleExW(DWORD(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT), unsafeBitCast(pointer, to: LPCWSTR?.self), &handle) else {
            return Path("")
        }
        do {
            return try Path(SWB_GetModuleFileNameW(handle))
        } catch {
            return Path("")
        }
        #else
        let outPointer: UnsafeMutablePointer<CInterop.PlatformChar>
        var info = Dl_info()
        #if os(Android)
        dladdr(unsafeBitCast(pointer, to: UnsafeMutableRawPointer.self), &info)
        outPointer = UnsafeMutablePointer(mutating: info.dli_fname!)
        #else
        dladdr(unsafeBitCast(pointer, to: UnsafeMutableRawPointer?.self), &info)
        outPointer = UnsafeMutablePointer(mutating: info.dli_fname)
        #endif
        return Path(platformString: outPointer)
        #endif
    }
}

public struct LibraryOpenError: Error, CustomStringConvertible, Sendable {
    public let message: String

    public var description: String {
        message
    }

    @usableFromInline
    internal init(message: String) {
        self.message = message
    }
}

// Library handles just store an opaque reference to the dlopen/LoadLibrary-returned pointer, and so are Sendable in practice based on how they are used.
public struct LibraryHandle: @unchecked Sendable {
    #if os(Windows)
    @usableFromInline typealias PlatformHandle = HMODULE
    #else
    @usableFromInline typealias PlatformHandle = UnsafeMutableRawPointer
    #endif

    fileprivate let rawValue: PlatformHandle

    @usableFromInline
    internal init(rawValue: PlatformHandle) {
        self.rawValue = rawValue
    }
}