File: ThreadTest.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 (311 lines) | stat: -rw-r--r-- 10,340 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
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2019 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

@testable import NIO
import NIOConcurrencyHelpers
import XCTest
import Dispatch

class ThreadTest: XCTestCase {
    func testCurrentThreadWorks() throws {
        let s = DispatchSemaphore(value: 0)
        NIOThread.spawnAndRun { t in
            XCTAssertTrue(t.isCurrent)
            s.signal()
        }
        s.wait()
    }

    func testCurrentThreadIsNotTrueOnOtherThread() throws {
        let s = DispatchSemaphore(value: 0)
        NIOThread.spawnAndRun { t1 in
            NIOThread.spawnAndRun { t2 in
                XCTAssertFalse(t1.isCurrent)
                XCTAssertTrue(t2.isCurrent)
                s.signal()
            }
        }
        s.wait()
    }

    func testThreadSpecificsAreNilWhenNotPresent() throws {
        class SomeClass {}
        let s = DispatchSemaphore(value: 0)
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let tsv: ThreadSpecificVariable<SomeClass> = ThreadSpecificVariable()
            XCTAssertNil(tsv.currentValue)
            s.signal()
        }
        s.wait()
    }

    func testThreadSpecificsWorks() throws {
        class SomeClass {}
        let s = DispatchSemaphore(value: 0)
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let tsv: ThreadSpecificVariable<SomeClass> = ThreadSpecificVariable()
            XCTAssertNil(tsv.currentValue)
            let expected = SomeClass()
            tsv.currentValue = expected
            XCTAssert(expected === tsv.currentValue)
            s.signal()
        }
        s.wait()
    }

    func testThreadSpecificsAreNotAvailableOnADifferentThread() throws {
        class SomeClass {}
        let s = DispatchSemaphore(value: 0)
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let tsv = ThreadSpecificVariable<SomeClass>()
            XCTAssertNil(tsv.currentValue)
            tsv.currentValue = SomeClass()
            XCTAssertNotNil(tsv.currentValue)
            NIOThread.spawnAndRun { t2 in
                XCTAssertNil(tsv.currentValue)
                s.signal()
            }
        }
        s.wait()
    }

    func testThreadSpecificDoesNotLeakIfThreadExitsWhilstSet() throws {
        let s = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }
        weak var weakSome: SomeClass? = nil
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let some = SomeClass(sem: s)
            weakSome = some
            let tsv = ThreadSpecificVariable<SomeClass>()
            tsv.currentValue = some
            XCTAssertNotNil(tsv.currentValue)
        }
        s.wait()
        XCTAssertNil(weakSome)
    }

    func testThreadSpecificDoesNotLeakIfThreadExitsAfterUnset() throws {
        let s = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }
        weak var weakSome: SomeClass? = nil
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let some = SomeClass(sem: s)
            weakSome = some
            let tsv = ThreadSpecificVariable<SomeClass>()
            tsv.currentValue = some
            XCTAssertNotNil(tsv.currentValue)
            tsv.currentValue = nil
        }
        s.wait()
        XCTAssertNil(weakSome)
    }

    func testThreadSpecificDoesNotLeakIfReplacedWithNewValue() throws {
        let s1 = DispatchSemaphore(value: 0)
        let s2 = DispatchSemaphore(value: 0)
        let s3 = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }
        weak var weakSome1: SomeClass? = nil
        weak var weakSome2: SomeClass? = nil
        weak var weakSome3: SomeClass? = nil
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let some1 = SomeClass(sem: s1)
            weakSome1 = some1
            let some2 = SomeClass(sem: s2)
            weakSome2 = some2
            let some3 = SomeClass(sem: s3)
            weakSome3 = some3

            let tsv = ThreadSpecificVariable<SomeClass>()
            tsv.currentValue = some1
            XCTAssertNotNil(tsv.currentValue)
            tsv.currentValue = some2
            XCTAssertNotNil(tsv.currentValue)
            tsv.currentValue = some3
            XCTAssertNotNil(tsv.currentValue)
        }
        s1.wait()
        s2.wait()
        s3.wait()
        XCTAssertNil(weakSome1)
        XCTAssertNil(weakSome2)
        XCTAssertNil(weakSome3)
    }

    func testSharingThreadSpecificVariableWorks() throws {
        let s = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }
        weak var weakSome: SomeClass? = nil
        NIOThread.spawnAndRun { (_: NIO.NIOThread) in
            let some = SomeClass(sem: s)
            weakSome = some
            let tsv = ThreadSpecificVariable<SomeClass>()
            for _ in 0..<10 {
                NIOThread.spawnAndRun { (_: NIO.NIOThread) in
                    tsv.currentValue = some
                }
            }
        }
        s.wait()
        XCTAssertNil(weakSome)
    }

    func testThreadSpecificInitWithValueWorks() throws {
        class SomeClass {}
        let tsv = ThreadSpecificVariable(value: SomeClass())
        XCTAssertNotNil(tsv.currentValue)
    }

    func testThreadSpecificDoesNotLeakWhenOutOfScopeButThreadStillRunning() throws {
        let s = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }
        weak var weakSome: SomeClass? = nil
        weak var weakTSV: ThreadSpecificVariable<SomeClass>? = nil
        NIOThread.spawnAndRun { (_: NIOThread) in
            {
                let some = SomeClass(sem: s)
                weakSome = some
                let tsv = ThreadSpecificVariable<SomeClass>()
                weakTSV = tsv
                tsv.currentValue = some
                XCTAssertNotNil(tsv.currentValue)
                XCTAssertNotNil(weakTSV)
            }()
        }
        s.wait()
        assert(weakSome == nil, within: .seconds(1))
        assert(weakTSV == nil, within: .seconds(1))
    }

    func testThreadSpecificDoesNotLeakIfThreadExitsWhilstSetOnMultipleThreads() throws {
        let numberOfThreads = 6
        let s = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }

        for _ in 0..<numberOfThreads {
            NIOThread.spawnAndRun { (_: NIOThread) in
                let some = SomeClass(sem: s)
                let tsv = ThreadSpecificVariable<SomeClass>()
                tsv.currentValue = some
                XCTAssertNotNil(tsv.currentValue)
            }
        }

        let timeout: DispatchTime = .now() + .seconds(1)
        for _ in 0..<numberOfThreads {
            switch s.wait(timeout: timeout) {
            case .success:
                ()
            case .timedOut:
                XCTFail("timed out")
            }
        }
    }

    func testThreadSpecificDoesNotLeakWhenOutOfScopeButSetOnMultipleThreads() throws {
        let t1Sem = DispatchSemaphore(value: 0)
        let t2Sem = DispatchSemaphore(value: 0)
        class SomeClass {
            let s: DispatchSemaphore
            init(sem: DispatchSemaphore) { self.s = sem }
            deinit {
                s.signal()
            }
        }
        var globalTSVs: [ThreadSpecificVariable<SomeClass>] = []
        let globalTSVLock = Lock()
        ({
            let tsv = ThreadSpecificVariable<SomeClass>()
            globalTSVLock.withLock {
                globalTSVs.append(tsv)
                globalTSVs.append(tsv)
            }
        })()

        weak var weakSome1: SomeClass? = nil
        weak var weakSome2: SomeClass? = nil
        weak var weakTSV: ThreadSpecificVariable<SomeClass>? = nil
        NIOThread.spawnAndRun { (_: NIOThread) in
            {
                let some = SomeClass(sem: t1Sem)
                weakSome1 = some
                var tsv: ThreadSpecificVariable<SomeClass>!
                globalTSVLock.withLock {
                    tsv = globalTSVs.removeFirst()
                }
                weakTSV = tsv
                tsv.currentValue = some
                XCTAssertNotNil(tsv.currentValue)
                XCTAssertNotNil(weakTSV)
            }()
        }
        NIOThread.spawnAndRun { (_: NIOThread) in
            {
                let some = SomeClass(sem: t2Sem)
                weakSome2 = some
                var tsv: ThreadSpecificVariable<SomeClass>!
                globalTSVLock.withLock {
                    tsv = globalTSVs.removeFirst()
                }
                weakTSV = tsv
                tsv.currentValue = some
                XCTAssertNotNil(tsv.currentValue)
                XCTAssertNotNil(weakTSV)
            }()
        }
        t2Sem.wait() /* wait on the other thread's `some` deallocation */
        assert(weakSome1 == nil, within: .seconds(1))
        assert(weakTSV == nil, within: .seconds(1))

        t1Sem.wait() /* wait on the other thread's `some` deallocation */
        assert(weakSome2 == nil, within: .seconds(1))
        assert(weakTSV == nil, within: .seconds(1))
    }
}