Skip to content

Added lockfree bounded MPMC queue (Vyukov/Strauss-style) with unique_ptr wrapper, GTest suite, and sanitizer builds #11

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
toshit3q34 merged 3 commits into from
Jun 21, 2026
Merged

Added lockfree bounded MPMC queue (Vyukov/Strauss-style) with unique_ptr wrapper, GTest suite, and sanitizer builds #11

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
5292d50
Add files via upload
Aryan810 Jun 3, 2026
b3687ff
Update tests.yaml to modify MPMC and remove MPSC
Aryan810 Jun 3, 2026
5f78e9e
Added -mcx16 Flag, so that this works on Github Workflows.
Aryan810 Jun 9, 2026
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
22 changes: 6 additions & 16 deletions .github/workflows/tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,6 @@ jobs:
echo "run_spsc=true" >> $GITHUB_OUTPUT
fi

# MPSC
if echo "$CHANGED_FILES" | grep -E "lockfree_mpsc"; then
echo "run_mpsc=true" >> $GITHUB_OUTPUT
fi

# MPMC
if echo "$CHANGED_FILES" | grep -E "lockfree_mpmc|blocking_mpmc"; then
echo "run_mpmc=true" >> $GITHUB_OUTPUT
Expand All @@ -53,11 +48,7 @@ jobs:
echo "run_spsc=true" >> $GITHUB_OUTPUT
fi

if echo "$CHANGED_FILES" | grep -E "test_mpsc.cpp"; then
echo "run_mpsc=true" >> $GITHUB_OUTPUT
fi

if echo "$CHANGED_FILES" | grep -E "test_mpmc.cpp"; then
if echo "$CHANGED_FILES" | grep -E "test_mpmc_unbounded_blocking.cpp|test_mpmc_bounded_lockfree.cpp"; then
echo "run_mpmc=true" >> $GITHUB_OUTPUT
fi

Expand Down Expand Up @@ -87,14 +78,13 @@ jobs:
if: steps.changes.outputs.run_spsc == 'true'
run: cd build && ./test_spsc

- name: Run MPSC tests
if: steps.changes.outputs.run_mpsc == 'true'
run: cd build && ./test_mpsc

- name: Run MPMC tests
if: steps.changes.outputs.run_mpmc == 'true'
run: cd build && ./test_mpmc
run: |
cd build
./test_mpmc_unbounded_blocking
./test_mpmc_bounded_lockfree

# 🔹 Safety net (always runs)
- name: Run full test suite (safety)
run: cd build && ctest --output-on-failure
run: cd build && ctest --output-on-failure
57 changes: 47 additions & 10 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,69 @@ cmake_minimum_required(VERSION 3.14)
project(ThreadsafeQueueLib)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
enable_testing()

find_package(Threads REQUIRED)
find_package(GTest REQUIRED)
include_directories(include)

option(ENABLE_TSAN "Enable ThreadSanitizer" OFF)
# ---------------------------------------------------------------------------
# Sanitizer options. Only one of TSAN / ASAN can be active per build.
# cmake -DENABLE_TSAN=ON .. -> ThreadSanitizer (data races)
# cmake -DENABLE_ASAN=ON .. -> AddressSanitizer (UAF, leaks, OOB)
# cmake -DENABLE_UBSAN=ON .. -> UndefinedBehaviorSanitizer
# Sanitizer builds use -O1 -g -fno-omit-frame-pointer for usable stacks.
# ---------------------------------------------------------------------------
option(ENABLE_TSAN "Enable ThreadSanitizer" OFF)
option(ENABLE_ASAN "Enable AddressSanitizer" OFF)
option(ENABLE_UBSAN "Enable UndefinedBehaviorSanitizer" OFF)

if(ENABLE_TSAN AND ENABLE_ASAN)
message(FATAL_ERROR "TSAN and ASAN cannot be enabled together; pick one")
endif()

if(ENABLE_TSAN)
add_compile_options(-fsanitize=thread -g -O1)
message(STATUS "ThreadSanitizer enabled")
add_compile_options(-fsanitize=thread -O1 -g -fno-omit-frame-pointer)
add_link_options(-fsanitize=thread)
add_compile_definitions(TSFQUEUE_TSAN_BUILD=1)
endif()

if(ENABLE_ASAN)
message(STATUS "AddressSanitizer enabled")
add_compile_options(-fsanitize=address -O1 -g -fno-omit-frame-pointer)
add_link_options(-fsanitize=address)
endif()

if(ENABLE_UBSAN)
message(STATUS "UndefinedBehaviorSanitizer enabled")
add_compile_options(-fsanitize=undefined -O1 -g -fno-omit-frame-pointer)
add_link_options(-fsanitize=undefined)
endif()

# ---------------------------------------------------------------------------
# 128-bit atomics (used by lockfree_mpmc_bounded packed entries).
# On x86_64, -mcx16 lets the compiler emit `cmpxchg16b` inline instead of
# generating __sync_*_16 libcalls that require linking libatomic.
# ---------------------------------------------------------------------------
if(CMAKE_SYSTEM_PROCESSOR MATCHES "(x86_64|AMD64)")
add_compile_options(-mcx16)
endif()

# SPSC tests
add_executable(test_spsc tests/test_spsc.cpp)
target_link_libraries(test_spsc GTest::GTest GTest::Main Threads::Threads)

# MPSC tests
add_executable(test_mpsc tests/test_mpsc.cpp)
target_link_libraries(test_mpsc GTest::GTest GTest::Main Threads::Threads)
# MPMC unbounded blocking tests
add_executable(test_mpmc_unbounded_blocking tests/test_mpmc_unbounded_blocking.cpp)
target_link_libraries(test_mpmc_unbounded_blocking GTest::GTest GTest::Main Threads::Threads)

# MPMC tests
add_executable(test_mpmc tests/test_mpmc.cpp)
target_link_libraries(test_mpmc GTest::GTest GTest::Main Threads::Threads)
# MPMC bounded lockfree tests
add_executable(test_mpmc_bounded_lockfree tests/test_mpmc_bounded_lockfree.cpp)
target_link_libraries(test_mpmc_bounded_lockfree GTest::GTest GTest::Main Threads::Threads)

# Register tests
add_test(NAME SPSC COMMAND test_spsc)
add_test(NAME MPSC COMMAND test_mpsc)
add_test(NAME MPMC COMMAND test_mpmc)
add_test(NAME MPMC_UNBOUNDED_BLOCKING COMMAND test_mpmc_unbounded_blocking)
add_test(NAME MPMC_BOUNDED_LOCKFREE COMMAND test_mpmc_bounded_lockfree)
Loading
Loading