File: BoundedBufferStorage.swift

package info (click to toggle)
swiftlang 6.1.3-4
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,791,644 kB
  • sloc: cpp: 9,901,738; ansic: 2,201,433; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (155 lines) | stat: -rw-r--r-- 4,837 bytes parent folder | download | duplicates (2)
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Async Algorithms open source project
//
// Copyright (c) 2022 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
//
//===----------------------------------------------------------------------===//

final class BoundedBufferStorage<Base: AsyncSequence>: Sendable where Base: Sendable {
  private let stateMachine: ManagedCriticalState<BoundedBufferStateMachine<Base>>

  init(base: Base, limit: Int) {
    self.stateMachine = ManagedCriticalState(BoundedBufferStateMachine(base: base, limit: limit))
  }

  func next() async -> Result<Base.Element, Error>? {
    return await withTaskCancellationHandler {
      let action: BoundedBufferStateMachine<Base>.NextAction? = self.stateMachine.withCriticalRegion { stateMachine in
        let action = stateMachine.next()
        switch action {
          case .startTask(let base):
            self.startTask(stateMachine: &stateMachine, base: base)
            return nil

          case .suspend:
            return action
          case .returnResult:
            return action
        }
      }

      switch action {
        case .startTask:
          // We are handling the startTask in the lock already because we want to avoid
          // other inputs interleaving while starting the task
          fatalError("Internal inconsistency")

        case .suspend:
          break

        case .returnResult(let producerContinuation, let result):
          producerContinuation?.resume()
          return result

      case .none:
        break
      }

      return await withUnsafeContinuation { (continuation: UnsafeContinuation<Result<Base.Element, Error>?, Never>) in
        let action = self.stateMachine.withCriticalRegion { stateMachine in
          stateMachine.nextSuspended(continuation: continuation)
        }
        switch action {
          case .none:
            break
          case .returnResult(let producerContinuation, let result):
            producerContinuation?.resume()
            continuation.resume(returning: result)
        }
      }
    } onCancel: {
      self.interrupted()
    }
  }

  private func startTask(
    stateMachine: inout BoundedBufferStateMachine<Base>,
    base: Base
  ) {
    let task = Task {
      do {
        var iterator = base.makeAsyncIterator()

        loop: while true {
          let shouldSuspend = self.stateMachine.withCriticalRegion { stateMachine -> Bool in
            return stateMachine.shouldSuspendProducer()
          }

          if shouldSuspend {
            await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in
              let action = self.stateMachine.withCriticalRegion { stateMachine in
                stateMachine.producerSuspended(continuation: continuation)
              }

              switch action {
                case .none:
                  break
                case .resumeProducer:
                  continuation.resume()
              }
            }
          }

          guard let element = try await iterator.next() else {
            // the upstream is finished
            break loop
          }

          let action = self.stateMachine.withCriticalRegion { stateMachine in
            stateMachine.elementProduced(element: element)
          }
          switch action {
            case .none:
              break
            case .resumeConsumer(let continuation, let result):
              continuation.resume(returning: result)
          }
        }

        let action = self.stateMachine.withCriticalRegion { stateMachine in
          stateMachine.finish(error: nil)
        }
        switch action {
          case .none:
            break
          case .resumeConsumer(let continuation):
            continuation?.resume(returning: nil)
        }
      } catch {
        let action = self.stateMachine.withCriticalRegion { stateMachine in
          stateMachine.finish(error: error)
        }
        switch action {
          case .none:
            break
          case .resumeConsumer(let continuation):
            continuation?.resume(returning: .failure(error))
        }
      }
    }

    stateMachine.taskStarted(task: task)
  }

  func interrupted() {
    let action = self.stateMachine.withCriticalRegion { stateMachine in
      stateMachine.interrupted()
    }
    switch action {
      case .none:
        break
      case .resumeProducerAndConsumer(let task, let producerContinuation, let consumerContinuation):
        task.cancel()
        producerContinuation?.resume()
        consumerContinuation?.resume(returning: nil)
    }
  }

  deinit {
    self.interrupted()
  }
}