vecmem 1.14.0
Loading...
Searching...
No Matches
copy.hpp
1/*
2 * VecMem project, part of the ACTS project (R&D line)
3 *
4 * (c) 2021-2024 CERN for the benefit of the ACTS project
5 *
6 * Mozilla Public License Version 2.0
7 */
8#pragma once
9
10// VecMem include(s).
11#include "vecmem/containers/data/jagged_vector_buffer.hpp"
12#include "vecmem/containers/data/jagged_vector_view.hpp"
13#include "vecmem/containers/data/vector_buffer.hpp"
14#include "vecmem/containers/data/vector_view.hpp"
15#include "vecmem/edm/details/schema_traits.hpp"
16#include "vecmem/edm/host.hpp"
17#include "vecmem/edm/view.hpp"
18#include "vecmem/memory/memory_resource.hpp"
19#include "vecmem/utils/abstract_event.hpp"
20#include "vecmem/utils/attributes.hpp"
21#include "vecmem/vecmem_core_export.hpp"
22
23// System include(s).
24#include <cstddef>
25#include <memory>
26#include <type_traits>
27#include <vector>
28
29namespace vecmem {
30
41class VECMEM_CORE_EXPORT copy {
42
43public:
50 struct type {
52 enum copy_type {
54 host_to_device = 0,
56 device_to_host = 1,
58 host_to_host = 2,
60 device_to_device = 3,
62 unknown = 4,
64 count = 5
65 }; // enum copy_type
66 }; // struct type
67
69 using event_type = std::unique_ptr<abstract_event>;
70
73
75 virtual ~copy() {}
76
78 template <typename TYPE>
79 VECMEM_NODISCARD event_type setup(data::vector_view<TYPE> data) const;
80
82 template <typename TYPE>
83 VECMEM_NODISCARD event_type memset(data::vector_view<TYPE> data,
84 int value) const;
85
87 template <typename TYPE>
88 data::vector_buffer<std::remove_cv_t<TYPE>> to(
89 const data::vector_view<TYPE>& data, memory_resource& resource,
90 type::copy_type cptype = type::unknown) const;
91
93 template <typename TYPE>
94 VECMEM_NODISCARD event_type
95 operator()(const data::vector_view<std::add_const_t<TYPE>>& from,
96 data::vector_view<TYPE> to,
97 type::copy_type cptype = type::unknown) const;
98
100 template <typename TYPE, typename ALLOC>
101 VECMEM_NODISCARD event_type
102 operator()(const data::vector_view<std::add_const_t<TYPE>>& from,
103 std::vector<TYPE, ALLOC>& to,
104 type::copy_type cptype = type::unknown) const;
105
107 template <typename TYPE>
108 typename data::vector_view<TYPE>::size_type get_size(
109 const data::vector_view<TYPE>& data) const;
110
112
115
117 template <typename TYPE>
118 VECMEM_NODISCARD event_type
119 setup(data::jagged_vector_view<TYPE> data) const;
120
122 template <typename TYPE>
123 VECMEM_NODISCARD event_type memset(data::jagged_vector_view<TYPE> data,
124 int value) const;
125
127 template <typename TYPE>
128 data::jagged_vector_buffer<std::remove_cv_t<TYPE>> to(
129 const data::jagged_vector_view<TYPE>& data, memory_resource& resource,
130 memory_resource* host_access_resource = nullptr,
131 type::copy_type cptype = type::unknown) const;
132
134 template <typename TYPE>
135 VECMEM_NODISCARD event_type
136 operator()(const data::jagged_vector_view<std::add_const_t<TYPE>>& from,
137 data::jagged_vector_view<TYPE> to,
138 type::copy_type cptype = type::unknown) const;
139
141 template <typename TYPE, typename ALLOC1, typename ALLOC2>
142 VECMEM_NODISCARD event_type
143 operator()(const data::jagged_vector_view<std::add_const_t<TYPE>>& from,
144 std::vector<std::vector<TYPE, ALLOC2>, ALLOC1>& to,
145 type::copy_type cptype = type::unknown) const;
146
148 template <typename TYPE>
149 std::vector<typename data::vector_view<TYPE>::size_type> get_sizes(
150 const data::jagged_vector_view<TYPE>& data) const;
151
153 template <typename TYPE>
154 VECMEM_NODISCARD event_type set_sizes(
155 const std::vector<typename data::vector_view<TYPE>::size_type>& sizes,
156 data::jagged_vector_view<TYPE> data) const;
157
159
162
164 template <typename SCHEMA>
165 VECMEM_NODISCARD event_type setup(edm::view<SCHEMA> data) const;
166
168 template <typename... VARTYPES>
169 VECMEM_NODISCARD event_type memset(edm::view<edm::schema<VARTYPES...>> data,
170 int value) const;
171
173 template <typename... VARTYPES>
174 VECMEM_NODISCARD event_type operator()(
175 const edm::view<edm::details::add_const_t<edm::schema<VARTYPES...>>>&
176 from,
177 edm::view<edm::schema<VARTYPES...>> to,
178 type::copy_type cptype = type::unknown) const;
179
181 template <typename... VARTYPES, template <typename> class INTERFACE>
182 VECMEM_NODISCARD event_type operator()(
183 const edm::view<edm::details::add_const_t<edm::schema<VARTYPES...>>>&
184 from,
185 edm::host<edm::schema<VARTYPES...>, INTERFACE>& to,
186 type::copy_type cptype = type::unknown) const;
187
189 template <typename... VARTYPES>
190 typename edm::view<edm::schema<VARTYPES...>>::size_type get_size(
191 const edm::view<edm::schema<VARTYPES...>>& data) const;
192
194
195protected:
197 virtual void do_copy(std::size_t size, const void* from, void* to,
198 type::copy_type cptype) const;
200 virtual void do_memset(std::size_t size, void* ptr, int value) const;
202 VECMEM_NODISCARD virtual event_type create_event() const;
203
204private:
206 template <typename TYPE>
207 bool copy_view_impl(const data::vector_view<std::add_const_t<TYPE>>& from,
208 data::vector_view<TYPE> to,
209 type::copy_type cptype) const;
211 template <typename TYPE>
212 bool copy_view_impl(
213 const data::jagged_vector_view<std::add_const_t<TYPE>>& from,
214 data::jagged_vector_view<TYPE> to, type::copy_type cptype) const;
216 template <typename TYPE>
217 void copy_views_impl(
218 const std::vector<typename data::vector_view<TYPE>::size_type>& sizes,
219 const data::vector_view<std::add_const_t<TYPE>>* from,
220 data::vector_view<TYPE>* to, type::copy_type cptype) const;
222 template <typename TYPE>
223 void copy_views_contiguous_impl(
224 const std::vector<typename data::vector_view<TYPE>::size_type>& sizes,
225 const data::vector_view<std::add_const_t<TYPE>>* from,
226 data::vector_view<TYPE>* to, type::copy_type cptype) const;
228 template <typename TYPE>
229 std::vector<typename data::vector_view<TYPE>::size_type> get_sizes_impl(
230 const data::vector_view<TYPE>* data, std::size_t size) const;
232 template <typename TYPE>
233 static bool is_contiguous(const data::vector_view<TYPE>* data,
234 std::size_t size);
236 template <std::size_t INDEX, typename... VARTYPES>
237 void memset_impl(edm::view<edm::schema<VARTYPES...>> data, int value) const;
239 template <std::size_t INDEX, typename... VARTYPES,
240 template <typename> class INTERFACE>
241 void resize_impl(
242 const edm::view<edm::details::add_const_t<edm::schema<VARTYPES...>>>&
243 from,
244 edm::host<edm::schema<VARTYPES...>, INTERFACE>& to,
245 type::copy_type cptype) const;
247 template <std::size_t INDEX, typename... VARTYPES>
248 void copy_sizes_impl(
249 const edm::view<edm::details::add_const_t<edm::schema<VARTYPES...>>>&
250 from,
251 edm::view<edm::schema<VARTYPES...>> to, type::copy_type cptype) const;
253 template <std::size_t INDEX, typename... VARTYPES>
254 void copy_payload_impl(
255 const edm::view<edm::details::add_const_t<edm::schema<VARTYPES...>>>&
256 from,
257 edm::view<edm::schema<VARTYPES...>> to, type::copy_type cptype) const;
258
259}; // class copy
260
261} // namespace vecmem
262
263// Include the implementation.
264#include "vecmem/utils/impl/copy.ipp"
vecmem::copy
Class implementing (synchronous) host <-> device memory copies.
Definition copy.hpp:41
vecmem::copy::setup
VECMEM_NODISCARD event_type setup(data::jagged_vector_view< TYPE > data) const
Copy the internal state of a jagged vector buffer to the target device.
vecmem::copy::set_sizes
VECMEM_NODISCARD event_type set_sizes(const std::vector< typename data::vector_view< TYPE >::size_type > &sizes, data::jagged_vector_view< TYPE > data) const
Helper function for setting the sizes of a resizable jagged vector.
vecmem::copy::operator()
VECMEM_NODISCARD event_type operator()(const data::vector_view< std::add_const_t< TYPE > > &from, data::vector_view< TYPE > to, type::copy_type cptype=type::unknown) const
Copy a 1-dimensional vector's data between two existing memory blocks.
vecmem::copy::setup
VECMEM_NODISCARD event_type setup(data::vector_view< TYPE > data) const
Set up the internal state of a vector buffer correctly on a device.
vecmem::copy::operator()
VECMEM_NODISCARD event_type operator()(const edm::view< edm::details::add_const_t< edm::schema< VARTYPES... > > > &from, edm::host< edm::schema< VARTYPES... >, INTERFACE > &to, type::copy_type cptype=type::unknown) const
Copy from a view, into a host container.
vecmem::copy::operator()
VECMEM_NODISCARD event_type operator()(const data::jagged_vector_view< std::add_const_t< TYPE > > &from, std::vector< std::vector< TYPE, ALLOC2 >, ALLOC1 > &to, type::copy_type cptype=type::unknown) const
Copy a jagged vector's data into a vector object.
vecmem::copy::operator()
VECMEM_NODISCARD event_type operator()(const data::vector_view< std::add_const_t< TYPE > > &from, std::vector< TYPE, ALLOC > &to, type::copy_type cptype=type::unknown) const
Copy a 1-dimensional vector's data into a vector object.
vecmem::copy::event_type
std::unique_ptr< abstract_event > event_type
Event type used by the copy class.
Definition copy.hpp:69
vecmem::copy::memset
VECMEM_NODISCARD event_type memset(edm::view< edm::schema< VARTYPES... > > data, int value) const
Set all bytes of the container to some value.
vecmem::copy::operator()
VECMEM_NODISCARD event_type operator()(const edm::view< edm::details::add_const_t< edm::schema< VARTYPES... > > > &from, edm::view< edm::schema< VARTYPES... > > to, type::copy_type cptype=type::unknown) const
Copy between two views.
vecmem::copy::memset
VECMEM_NODISCARD event_type memset(data::jagged_vector_view< TYPE > data, int value) const
Set all bytes of the jagged vector to some value.
vecmem::copy::operator()
VECMEM_NODISCARD event_type operator()(const data::jagged_vector_view< std::add_const_t< TYPE > > &from, data::jagged_vector_view< TYPE > to, type::copy_type cptype=type::unknown) const
Copy a jagged vector's data between two existing allocations.
vecmem::copy::setup
VECMEM_NODISCARD event_type setup(edm::view< SCHEMA > data) const
Set up the internal state of a buffer correctly on a device.
vecmem::copy::memset
VECMEM_NODISCARD event_type memset(data::vector_view< TYPE > data, int value) const
Set all bytes of the vector to some value.
vecmem::copy::~copy
virtual ~copy()
Virtual destructor.
Definition copy.hpp:75
vecmem::data::jagged_vector_buffer
Object owning all the data of a jagged vector.
Definition jagged_vector_buffer.hpp:30
vecmem::data::jagged_vector_view
A view for jagged vectors.
Definition jagged_vector_view.hpp:44
vecmem::data::vector_buffer
Object owning the data held by it.
Definition vector_buffer.hpp:29
vecmem::data::vector_view
Class holding data about a 1 dimensional vector/array.
Definition vector_view.hpp:38
vecmem::data::vector_view::size_type
unsigned int size_type
We cannot use boolean types.
Definition vector_view.hpp:47
vecmem::edm::host
Technical base type for host<schema<VARTYPES...>,INTERFACE>
Definition host.hpp:28
vecmem::edm::view
Technical base type for view<schema<VARTYPES...>>
Definition view.hpp:28
vecmem
Main namespace for the vecmem classes/functions.
Definition atomic_ref.hpp:16
vecmem::vector
std::vector< T, vecmem::polymorphic_allocator< T > > vector
Alias type for vectors with our polymorphic allocator.
Definition vector.hpp:35
vecmem::copy::type
Wrapper struct around the copy_type enumeration.
Definition copy.hpp:50
vecmem::copy::type::copy_type
copy_type
Types of memory copies to handle.
Definition copy.hpp:52
vecmem::edm::schema
Meta type describing the "schema" of an SoA container.
Definition schema.hpp:46
Generated by doxygen 1.9.8