1
0
forked from 0ad/0ad
0ad/source/lib/tests/test_lockfree.h

282 lines
7.2 KiB
C++

/* Copyright (c) 2010 Wildfire Games
*
* 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 "lib/self_test.h"
#include "lib/lockfree.h"
#include "lib/sysdep/cpu.h" // atomic_add
#include "lib/timer.h"
#include "lib/rand.h"
// make sure the data structures work at all; doesn't test thread-safety.
class TestLockfreeBasic : public CxxTest::TestSuite
{
public:
// note: the lockfree module is no longer part of the build, but cxxtestgen
// still sees this class and its methods despite them being commented out
// (#if 0 doesn't help, either). we therefore need to disable their bodies.
#if 0
void setUp()
{
lockfree_Init();
}
void tearDown()
{
lockfree_Shutdown();
}
#endif
void test_basic_single_threaded()
{
#if 0
void* user_data;
const size_t ENTRIES = 50;
// should be more than max # retired nodes to test release..() code
uintptr_t key = 0x1000;
size_t sig = 10;
LFList list;
TS_ASSERT_OK(lfl_init(&list));
LFHash hash;
TS_ASSERT_OK(lfh_init(&hash, 8));
// add some entries; store "signatures" (ascending int values)
for(size_t i = 0; i < ENTRIES; i++)
{
int was_inserted;
user_data = lfl_insert(&list, key+i, sizeof(int), &was_inserted);
TS_ASSERT(user_data != 0 && was_inserted);
*(size_t*)user_data = sig+i;
user_data = lfh_insert(&hash, key+i, sizeof(int), &was_inserted);
TS_ASSERT(user_data != 0 && was_inserted);
*(size_t*)user_data = sig+i;
}
// make sure all "signatures" are present in list
for(size_t i = 0; i < ENTRIES; i++)
{
user_data = lfl_find(&list, key+i);
TS_ASSERT(user_data != 0);
TS_ASSERT_EQUALS(*(size_t*)user_data, sig+i);
user_data = lfh_find(&hash, key+i);
TS_ASSERT(user_data != 0);
TS_ASSERT_EQUALS(*(size_t*)user_data, sig+i);
}
lfl_free(&list);
lfh_free(&hash);
#endif
}
};
// known to fail on P4 due to mem reordering and lack of membars.
class TestMultithread : public CxxTest::TestSuite
{
#if 0
void setUp()
{
lockfree_Init();
}
void tearDown()
{
lockfree_Shutdown();
}
// poor man's synchronization "barrier"
bool is_complete;
intptr_t num_active_threads;
LFList list;
LFHash hash;
typedef std::set<uintptr_t> KeySet;
typedef KeySet::const_iterator KeySetIt;
KeySet keys;
pthread_mutex_t mutex; // protects <keys>
struct ThreadFuncParam
{
TestMultithread* this_;
uintptr_t thread_number;
ThreadFuncParam(TestMultithread* this__, uintptr_t thread_number_)
: this_(this__), thread_number(thread_number_) {}
};
static void* thread_func(void* arg)
{
debug_SetThreadName("LF_test");
ThreadFuncParam* param = (ThreadFuncParam*)arg;
TestMultithread* this_ = param->this_;
const uintptr_t thread_number = param->thread_number;
cpu_AtomicAdd(&this_->num_active_threads, 1);
// chosen randomly every iteration (int_value % 4)
enum TestAction
{
TA_FIND = 0,
TA_INSERT = 1,
TA_ERASE = 2,
TA_SLEEP = 3
};
static const wchar_t* const action_strings[] =
{
L"find", L"insert", L"erase", L"sleep"
};
while(!this_->is_complete)
{
void* user_data;
const size_t action = rand(0, 4);
const uintptr_t key = (uintptr_t)rand(0, 100);
const size_t sleep_duration_ms = rand(0, 100);
debug_printf(L"thread %d: %ls\n", thread_number, action_strings[action]);
//
pthread_mutex_lock(&this_->mutex);
const bool was_in_set = this_->keys.find(key) != this_->keys.end();
if(action == TA_INSERT)
this_->keys.insert(key);
else if(action == TA_ERASE)
this_->keys.erase(key);
pthread_mutex_unlock(&this_->mutex);
switch(action)
{
case TA_FIND:
{
user_data = lfl_find(&this_->list, key);
TS_ASSERT(was_in_set == (user_data != 0));
if(user_data)
TS_ASSERT_EQUALS(*(uintptr_t*)user_data, ~key);
user_data = lfh_find(&this_->hash, key);
// typical failure site if lockfree data structure has bugs.
TS_ASSERT(was_in_set == (user_data != 0));
if(user_data)
TS_ASSERT_EQUALS(*(uintptr_t*)user_data, ~key);
}
break;
case TA_INSERT:
{
int was_inserted;
user_data = lfl_insert(&this_->list, key, sizeof(uintptr_t), &was_inserted);
TS_ASSERT(user_data != 0); // only triggers if out of memory
*(uintptr_t*)user_data = ~key; // checked above
TS_ASSERT(was_in_set == !was_inserted);
user_data = lfh_insert(&this_->hash, key, sizeof(uintptr_t), &was_inserted);
TS_ASSERT(user_data != 0); // only triggers if out of memory
*(uintptr_t*)user_data = ~key; // checked above
TS_ASSERT(was_in_set == !was_inserted);
}
break;
case TA_ERASE:
{
int err;
err = lfl_erase(&this_->list, key);
TS_ASSERT(was_in_set == (err == INFO::OK));
err = lfh_erase(&this_->hash, key);
TS_ASSERT(was_in_set == (err == INFO::OK));
}
break;
case TA_SLEEP:
usleep(useconds_t(sleep_duration_ms*1000));
break;
default:
TS_FAIL(L"invalid TA_* action");
break;
} // switch
} // while !is_complete
cpu_AtomicAdd(&this_->num_active_threads, -1);
TS_ASSERT(this_->num_active_threads >= 0);
delete param;
return 0;
}
public:
TestMultithread()
: is_complete(false), num_active_threads(0),
list(), hash()
{
pthread_mutex_init(&mutex, NULL);
}
void disabled_due_to_failure_on_p4_test_multithread()
{
// this test is randomized; we need deterministic results.
srand(1);
static const double TEST_LENGTH = 30.; // [seconds]
const double end_time = timer_Time() + TEST_LENGTH;
is_complete = false;
TS_ASSERT_OK(lfl_init(&list));
TS_ASSERT_OK(lfh_init(&hash, 128));
TS_ASSERT_OK(pthread_mutex_init(&mutex, 0));
// spin off test threads (many, to force preemption)
const size_t NUM_THREADS = 16;
for(uintptr_t i = 0; i < NUM_THREADS; i++)
{
ThreadFuncParam* param = new ThreadFuncParam(this, i);
pthread_t thread; // unused, but GCC raises warning if 0 is passed
pthread_create(&thread, 0, thread_func, param);
}
// wait until time interval elapsed (if we get that far, all is well).
while(timer_Time() < end_time)
usleep(10*1000);
// signal and wait for all threads to complete (poor man's barrier -
// those aren't currently implemented in wpthread).
is_complete = true;
while(num_active_threads > 0)
usleep(5*1000);
lfl_free(&list);
lfh_free(&hash);
TS_ASSERT_OK(pthread_mutex_destroy(&mutex));
}
#endif
};