sync/test/run/thread_specific_ptr.cpp

// Copyright (C) 2001-2003
// William E. Kempf
// Copyright (C) 2007 Anthony Williams
// Copyright (C) 2013 Andrey Semashev
//
//  Distributed under the Boost Software License, Version 1.0. (See accompanying
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#include <cstddef>
#include <new>
#include <iostream>
#include <boost/aligned_storage.hpp>
#include <boost/core/lightweight_test.hpp>
#include <boost/thread/thread.hpp>
#include <boost/sync/detail/config.hpp>
#include <boost/sync/thread_specific/thread_specific_ptr.hpp>
#include <boost/sync/mutexes/mutex.hpp>
#include <boost/sync/locks/lock_guard.hpp>
#include "utils.hpp"

#if defined(BOOST_SYNC_DETAIL_PLATFORM_WINAPI)
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#else
#include <pthread.h>
#endif

boost::sync::mutex check_mutex;
boost::sync::mutex tss_mutex;
int tss_instances = 0;
int tss_total = 0;

struct tss_value_t
{
    tss_value_t()
    {
        boost::sync::lock_guard<boost::sync::mutex> lock(tss_mutex);
        ++tss_instances;
        ++tss_total;
        value = 0;
    }

    ~tss_value_t()
    {
        boost::sync::lock_guard<boost::sync::mutex> lock(tss_mutex);
        --tss_instances;
    }

    int value;
};

boost::sync::thread_specific_ptr<tss_value_t> tss_value;

void test_tss_thread()
{
    tss_value.reset(new tss_value_t());
    for (int i=0; i<1000; ++i)
    {
        int& n = tss_value->value;
        if (n != i)
        {
            // Don't call BOOST_TEST_EQ directly, as it's not thread-safe.
            boost::sync::lock_guard<boost::sync::mutex> lock(check_mutex);
            BOOST_TEST_EQ(n, i);
        }
        ++n;
    }
}

#if defined(BOOST_SYNC_DETAIL_PLATFORM_WINAPI)

typedef HANDLE native_thread_t;

DWORD WINAPI test_tss_thread_native(LPVOID /*lpParameter*/)
{
    test_tss_thread();
    return 0;
}

native_thread_t create_native_thread(void)
{
    native_thread_t const res=CreateThread
    (
        0, //security attributes (0 = not inheritable)
        0, //stack size (0 = default)
        &test_tss_thread_native, //function to execute
        0, //parameter to pass to function
        0, //creation flags (0 = run immediately)
        0  //thread id (0 = thread id not returned)
    );
    BOOST_TEST(res!=0);
    return res;
}

void join_native_thread(native_thread_t thread)
{
    DWORD res = WaitForSingleObject(thread, INFINITE);
    BOOST_TEST(res == WAIT_OBJECT_0);

    res = CloseHandle(thread);
    BOOST_TEST(SUCCEEDED(res));
}

#else // defined(BOOST_SYNC_DETAIL_PLATFORM_WINAPI)

typedef pthread_t native_thread_t;

extern "C"
{
    void* test_tss_thread_native(void*)
    {
        test_tss_thread();
        return 0;
    }
}

native_thread_t create_native_thread()
{
    native_thread_t thread_handle;

    int const res = pthread_create(&thread_handle, 0, &test_tss_thread_native, 0);
    BOOST_TEST(!res);
    return thread_handle;
}

void join_native_thread(native_thread_t thread)
{
    void* result=0;
    int const res = pthread_join(thread, &result);
    BOOST_TEST(!res);
}

#endif // defined(BOOST_SYNC_DETAIL_PLATFORM_WINAPI)

void do_test_tss()
{
    tss_instances = 0;
    tss_total = 0;

    const int NUMTHREADS = 5;
    boost::thread_group threads;
    try
    {
        for (int i = 0; i < NUMTHREADS; ++i)
            threads.create_thread(&test_tss_thread);
        threads.join_all();
    }
    catch(...)
    {
        threads.interrupt_all();
        threads.join_all();
        throw;
    }


    std::cout
        << "tss_instances = " << tss_instances
        << "; tss_total = " << tss_total
        << "\n";
    std::cout.flush();

    BOOST_TEST_EQ(tss_instances, 0);
    BOOST_TEST_EQ(tss_total, 5);

    tss_instances = 0;
    tss_total = 0;

    native_thread_t thread1 = create_native_thread();
    native_thread_t thread2 = create_native_thread();
    native_thread_t thread3 = create_native_thread();
    native_thread_t thread4 = create_native_thread();
    native_thread_t thread5 = create_native_thread();

    join_native_thread(thread5);
    join_native_thread(thread4);
    join_native_thread(thread3);
    join_native_thread(thread2);
    join_native_thread(thread1);

    std::cout
        << "tss_instances = " << tss_instances
        << "; tss_total = " << tss_total
        << "\n";
    std::cout.flush();

    // The following is not really an error. TSS cleanup support still is available for boost threads.
    // Also this usually will be triggered only when bound to the static version of thread lib.
    // 2006-10-02 Roland Schwarz
    //BOOST_TEST_EQ(tss_instances, 0);
    if (tss_instances != 0)
        std::cout << "Support of automatic tss cleanup for native threading API not available" << std::endl;
    BOOST_TEST_EQ(tss_total, 5);
}

void test_tss()
{
    timed_test(&do_test_tss, 2);
}

#if !defined(UBSAN)

// thread_specific_ptr does type erasure as it casts the pointer to the cleanup function to a similar but different pointer to function that receives a void* argument.
// The cleanup function is then called through the casted pointer. UBSan flags this as an error, and in strict C++ it is true. But on all real
// systems this works as intended since the two pointers have exactly the same calling conventions. This optimization allows us to avoid allocating dynamic
// memory and proxying the call through a shim, which will only cast the pointer from void* to T*. This saves dynamic memory, code size and compile time, so we really
// want this optimization. Therefore, disable UBSan for these tests.

bool tss_cleanup_called = false;

struct Dummy
{
};

void tss_custom_cleanup(Dummy* d)
{
    delete d;
    tss_cleanup_called=true;
}

boost::sync::thread_specific_ptr<Dummy> tss_with_cleanup(tss_custom_cleanup);

void tss_thread_with_custom_cleanup()
{
    tss_with_cleanup.reset(new Dummy);
}

void do_test_tss_with_custom_cleanup()
{
    boost::thread t(tss_thread_with_custom_cleanup);
    try
    {
        t.join();
    }
    catch(...)
    {
        t.interrupt();
        t.join();
        throw;
    }

    BOOST_TEST(tss_cleanup_called);
}


void test_tss_with_custom_cleanup()
{
    timed_test(&do_test_tss_with_custom_cleanup, 2);
}

Dummy* tss_object = new Dummy;

void tss_thread_with_custom_cleanup_and_release()
{
    tss_with_cleanup.reset(tss_object);
    tss_with_cleanup.release();
}

void do_test_tss_does_no_cleanup_after_release()
{
    tss_cleanup_called = false;
    boost::thread t(tss_thread_with_custom_cleanup_and_release);
    try
    {
        t.join();
    }
    catch(...)
    {
        t.interrupt();
        t.join();
        throw;
    }

    BOOST_TEST(!tss_cleanup_called);
    if(!tss_cleanup_called)
    {
        delete tss_object;
    }
}

void test_tss_does_no_cleanup_after_release()
{
    timed_test(&do_test_tss_does_no_cleanup_after_release, 2);
}

#endif // !defined(UBSAN)

struct dummy_class_tracks_deletions
{
    static unsigned deletions;

    ~dummy_class_tracks_deletions()
    {
        ++deletions;
    }
};

unsigned dummy_class_tracks_deletions::deletions = 0;

boost::sync::thread_specific_ptr<dummy_class_tracks_deletions> tss_with_null_cleanup(NULL);

void tss_thread_with_null_cleanup(dummy_class_tracks_deletions* delete_tracker)
{
    tss_with_null_cleanup.reset(delete_tracker);
}

void do_test_tss_does_no_cleanup_with_null_cleanup_function()
{
    dummy_class_tracks_deletions* delete_tracker = new dummy_class_tracks_deletions;
    boost::thread t(tss_thread_with_null_cleanup, delete_tracker);
    try
    {
        t.join();
    }
    catch(...)
    {
        t.interrupt();
        t.join();
        throw;
    }

    BOOST_TEST(!dummy_class_tracks_deletions::deletions);
    if(!dummy_class_tracks_deletions::deletions)
    {
        delete delete_tracker;
    }
}

void test_tss_does_no_cleanup_with_null_cleanup_function()
{
    timed_test(&do_test_tss_does_no_cleanup_with_null_cleanup_function, 2);
}

#if !defined(UBSAN)

// See the comment above about why the tests with custom cleanup functions are disabled for UBSan.

void thread_with_local_tss_ptr()
{
    {
        boost::sync::thread_specific_ptr<Dummy> local_tss(tss_custom_cleanup);

        local_tss.reset(new Dummy);
    }
    BOOST_TEST(tss_cleanup_called);
    tss_cleanup_called = false;
}


void test_tss_does_not_call_cleanup_after_ptr_destroyed()
{
    boost::thread t(thread_with_local_tss_ptr);
    t.join();
    BOOST_TEST(!tss_cleanup_called);
}

void test_tss_cleanup_not_called_for_null_pointer()
{
    boost::sync::thread_specific_ptr<Dummy> local_tss(tss_custom_cleanup);
    local_tss.reset(new Dummy);
    tss_cleanup_called = false;
    local_tss.reset(0);
    BOOST_TEST(tss_cleanup_called);
    tss_cleanup_called = false;
    local_tss.reset(new Dummy);
    BOOST_TEST(!tss_cleanup_called);
}

void test_tss_at_the_same_adress()
{
    typedef boost::sync::thread_specific_ptr<Dummy> ptr_t;
    enum { size = sizeof(ptr_t) };
    boost::aligned_storage< size > storage;
    ptr_t* ptr = static_cast< ptr_t* >(storage.address());

    // Create the first pointer
    tss_cleanup_called = false;

    new (ptr) ptr_t(tss_custom_cleanup);
    BOOST_TEST(!tss_cleanup_called);
    BOOST_TEST(ptr->get() == NULL);

    ptr->reset(new Dummy);
    BOOST_TEST(!tss_cleanup_called);
    BOOST_TEST(ptr->get() != NULL);

    ptr->~ptr_t();
    BOOST_TEST(tss_cleanup_called);

    // Create the second pointer at the same address
    tss_cleanup_called = false;

    new (ptr) ptr_t(tss_custom_cleanup);
    BOOST_TEST(!tss_cleanup_called);
    BOOST_TEST(ptr->get() == NULL);

    ptr->~ptr_t();
    BOOST_TEST(!tss_cleanup_called);
}

#endif // !defined(UBSAN)

int main()
{
    test_tss();
#if !defined(UBSAN)
    test_tss_with_custom_cleanup();
    test_tss_does_no_cleanup_after_release();
#endif
    test_tss_does_no_cleanup_with_null_cleanup_function();
#if !defined(UBSAN)
    test_tss_does_not_call_cleanup_after_ptr_destroyed();
    test_tss_cleanup_not_called_for_null_pointer();
    test_tss_at_the_same_adress();
#endif

    return boost::report_errors();
}