jaulib v1.3.0
Jau Support Library (C++, Java, ..)
test_mm_sc_drf_01.cpp

Testing SC-DRF non-atomic global read and write within a locked mutex critical block.

Testing SC-DRF non-atomic global read and write within a locked mutex critical block.

With test_mm_sc_drf_00.cpp, this work laid the groundwork for jau::sc_atomic_critical and jau::ringbuffer

/*
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2020 Gothel Software e.K.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <cassert>
#include <cinttypes>
#include <cstring>
#include <atomic>
#include <mutex>
#include <condition_variable>
#include <memory>
#include <thread>
#include <pthread.h>
using namespace jau;
static int loops = 10;
/**
* test_mm_sc_drf_01: Testing SC-DRF non-atomic global read and write within a locked mutex critical block.
* <p>
* Modified non-atomic memory within the locked mutex acquire and release block,
* must be visible for all threads according to memory model (MM) Sequentially Consistent (SC) being data-race-free (DRF).
* <br>
* See Herb Sutter's 2013-12-23 slides p19, first box "It must be impossible for the assertion to fail – wouldn’t be SC.".
* </p>
* See 'test_mm_sc_drf_00' implementing same test using an atomic acquire/release critical block with spin-lock.
*/
private:
enum Defaults : int {
array_size = 10
};
constexpr int number(const Defaults rhs) noexcept {
return static_cast<int>(rhs);
}
int value1 = 0;
int array[array_size] = { 0 };
std::mutex mtx_value;
std::condition_variable cvRead;
std::condition_variable cvWrite;
void reset(int v1, int array_value) {
std::unique_lock<std::mutex> lock(mtx_value); // SC-DRF acquire and release @ scope exit
value1 = v1;
for(int & i : array) {
i = array_value;
}
}
void putThreadType01(int _len, int startValue) {
const int len = std::min(number(array_size), _len);
{
std::unique_lock<std::mutex> lock(mtx_value); // SC-DRF acquire and release @ scope exit
for(int i=0; i<len; i++) {
array[i] = startValue+i;
}
value1 = startValue;
cvRead.notify_all(); // notify waiting getter
}
}
void getThreadType01(const std::string& msg, int _len, int startValue) {
const int len = std::min(number(array_size), _len);
std::unique_lock<std::mutex> lock(mtx_value); // SC-DRF acquire and release @ scope exit
while( startValue != value1 ) {
cvRead.wait(lock);
}
REQUIRE_MSG(msg+": %s: value at read value1 (start)", startValue == value1);
for(int i=0; i<len; i++) {
int v = array[i];
REQUIRE_MSG(msg+": %s: start value at read array #"+std::to_string(i), (startValue+i) == v);
}
}
void putThreadType11(int indexAndValue) {
const int idx = std::min(number(array_size)-1, indexAndValue);
{
// idx is encoded on sync_value (v) as follows
// v > 0: get @ idx = v -1
// v < 0: put @ idx = abs(v) -1
std::unique_lock<std::mutex> lock(mtx_value); // SC-DRF acquire and release @ scope exit
// SC-DRF acquire atomic with spin-lock waiting for encoded idx
while( idx != (value1 * -1) - 1 ) {
cvWrite.wait(lock);
}
// INFO_STR("putThreadType11.done @ %d (has %d, exp %d)\n", idx, value1, (idx+1)*-1);
value1 = idx;
array[idx] = idx; // last written checked first, SC-DRF should handle...
cvRead.notify_all();
}
}
void getThreadType11(const std::string& msg, int _idx) {
const int idx = std::min(number(array_size)-1, _idx);
// idx is encoded on sync_value (v) as follows
// v > 0: get @ idx = v -1
// v < 0: put @ idx = abs(v) -1
// SC-DRF acquire atomic with spin-lock waiting for idx
std::unique_lock<std::mutex> lock(mtx_value);
while( idx != value1 ) {
// INFO_STR("getThreadType11.wait for has %d == exp %d\n", value1, idx);
cvRead.wait(lock);
}
REQUIRE_MSG(msg+": %s: value at read array (idx), idx "+std::to_string(idx), idx == array[idx]); // check last-written first
REQUIRE_MSG(msg+": %s: value at read value1 (idx), idx "+std::to_string(idx), idx == value1);
// next write encoded idx
int next_idx = (idx+1)%array_size;
next_idx = ( next_idx + 1 ) * -1;
// INFO_STR("getThreadType11.done for %d, next %d (v %d)\n", idx, (idx+1)%array_size, next_idx);
value1 = next_idx;
cvWrite.notify_all();
}
public:
: value1(0) {}
INFO_STR("\n\ntest01_Read1Write1.a\n");
reset(0, 1010);
std::thread getThread01(&TestMemModelSCDRF01::getThreadType01, this, "test01.get01", array_size, 3); // @suppress("Invalid arguments")
std::thread putThread01(&TestMemModelSCDRF01::putThreadType01, this, array_size, 3); // @suppress("Invalid arguments")
putThread01.join();
getThread01.join();
}
INFO_STR("\n\ntest01_Read2Write1.a\n");
reset(0, 1021);
{
std::thread getThread00(&TestMemModelSCDRF01::getThreadType01, this, "test01.get00", array_size, 4); // @suppress("Invalid arguments")
std::thread getThread01(&TestMemModelSCDRF01::getThreadType01, this, "test01.get01", array_size, 4); // @suppress("Invalid arguments")
std::thread putThread01(&TestMemModelSCDRF01::putThreadType01, this, array_size, 4); // @suppress("Invalid arguments")
putThread01.join();
getThread00.join();
getThread01.join();
}
INFO_STR("\n\ntest01_Read2Write1.b\n");
reset(0, 1022);
{
std::thread putThread01(&TestMemModelSCDRF01::putThreadType01, this, array_size, 5); // @suppress("Invalid arguments")
std::thread getThread00(&TestMemModelSCDRF01::getThreadType01, this, "test01.get00", array_size, 5); // @suppress("Invalid arguments")
std::thread getThread01(&TestMemModelSCDRF01::getThreadType01, this, "test01.get01", array_size, 5); // @suppress("Invalid arguments")
putThread01.join();
getThread00.join();
getThread01.join();
}
}
INFO_STR("\n\ntest02_Read4Write1\n");
reset(0, 1030);
std::thread getThread01(&TestMemModelSCDRF01::getThreadType01, this, "test02.get01", array_size, 6); // @suppress("Invalid arguments")
std::thread getThread02(&TestMemModelSCDRF01::getThreadType01, this, "test02.get02", array_size, 6); // @suppress("Invalid arguments")
std::thread putThread01(&TestMemModelSCDRF01::putThreadType01, this, array_size, 6); // @suppress("Invalid arguments")
std::thread getThread03(&TestMemModelSCDRF01::getThreadType01, this, "test02.get03", array_size, 6); // @suppress("Invalid arguments")
std::thread getThread04(&TestMemModelSCDRF01::getThreadType01, this, "test02.get04", array_size, 6); // @suppress("Invalid arguments")
putThread01.join();
getThread01.join();
getThread02.join();
getThread03.join();
getThread04.join();
}
INFO_STR("\n\ntest11_Read10Write10\n");
reset(-1, 1110);
std::thread reader[array_size];
std::thread writer[array_size];
for(int i=0; i<number(array_size); i++) {
reader[i] = std::thread(&TestMemModelSCDRF01::getThreadType11, this, "test11.get11", i); // @suppress("Invalid arguments") // @suppress("Symbol is not resolved")
}
for(int i=0; i<number(array_size); i++) {
writer[i] = std::thread(&TestMemModelSCDRF01::putThreadType11, this, i); // @suppress("Invalid arguments") // @suppress("Symbol is not resolved")
}
for(int i=0; i<number(array_size); i++) {
writer[i].join();
}
for(int i=0; i<number(array_size); i++) {
reader[i].join();
}
}
INFO_STR("\n\ntest12_Read10Write10\n");
reset(-1, 1120);
std::thread reader[array_size];
std::thread writer[array_size];
for(int i=0; i<number(array_size); i++) {
writer[i] = std::thread(&TestMemModelSCDRF01::putThreadType11, this, i); // @suppress("Invalid arguments") // @suppress("Symbol is not resolved")
}
for(int i=0; i<number(array_size); i++) {
reader[i] = std::thread(&TestMemModelSCDRF01::getThreadType11, this, "test12.get11", i); // @suppress("Invalid arguments") // @suppress("Symbol is not resolved")
}
for(int i=0; i<number(array_size); i++) {
writer[i].join();
}
for(int i=0; i<number(array_size); i++) {
reader[i].join();
}
}
void test_list() {
for(int i=loops; i>0; i--) { test01_Read1Write1(); }
for(int i=loops; i>0; i--) { test02_Read2Write1(); }
for(int i=loops; i>0; i--) { test03_Read4Write1(); }
for(int i=loops; i>0; i--) { test11_Read10Write10(); }
for(int i=loops; i>0; i--) { test12_Read10Write10(); }
}
};
METHOD_AS_TEST_CASE( TestMemModelSCDRF01::test_list, "Test TestMemModelSCDRF 01- test_list");
#define INFO_STR(msg)
Definition: catch2_ext.hpp:75
#define REQUIRE_MSG(MSG,...)
Definition: catch2_ext.hpp:58
test_mm_sc_drf_01: Testing SC-DRF non-atomic global read and write within a locked mutex critical blo...
std::string to_string(const alphabet &v) noexcept
Definition: base_codec.hpp:97
constexpr T min(const T x, const T y) noexcept
Returns the minimum of two integrals (w/ branching) in O(1)
Definition: base_math.hpp:177
__pack(...): Produces MSVC, clang and gcc compatible lead-in and -out macros.
Definition: backtrace.hpp:32
static int loops
METHOD_AS_TEST_CASE(TestMemModelSCDRF01::test_list, "Test TestMemModelSCDRF 01- test_list")