mirror of
https://github.com/minetest/minetest.git
synced 2024-08-19 21:14:15 +02:00
Add unittest to check thread_local destructor brokenness
This commit is contained in:
parent
6550bc252f
commit
3fbe42c3a2
@ -20,6 +20,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
#include "test.h"
|
||||
|
||||
#include <atomic>
|
||||
#include <iostream>
|
||||
#include "threading/semaphore.h"
|
||||
#include "threading/thread.h"
|
||||
|
||||
@ -32,6 +33,7 @@ public:
|
||||
|
||||
void testStartStopWait();
|
||||
void testAtomicSemaphoreThread();
|
||||
void testTLS();
|
||||
};
|
||||
|
||||
static TestThreading g_test_instance;
|
||||
@ -40,6 +42,7 @@ void TestThreading::runTests(IGameDef *gamedef)
|
||||
{
|
||||
TEST(testStartStopWait);
|
||||
TEST(testAtomicSemaphoreThread);
|
||||
TEST(testTLS);
|
||||
}
|
||||
|
||||
class SimpleTestThread : public Thread {
|
||||
@ -156,3 +159,86 @@ void TestThreading::testAtomicSemaphoreThread()
|
||||
UASSERT(val == num_threads * 0x10000);
|
||||
}
|
||||
|
||||
|
||||
|
||||
static volatile bool g_tls_broken;
|
||||
|
||||
class TLSTestThread : public Thread {
|
||||
public:
|
||||
TLSTestThread() : Thread("TLSTest")
|
||||
{
|
||||
}
|
||||
|
||||
private:
|
||||
struct TestObject {
|
||||
TestObject() {
|
||||
for (u32 i = 0; i < buffer_size; i++)
|
||||
buffer[i] = (i % 2) ? 0xa1 : 0x1a;
|
||||
}
|
||||
~TestObject() {
|
||||
for (u32 i = 0; i < buffer_size; i++) {
|
||||
const u8 expect = (i % 2) ? 0xa1 : 0x1a;
|
||||
if (buffer[i] != expect) {
|
||||
std::cout << "At offset " << i << " expected " << (int)expect
|
||||
<< " but found " << (int)buffer[i] << std::endl;
|
||||
g_tls_broken = true;
|
||||
break;
|
||||
}
|
||||
// If we're unlucky the loop might actually just crash.
|
||||
// probably the user will realize the test failure :)
|
||||
}
|
||||
}
|
||||
// larger objects seem to surface corruption more easily
|
||||
static constexpr u32 buffer_size = 576;
|
||||
u8 buffer[buffer_size];
|
||||
};
|
||||
|
||||
void *run() {
|
||||
thread_local TestObject foo;
|
||||
while (!stopRequested())
|
||||
sleep_ms(1);
|
||||
return nullptr;
|
||||
}
|
||||
};
|
||||
|
||||
/*
|
||||
What are we actually testing here?
|
||||
|
||||
MinGW with gcc has a long-standing unsolved bug where memory belonging to
|
||||
thread-local variables is freed *before* the destructors are called.
|
||||
Needless to say this leads to unreliable crashes whenever a thread exits.
|
||||
It does not affect MSVC or MinGW+clang and as far as we know no other platforms
|
||||
are affected either.
|
||||
|
||||
Related reports and information:
|
||||
* <https://sourceforge.net/p/mingw-w64/bugs/727/> (2018)
|
||||
* <https://github.com/msys2/MINGW-packages/issues/2519> (2017)
|
||||
* <https://gcc.gnu.org/bugzilla/show_bug.cgi?id=58142> maybe
|
||||
|
||||
Note that this is different from <https://sourceforge.net/p/mingw-w64/bugs/527/>,
|
||||
which affected only 32-bit MinGW. It was caused by incorrect calling convention
|
||||
and fixed in GCC in 2020.
|
||||
|
||||
Occurrences in Minetest:
|
||||
* <https://github.com/minetest/minetest/issues/10137> (2020)
|
||||
* <https://github.com/minetest/minetest/issues/12022> (2022)
|
||||
* <https://github.com/minetest/minetest/issues/14140> (2023)
|
||||
*/
|
||||
void TestThreading::testTLS()
|
||||
{
|
||||
static const int num_threads = 10;
|
||||
|
||||
for (int j = 0; j < num_threads; j++) {
|
||||
g_tls_broken = false;
|
||||
|
||||
TLSTestThread thread;
|
||||
thread.start();
|
||||
thread.stop();
|
||||
thread.wait();
|
||||
|
||||
if (g_tls_broken) {
|
||||
std::cout << "While running test thread " << j << std::endl;
|
||||
UASSERT(!g_tls_broken);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user