Loading...
Searching...
No Matches
queue.hpp
Go to the documentation of this file.
#ifndef OSMIUM_THREAD_QUEUE_HPP
#define OSMIUM_THREAD_QUEUE_HPP
/*
This file is part of Osmium (https://osmcode.org/libosmium).
Copyright 2013-2026 Jochen Topf <jochen@topf.org> and others (see README).
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <atomic>
#include <chrono>
#include <condition_variable>
#include <cstddef>
#include <mutex>
#include <queue>
#include <string>
#include <utility> // IWYU pragma: keep
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
# include <iostream>
#endif
namespace osmium {
namespace thread {
template <typename T>
class Queue {
const std::size_t m_max_size;
const std::string m_name;
mutable std::mutex m_mutex;
std::queue<T> m_queue;
std::condition_variable m_data_available;
std::condition_variable m_space_available;
std::atomic<bool> m_in_use{true};
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
std::size_t m_largest_size;
std::atomic<int> m_push_counter;
std::atomic<int> m_full_counter;
std::atomic<int> m_pop_counter;
std::atomic<int> m_empty_counter;
#endif
public:
explicit Queue(std::size_t max_size = 0, std::string name = "") :
m_max_size(max_size),
m_name(std::move(name)),
m_queue()
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
,
m_largest_size(0),
m_push_counter(0),
m_full_counter(0),
m_pop_counter(0),
m_empty_counter(0)
#endif
{
}
Queue(const Queue&) = delete;
Queue& operator=(const Queue&) = delete;
Queue(Queue&&) = delete;
Queue& operator=(Queue&&) = delete;
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
~Queue() {
std::cerr << "queue '" << m_name
<< "' with max_size=" << m_max_size
<< " had largest size " << m_largest_size
<< " and was full " << m_full_counter
<< " times in " << m_push_counter
<< " push() calls and was empty " << m_empty_counter
<< " times in " << m_pop_counter
<< " pop() calls\n";
}
#else
~Queue() = default;
#endif
void push(T value) {
if (!m_in_use) {
return;
}
constexpr const std::chrono::milliseconds max_wait{10};
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
++m_push_counter;
#endif
if (m_max_size) {
while (size() >= m_max_size) {
std::unique_lock<std::mutex> lock{m_mutex};
m_space_available.wait_for(lock, max_wait, [this] {
return m_queue.size() < m_max_size;
});
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
++m_full_counter;
#endif
}
}
const std::lock_guard<std::mutex> lock{m_mutex};
m_queue.push(std::move(value));
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
if (m_largest_size < m_queue.size()) {
m_largest_size = m_queue.size();
}
#endif
m_data_available.notify_one();
}
void wait_and_pop(T& value) {
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
++m_pop_counter;
#endif
std::unique_lock<std::mutex> lock{m_mutex};
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
if (m_queue.empty()) {
++m_empty_counter;
}
#endif
m_data_available.wait(lock, [this] {
return !m_in_use || !m_queue.empty();
});
if (!m_queue.empty()) {
value = std::move(m_queue.front());
m_queue.pop();
lock.unlock();
if (m_max_size) {
m_space_available.notify_one();
}
}
}
bool try_pop(T& value) {
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
++m_pop_counter;
#endif
{
const std::lock_guard<std::mutex> lock{m_mutex};
if (m_queue.empty()) {
#ifdef OSMIUM_DEBUG_QUEUE_SIZE
++m_empty_counter;
#endif
return false;
}
value = std::move(m_queue.front());
m_queue.pop();
}
if (m_max_size) {
m_space_available.notify_one();
}
return true;
}
bool empty() const {
const std::lock_guard<std::mutex> lock{m_mutex};
return m_queue.empty();
}
std::size_t size() const {
const std::lock_guard<std::mutex> lock{m_mutex};
return m_queue.size();
}
bool in_use() const noexcept {
return m_in_use;
}
void shutdown() {
m_in_use = false;
const std::lock_guard<std::mutex> lock{m_mutex};
while (!m_queue.empty()) {
m_queue.pop();
}
m_data_available.notify_all();
}
}; // class Queue
} // namespace thread
} // namespace osmium
#endif // OSMIUM_THREAD_QUEUE_HPP
osmium::thread::Queue::try_pop
bool try_pop(T &value)
Definition queue.hpp:201
osmium::thread::Queue::m_mutex
std::mutex m_mutex
Definition queue.hpp:66
osmium::thread::Queue::~Queue
~Queue()=default
osmium::thread::Queue::operator=
Queue & operator=(const Queue &)=delete
osmium::thread::Queue::operator=
Queue & operator=(Queue &&)=delete
osmium::thread::Queue::empty
bool empty() const
Definition queue.hpp:222
osmium::thread::Queue::in_use
bool in_use() const noexcept
Definition queue.hpp:232
osmium::thread::Queue::push
void push(T value)
Definition queue.hpp:149
osmium::thread::Queue::wait_and_pop
void wait_and_pop(T &value)
Definition queue.hpp:178
osmium::thread::Queue::m_in_use
std::atomic< bool > m_in_use
Definition queue.hpp:76
osmium::thread::Queue::Queue
Queue(const Queue &)=delete
osmium::thread::Queue::m_space_available
std::condition_variable m_space_available
Used to signal producers when queue is not full.
Definition queue.hpp:74
osmium::thread::Queue::Queue
Queue(std::size_t max_size=0, std::string name="")
Definition queue.hpp:109
osmium::thread::Queue::size
std::size_t size() const
Definition queue.hpp:227
osmium::thread::Queue::m_queue
std::queue< T > m_queue
Definition queue.hpp:68
osmium::thread::Queue::Queue
Queue(Queue &&)=delete
osmium::thread::Queue::m_max_size
const std::size_t m_max_size
Definition queue.hpp:61
osmium::thread::Queue::m_data_available
std::condition_variable m_data_available
Used to signal consumers when data is available in the queue.
Definition queue.hpp:71
osmium::thread::Queue::shutdown
void shutdown()
Definition queue.hpp:236
osmium::thread::Queue::m_name
const std::string m_name
Name of this queue (for debugging only).
Definition queue.hpp:64
osmium::thread
Threading-related low-level code.
Definition function_wrapper.hpp:41
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
std
Definition location.hpp:654