NodeInstance.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once
 
#include "shambase/aliases_int.hpp"
#include "shambackends/DeviceScheduler.hpp"
#include "shamcomm/mpiInfo.hpp"
#include "shamcomm/worldInfo.hpp"
#include <sycl/sycl.hpp>
#include <vector>
 
namespace shamsys::instance {
 
    class ShamsysInstanceException : public std::exception {
        public:
        explicit ShamsysInstanceException(const char *message) : msg_(message) {}
 
        explicit ShamsysInstanceException(const std::string &message) : msg_(message) {}
 
        ~ShamsysInstanceException() noexcept override = default;
 
        [[nodiscard]] const char *what() const noexcept override { return msg_.c_str(); }
 
        protected:
        std::string msg_;
    };
 
    struct SyclInitInfo {
        u32 alt_queue_id;
        u32 compute_queue_id;
    };
 
    struct MPIInitInfo {
        int argc;
        char **argv;
        std::optional<shamcomm::StateMPI_Aware> forced_state;
    };
 
    bool is_initialized();
 
    void init(int argc, char *argv[]);
 
    void start_mpi(MPIInitInfo mpi_info);
 
    void init_sycl_mpi(std::string search_key, MPIInitInfo mpi_info);
 
    void close();
 
    void close_mpi();
 
    [[deprecated("Please use shamrock smi instead")]]
    void print_device_list();
 
    void print_queue_map();
 
    // sycl related routines
 
    sycl::queue &get_compute_queue(u32 id = 0);
    u32 get_compute_queue_eu_count(u32 id = 0);
 
    inline sycl::device get_compute_device() { return get_compute_queue().get_device(); }
 
    sycl::queue &get_alt_queue(u32 id = 0);
 
    sham::DeviceScheduler &get_compute_scheduler();
    sham::DeviceScheduler &get_alt_scheduler();
 
    std::shared_ptr<sham::DeviceScheduler> get_compute_scheduler_ptr();
    std::shared_ptr<sham::DeviceScheduler> get_alt_scheduler_ptr();
 
    // MPI related routines
 
    // idea to handle multiple GPU with MPI : i32 get_mpi_tag(u32 tag);
 
    void print_mpi_capabilities();
 
    void print_mpi_comm_info();
 
    void check_dgpu_available();
 
} // namespace shamsys::instance