USMPtrHolder.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/ptr.hpp"
#include "shambackends/DeviceScheduler.hpp"
#include <memory>
#include <utility>
 
namespace sham {
 
    enum USMKindTarget {
        device, 
        shared, 
        host    
    };
 
    template<USMKindTarget target>
    class USMPtrHolder {
 
        void *usm_ptr = nullptr; 
        size_t size   = 0;       
        std::shared_ptr<DeviceScheduler>
            dev_sched; 
 
        USMPtrHolder(void *usm_ptr, size_t size, std::shared_ptr<DeviceScheduler> dev_sched)
            : usm_ptr(usm_ptr), size(size), dev_sched(std::move(dev_sched)) {}
 
        public:
        void free_ptr(); 
 
        static USMPtrHolder create(
            size_t sz,
            std::shared_ptr<DeviceScheduler> dev_sched,
            std::optional<size_t> alignment = std::nullopt);
 
        static USMPtrHolder create_nullptr(std::shared_ptr<DeviceScheduler> dev_sched);
 
        ~USMPtrHolder();
 
        USMPtrHolder(const USMPtrHolder &other) = delete;
 
        USMPtrHolder(USMPtrHolder &&other) noexcept
            : usm_ptr(std::exchange(other.usm_ptr, nullptr)), size(other.size),
              dev_sched(other.dev_sched) {}
 
        USMPtrHolder &operator=(const USMPtrHolder &other) = delete;
 
        USMPtrHolder &operator=(USMPtrHolder &&other) noexcept {
            dev_sched = other.dev_sched;
            size      = other.size;
            std::swap(usm_ptr, other.usm_ptr);
            return *this;
        }
 
        template<class T>
        inline T *ptr_cast() const {
            if (!shambase::is_aligned<T>(usm_ptr)) {
                shambase::throw_with_loc<std::runtime_error>(
                    "The USM pointer is not aligned with the given type");
            }
            return reinterpret_cast<T *>(usm_ptr);
        }
 
        [[nodiscard]] inline void *get_raw_ptr() const { return usm_ptr; }
 
        [[nodiscard]] inline size_t get_bytesize() const { return size; }
 
        [[nodiscard]] inline DeviceScheduler &get_dev_scheduler() const { return *dev_sched; }
 
        [[nodiscard]] inline std::shared_ptr<DeviceScheduler> &get_dev_scheduler_ptr() {
            return dev_sched;
        }
 
        [[nodiscard]] inline const std::shared_ptr<DeviceScheduler> &get_dev_scheduler_ptr() const {
            return dev_sched;
        }
    };
 
} // namespace sham