[sanitizer_common][tests] Fix SanitizerCommon-Unit :: ./Sanitizer-*-Test/SanitizerCommon.PthreadDestructorIterations on Solaris

[ro]

Summary

SanitizerCommon.PthreadDestructorIterations currently FAILs on Solaris:

[ RUN      ] SanitizerCommon.PthreadDestructorIterations
/vol/llvm/src/compiler-rt/local/lib/sanitizer_common/tests/sanitizer_posix_test.cc:58: Failure
Value of: destructor_executed
  Actual: true
Expected: false
[  FAILED  ] SanitizerCommon.PthreadDestructorIterations (1 ms)

It turns out that destructor is called 4 times after the first call to SpawnThread, but
5 times after the second. While PTHREAD_DESTRUCTOR_ITERATIONS is 4 in
<limits.h>, the Solaris pthread_key_create(3C) man page documents

If, after all the destructors have been called for all keys  with  non-
null  values,  there  are  still  some  keys  with non-null values, the
process will be repeated. POSIX requires that this process be  executed
at   least   PTHREAD_DESTRUCTOR_ITERATIONS  times.  Solaris  calls  the
destructors repeatedly until all values with associated destructors are
NULL. Destructors that set new values can cause an infinite loop.

The patch adjusts the test case to allow for this.

Tested on x86_64-pc-solaris2.11. Ok for trunk?

[ro]

Ping? It's been a week and the behaviour of Solaris pthread_key_create is allowed by the spec.

[ro]

This comment was removed by ro.

[ro]

This comment was removed by ro.

[ro]

Ping? It's been a week and the behaviour of Solaris pthread_key_create is allowed by the spec.

[ro]

Rebased after .cc -> .cpp mass renamings.

lib/sanitizer_common/tests/sanitizer_posix_test.cpp

static void SpawnThread(uptr iteration) {
   ASSERT_EQ(0, retval);
 }
 
 TEST(SanitizerCommon, PthreadDestructorIterations) {
   ASSERT_EQ(0, pthread_key_create(&key, &destructor));
   SpawnThread(GetPthreadDestructorIterations());
   EXPECT_TRUE(destructor_executed);
   SpawnThread(GetPthreadDestructorIterations() + 1);
+#if SANITIZER_SOLARIS
+  // Solaris continues calling destructors beyond PTHREAD_DESTRUCTOR_ITERATIONS.
+  EXPECT_TRUE(destructor_executed);
+#else
   EXPECT_FALSE(destructor_executed);
+#endif
   ASSERT_EQ(0, pthread_key_delete(key));
 }
 
 TEST(SanitizerCommon, IsAccessibleMemoryRange) {
   const int page_size = GetPageSize();
   uptr mem = (uptr)mmap(0, 3 * page_size, PROT_READ | PROT_WRITE,
                         MAP_PRIVATE | MAP_ANON, -1, 0);
   // Protect the middle page.