TheRock/rocm-libraries/projects/rocthrust/test/test_unique_ptr_allocate_deallocate.cpp

// Copyright © Advanced Micro Devices, Inc., or its affiliates.
// SPDX-License-Identifier:  Apache-2.0

#include <thrust/unique_ptr.h>
#include <thrust/device_delete.h>
#include "hip/hip_runtime.h"
#include "test_param_fixtures.hpp"
#include "test_utils.hpp"

class A {
public:    
    __host__ __device__ A() : finished(nullptr), val_a(0) {}
    __host__ __device__ A(int num): finished(nullptr), val_a(num) {}
    __host__ __device__ A(thrust::device_ptr<bool> dev_p, int num): finished(dev_p), val_a(num) {}

    __host__ __device__ ~A() {
    #if defined(__HIP_DEVICE_COMPILE__)
        if(finished)
            *finished = true; 
    #endif
    }
 
    thrust::device_ptr<bool> finished;
    int val_a;
}; 

class B : public A
{
public:
    __host__ __device__ B() : A() {}
    __host__ __device__ B(int num) : A(num) {}
};

TESTS_DEFINE(UniquePtrAllocDeallocTests, NumericalTestsParams);

// Based on libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.create/make_unique.single.pass.cpp
TYPED_TEST(UniquePtrAllocDeallocTests, TestUniquePtrMakeUnique)
{
    using T = typename TestFixture::input_type;
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    T initial_value = T(1);
    if(std::is_floating_point<T>::value)
    {
        initial_value = T(7.71);
    }

    thrust::unique_ptr<T> p1 = thrust::make_unique<T>(initial_value);
    ASSERT_EQ(*p1, initial_value);

    p1 = thrust::make_unique<T>();
    ASSERT_EQ(*p1, T {});
}

// Based on libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.create/make_unique.single.pass.cpp
TEST(UniquePtrAllocDeallocTests, TestUniquePtrMakeUniqueUserType)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    thrust::unique_ptr<A> p = thrust::make_unique<A>(7);
    A host_p = *p;

    ASSERT_EQ(host_p.val_a, 7);
}

// Thrust-specific test for deleter behavior.
TEST(UniquePtrAllocDeallocTests, TestUniquePtrDltr)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    thrust::device_ptr<bool> finished = thrust::device_new<bool>(1);
    *finished = false;
    {
        thrust::unique_ptr<A> p = thrust::make_unique<A>(finished, 18);
        ASSERT_NE(p, nullptr);
    }
    ASSERT_EQ(*finished, true);
    thrust::device_delete(finished);
}

// Based on llvm-project/libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.special/cmp.pass.cpp
TEST(UniquePtrAllocDeallocTests, TestUniquePtrCmp)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    // Pointers of same type
    {
        thrust::unique_ptr<A> p1 = thrust::make_unique<A>(1);
        thrust::unique_ptr<A> p2 = thrust::make_unique<A>(2);

        A* ptr1 = p1.get_raw();
        A* ptr2 = p2.get_raw();

        ASSERT_FALSE(p1 == p2);
        ASSERT_TRUE(p1 != p2);
        ASSERT_EQ((p1 < p2), (ptr1 < ptr2));
        ASSERT_EQ((p1 <= p2), (ptr1 <= ptr2));
        ASSERT_EQ((p1 > p2), (ptr1 > ptr2));
        ASSERT_EQ((p1 >= p2), (ptr1 >= ptr2));
    }

    // Pointers of different type
    {
        thrust::unique_ptr<A> p1(thrust::device_new<A>(1));
        thrust::unique_ptr<B> p2(thrust::device_new<B>(2));

        A* ptr1 = p1.get_raw();
        B* ptr2 = p2.get_raw();

        ASSERT_FALSE(p1 == p2);
        ASSERT_TRUE(p1 != p2);
        ASSERT_EQ((p1 < p2), ((ptr1) < (ptr2)));
        ASSERT_EQ((p1 <= p2), ((ptr1) <= (ptr2)));
        ASSERT_EQ((p1 > p2), ((ptr1) > (ptr2)));
        ASSERT_EQ((p1 >= p2), ((ptr1) >= (ptr2)));
    }

    // Default-constructed pointers of same type
    {
        const thrust::unique_ptr<A> p1;
        const thrust::unique_ptr<A> p2;

        ASSERT_EQ(p1, p2);
    }

    // Default-constructed pointers of different type
    {
        const thrust::unique_ptr<A> p1;
        const thrust::unique_ptr<B> p2;

        ASSERT_EQ(p1, p2);
    }
}

// Based on llvm-project/libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.special/cmp.pass.cpp
TEST(UniquePtrAllocDeallocTests, TestUniquePtrCmpArray)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    // Pointers of same array type
    {
        thrust::unique_ptr<A[]> p1 = thrust::make_unique<A[]>(10);
        thrust::unique_ptr<A[]> p2 = thrust::make_unique<A[]>(10);

        for (int i = 0; i < 10; ++i)
        {
            p1[i] = A();
            p2[i] = A();
        }

        A* ptr1 = p1.get_raw();
        A* ptr2 = p2.get_raw();

        ASSERT_FALSE(p1 == p2); 
        ASSERT_TRUE(p1 != p2);
        ASSERT_EQ((p1 < p2), (ptr1 < ptr2));
        ASSERT_EQ((p1 <= p2), (ptr1 <= ptr2));
        ASSERT_EQ((p1 > p2), (ptr1 > ptr2));
        ASSERT_EQ((p1 >= p2), (ptr1 >= ptr2));
    }

    // Pointers of different array type
    {
        thrust::unique_ptr<A[]> p1 = thrust::make_unique<A[]>(10);
        thrust::unique_ptr<B[]> p2 = thrust::make_unique<B[]>(10);

        for (int i = 0; i < 10; ++i)
        {
            p1[i] = A();
            p2[i] = B();
        }

        A* ptr1 = p1.get_raw();
        B* ptr2 = p2.get_raw();

        ASSERT_FALSE(p1 == p2);
        ASSERT_TRUE(p1 != p2);
        ASSERT_EQ((p1 < p2), (ptr1 < ptr2));
        ASSERT_EQ((p1 <= p2), (ptr1 <= ptr2));
        ASSERT_EQ((p1 > p2), (ptr1 > ptr2));
        ASSERT_EQ((p1 >= p2), (ptr1 >= ptr2));
    }
}

// Based on libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.special/cmp_nullptr.pass.cpp
TEST(UniquePtrAllocDeallocTests, TestUniquePtrCmpNullptr)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    // Test with a non-null unqiue_ptr
    {
        const thrust::unique_ptr<int> p = thrust::make_unique<int>(1);
 
        ASSERT_NE(p, nullptr);
        ASSERT_LT(nullptr, p);
        ASSERT_LE(nullptr, p);
        ASSERT_GT(p, nullptr);
        ASSERT_GE(p, nullptr);
    }

    // Test with null unique_ptr
    {
        const thrust::unique_ptr<int> p;

        ASSERT_EQ(p, nullptr);
        ASSERT_LE(p, nullptr);
        ASSERT_LE(nullptr, p);
        ASSERT_GE(p, nullptr);
        ASSERT_GE(nullptr, p);
    }
}

// Based on libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.create/make_unique.array.pass.cpp
TYPED_TEST(UniquePtrAllocDeallocTests, TestUniquePtrMakeUniqueArray)
{
    using T = typename TestFixture::input_type;
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    thrust::unique_ptr<T[]> p = thrust::make_unique<T[]>(5);

    for(int i = 0; i < 5; ++i)
    {
        thrust::device_reference<T> ref = p[i];
        ASSERT_EQ(p[i], ref);
        ASSERT_EQ(&p[i], &ref);
        p[i] = T(7);
        ASSERT_EQ(p[i], ref);
    }
}

// Based on libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.create/make_unique.array.pass.cpp
TEST(UniquePtrAllocDeallocTests, TestUniquePtrMakeUniqueArrayUserType)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    thrust::unique_ptr<A[]> p = thrust::make_unique<A[]>(7);

    for(int i = 0; i < 7; ++i)
    {
        A host_p;
        host_p.val_a = 2;
        thrust::device_reference<A> ref = p[i];
        ref = host_p;
    }

    for (int i = 0; i < 7; ++i)
    {
        thrust::device_reference<A> ref = p[i];
        A host_p = ref;
        ASSERT_EQ(host_p.val_a, 2);
    }
}

// Thrust-specific test for array deleter behavior.
TEST(UniquePtrAllocDeallocTests, TestUniquePtrDltrArray)
{
    SCOPED_TRACE(testing::Message() << "with device_id= " << test::set_device_from_ctest());

    thrust::device_ptr<bool> finished = thrust::device_new<bool>(3);
    for (int i = 0; i < 3; ++i)
        finished[i] = false;
    {
        thrust::unique_ptr<A[]> p = thrust::make_unique<A[]>(3);
        ASSERT_NE(p, nullptr);
        
        p[0] = A(finished + 0, 1);
        p[1] = A(finished + 1, 2);
        p[2] = A(finished + 2, 3);
    }
    ASSERT_EQ(finished[0], true);
    ASSERT_EQ(finished[1], true);
    ASSERT_EQ(finished[2], true);
    thrust::device_delete(finished, 3);
}

#if THRUST_CPP_DIALECT >= 2020
// Based on libcxx/test/std/utilities/smartptr/unique.ptr/unique.ptr.create/make_unique_for_overwrite.pass.cpp
TEST(UniquePtrAllocDeallocTests, TestUniquePtrMakeUniqueForOverwriteSingleInt)
{
    thrust::unique_ptr<int> p = thrust::make_unique_for_overwrite<int>();
    *p = 5;
    ASSERT_EQ(*p, 5);
}

TEST(UniquePtrAllocDeallocTests, TestUniquePtrMakeUniqueForOverwriteUnboundedArrayInt)
{
    thrust::unique_ptr<int[]> p = thrust::make_unique_for_overwrite<int[]>(3);
    p[0] = 3;
    p[1] = 4;
    p[2] = 5;
    ASSERT_EQ(p[0], 3);
    ASSERT_EQ(p[1], 4);
    ASSERT_EQ(p[2], 5);
}
#endif