データ構造の制約

一部のデータ構造では、単一プロデューサー・単一コンシューマーキューのように、一部の操作を並行して実行してはならない場合があります。Lincheckは、このような契約に対して組み込みのサポートを提供し、制約に従って並行シナリオを生成します。

JCToolsライブラリの単一コンシューマーキューについて考えてみましょう。そのpoll()、peek()、およびoffer(x)操作の正確性を確認するためのテストを記述します。

build.gradle(.kts)ファイルに、JCToolsの依存関係を追加します。

KotlinGroovy

dependencies {
    // jctools dependency
    testImplementation("org.jctools:jctools-core:3.3.0")
}

dependencies {
    // jctools dependency
    testImplementation "org.jctools:jctools-core:3.3.0"
}

単一コンシューマーの制約を満たすには、すべてのpoll()およびpeek()消費操作が単一のスレッドから呼び出されるようにします。そのためには、対応する@OperationアノテーションのnonParallelGroupパラメーターを、例えば"consumers"のように同じ値に設定します。

以下が、そのテストです。

import org.jctools.queues.atomic.*
import org.jetbrains.lincheck.*
import org.jetbrains.lincheck.datastructures.*
import org.junit.*

class MPSCQueueTest {
    private val queue = MpscLinkedAtomicQueue<Int>()

    @Operation
    fun offer(x: Int) = queue.offer(x)

    @Operation(nonParallelGroup = "consumers") 
    fun poll(): Int? = queue.poll()

    @Operation(nonParallelGroup = "consumers")
    fun peek(): Int? = queue.peek()

    @Test
    fun stressTest() = StressOptions().check(this::class)

    @Test
    fun modelCheckingTest() = ModelCheckingOptions().check(this::class)
}

このテスト用に生成されたシナリオの例を以下に示します。

= Iteration 15 / 100 =
| --------------------- |
| Thread 1  | Thread 2  |
| --------------------- |
| poll()    |           |
| poll()    |           |
| peek()    |           |
| peek()    |           |
| peek()    |           |
| --------------------- |
| offer(-1) | offer(0)  |
| offer(0)  | offer(-1) |
| peek()    | offer(-1) |
| offer(1)  | offer(1)  |
| peek()    | offer(1)  |
| --------------------- |
| peek()    |           |
| offer(-2) |           |
| offer(-2) |           |
| offer(2)  |           |
| offer(-2) |           |
| --------------------- |

すべての消費poll()およびpeek()呼び出しが単一スレッドから実行されているため、「単一コンシューマー」の制約を満たしていることに注意してください。

完全なコードを取得する。

次のステップ

モデルチェック戦略を使用して、アルゴリズムの進行保証をチェックする方法を学習します。