summaryrefslogtreecommitdiff
path: root/src/thread_utils.h
blob: 6c0441383c108d8bd8731f828c3892b3985d82c2 (plain)
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
#ifndef MO2_THREAD_UTILS_H
#define MO2_THREAD_UTILS_H

#include <mutex>
#include <thread>

namespace MOShared {

/**
 * Class that can be used to perform thread-safe memoization.
 *
 * Each instance hold a flag indicating if the current value is up-to-date
 * or not. This flag can be reset using `invalidate()`. When the value is queried,
 * the flag is checked, and if it is not up-to-date, the given callback is used
 * to compute the value.
 *
 * The computation and update of the value is locked to avoid concurrent modifications.
 *
 * @tparam T Type of value ot memoized.
 * @tparam Fn Type of the callback.
 */
template <class T, class Fn>
struct MemoizedLocked {

  MemoizedLocked(Fn callback, T value = {}) :
    m_Fn{ callback }, m_Value{ std::move(value) } { }
  
  template <class... Args>
  T& value(Args&&... args) const {
    if (m_NeedUpdating) {
      std::scoped_lock lock(m_Mutex);
      if (m_NeedUpdating) {
        m_Value = std::invoke(m_Fn, std::forward<Args>(args)... );
        m_NeedUpdating.store(false);
      }
    }
    return m_Value;
  }

  void invalidate() const {
    m_NeedUpdating.store(true);
  }

private:
  mutable std::mutex m_Mutex;
  mutable std::atomic<bool> m_NeedUpdating{ true };

  Fn m_Fn;
  mutable T m_Value;
};

/**
 * @brief Apply the given callable to each element between the two given iterators
 *     in a parallel way.
 *
 * The callable should be independent, or properly synchronized, and the source of
 * the range should not change during this call.
 *
 * @param start Beginning of the range.
 * @param end End of the range.
 * @param callable Callable to apply to every element of the range. See std::invoke
 *     requirements. Must be copiable.
 * @param nThreads Number of threads to use.
 *
 */
template <class It, class Callable>
void parallelMap(It begin, It end, Callable callable, std::size_t nThreads) 
{
  std::mutex m;
  std::vector<std::thread> threads(nThreads);

  // Create the thread:
  //  - The mutex is only used to fetch/increment the iterator.
  //  - The callable is copied in each thread to avoid conflicts.
  for (auto &thread: threads) {
    thread = std::thread([&m, &begin, end, callable]() {
      while (true) {
        decltype(begin) it;
        {
          std::scoped_lock lock(m);
          if (begin == end) {
            break;
          }
          it = begin++;
        }
        if (it != end) {
          std::invoke(callable, *it);
        }
      }
    });
  }

  // Join everything:
  for (auto& t : threads) {
    t.join();
  }
}

}

#endif