Skip to content

Add rr support for concurrentqueue with Nix build system #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fhackett merged 3 commits into from
Oct 25, 2025
Merged

Add rr support for concurrentqueue with Nix build system #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d42645d
Add rr support for concurrentqueue with Nix build system
AnzheXue Oct 23, 2025
cf078a1
Merge branch 'main' into concurrentqueue-rr-support
fhackett Oct 25, 2025
f692cf4
update build + fix formatting
fhackett Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions omnilink/concurrentqueue/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
cmake_minimum_required(VERSION 4.1.1)
project(setbench-stressor)

set(CMAKE_BUILD_TYPE Debug)

# Generate the `compile_commands.json` file.
set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE INTERNAL "")

if(CMAKE_EXPORT_COMPILE_COMMANDS)
set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES
${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES})
endif()

find_package(msgpack-cxx REQUIRED)
find_package(concurrentqueue REQUIRED)

add_executable(main main.cpp)
target_include_directories(main PRIVATE ${OMNILINK_INCLUDE_DIRS})
target_link_libraries(main msgpack-cxx concurrentqueue::concurrentqueue)
90 changes: 43 additions & 47 deletions omnilink/concurrentqueue/ConcurrentQueueAPI.tla
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ EXTENDS FiniteSets, Integers, Sequences, TLC

CONSTANTS Elements, MaxElements, Threads, MaxBulkSize

VARIABLES queue, enqueued, dequeued, producerTokens, consumerTokens
VARIABLES queue, enqueued, dequeued

vars == <<queue, enqueued, dequeued, producerTokens, consumerTokens>>
vars == <<queue, enqueued, dequeued>>

TypeOK ==
/\ queue \in Seq(Elements)
/\ enqueued \in Nat
/\ dequeued \in Nat
/\ producerTokens \in SUBSET Threads
/\ consumerTokens \in SUBSET Threads
\* /\ producerTokens \in SUBSET Threads
\* /\ consumerTokens \in SUBSET Threads
/\ dequeued <= enqueued

varsEnqueued == <<dequeued, producerTokens, consumerTokens>>
varsDequeued == <<enqueued, producerTokens, consumerTokens>>
varsEnqueued == <<dequeued>>
varsDequeued == <<enqueued>>
varsEnqueueFail == <<queue, enqueued>>
varsDequeueFail == <<queue, dequeued>>
varsCreateProducer == <<queue, enqueued, dequeued, consumerTokens>>
varsCreateConsumer == <<queue, enqueued, dequeued, producerTokens>>
varsCreateProducer == <<queue, enqueued, dequeued>>
varsCreateConsumer == <<queue, enqueued, dequeued>>

QueueEnqueue(element, success) ==
/\ element \in Elements
Expand All @@ -33,7 +33,7 @@ QueueEnqueue(element, success) ==
/\ UNCHANGED varsEnqueued

QueueEnqueueWithToken(prodToken, element, success) ==
/\ prodToken \in producerTokens
\* /\ prodToken \in producerTokens
/\ element \in Elements
/\ IF Len(queue) < MaxElements
THEN /\ success = TRUE
Expand All @@ -56,7 +56,7 @@ QueueEnqueueBulk(elements, count, success) ==
/\ UNCHANGED varsEnqueued

QueueEnqueueBulkWithToken(prodToken, elements, count, success) ==
/\ prodToken \in producerTokens
\* /\ prodToken \in producerTokens
/\ elements \in [1..MaxBulkSize -> Elements]
/\ count \in 1..MaxBulkSize
/\ Len(elements) >= count
Expand All @@ -79,7 +79,7 @@ QueueTryEnqueue(element, success) ==
/\ UNCHANGED varsEnqueued

QueueTryEnqueueWithToken(prodToken, element, success) ==
/\ prodToken \in producerTokens
\* /\ prodToken \in producerTokens
/\ element \in Elements
/\ IF Len(queue) < MaxElements
THEN /\ success = TRUE
Expand All @@ -102,7 +102,7 @@ QueueTryEnqueueBulk(elements, count, success) ==
/\ UNCHANGED varsEnqueued

QueueTryEnqueueBulkWithToken(prodToken, elements, count, success) ==
/\ prodToken \in producerTokens
\* /\ prodToken \in producerTokens
/\ elements \in [1..MaxBulkSize -> Elements]
/\ count \in 1..MaxBulkSize
/\ Len(elements) >= count
Expand All @@ -126,7 +126,7 @@ QueueTryDequeue(element, success) ==
/\ UNCHANGED varsDequeued

QueueTryDequeueWithToken(consToken, element, success) ==
/\ consToken \in consumerTokens
\* /\ consToken \in consumerTokens
/\ IF Len(queue) > 0
THEN /\ success = TRUE
/\ element = Head(queue)
Expand All @@ -150,7 +150,7 @@ QueueTryDequeueBulk(elements, max, count) ==
/\ UNCHANGED varsDequeued

QueueTryDequeueBulkWithToken(consToken, elements, max, count) ==
/\ consToken \in consumerTokens
\* /\ consToken \in consumerTokens
/\ elements \in [1..MaxBulkSize -> Elements]
/\ max \in 1..MaxBulkSize
/\ Len(elements) >= max
Expand All @@ -163,19 +163,19 @@ QueueTryDequeueBulkWithToken(consToken, elements, max, count) ==
/\ UNCHANGED varsDequeued

QueueTryDequeueFromProducer(prodToken, element, success) ==
/\ prodToken \in producerTokens
\* /\ prodToken \in producerTokens
/\ IF Len(queue) > 0
THEN /\ success = TRUE
/\ element = Head(queue)
/\ queue' = Tail(queue)
/\ dequeued' = dequeued + 1
ELSE /\ success = FALSE
/\ element \in Elements \* Dummy value when queue is empty
/\ element \in Elements
/\ UNCHANGED varsDequeueFail
/\ UNCHANGED varsDequeued

QueueTryDequeueBulkFromProducer(prodToken, elements, max, count) ==
/\ prodToken \in producerTokens
\* /\ prodToken \in producerTokens
/\ elements \in [1..MaxBulkSize -> Elements]
/\ max \in 1..MaxBulkSize
/\ Len(elements) >= max
Expand All @@ -191,60 +191,56 @@ QueueSizeApprox(size) ==
/\ size = Len(queue)
/\ UNCHANGED vars

CreateProducerToken(thread) ==
/\ thread \in Threads
/\ thread \notin producerTokens
/\ producerTokens' = producerTokens \cup {thread}
/\ UNCHANGED varsCreateProducer
\* CreateProducerToken(thread) ==
\* /\ thread \in Threads
\* /\ thread \notin producerTokens
\* /\ producerTokens' = producerTokens \cup {thread}
\* /\ UNCHANGED varsCreateProducer

CreateConsumerToken(thread) ==
/\ thread \in Threads
/\ thread \notin consumerTokens
/\ consumerTokens' = consumerTokens \cup {thread}
/\ UNCHANGED varsCreateConsumer
\* CreateConsumerToken(thread) ==
\* /\ thread \in Threads
\* /\ thread \notin consumerTokens
\* /\ consumerTokens' = consumerTokens \cup {thread}
\* /\ UNCHANGED varsCreateConsumer

Init ==
/\ queue = <<>>
/\ enqueued = 0
/\ dequeued = 0
/\ producerTokens = {}
/\ consumerTokens = {}
\* /\ producerTokens = Threads
\* /\ consumerTokens = Threads

Next ==
\/ \E element \in Elements, success \in BOOLEAN :
QueueEnqueue(element, success)
\/ \E prodToken \in Threads, element \in Elements, success \in BOOLEAN :
QueueEnqueueWithToken(prodToken, element, success)
\* \/ \E prodToken \in Threads, element \in Elements, success \in BOOLEAN :
\* QueueEnqueueWithToken(prodToken, element, success)
\/ \E elements \in [1..MaxBulkSize -> Elements], count \in 1..MaxBulkSize, success \in BOOLEAN :
QueueEnqueueBulk(elements, count, success)
\/ \E prodToken \in Threads, elements \in [1..MaxBulkSize -> Elements], count \in 1..MaxBulkSize, success \in BOOLEAN :
QueueEnqueueBulkWithToken(prodToken, elements, count, success)
\* \/ \E prodToken \in Threads, elements \in [1..MaxBulkSize -> Elements], count \in 1..MaxBulkSize, success \in BOOLEAN :
\* QueueEnqueueBulkWithToken(prodToken, elements, count, success)
\/ \E element \in Elements, success \in BOOLEAN :
QueueTryEnqueue(element, success)
\/ \E prodToken \in Threads, element \in Elements, success \in BOOLEAN :
QueueTryEnqueueWithToken(prodToken, element, success)
\* \/ \E prodToken \in Threads, element \in Elements, success \in BOOLEAN :
\* QueueTryEnqueueWithToken(prodToken, element, success)
\/ \E elements \in [1..MaxBulkSize -> Elements], count \in 1..MaxBulkSize, success \in BOOLEAN :
QueueTryEnqueueBulk(elements, count, success)
\/ \E prodToken \in Threads, elements \in [1..MaxBulkSize -> Elements], count \in 1..MaxBulkSize, success \in BOOLEAN :
QueueTryEnqueueBulkWithToken(prodToken, elements, count, success)
\* \/ \E prodToken \in Threads, elements \in [1..MaxBulkSize -> Elements], count \in 1..MaxBulkSize, success \in BOOLEAN :
\* QueueTryEnqueueBulkWithToken(prodToken, elements, count, success)
\/ \E element \in Elements, success \in BOOLEAN :
QueueTryDequeue(element, success)
\/ \E consToken \in Threads, element \in Elements, success \in BOOLEAN :
QueueTryDequeueWithToken(consToken, element, success)
\* \/ \E consToken \in Threads, element \in Elements, success \in BOOLEAN :
\* QueueTryDequeueWithToken(consToken, element, success)
\/ \E elements \in [1..MaxBulkSize -> Elements], max \in 1..MaxBulkSize, count \in 0..MaxBulkSize :
QueueTryDequeueBulk(elements, max, count)
\/ \E consToken \in Threads, elements \in [1..MaxBulkSize -> Elements], max \in 1..MaxBulkSize, count \in 0..MaxBulkSize :
QueueTryDequeueBulkWithToken(consToken, elements, max, count)
\* \/ \E consToken \in Threads, elements \in [1..MaxBulkSize -> Elements], max \in 1..MaxBulkSize, count \in 0..MaxBulkSize :
\* QueueTryDequeueBulkWithToken(consToken, elements, max, count)
\/ \E prodToken \in Threads, element \in Elements, success \in BOOLEAN :
QueueTryDequeueFromProducer(prodToken, element, success)
\/ \E prodToken \in Threads, elements \in [1..MaxBulkSize -> Elements], max \in 1..MaxBulkSize, count \in 0..MaxBulkSize :
QueueTryDequeueBulkFromProducer(prodToken, elements, max, count)
\* \/ \E prodToken \in Threads, elements \in [1..MaxBulkSize -> Elements], max \in 1..MaxBulkSize, count \in 0..MaxBulkSize :
\* QueueTryDequeueBulkFromProducer(prodToken, elements, max, count)
\/ \E size \in 0..MaxElements :
QueueSizeApprox(size)
\/ \E thread \in Threads :
CreateProducerToken(thread)
\/ \E thread \in Threads :
CreateConsumerToken(thread)


QueueInvariant ==
Expand Down
21 changes: 21 additions & 0 deletions omnilink/concurrentqueue/MCConcurrentQueueAPIValidate.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
INIT Init
NEXT Next

CONSTANTS
Elements <- ElementsImpl
Threads <- ThreadsImpl

MaxElements = 5
MaxBulkSize = 3

INVARIANTS
TypeOK
QueueInvariant
NoLostElements

ALIAS DebugAlias
POSTCONDITION PostCondition
CHECK_DEADLOCK FALSE

VIEW PragmaticView

39 changes: 39 additions & 0 deletions omnilink/concurrentqueue/MCConcurrentQueueAPIValidate.tla
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---- MODULE MCConcurrentQueueAPIValidate ----
EXTENDS ConcurrentQueueAPIValidate, TLC, TLCExt, Sequences, FiniteSets

ElementsImpl == TLCCache(UNION UNION { {
LET __rec == __traces[t][i]
IN IF "element" \in DOMAIN __rec.operation
THEN {__rec.operation.element}
ELSE IF "elements" \in DOMAIN __rec.operation
THEN {__rec.operation.elements[j] : j \in DOMAIN __rec.operation.elements}
ELSE {}
: i \in DOMAIN __traces[t] }
: t \in DOMAIN __traces }, {"ElementsImpl"})

ThreadsImpl == TLCCache(UNION UNION { {
LET __rec == __traces[t][i]
IN IF "prodToken" \in DOMAIN __rec.operation
THEN {__rec.operation.prodToken}
ELSE IF "consToken" \in DOMAIN __rec.operation
THEN {__rec.operation.consToken}
ELSE {}
: i \in DOMAIN __traces[t] }
: t \in DOMAIN __traces }, {"ThreadsImpl"})


DebugAlias == __TraceOps!DebugAlias
PostCondition == __TraceOps!PostCondition

TypeOK == __Spec!TypeOK
QueueInvariant == __Spec!QueueInvariant
NoLostElements == __Spec!NoLostElements

PragmaticView ==
[
__pc |-> __pc,
queue_len |-> Len(queue)
]

====

31 changes: 31 additions & 0 deletions omnilink/concurrentqueue/flake.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
description = "OmniLink ConcurrentQueue Stressor";

inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
concurrentqueue.url = ./versions;
concurrentqueue.inputs.nixpkgs.follows = "nixpkgs";
};

outputs = { nixpkgs, concurrentqueue, ... }:
let
pkgs = nixpkgs.legacyPackages.x86_64-linux;
forCQVersion = { version, cq }: pkgs.stdenv.mkDerivation {
version = version;
pname = "concurrentqueue-stressor";
buildInputs = [
cq
pkgs.msgpack-cxx
];
nativeBuildInputs = [
pkgs.cmake
];
};
in {
systems = [ "x86_64-linux" ];
packages.x86_64-linux.v1_0_4 = forCQVersion {
version = "1.0.4";
cq = concurrentqueue.packages.x86_64-linux.v1_0_4;
};
};
}
Loading
Loading