mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-06-24 12:21:58 +02:00
a6c926fa34
For ID counters and standalone flags (most sites), drop to .relaxed since nothing reads other memory based on the atomic's value. MultiEntrySemaphore.signaled is the exception: it is used as a signal/wait primitive where waiters proceed to use state set up before signal(). Use .releasing on store and .acquiring on load so that pre-signal writes are visible to waiters that observe `true`. .relaxed there would be incorrect on weakly-ordered architectures.
57 lines
1.8 KiB
Swift
57 lines
1.8 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2024 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import SwiftExtensions
|
|
import Synchronization
|
|
@_spi(SourceKitLSP) import ToolsProtocolsSwiftExtensions
|
|
import XCTest
|
|
|
|
/// A semaphore that, once signaled, will pass on every `wait` call. Ie. the semaphore only needs to be signaled once
|
|
/// and from that point onwards it can be acquired as many times as necessary.
|
|
///
|
|
/// Use cases of this are for example to delay indexing until a some other task has been performed. But once that is
|
|
/// done, all index operations should be able to run, not just one.
|
|
package final class MultiEntrySemaphore: Sendable {
|
|
private let name: String
|
|
private let signaled = Atomic<Bool>(false)
|
|
|
|
package init(name: String) {
|
|
self.name = name
|
|
}
|
|
|
|
package func signal() {
|
|
signaled.store(true, ordering: .releasing)
|
|
}
|
|
|
|
package func waitOrThrow() async throws {
|
|
do {
|
|
try await repeatUntilExpectedResult(sleepInterval: .seconds(0.01)) {
|
|
signaled.load(ordering: .acquiring)
|
|
}
|
|
} catch {
|
|
struct TimeoutError: Error, CustomStringConvertible {
|
|
let name: String
|
|
var description: String { "\(name) timed out" }
|
|
}
|
|
throw TimeoutError(name: "\(name) timed out")
|
|
}
|
|
}
|
|
|
|
package func waitOrXCTFail(file: StaticString = #filePath, line: UInt = #line) async {
|
|
do {
|
|
try await waitOrThrow()
|
|
} catch {
|
|
XCTFail("\(error)", file: file, line: line)
|
|
}
|
|
}
|
|
}
|