File: ThreadLocalWrapper.h

package info (click to toggle)
ausaxs 1.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 72,592 kB
  • sloc: cpp: 49,853; ansic: 6,901; python: 730; makefile: 18
file content (115 lines) | stat: -rw-r--r-- 4,606 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje

#pragma once

#include <settings/GeneralSettings.h>
#include <utility/MultiThreading.h>

#include <type_traits>
#include <utility>
#include <thread>
#include <vector>
#include <functional>
#include <unordered_map>

namespace ausaxs::container {
    template <typename X>
    using base_t = std::remove_cvref_t<X>;

    template <typename T, typename... Args>
    concept ValueConstructible =
        (!std::is_reference_v<T> && !std::is_pointer_v<T>) &&
        std::constructible_from<T, base_t<Args>...> &&
        (std::copy_constructible<base_t<Args>> && ...)
    ;

    /**
     * @brief A simple wrapper around T to keep track of the thread-local instances of T.
     *        This allows access to all the thread-local data from any single thread.
     *        Note that it is assumed that all threads have a longer lifetime than this class.
     *        
     *        ! Making a static instance of this class will cause Windows DLL to deadlock when the program is closed.
     *        ? This is probably due to the threads owning the data no longer existing when this class is destroyed, combined with the FreeLibrary locking the system resources necessary for C++ to solve this. 
     */
    template <typename T>
    class ThreadLocalWrapper {        
        public:
            /**
             * @brief Create a wrapper around T, and create a thread-local instance of T for each thread using the given arguments.
             * 
             * ! This constructor *must* be called from the main thread, otherwise it will not receive its own thread-local instance.
             */
            template <typename... Args>
            requires ValueConstructible<T, Args...>
            ThreadLocalWrapper(Args&&... args) {
                auto ids = utility::multi_threading::get_global_pool()->get_thread_ids();
                for (auto& id : ids) {
                    data.emplace(id, T(args...));
                }
                data.emplace(std::this_thread::get_id(), T(std::move(args)...));
            }

            /**
             * @brief Get the thread-local instance of the wrapped type.
             */
            T& get() {return data.at(std::this_thread::get_id());}

            // @copydoc get()
            const T& get() const {return data.at(std::this_thread::get_id());}

            /**
             * @brief Get the thread-local instances of the wrapped type for all threads.
             */
            std::vector<std::reference_wrapper<T>> get_all() {
                std::vector<std::reference_wrapper<T>> result; result.reserve(data.size());
                for (auto& [id, t] : data) {result.emplace_back(t);}
                return result;
            }

            /**
             * @brief Get the number of thread-local instances of the wrapped type.
             */
            std::size_t size() const {return data.size();}

            /**
             * @brief Reinitialize all thread-local instances of the wrapped type using the given arguments.
             */
            template <typename... Args>
            requires ValueConstructible<T, Args...>
            void reinitialize_all(Args&&... args) {
                for (auto& e : data) {
                    e.second = T(args...);
                }
            }

            /**
             * @brief Merge all thread-local instances of the wrapped type into a single instance.
             */
            T merge() const {
                T result = get();
                auto this_id = std::this_thread::get_id();
                if constexpr (std::ranges::range<T>) {
                    for (const auto& [id, t] : data) {
                        if (id == this_id) {continue;}
                        std::transform(t.begin(), t.end(), result.begin(), result.begin(), std::plus<>());
                    }
                    return result;
                } else {
                    for (const auto& [id, t] : data) {
                        if (id == this_id) {continue;}
                        result += t;
                    }
                    return result;
                }
            }

        private:
            std::unordered_map<std::thread::id, T> data;
    };

    static_assert(!std::is_constructible<ThreadLocalWrapper<int&>>::value);
    static_assert(!std::is_constructible<ThreadLocalWrapper<int*>>::value);    
    static_assert(!std::is_constructible<ThreadLocalWrapper<const int&>>::value);
    static_assert(!std::is_constructible<ThreadLocalWrapper<const int*>>::value);    
}