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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
|
//===------------------------ SwiftScanCAS.swift --------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
@_implementationOnly import CSwiftScan
import struct Foundation.Data
// Swift Package Manager is building with `-disable-implicit-concurrency-module-import`
// to avoid warnings on old SDKs. Explicity importing concurrency if available
// and only adds async APIs when concurrency is available.
#if canImport(_Concurrency)
import _Concurrency
#endif
public final class CachedCompilation {
let ptr: swiftscan_cached_compilation_t
private let lib: SwiftScan
init(_ ptr: swiftscan_cached_compilation_t, lib: SwiftScan) {
self.ptr = ptr
self.lib = lib
}
public lazy var count: UInt32 = {
lib.api.swiftscan_cached_compilation_get_num_outputs(ptr)
}()
public var isUncacheable: Bool {
lib.api.swiftscan_cached_compilation_is_uncacheable(ptr)
}
public func makeGlobal(_ callback: @escaping (Swift.Error?) -> ()) {
class CallbackContext {
func retain() -> UnsafeMutableRawPointer {
return Unmanaged.passRetained(self).toOpaque()
}
let comp: CachedCompilation
let callback: (Swift.Error?) -> ()
init(_ compilation: CachedCompilation, _ callback: @escaping (Swift.Error?) -> ()) {
self.comp = compilation
self.callback = callback
}
}
func callbackFunc(_ context: UnsafeMutableRawPointer?, _ error: swiftscan_string_ref_t) {
let obj = Unmanaged<CallbackContext>.fromOpaque(context!).takeRetainedValue()
if error.length != 0 {
if let err = try? obj.comp.lib.toSwiftString(error) {
obj.callback(DependencyScanningError.casError(err))
} else {
obj.callback(DependencyScanningError.casError("unknown makeGlobal error"))
}
}
obj.callback(nil)
}
let context = CallbackContext(self, callback)
lib.api.swiftscan_cached_compilation_make_global_async(ptr, context.retain(), callbackFunc, nil)
}
deinit {
lib.api.swiftscan_cached_compilation_dispose(ptr)
}
}
extension CachedCompilation: Sequence {
public typealias Element = CachedOutput
public struct Iterator: IteratorProtocol {
public typealias Element = CachedOutput
let limit: UInt32
let ptr: swiftscan_cached_compilation_t
let lib: SwiftScan
var idx: UInt32 = 0
public mutating func next() -> CachedOutput? {
guard idx < self.limit else { return nil }
let output = self.lib.api.swiftscan_cached_compilation_get_output(self.ptr, idx)
idx += 1
// output can never be nil.
return CachedOutput(output!, lib: self.lib)
}
}
public func makeIterator() -> Iterator {
return Iterator(limit: self.count, ptr: self.ptr, lib: self.lib)
}
}
public final class CachedOutput {
let ptr: swiftscan_cached_output_t
private let lib: SwiftScan
init(_ ptr: swiftscan_cached_output_t, lib: SwiftScan) {
self.ptr = ptr
self.lib = lib
}
public func load() throws -> Bool {
try lib.handleCASError { err_msg in
lib.api.swiftscan_cached_output_load(ptr, &err_msg)
}
}
public var isMaterialized: Bool {
lib.api.swiftscan_cached_output_is_materialized(ptr)
}
public func getCASID() throws -> String {
let id = lib.api.swiftscan_cached_output_get_casid(ptr)
defer { lib.api.swiftscan_string_dispose(id) }
return try lib.toSwiftString(id)
}
public func getOutputKindName() throws -> String {
let kind = lib.api.swiftscan_cached_output_get_name(ptr)
defer { lib.api.swiftscan_string_dispose(kind) }
return try lib.toSwiftString(kind)
}
deinit {
lib.api.swiftscan_cached_output_dispose(ptr)
}
}
public final class CacheReplayInstance {
let ptr: swiftscan_cache_replay_instance_t
private let lib: SwiftScan
init(_ ptr: swiftscan_cache_replay_instance_t, lib: SwiftScan) {
self.ptr = ptr
self.lib = lib
}
deinit {
lib.api.swiftscan_cache_replay_instance_dispose(ptr)
}
}
public final class CacheReplayResult {
let ptr: swiftscan_cache_replay_result_t
private let lib: SwiftScan
init(_ ptr: swiftscan_cache_replay_result_t, lib: SwiftScan) {
self.ptr = ptr
self.lib = lib
}
public func getStdOut() throws -> String {
let str = lib.api.swiftscan_cache_replay_result_get_stdout(ptr)
return try lib.toSwiftString(str)
}
public func getStdErr() throws -> String {
let str = lib.api.swiftscan_cache_replay_result_get_stderr(ptr)
return try lib.toSwiftString(str)
}
deinit {
lib.api.swiftscan_cache_replay_result_dispose(ptr)
}
}
public final class SwiftScanCAS {
let cas: swiftscan_cas_t
private let scanner: SwiftScan
deinit {
scanner.api.swiftscan_cas_dispose(cas)
}
init(cas: swiftscan_cas_t, scanner: SwiftScan) {
self.cas = cas
self.scanner = scanner
}
private func convert(compilation: swiftscan_cached_compilation_t?) -> CachedCompilation? {
return compilation?.convert(scanner)
}
private func convert(instance: swiftscan_cache_replay_instance_t?) -> CacheReplayInstance? {
return instance?.convert(scanner)
}
private func convert(result: swiftscan_cache_replay_result_t?) -> CacheReplayResult? {
return result?.convert(scanner)
}
public func store(data: Data) throws -> String {
let bytes = UnsafeMutablePointer<UInt8>.allocate(capacity: data.count)
data.copyBytes(to: bytes, count: data.count)
let casid = try scanner.handleCASError { err_msg in
scanner.api.swiftscan_cas_store(cas, bytes, UInt32(data.count), &err_msg)
}
return try scanner.toSwiftString(casid)
}
public var supportsSizeManagement: Bool {
scanner.supportsCASSizeManagement
}
public func getStorageSize() throws -> Int64? {
let size = try scanner.handleCASError { err_msg in
scanner.api.swiftscan_cas_get_ondisk_size(cas, &err_msg)
}
return size == -1 ? nil : size
}
public func setSizeLimit(_ size: Int64) throws {
_ = try scanner.handleCASError { err_msg in
scanner.api.swiftscan_cas_set_ondisk_size_limit(cas, size, &err_msg)
}
}
public func prune() throws {
_ = try scanner.handleCASError { err_msg in
scanner.api.swiftscan_cas_prune_ondisk_data(cas, &err_msg)
}
}
@available(*, deprecated)
public func computeCacheKey(commandLine: [String], input: String) throws -> String {
let casid = try scanner.handleCASError { err_msg in
withArrayOfCStrings(commandLine) { commandArray in
scanner.api.swiftscan_cache_compute_key(cas,
Int32(commandLine.count),
commandArray,
input.cString(using: String.Encoding.utf8),
&err_msg)
}
}
return try scanner.toSwiftString(casid)
}
public func computeCacheKey(commandLine: [String], index: Int) throws -> String {
let casid = try scanner.handleCASError { err_msg in
withArrayOfCStrings(commandLine) { commandArray in
scanner.api.swiftscan_cache_compute_key_from_input_index(cas,
Int32(commandLine.count),
commandArray,
UInt32(index),
&err_msg)
}
}
return try scanner.toSwiftString(casid)
}
public func createReplayInstance(commandLine: [String]) throws -> CacheReplayInstance {
let instance = try scanner.handleCASError { err_msg in
withArrayOfCStrings(commandLine) { commandArray in
scanner.api.swiftscan_cache_replay_instance_create(Int32(commandLine.count),
commandArray,
&err_msg)
}
}
// Never return nullptr when no error occurs.
guard let result = convert(instance: instance) else {
throw DependencyScanningError.casError("unexpected nil for replay instance")
}
return result
}
public func queryCacheKey(_ key: String, globally: Bool) throws -> CachedCompilation? {
let result = try scanner.handleCASError { error in
scanner.api.swiftscan_cache_query(cas, key.cString(using: .utf8), globally, &error)
}
return convert(compilation: result)
}
public func replayCompilation(instance: CacheReplayInstance, compilation: CachedCompilation) throws -> CacheReplayResult {
let result = try scanner.handleCASError { err_msg in
scanner.api.swiftscan_cache_replay_compilation(instance.ptr, compilation.ptr, &err_msg)
}
guard let res = convert(result: result) else {
throw DependencyScanningError.casError("unexpected nil for cache_replay_result")
}
return res
}
}
extension SwiftScanCAS: Equatable {
static public func == (lhs: SwiftScanCAS, rhs: SwiftScanCAS) -> Bool {
return lhs.cas == rhs.cas
}
}
extension swiftscan_cached_compilation_t {
func convert(_ lib: SwiftScan) -> CachedCompilation {
return CachedCompilation(self, lib: lib)
}
}
extension swiftscan_cache_replay_instance_t {
func convert(_ lib: SwiftScan) -> CacheReplayInstance {
return CacheReplayInstance(self, lib: lib)
}
}
extension swiftscan_cache_replay_result_t {
func convert(_ lib: SwiftScan) -> CacheReplayResult {
return CacheReplayResult(self, lib: lib)
}
}
#if canImport(_Concurrency)
// Async API Vendor
extension CachedCompilation {
public func makeGlobal() async throws {
return try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, Swift.Error>) in
makeGlobal { (error: Swift.Error?) in
if let err = error {
continuation.resume(throwing: err)
} else {
continuation.resume(returning: ())
}
}
}
}
}
extension CachedOutput {
public func load() async throws -> Bool {
class CallbackContext {
func retain() -> UnsafeMutableRawPointer {
return Unmanaged.passRetained(self).toOpaque()
}
let continuation: CheckedContinuation<Bool, Swift.Error>
let output: CachedOutput
init(_ continuation: CheckedContinuation<Bool, Swift.Error>, output: CachedOutput) {
self.continuation = continuation
self.output = output
}
}
func callbackFunc(_ context: UnsafeMutableRawPointer?, _ success: Bool, _ error: swiftscan_string_ref_t) {
let obj = Unmanaged<CallbackContext>.fromOpaque(context!).takeRetainedValue()
if error.length != 0 {
if let err = try? obj.output.lib.toSwiftString(error) {
obj.continuation.resume(throwing: DependencyScanningError.casError(err))
} else {
obj.continuation.resume(throwing: DependencyScanningError.casError("unknown output loading error"))
}
} else {
obj.continuation.resume(returning: success)
}
}
return try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Bool, Swift.Error>) in
let context = CallbackContext(continuation, output: self)
lib.api.swiftscan_cached_output_load_async(ptr, context.retain(), callbackFunc, nil)
}
}
}
extension SwiftScanCAS {
public func queryCacheKey(_ key: String, globally: Bool) async throws -> CachedCompilation? {
class CallbackContext {
func retain() -> UnsafeMutableRawPointer {
return Unmanaged.passRetained(self).toOpaque()
}
let continuation: CheckedContinuation<CachedCompilation?, Swift.Error>
let cas: SwiftScanCAS
init(_ continuation: CheckedContinuation<CachedCompilation?, Swift.Error>, cas: SwiftScanCAS) {
self.continuation = continuation
self.cas = cas
}
}
func callbackFunc(_ context: UnsafeMutableRawPointer?, _ comp: swiftscan_cached_compilation_t?, _ error: swiftscan_string_ref_t) {
let obj = Unmanaged<CallbackContext>.fromOpaque(context!).takeRetainedValue()
if error.length != 0 {
if let err = try? obj.cas.scanner.toSwiftString(error) {
obj.continuation.resume(throwing: DependencyScanningError.casError(err))
} else {
obj.continuation.resume(throwing: DependencyScanningError.casError("unknown cache querying error"))
}
} else {
obj.continuation.resume(returning: obj.cas.convert(compilation: comp))
}
}
return try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<CachedCompilation?, Swift.Error>) in
let context = CallbackContext(continuation, cas: self)
scanner.api.swiftscan_cache_query_async(cas, key.cString(using: .utf8), globally, context.retain(), callbackFunc, nil)
}
}
public func download(with id: String) async throws -> Bool {
class CallbackContext {
func retain() -> UnsafeMutableRawPointer {
return Unmanaged.passRetained(self).toOpaque()
}
let continuation: CheckedContinuation<Bool, Swift.Error>
let cas: SwiftScanCAS
init(_ continuation: CheckedContinuation<Bool, Swift.Error>, cas: SwiftScanCAS) {
self.continuation = continuation
self.cas = cas
}
}
func callbackFunc(_ context: UnsafeMutableRawPointer?, _ success: Bool, _ error: swiftscan_string_ref_t) {
let obj = Unmanaged<CallbackContext>.fromOpaque(context!).takeRetainedValue()
if error.length != 0 {
if let err = try? obj.cas.scanner.toSwiftString(error) {
obj.continuation.resume(throwing: DependencyScanningError.casError(err))
} else {
obj.continuation.resume(throwing: DependencyScanningError.casError("unknown output loading error"))
}
} else {
obj.continuation.resume(returning: success)
}
}
return try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Bool, Swift.Error>) in
let context = CallbackContext(continuation, cas: self)
scanner.api.swiftscan_cache_download_cas_object_async(cas, id.cString(using: .utf8), context.retain(), callbackFunc, nil)
}
}
}
#endif
|