memory.hpp

// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef GKO_PUBLIC_CORE_BASE_MEMORY_HPP_
#define GKO_PUBLIC_CORE_BASE_MEMORY_HPP_
 
 
#include <ginkgo/core/base/fwd_decls.hpp>
#include <ginkgo/core/base/types.hpp>
 
 
namespace gko {
 
 
class Allocator {
public:
    virtual ~Allocator() = default;
 
    virtual void* allocate(size_type num_bytes) = 0;
 
    virtual void deallocate(void* ptr) = 0;
};
 
 
class CpuAllocatorBase : public Allocator {};
 
 
class CudaAllocatorBase : public Allocator {
    friend class CudaExecutor;
 
protected:
    virtual bool check_environment(int device_id, CUstream_st* stream) const
    {
        return true;
    }
};
 
 
class HipAllocatorBase : public Allocator {
    friend class HipExecutor;
 
protected:
    virtual bool check_environment(int device_id,
                                   GKO_HIP_STREAM_STRUCT* stream) const
    {
        return true;
    }
};
 
 
class CpuAllocator : public CpuAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
};
 
 
class CudaAllocator : public CudaAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
};
 
 
/*
 * Allocator using cudaMallocAsync.
 */
class CudaAsyncAllocator : public CudaAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
 
    CudaAsyncAllocator(CUstream_st* stream);
 
    bool check_environment(int device_id, CUstream_st* stream) const override;
 
private:
    CUstream_st* stream_;
};
 
 
/*
 * Allocator using cudaMallocManaged
 */
class CudaUnifiedAllocator : public CudaAllocatorBase, public CpuAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
 
    CudaUnifiedAllocator(int device_id);
 
    CudaUnifiedAllocator(int device_id, unsigned int flags);
 
protected:
    bool check_environment(int device_id, CUstream_st* stream) const override;
 
private:
    int device_id_;
    unsigned int flags_;
};
 
 
/*
 * Allocator using cudaHostMalloc.
 */
class CudaHostAllocator : public CudaAllocatorBase, public CpuAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
 
    CudaHostAllocator(int device_id);
 
protected:
    bool check_environment(int device_id, CUstream_st* stream) const override;
 
private:
    int device_id_;
};
 
 
/*
 * Allocator using hipMalloc.
 */
class HipAllocator : public HipAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
};
 
 
/*
 * Allocator using hipMallocAsync.
 */
class HipAsyncAllocator : public HipAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
 
    HipAsyncAllocator(GKO_HIP_STREAM_STRUCT* stream);
 
protected:
    bool check_environment(int device_id,
                           GKO_HIP_STREAM_STRUCT* stream) const override;
 
private:
    GKO_HIP_STREAM_STRUCT* stream_;
};
 
 
/*
 * Allocator using hipMallocManaged
 */
class HipUnifiedAllocator : public HipAllocatorBase, public CpuAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
 
    HipUnifiedAllocator(int device_id);
 
    HipUnifiedAllocator(int device_id, unsigned int flags);
 
protected:
    bool check_environment(int device_id,
                           GKO_HIP_STREAM_STRUCT* stream) const override;
 
private:
    int device_id_;
    unsigned int flags_;
};
 
 
/*
 * Allocator using hipHostAlloc.
 */
class HipHostAllocator : public HipAllocatorBase, public CpuAllocatorBase {
public:
    void* allocate(size_type num_bytes) override;
 
    void deallocate(void* ptr) override;
 
    HipHostAllocator(int device_id);
 
protected:
    bool check_environment(int device_id,
                           GKO_HIP_STREAM_STRUCT* stream) const override;
 
private:
    int device_id_;
};
 
 
}  // namespace gko
 
 
#endif  // GKO_PUBLIC_CORE_BASE_MEMORY_HPP_