|
| 1 | +#include <deque> |
| 2 | + |
| 3 | +#ifdef YOSYS_ENABLE_THREADS |
| 4 | +#include <condition_variable> |
| 5 | +#include <mutex> |
| 6 | +#include <thread> |
| 7 | +#endif |
| 8 | + |
| 9 | +#include "kernel/yosys_common.h" |
| 10 | +#include "kernel/log.h" |
| 11 | + |
| 12 | +#ifndef YOSYS_THREADING_H |
| 13 | +#define YOSYS_THREADING_H |
| 14 | + |
| 15 | +YOSYS_NAMESPACE_BEGIN |
| 16 | + |
| 17 | +// Concurrent queue implementation. Not fast, but simple. |
| 18 | +// Multi-producer, multi-consumer, optionally bounded. |
| 19 | +// When YOSYS_ENABLE_THREADS is not defined, this is just a non-thread-safe non-blocking deque. |
| 20 | +template <typename T> |
| 21 | +class ConcurrentQueue |
| 22 | +{ |
| 23 | +public: |
| 24 | + ConcurrentQueue(int capacity = INT_MAX) |
| 25 | + : capacity(capacity) {} |
| 26 | + // Push an element into the queue. If it's at capacity, block until there is room. |
| 27 | + void push_back(T t) |
| 28 | + { |
| 29 | +#ifdef YOSYS_ENABLE_THREADS |
| 30 | + std::unique_lock<std::mutex> lock(mutex); |
| 31 | + not_full_condition.wait(lock, [this] { return static_cast<int>(contents.size()) < capacity; }); |
| 32 | + if (contents.empty()) |
| 33 | + not_empty_condition.notify_one(); |
| 34 | +#endif |
| 35 | + log_assert(!closed); |
| 36 | + contents.push_back(std::move(t)); |
| 37 | +#ifdef YOSYS_ENABLE_THREADS |
| 38 | + if (static_cast<int>(contents.size()) < capacity) |
| 39 | + not_full_condition.notify_one(); |
| 40 | +#endif |
| 41 | + } |
| 42 | + // Signal that no more elements will be produced. `pop_front()` will return nullopt. |
| 43 | + void close() |
| 44 | + { |
| 45 | +#ifdef YOSYS_ENABLE_THREADS |
| 46 | + std::unique_lock<std::mutex> lock(mutex); |
| 47 | + not_empty_condition.notify_all(); |
| 48 | +#endif |
| 49 | + closed = true; |
| 50 | + } |
| 51 | + // Pop an element from the queue. Blocks until an element is available |
| 52 | + // or the queue is closed and empty. |
| 53 | + std::optional<T> pop_front() |
| 54 | + { |
| 55 | + return pop_front_internal(true); |
| 56 | + } |
| 57 | + // Pop an element from the queue. Does not block, just returns nullopt if the |
| 58 | + // queue is empty. |
| 59 | + std::optional<T> try_pop_front() |
| 60 | + { |
| 61 | + return pop_front_internal(false); |
| 62 | + } |
| 63 | +private: |
| 64 | +#ifdef YOSYS_ENABLE_THREADS |
| 65 | + std::optional<T> pop_front_internal(bool wait) |
| 66 | + { |
| 67 | + std::unique_lock<std::mutex> lock(mutex); |
| 68 | + if (wait) { |
| 69 | + not_empty_condition.wait(lock, [this] { return !contents.empty() || closed; }); |
| 70 | + } |
| 71 | +#else |
| 72 | + std::optional<T> pop_front_internal(bool) |
| 73 | + { |
| 74 | +#endif |
| 75 | + if (contents.empty()) |
| 76 | + return std::nullopt; |
| 77 | +#ifdef YOSYS_ENABLE_THREADS |
| 78 | + if (static_cast<int>(contents.size()) == capacity) |
| 79 | + not_full_condition.notify_one(); |
| 80 | +#endif |
| 81 | + T result = std::move(contents.front()); |
| 82 | + contents.pop_front(); |
| 83 | +#ifdef YOSYS_ENABLE_THREADS |
| 84 | + if (!contents.empty()) |
| 85 | + not_empty_condition.notify_one(); |
| 86 | +#endif |
| 87 | + return std::move(result); |
| 88 | + } |
| 89 | + |
| 90 | +#ifdef YOSYS_ENABLE_THREADS |
| 91 | + std::mutex mutex; |
| 92 | + // Signals one waiter thread when the queue changes and is not full. |
| 93 | + std::condition_variable not_full_condition; |
| 94 | + // Signals one waiter thread when the queue changes and is not empty. |
| 95 | + std::condition_variable not_empty_condition; |
| 96 | +#endif |
| 97 | + std::deque<T> contents; |
| 98 | + int capacity; |
| 99 | + bool closed = false; |
| 100 | +}; |
| 101 | + |
| 102 | +class DeferredLogs |
| 103 | +{ |
| 104 | +public: |
| 105 | + template <typename... Args> |
| 106 | + void log(FmtString<TypeIdentity<Args>...> fmt, Args... args) |
| 107 | + { |
| 108 | + logs.push_back({fmt.format(args...), false}); |
| 109 | + } |
| 110 | + template <typename... Args> |
| 111 | + void log_error(FmtString<TypeIdentity<Args>...> fmt, Args... args) |
| 112 | + { |
| 113 | + logs.push_back({fmt.format(args...), true}); |
| 114 | + } |
| 115 | + void flush(); |
| 116 | +private: |
| 117 | + struct Message |
| 118 | + { |
| 119 | + std::string text; |
| 120 | + bool error; |
| 121 | + }; |
| 122 | + std::vector<Message> logs; |
| 123 | +}; |
| 124 | + |
| 125 | +class ThreadPool |
| 126 | +{ |
| 127 | +public: |
| 128 | + // Computes the number of worker threads to use. |
| 129 | + // `reserved_cores` cores are set aside for other threads (e.g. work on the main thread). |
| 130 | + // `max_threads` --- don't return more workers than this. |
| 131 | + // The result may be 0. |
| 132 | + static int pool_size(int reserved_cores, int max_threads); |
| 133 | + |
| 134 | + // Create a pool of threads running the given closure (parameterized by thread number). |
| 135 | + // `pool_size` must be the result of a `pool_size()` call. |
| 136 | + ThreadPool(int pool_size, std::function<void(int)> b); |
| 137 | + ThreadPool(ThreadPool &&other) = delete; |
| 138 | + // Waits for all threads to terminate. Make sure those closures return! |
| 139 | + ~ThreadPool(); |
| 140 | + |
| 141 | + // Return the number of threads in the pool. |
| 142 | + int num_threads() const |
| 143 | + { |
| 144 | +#ifdef YOSYS_ENABLE_THREADS |
| 145 | + return threads.size(); |
| 146 | +#else |
| 147 | + return 0; |
| 148 | +#endif |
| 149 | + } |
| 150 | +private: |
| 151 | + std::function<void(int)> body; |
| 152 | +#ifdef YOSYS_ENABLE_THREADS |
| 153 | + std::vector<std::thread> threads; |
| 154 | +#endif |
| 155 | +}; |
| 156 | + |
| 157 | +template <class T> |
| 158 | +class ConcurrentStack |
| 159 | +{ |
| 160 | +public: |
| 161 | + void push_back(T &&t) { |
| 162 | +#ifdef YOSYS_ENABLE_THREADS |
| 163 | + std::lock_guard<std::mutex> lock(mutex); |
| 164 | +#endif |
| 165 | + contents.push_back(std::move(t)); |
| 166 | + } |
| 167 | + std::optional<T> try_pop_back() { |
| 168 | +#ifdef YOSYS_ENABLE_THREADS |
| 169 | + std::lock_guard<std::mutex> lock(mutex); |
| 170 | +#endif |
| 171 | + if (contents.empty()) |
| 172 | + return std::nullopt; |
| 173 | + T result = std::move(contents.back()); |
| 174 | + contents.pop_back(); |
| 175 | + return result; |
| 176 | + } |
| 177 | +private: |
| 178 | +#ifdef YOSYS_ENABLE_THREADS |
| 179 | + std::mutex mutex; |
| 180 | +#endif |
| 181 | + std::vector<T> contents; |
| 182 | +}; |
| 183 | + |
| 184 | +YOSYS_NAMESPACE_END |
| 185 | + |
| 186 | +#endif // YOSYS_THREADING_H |
0 commit comments