File: fancy_pointer_resource.h

package info (click to toggle)
rocthrust 6.4.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,588 kB
  • sloc: cpp: 66,309; ansic: 34,184; python: 1,519; sh: 331; xml: 212; makefile: 115
file content (87 lines) | stat: -rw-r--r-- 3,186 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
 *  Copyright 2018 NVIDIA Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

#pragma once

#include <thrust/detail/config.h>
#include <thrust/detail/type_traits/pointer_traits.h>

#include <thrust/mr/memory_resource.h>
#include <thrust/mr/validator.h>

THRUST_NAMESPACE_BEGIN
namespace mr
{

/*! A \p memory_resource derived class that wraps a pointer type.
 *
 * Wrapping the pointer type allows this class to use either the global (static) memory
 * resource (see \p mr::get_global_resource ), or a provided "upstream" memory resource
 * instance. When allocations are performed, the returned pointer is cast to the \p Pointer
 * template parameter type, for convenience.
 *
 * \tparam Upstream - a \p memory_resource derrived type. Will be wrapped by this class.
 * \tparam Pointer - when allocations are performed, the return value will be cast to this type.
 */
template<typename Upstream, typename Pointer>
class fancy_pointer_resource final : public memory_resource<Pointer>, private validator<Upstream>
{
public:
    /*! Constructs a pointer to the global (static) memory resource.
     * See \p mr::get_global_resource.
     */
    fancy_pointer_resource() : m_upstream(get_global_resource<Upstream>())
    {
    }

    /*! Constructs a pointer to the provided memory resource.
     * \param upstream - pointer to the memory_resource to wrap.
     */
    fancy_pointer_resource(Upstream * upstream) : m_upstream(upstream)
    {
    }

    /*! Performs a memory allocation. Returns a pointer of type \p Pointer.
     * \param bytes - the requested size of the allocation, in bytes
     * \param alignment - specifies the alignment for the allocation.
     *  Defaults to THRUST_MR_DEFAULT_ALIGNMENT.
     */
    THRUST_NODISCARD
    virtual Pointer do_allocate(std::size_t bytes, std::size_t alignment = THRUST_MR_DEFAULT_ALIGNMENT) override
    {
        return static_cast<Pointer>(m_upstream->do_allocate(bytes, alignment));
    }

    /*! Deallocates memory that was previously allocated with this allocator.
     * \param p - pointer to the memory that was previously allocated by \p do_allocate
     * \param bytes - the size of the allocation that was requested, in bytes
     * \param alignment - specifies the alignment that was used for the allocation
     */
    virtual void do_deallocate(Pointer p, std::size_t bytes, std::size_t alignment) override
    {
        return m_upstream->do_deallocate(
            static_cast<typename Upstream::pointer>(
                thrust::detail::pointer_traits<Pointer>::get(p)),
            bytes, alignment);
    }

private:
    Upstream * m_upstream;
};

} // end mr
THRUST_NAMESPACE_END