Loading...
Searching...
No Matches
util.hpp
Go to the documentation of this file.
#ifndef OSMIUM_THREAD_UTIL_HPP
#define OSMIUM_THREAD_UTIL_HPP
/*
This file is part of Osmium (https://osmcode.org/libosmium).
Copyright 2013-2025 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 <chrono>
#include <future>
#include <thread>
#include <utility>
#if defined(__linux__)
# include <sys/prctl.h>
#elif defined(__FreeBSD__)
# include <pthread.h>
#endif
namespace osmium {
namespace thread {
template <typename T>
inline void check_for_exception(std::future<T>& future) {
if (future.valid() && future.wait_for(std::chrono::seconds(0)) == std::future_status::ready) {
future.get();
}
}
template <typename T>
inline void wait_until_done(std::future<T>& future) {
if (future.valid()) {
future.get();
}
}
#if defined(__linux__)
inline void set_thread_name(const char* name) noexcept {
prctl(PR_SET_NAME, name, 0, 0, 0);
}
#elif defined(__FreeBSD__)
inline void set_thread_name(const char* name) noexcept {
pthread_setname_np(pthread_self(), name);
}
#else
inline void set_thread_name(const char*) noexcept {
// intentionally left blank
}
#endif
class thread_handler {
std::thread m_thread;
public:
thread_handler() = default;
template <typename TFunction, typename... TArgs>
explicit thread_handler(TFunction&& f, TArgs&&... args) :
m_thread(std::forward<TFunction>(f), std::forward<TArgs>(args)...) {
}
thread_handler(const thread_handler&) = delete;
thread_handler& operator=(const thread_handler&) = delete;
thread_handler(thread_handler&&) noexcept = default;
thread_handler& operator=(thread_handler&&) noexcept = default;
~thread_handler() {
if (m_thread.joinable()) {
m_thread.join();
}
}
}; // class thread_handler
} // namespace thread
} // namespace osmium
#endif // OSMIUM_THREAD_UTIL_HPP
osmium::thread::thread_handler::thread_handler
thread_handler(const thread_handler &)=delete
osmium::thread::thread_handler::thread_handler
thread_handler()=default
osmium::thread::thread_handler::operator=
thread_handler & operator=(const thread_handler &)=delete
osmium::thread::thread_handler::m_thread
std::thread m_thread
Definition util.hpp:93
osmium::thread::thread_handler::thread_handler
thread_handler(TFunction &&f, TArgs &&... args)
Definition util.hpp:100
osmium::thread::thread_handler::thread_handler
thread_handler(thread_handler &&) noexcept=default
osmium::thread
Threading-related low-level code.
Definition function_wrapper.hpp:41
osmium::thread::set_thread_name
void set_thread_name(const char *name) noexcept
Definition util.hpp:78
osmium::thread::check_for_exception
void check_for_exception(std::future< T > &future)
Definition util.hpp:57
osmium::thread::wait_until_done
void wait_until_done(std::future< T > &future)
Definition util.hpp:68
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
std
Definition location.hpp:555