scoped_device_id_guard.hpp

// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef GKO_PUBLIC_CORE_BASE_SCOPED_DEVICE_ID_GUARD_HPP_
#define GKO_PUBLIC_CORE_BASE_SCOPED_DEVICE_ID_GUARD_HPP_
 
 
#include <memory>
 
 
namespace gko {
 
 
class OmpExecutor;
class ReferenceExecutor;
class CudaExecutor;
class HipExecutor;
class DpcppExecutor;
 
 
namespace detail {
 

class generic_scoped_device_id_guard {
public:
    generic_scoped_device_id_guard() = default;
 
    // TODO: this should be a purely virtual function, but somehow that leads to
    // linker errors
    virtual ~generic_scoped_device_id_guard() = default;
 
    // Prohibit copy construction
    generic_scoped_device_id_guard(
        const generic_scoped_device_id_guard& other) = delete;
 
    // Prohibit copy assignment
    generic_scoped_device_id_guard& operator=(
        const generic_scoped_device_id_guard& other) = delete;
};
 
 
}  // namespace detail
 

class scoped_device_id_guard {
public:
    scoped_device_id_guard(const ReferenceExecutor* exec, int device_id);

    scoped_device_id_guard(const OmpExecutor* exec, int device_id);

    scoped_device_id_guard(const CudaExecutor* exec, int device_id);

    scoped_device_id_guard(const HipExecutor* exec, int device_id);

    scoped_device_id_guard(const DpcppExecutor* exec, int device_id);
 
    scoped_device_id_guard() = default;
 
    // Prohibit copy construction.
    scoped_device_id_guard(const scoped_device_id_guard&) = delete;
 
    // Allow move construction.
    // These are needed, since C++14 does not guarantee copy elision.
    scoped_device_id_guard(scoped_device_id_guard&&) = default;
 
    // Prohibit copy assignment.
    scoped_device_id_guard& operator=(const scoped_device_id_guard&) = delete;
 
    // Allow move construction.
    // These are needed, since C++14 does not guarantee copy elision.
    scoped_device_id_guard& operator=(scoped_device_id_guard&&) = default;
 
    ~scoped_device_id_guard() = default;
 
private:
    std::unique_ptr<detail::generic_scoped_device_id_guard> scope_;
};
 
 
}  // namespace gko
 
#endif  // GKO_PUBLIC_CORE_BASE_SCOPED_DEVICE_ID_GUARD_HPP_