File: IncrementalCompilationSynchronizer.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (75 lines) | stat: -rw-r--r-- 3,109 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
//===---------------IncrementalCompilationSynchronizer.swift --------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021 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 Dispatch

/// Any instance that can find the confinmentQueue for the incremental compilation state.
/// By confirming, a type gains the use of the shorthand methods in the extension.
public protocol IncrementalCompilationSynchronizer {
  var incrementalCompilationQueue: DispatchQueue {get}
}

extension IncrementalCompilationSynchronizer {
  func mutationSafetyPrecondition() {
    incrementalCompilationQueue.mutationSafetyPrecondition()
  }
  func accessSafetyPrecondition() {
    incrementalCompilationQueue.accessSafetyPrecondition()
  }

  @_spi(Testing) public func blockingConcurrentAccessOrMutation<T>( _ fn: () throws -> T ) rethrows -> T {
    try incrementalCompilationQueue.blockingConcurrentAccessOrMutation(fn)
  }
  @_spi(Testing) public func blockingConcurrentMutation<T>( _ fn: () throws -> T ) rethrows -> T {
    try incrementalCompilationQueue.blockingConcurrentMutation(fn)
  }
}

/// Methods to bridge the semantic gap from intention to implementation.
extension DispatchQueue {
  /// Ensure that it is safe to mutate or access the state protected by the queue.
  fileprivate func mutationSafetyPrecondition() {
    dispatchPrecondition(condition: .onQueueAsBarrier(self))
  }
  /// Ensure that it is safe to access the state protected by the queue.
  fileprivate func accessSafetyPrecondition() {
    dispatchPrecondition(condition: .onQueue(self))
  }

  /// Block any concurrent access or muitation so that the argument may access or mutate the protected state.
  @_spi(Testing) public func blockingConcurrentAccessOrMutation<T>( _ fn: () throws -> T ) rethrows -> T {
    try sync(flags: .barrier, execute: fn)
  }
  /// Block any concurrent mutation so that argument may access (but not mutate) the protected state.
  @_spi(Testing) public func blockingConcurrentMutation<T>( _ fn: () throws -> T ) rethrows -> T {
    try sync(execute: fn)
  }
}

/// A fixture for tests and dot file creation, etc., that require synchronization and  an ``InternedStringTable``
public struct MockIncrementalCompilationSynchronizer: IncrementalCompilationSynchronizer {
  public let incrementalCompilationQueue: DispatchQueue

  init() {
    self.incrementalCompilationQueue = DispatchQueue(label: "testing")
  }

  func withInternedStringTable<R>(_ fn: (InternedStringTable) throws -> R) rethrows -> R {
    try blockingConcurrentAccessOrMutation {
      try fn(InternedStringTable(incrementalCompilationQueue))
    }
  }

  public static func withInternedStringTable<R>(_ fn: (InternedStringTable) throws -> R) rethrows -> R {
    try Self().withInternedStringTable(fn)
  }
}