numa_thread_pool.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <kcenon/thread/core/thread_pool.h>
#include <kcenon/thread/core/worker_policy.h>
#include <kcenon/thread/stealing/enhanced_work_stealing_config.h>
#include <kcenon/thread/stealing/work_stealing_stats.h>
#include <kcenon/thread/stealing/numa_topology.h>
#include <kcenon/thread/stealing/numa_work_stealer.h>
 
namespace kcenon::thread
{
 
class numa_thread_pool : public thread_pool
{
public:
    explicit numa_thread_pool(const std::string& thread_title = "numa_thread_pool",
                              const thread_context& context = thread_context());
 
    numa_thread_pool(const std::string& thread_title,
                     std::shared_ptr<job_queue> custom_queue,
                     const thread_context& context = thread_context());
 
    numa_thread_pool(const std::string& thread_title,
                     std::unique_ptr<pool_queue_adapter_interface> queue_adapter,
                     const thread_context& context = thread_context());
 
    ~numa_thread_pool() override = default;
 
    // =========================================================================
    // NUMA-specific Methods
    // =========================================================================
 
    void configure_numa_work_stealing(const enhanced_work_stealing_config& config);
 
    [[nodiscard]] const enhanced_work_stealing_config& numa_work_stealing_config() const;
 
    [[nodiscard]] work_stealing_stats_snapshot numa_work_stealing_stats() const;
 
    [[nodiscard]] const numa_topology& numa_topology_info() const;
 
    [[nodiscard]] bool is_numa_system() const;
 
    void enable_numa_work_stealing();
 
    void disable_numa_work_stealing();
 
    [[nodiscard]] bool is_numa_work_stealing_enabled() const;
 
private:
    mutable numa_topology cached_topology_;
 
    mutable bool topology_detected_{false};
 
    enhanced_work_stealing_config enhanced_ws_config_;
 
    std::unique_ptr<numa_work_stealer> numa_work_stealer_;
 
    worker_policy worker_policy_;
 
    void ensure_topology_detected() const;
};
 
} // namespace kcenon::thread