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
|
/*
* Copyright 2016-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("unused")
package kotlinx.coroutines.lincheck
import kotlinx.coroutines.*
import kotlinx.coroutines.channels.*
import kotlinx.coroutines.channels.Channel.Factory.CONFLATED
import kotlinx.coroutines.channels.Channel.Factory.RENDEZVOUS
import kotlinx.coroutines.channels.Channel.Factory.UNLIMITED
import kotlinx.coroutines.selects.*
import org.jetbrains.kotlinx.lincheck.*
import org.jetbrains.kotlinx.lincheck.annotations.*
import org.jetbrains.kotlinx.lincheck.annotations.Operation
import org.jetbrains.kotlinx.lincheck.paramgen.*
import org.jetbrains.kotlinx.lincheck.verifier.*
class RendezvousChannelLincheckTest : ChannelLincheckTestBase(
c = Channel(RENDEZVOUS),
sequentialSpecification = SequentialRendezvousChannel::class.java
)
class SequentialRendezvousChannel : SequentialIntChannelBase(RENDEZVOUS)
class Array1ChannelLincheckTest : ChannelLincheckTestBase(
c = Channel(1),
sequentialSpecification = SequentialArray1RendezvousChannel::class.java
)
class SequentialArray1RendezvousChannel : SequentialIntChannelBase(1)
class Array2ChannelLincheckTest : ChannelLincheckTestBase(
c = Channel(2),
sequentialSpecification = SequentialArray2RendezvousChannel::class.java
)
class SequentialArray2RendezvousChannel : SequentialIntChannelBase(2)
class UnlimitedChannelLincheckTest : ChannelLincheckTestBase(
c = Channel(UNLIMITED),
sequentialSpecification = SequentialUnlimitedChannel::class.java
)
class SequentialUnlimitedChannel : SequentialIntChannelBase(UNLIMITED)
class ConflatedChannelLincheckTest : ChannelLincheckTestBase(
c = Channel(CONFLATED),
sequentialSpecification = SequentialConflatedChannel::class.java
)
class SequentialConflatedChannel : SequentialIntChannelBase(CONFLATED)
@Param.Params(
Param(name = "value", gen = IntGen::class, conf = "1:5"),
Param(name = "closeToken", gen = IntGen::class, conf = "1:3")
)
abstract class ChannelLincheckTestBase(
private val c: Channel<Int>,
private val sequentialSpecification: Class<*>
) : AbstractLincheckTest() {
@Operation(promptCancellation = true)
suspend fun send(@Param(name = "value") value: Int): Any = try {
c.send(value)
} catch (e: NumberedCancellationException) {
e.testResult
}
@Operation
fun offer(@Param(name = "value") value: Int): Any = try {
c.offer(value)
} catch (e: NumberedCancellationException) {
e.testResult
}
// TODO: this operation should be (and can be!) linearizable, but is not
// @Operation
suspend fun sendViaSelect(@Param(name = "value") value: Int): Any = try {
select<Unit> { c.onSend(value) {} }
} catch (e: NumberedCancellationException) {
e.testResult
}
@Operation(promptCancellation = true)
suspend fun receive(): Any = try {
c.receive()
} catch (e: NumberedCancellationException) {
e.testResult
}
@Operation
fun poll(): Any? = try {
c.poll()
} catch (e: NumberedCancellationException) {
e.testResult
}
// TODO: this operation should be (and can be!) linearizable, but is not
// @Operation
suspend fun receiveViaSelect(): Any = try {
select<Int> { c.onReceive { it } }
} catch (e: NumberedCancellationException) {
e.testResult
}
@Operation(causesBlocking = true)
fun close(@Param(name = "closeToken") token: Int): Boolean = c.close(NumberedCancellationException(token))
// TODO: this operation should be (and can be!) linearizable, but is not
// @Operation
fun cancel(@Param(name = "closeToken") token: Int) = c.cancel(NumberedCancellationException(token))
// @Operation
fun isClosedForReceive() = c.isClosedForReceive
// @Operation
fun isClosedForSend() = c.isClosedForSend
// TODO: this operation should be (and can be!) linearizable, but is not
// @Operation
fun isEmpty() = c.isEmpty
override fun <O : Options<O, *>> O.customize(isStressTest: Boolean): O =
actorsBefore(0).sequentialSpecification(sequentialSpecification)
}
private class NumberedCancellationException(number: Int) : CancellationException() {
val testResult = "Closed($number)"
}
abstract class SequentialIntChannelBase(private val capacity: Int) : VerifierState() {
private val senders = ArrayList<Pair<CancellableContinuation<Any>, Int>>()
private val receivers = ArrayList<CancellableContinuation<Any>>()
private val buffer = ArrayList<Int>()
private var closedMessage: String? = null
suspend fun send(x: Int): Any = when (val offerRes = offer(x)) {
true -> Unit
false -> suspendCancellableCoroutine { cont ->
senders.add(cont to x)
}
else -> offerRes
}
fun offer(element: Int): Any {
if (closedMessage !== null) return closedMessage!!
if (capacity == CONFLATED) {
if (resumeFirstReceiver(element)) return true
buffer.clear()
buffer.add(element)
return true
}
if (resumeFirstReceiver(element)) return true
if (buffer.size < capacity) {
buffer.add(element)
return true
}
return false
}
private fun resumeFirstReceiver(element: Int): Boolean {
while (receivers.isNotEmpty()) {
val r = receivers.removeAt(0)
if (r.resume(element)) return true
}
return false
}
suspend fun receive(): Any = poll() ?: suspendCancellableCoroutine { cont ->
receivers.add(cont)
}
fun poll(): Any? {
if (buffer.isNotEmpty()) {
val el = buffer.removeAt(0)
resumeFirstSender().also {
if (it !== null) buffer.add(it)
}
return el
}
resumeFirstSender()?.also { return it }
if (closedMessage !== null) return closedMessage
return null
}
private fun resumeFirstSender(): Int? {
while (senders.isNotEmpty()) {
val (s, el) = senders.removeAt(0)
if (s.resume(Unit)) return el
}
return null
}
suspend fun sendViaSelect(element: Int) = send(element)
suspend fun receiveViaSelect() = receive()
fun close(token: Int): Boolean {
if (closedMessage !== null) return false
closedMessage = "Closed($token)"
for (r in receivers) r.resume(closedMessage!!)
receivers.clear()
return true
}
fun cancel(token: Int) {
if (!close(token)) return
for ((s, _) in senders) s.resume(closedMessage!!)
senders.clear()
buffer.clear()
}
fun isClosedForSend(): Boolean = closedMessage !== null
fun isClosedForReceive(): Boolean = isClosedForSend() && buffer.isEmpty() && senders.isEmpty()
fun isEmpty(): Boolean {
if (closedMessage !== null) return false
return buffer.isEmpty() && senders.isEmpty()
}
override fun extractState() = buffer to closedMessage
}
private fun <T> CancellableContinuation<T>.resume(res: T): Boolean {
val token = tryResume(res) ?: return false
completeResume(token)
return true
}
|
