forked from fwyzard/soa
-
Notifications
You must be signed in to change notification settings - Fork 0
/
soa_v10.h
602 lines (561 loc) · 52.8 KB
/
soa_v10.h
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
/*
* Structure-of-Arrays template with "columns" and "scalars", defined through preprocessor macros,
* with compile-time size and alignment, and accessors to the "rows" and "columns".
*/
#pragma once
#include <iostream>
#include <cassert>
#include "boost/preprocessor.hpp"
#include <Eigen/Core>
// CUDA attributes
#ifdef __CUDACC__
#define SOA_HOST_ONLY __host__
#define SOA_DEVICE_ONLY __device__
#define SOA_HOST_DEVICE __host__ __device__
#define SOA_HOST_DEVICE_INLINE __host__ __device__ __forceinline__
#else
#define SOA_HOST_ONLY
#define SOA_DEVICE_ONLY
#define SOA_HOST_DEVICE
#define SOA_HOST_DEVICE_INLINE inline
#endif
// compile-time sized SoA
// Helper template managing the value within it column
template<typename T>
class SoAValue {
public:
SOA_HOST_DEVICE_INLINE SoAValue(size_t i, T * col): val_(col[i]) {}
SOA_HOST_DEVICE_INLINE operator T&() { return val_; }
SOA_HOST_DEVICE_INLINE operator const T&() const { return val_; }
SOA_HOST_DEVICE_INLINE T* operator& () { return &val_; }
SOA_HOST_DEVICE_INLINE const T* operator& () const { return &val_; }
template <typename T2>
SOA_HOST_DEVICE_INLINE T& operator= (const T2& v) { return val_ = v; }
typedef T valueType;
static constexpr auto valueSize = sizeof(T);
private:
T &val_;
};
// Helper template managing the value within it column
template<class C>
class SoAEigenValue {
public:
typedef C Type;
typedef Eigen::Map<C, 0, Eigen::InnerStride<Eigen::Dynamic>> MapType;
typedef Eigen::Map<const C, 0, Eigen::InnerStride<Eigen::Dynamic>> CMapType;
SOA_HOST_DEVICE_INLINE SoAEigenValue(size_t i, typename C::Scalar * col, size_t stride):
val_(col + i, C::RowsAtCompileTime, C::ColsAtCompileTime,
Eigen::InnerStride<Eigen::Dynamic>(stride)),
crCol_(col),
cVal_(crCol_ + i, C::RowsAtCompileTime, C::ColsAtCompileTime,
Eigen::InnerStride<Eigen::Dynamic>(stride)),
stride_(stride) {}
SOA_HOST_DEVICE_INLINE MapType& operator() () { return val_; }
SOA_HOST_DEVICE_INLINE const CMapType& operator() () const { return cVal_; }
SOA_HOST_DEVICE_INLINE operator C() { return val_; }
SOA_HOST_DEVICE_INLINE operator const C() const { return cVal_; }
SOA_HOST_DEVICE_INLINE C* operator& () { return &val_; }
SOA_HOST_DEVICE_INLINE const C* operator& () const { return &cVal_; }
template <class C2>
SOA_HOST_DEVICE_INLINE MapType& operator= (const C2& v) { return val_ = v; }
typedef typename C::Scalar ValueType;
static constexpr auto valueSize = sizeof(C::Scalar);
SOA_HOST_DEVICE_INLINE size_t stride() { return stride_; }
template<typename OtherDerived>
typename Eigen::MatrixBase<C>::template cross_product_return_type<OtherDerived>::type
SOA_HOST_DEVICE_INLINE cross(const Eigen::MatrixBase<OtherDerived>& other) const { return cVal_.cross(other); }
template<typename OtherType>
typename Eigen::MatrixBase<C>::template cross_product_return_type<typename OtherType::MapType>::type
SOA_HOST_DEVICE_INLINE cross(const OtherType& other) const { return cVal_.cross(other.cVal_); }
private:
MapType val_;
const typename C::Scalar * __restrict__ crCol_;
CMapType cVal_;
size_t stride_;
};
// Helper template to avoid commas in macro
template<class C>
struct EigenConstMapMaker {
typedef Eigen::Map<const C, 0, Eigen::InnerStride<Eigen::Dynamic>> Type;
class DataHolder {
public:
DataHolder(const typename C::Scalar * data): data_(data) {}
EigenConstMapMaker::Type withStride(size_t stride) {
return EigenConstMapMaker::Type(data_, C::RowsAtCompileTime, C::ColsAtCompileTime,
Eigen::InnerStride<Eigen::Dynamic>(stride));
}
private:
const typename C::Scalar * const data_;
};
static DataHolder withData(const typename C::Scalar * data) {
return DataHolder(data);
}
};
/* declare "scalars" (one value shared across the whole SoA) and "columns" (one value per element) */
#define _VALUE_TYPE_SCALAR 0
#define _VALUE_TYPE_COLUMN 1
#define _VALUE_TYPE_EIGEN_COLUMN 2
#define _VALUE_TYPE_FUNDAMENTAL_COLUMN 3
#define SoA_scalar(TYPE, NAME) (_VALUE_TYPE_SCALAR, TYPE, NAME)
#define SoA_column(TYPE, NAME) (_VALUE_TYPE_COLUMN, TYPE, NAME)
#define SoA_eigenColumn(TYPE, NAME) (_VALUE_TYPE_EIGEN_COLUMN, TYPE, NAME)
#define SoA_FundamentalTypeColumn(TYPE, NAME) (_VALUE_TYPE_FUNDAMENTAL_COLUMN, TYPE, NAME)
/* Iterate on the macro MACRO and return the result as a comma separated list */
#define _ITERATE_ON_ALL_COMMA(MACRO, DATA, ...) \
BOOST_PP_TUPLE_ENUM( \
BOOST_PP_SEQ_TO_TUPLE( \
_ITERATE_ON_ALL(MACRO, DATA, __VA_ARGS__) \
) \
)
/* Iterate MACRO on all elements */
#define _ITERATE_ON_ALL(MACRO, DATA, ...) \
BOOST_PP_SEQ_FOR_EACH(MACRO, DATA, \
BOOST_PP_VARIADIC_TO_SEQ(__VA_ARGS__) \
)
/* Switch on macros depending on scalar / column type */
#define _SWITCH_ON_TYPE(VALUE_TYPE, IF_SCALAR, IF_COLUMN, IF_EIGEN_COLUMN, IF_FUNDAMENTAL_COLUMN) \
BOOST_PP_IF(BOOST_PP_EQUAL(VALUE_TYPE, _VALUE_TYPE_SCALAR), \
IF_SCALAR, \
BOOST_PP_IF(BOOST_PP_EQUAL(VALUE_TYPE, _VALUE_TYPE_COLUMN), \
IF_COLUMN, \
BOOST_PP_IF(BOOST_PP_EQUAL(VALUE_TYPE, _VALUE_TYPE_EIGEN_COLUMN), \
IF_EIGEN_COLUMN, \
BOOST_PP_IF(BOOST_PP_EQUAL(VALUE_TYPE, _VALUE_TYPE_FUNDAMENTAL_COLUMN), \
IF_FUNDAMENTAL_COLUMN, \
BOOST_PP_EMPTY() \
) \
) \
) \
)
/* dump SoA fields information; these should expand to, for columns:
* Example:
* declare_SoA_template(SoA,
* // predefined static scalars
* // size_t size;
* // size_t alignment;
*
* // columns: one value per element
* SoA_FundamentalTypeColumn(double, x),
* SoA_FundamentalTypeColumn(double, y),
* SoA_FundamentalTypeColumn(double, z),
* SoA_eigenColumn(Eigen::Vector3d, a),
* SoA_eigenColumn(Eigen::Vector3d, b),
* SoA_eigenColumn(Eigen::Vector3d, r),
* SoA_column(uint16_t, colour),
* SoA_column(int32_t, value),
* SoA_column(double *, py),
* SoA_FundamentalTypeColumn(uint32_t, count),
* SoA_FundamentalTypeColumn(uint32_t, anotherCount),
*
* // scalars: one value for the whole structure
* SoA_scalar(const char *, description),
* SoA_scalar(uint32_t, someNumber)
* );
*
* dumps as:
* SoA(32, 64):
* sizeof(SoA): 152
* Column x_ at offset 0 has size 256 and padding 0
* Column y_ at offset 256 has size 256 and padding 0
* Column z_ at offset 512 has size 256 and padding 0
* Eigen value a_ at offset 768 has dimension (3 x 1) and per column size 256 and padding 0
* Eigen value b_ at offset 1536 has dimension (3 x 1) and per column size 256 and padding 0
* Eigen value r_ at offset 2304 has dimension (3 x 1) and per column size 256 and padding 0
* Column colour_ at offset 3072 has size 64 and padding 0
* Column value_ at offset 3136 has size 128 and padding 0
* Column py_ at offset 3264 has size 256 and padding 0
* Column count_ at offset 3520 has size 128 and padding 0
* Column anotherCount_ at offset 3648 has size 128 and padding 0
* Scalar description_ at offset 3776 has size 8 and padding 56
* Scalar someNumber_ at offset 3840 has size 4 and padding 60
* Final offset = 3904 computeDataSize(...): 3904
*
*/
#define _DECLARE_SOA_DUMP_INFO_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Dump scalar */ \
std::cout << " Scalar " BOOST_PP_STRINGIZE(NAME) "_ at offset " << offset \
<< " has size " << sizeof(CPP_TYPE) << " and padding " \
<< ((sizeof(CPP_TYPE) - 1) / byteAlignment + 1) * byteAlignment - sizeof(CPP_TYPE) \
<< std::endl; \
offset+=((sizeof(CPP_TYPE) - 1) / byteAlignment + 1) * byteAlignment; \
, \
/* Dump column */ \
std::cout << " Column " BOOST_PP_STRINGIZE(NAME) "_ at offset " << offset \
<< " has size " << sizeof(CPP_TYPE) * nElements << " and padding " \
<< (((nElements * sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment - (sizeof(CPP_TYPE) * nElements) \
<< std::endl; \
offset+=(((nElements * sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment; \
, \
/* Dump Eigen column */ \
std::cout << " Eigen value " BOOST_PP_STRINGIZE(NAME) "_ at offset " << offset \
<< " has dimension (" << CPP_TYPE::RowsAtCompileTime << " x " << CPP_TYPE::ColsAtCompileTime << ")" \
<< " and per column size " << sizeof(CPP_TYPE::Scalar) * nElements << " and padding " \
<< (((nElements * sizeof(CPP_TYPE::Scalar) - 1) / byteAlignment) + 1) * byteAlignment \
- (sizeof(CPP_TYPE::Scalar) * nElements) \
<< std::endl; \
offset+=(((nElements * sizeof(CPP_TYPE::Scalar) - 1) / byteAlignment) + 1) * byteAlignment \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
, \
/* Dump fundamental type column */ \
std::cout << " Column " BOOST_PP_STRINGIZE(NAME) "_ at offset " << offset \
<< " has size " << sizeof(CPP_TYPE) * nElements << " and padding " \
<< (((nElements * sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment - (sizeof(CPP_TYPE) * nElements) \
<< std::endl; \
offset+=(((nElements * sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment; \
)
#define _DECLARE_SOA_DUMP_INFO(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_SOA_DUMP_INFO_IMPL TYPE_NAME)
/**
* Computation of the column or scalar pointer location in the memory layout (at SoA construction time)
*/
#define _ASSIGN_SOA_COLUMN_OR_SCALAR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_CAT(NAME, _) = reinterpret_cast<CPP_TYPE *>(curMem); \
curMem += (((sizeof(CPP_TYPE) - 1) / byteAlignment_) + 1) * byteAlignment_; \
, \
/* Column */ \
BOOST_PP_CAT(NAME, _) = reinterpret_cast<CPP_TYPE *>(curMem); \
curMem += (((nElements_ * sizeof(CPP_TYPE) - 1) / byteAlignment_) + 1) * byteAlignment_; \
, \
/* Eigen column */ \
BOOST_PP_CAT(NAME, _) = reinterpret_cast<CPP_TYPE::Scalar *>(curMem); \
curMem += (((nElements_ * sizeof(CPP_TYPE::Scalar) - 1) / byteAlignment_) + 1) * byteAlignment_ \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
BOOST_PP_CAT(NAME, Stride_) = (((nElements_ * sizeof(CPP_TYPE::Scalar) - 1) / byteAlignment_) + 1) \
* byteAlignment_ / sizeof(CPP_TYPE::Scalar); \
, \
/* Fundamental type column */ \
BOOST_PP_CAT(NAME, _) = reinterpret_cast<CPP_TYPE *>(curMem); \
curMem += (((nElements_ * sizeof(CPP_TYPE) - 1) / byteAlignment_) + 1) * byteAlignment_; \
)
#define _ASSIGN_SOA_COLUMN_OR_SCALAR(R, DATA, TYPE_NAME) \
_ASSIGN_SOA_COLUMN_OR_SCALAR_IMPL TYPE_NAME
/**
* Computation of the column or scalar size for SoA size computation
*/
#define _ACCUMULATE_SOA_ELEMENT_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
ret += (((sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment; \
, \
/* Column */ \
ret += (((nElements * sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment; \
, \
/* Eigen column */ \
ret += (((nElements * sizeof(CPP_TYPE::Scalar) - 1) / byteAlignment) + 1) * byteAlignment \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
, \
/* Fundamental type column */ \
ret += (((nElements * sizeof(CPP_TYPE) - 1) / byteAlignment) + 1) * byteAlignment; \
)
#define _ACCUMULATE_SOA_ELEMENT(R, DATA, TYPE_NAME) \
_ACCUMULATE_SOA_ELEMENT_IMPL TYPE_NAME
/**
* Value accessor of the const_element subclass.
*/
#define _DECLARE_SOA_CONST_ELEMENT_ACCESSOR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
SOA_HOST_DEVICE_INLINE \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
CPP_TYPE const & NAME() { return soa_. NAME (); } \
, \
/* Column */ \
CPP_TYPE const & NAME() { return * (soa_. NAME () + index_); } \
, \
/* Eigen column */ \
/* Ugly hack with a helper template to avoid having commas inside the macro parameter */ \
EigenConstMapMaker<CPP_TYPE>::Type const NAME() { \
return EigenConstMapMaker<CPP_TYPE>::withData(soa_. NAME () + index_).withStride(soa_.BOOST_PP_CAT(NAME, Stride)()); \
} \
, \
/* Fundamental type column */ \
CPP_TYPE const & NAME() { return * (soa_. NAME () + index_ + 0 + 0); } \
)
#define _DECLARE_SOA_CONST_ELEMENT_ACCESSOR(R, DATA, TYPE_NAME) \
_DECLARE_SOA_CONST_ELEMENT_ACCESSOR_IMPL TYPE_NAME
/**
* Generator of parameters for (non-const) element subclass (expanded comma separated).
*/
#define _DECLARE_ELEMENT_VALUE_ARG_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_EMPTY() \
, \
/* Column */ \
(CPP_TYPE *NAME) \
, \
/* Eigen column */ \
(CPP_TYPE::Scalar *NAME) (size_t BOOST_PP_CAT(NAME, Stride)) \
, \
/* Fundamental type column */ \
(CPP_TYPE &NAME) \
)
#define _DECLARE_ELEMENT_VALUE_ARG(R, DATA, TYPE_NAME) \
_DECLARE_ELEMENT_VALUE_ARG_IMPL TYPE_NAME
/**
* Generator of member initialization for constructor of element subclass
*/
#define _DECLARE_ELEMENT_VALUE_MEMBER_INITIALISATION_IMPL(VALUE_TYPE, CPP_TYPE, NAME, DATA) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_EMPTY() \
, \
/* Column */ \
(NAME (DATA, NAME)) \
, \
/* Eigen column */ \
(NAME (DATA, NAME, BOOST_PP_CAT(NAME, Stride))) \
, \
/* Fundamental type column */ \
(NAME (NAME)) \
)
/* declare AoS-like element value args for contructor; these should expand,for columns only */
#define _DECLARE_ELEMENT_VALUE_MEMBER_INITIALISATION(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_ELEMENT_VALUE_MEMBER_INITIALISATION_IMPL BOOST_PP_TUPLE_PUSH_BACK(TYPE_NAME, DATA))
/**
* Generator of the member-by-member copy operator of the element subclass.
*/
#define _DECLARE_ELEMENT_VALUE_COPY_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_EMPTY() \
, \
/* Column */ \
static_cast<CPP_TYPE &>(NAME) = static_cast<std::add_const<CPP_TYPE>::type &>(other.NAME); \
, \
/* Eigen column */ \
static_cast<CPP_TYPE>(NAME) = static_cast<std::add_const<CPP_TYPE>::type &>(other.NAME); \
, \
/* Fundamental type column */ \
NAME = static_cast<std::add_const<CPP_TYPE>::type &>(other.NAME); \
)
#define _DECLARE_ELEMENT_VALUE_COPY(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_ELEMENT_VALUE_COPY_IMPL TYPE_NAME)
/**
* Declaration of the members of the element subclass
*/
#define _DECLARE_ELEMENT_VALUE_MEMBER_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_EMPTY() \
, \
/* Column */ \
SoAValue<CPP_TYPE> NAME; \
, \
/* Eigen column */ \
SoAEigenValue<CPP_TYPE> NAME; \
, \
/* Fundamental type column */ \
CPP_TYPE & NAME; \
)
#define _DECLARE_ELEMENT_VALUE_MEMBER(R, DATA, TYPE_NAME) \
_DECLARE_ELEMENT_VALUE_MEMBER_IMPL TYPE_NAME
/**
* Parameters passed to element subclass constructor in operator[]
*/
#define _DECLARE_ELEMENT_CONSTR_CALL_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_EMPTY() \
, \
/* Column */ \
(BOOST_PP_CAT(NAME, _)) \
, \
/* Eigen column */ \
(BOOST_PP_CAT(NAME, _)) (BOOST_PP_CAT(NAME, Stride_)) \
, \
/* Fundamental type column */ \
(BOOST_PP_CAT(NAME, _[index])) \
)
#define _DECLARE_ELEMENT_CONSTR_CALL(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_ELEMENT_CONSTR_CALL_IMPL TYPE_NAME)
/**
* Direct access to column pointer.
*/
#define _DECLARE_SOA_ACCESSOR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE& NAME() { return * BOOST_PP_CAT(NAME, _); } \
, \
/* Column */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE* NAME() { return BOOST_PP_CAT(NAME, _); } \
, \
/* Eigen column */ \
/* Unsupported for the moment TODO */ \
BOOST_PP_EMPTY() \
, \
/* Fundamental type column */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE* NAME() { return BOOST_PP_CAT(NAME, _); } \
)
#define _DECLARE_SOA_ACCESSOR(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_SOA_ACCESSOR_IMPL TYPE_NAME)
/**
* Direct access to column pointer (const).
*/
#define _DECLARE_SOA_CONST_ACCESSOR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE const& NAME() const { return * BOOST_PP_CAT(NAME, _); } \
, \
/* Column */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE const* NAME() const { return BOOST_PP_CAT(NAME, _); } \
, \
/* Eigen column */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE::Scalar const* NAME() const { return BOOST_PP_CAT(NAME, _); } \
SOA_HOST_DEVICE_INLINE size_t BOOST_PP_CAT(NAME,Stride)() const { return BOOST_PP_CAT(NAME, Stride_); } \
, \
/* Fundamental type column */ \
SOA_HOST_DEVICE_INLINE CPP_TYPE const* NAME() const { return BOOST_PP_CAT(NAME, _); } \
)
#define _DECLARE_SOA_CONST_ACCESSOR(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_SOA_CONST_ACCESSOR_IMPL TYPE_NAME)
/**
* SoA class member declaration (column pointers).
*/
#define _DECLARE_SOA_DATA_MEMBER_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
CPP_TYPE * BOOST_PP_CAT(NAME, _); \
, \
/* Column */ \
CPP_TYPE * BOOST_PP_CAT(NAME, _); \
, \
/* Eigen column */ \
CPP_TYPE::Scalar * BOOST_PP_CAT(NAME, _); \
size_t BOOST_PP_CAT(NAME, Stride_); \
, \
/* Fundamental type column */ \
CPP_TYPE * BOOST_PP_CAT(NAME, _); \
)
#define _DECLARE_SOA_DATA_MEMBER(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_SOA_DATA_MEMBER_IMPL TYPE_NAME)
#ifdef DEBUG
#define _DO_RANGECHECK true
#else
#define _DO_RANGECHECK false
#endif
/*
* A macro defining a SoA (structure of variable sized arrays variant).
*/
#define declare_SoA_template(CLASS, ...) \
struct CLASS { \
\
/* these could be moved to an external type trait to free up the symbol names */ \
using self_type = CLASS; \
\
/* For CUDA applications, we align to the 128 bytes of the cache lines. \
* See https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#global-memory-3-0 this is still valid \
* up to compute capability 8.X. \
*/ \
constexpr static size_t defaultAlignment = 128; \
\
/* dump the SoA internal structure */ \
SOA_HOST_ONLY \
static void dump(size_t nElements, size_t byteAlignment = defaultAlignment) { \
std::cout << #CLASS "(" << nElements << ", " << byteAlignment << "): " << std::endl; \
std::cout << " sizeof(" #CLASS "): " << sizeof(CLASS) << std::endl; \
size_t offset=0; \
_ITERATE_ON_ALL(_DECLARE_SOA_DUMP_INFO, ~, __VA_ARGS__) \
std::cout << "Final offset = " << offset << " computeDataSize(...): " << computeDataSize(nElements, byteAlignment) << std::endl;\
std::cout << std::endl; \
} \
/* Helper function used by caller to externally allocate the storage */ \
static size_t computeDataSize(size_t nElements, size_t byteAlignment = defaultAlignment) { \
size_t ret = 0; \
_ITERATE_ON_ALL(_ACCUMULATE_SOA_ELEMENT, ~, __VA_ARGS__) \
return ret; \
} \
\
SOA_HOST_DEVICE_INLINE size_t nElements() const { return nElements_; } \
SOA_HOST_DEVICE_INLINE size_t byteAlignment() const { return byteAlignment_; } \
\
/* Constructor relying on user provided storage */ \
SOA_HOST_ONLY CLASS(std::byte* mem, size_t nElements, size_t byteAlignment = defaultAlignment): \
mem_(mem), nElements_(nElements), byteAlignment_(byteAlignment) { \
auto curMem = mem_; \
_ITERATE_ON_ALL(_ASSIGN_SOA_COLUMN_OR_SCALAR, ~, __VA_ARGS__) \
/* Sanity check: we should have reached the computed size, only on host code */ \
if(mem_ + computeDataSize(nElements_, byteAlignment_) != curMem) \
throw std::out_of_range("In " #CLASS "::" #CLASS ": unexpected end pointer."); \
} \
\
/* Constructor relying on user provided storage */ \
SOA_DEVICE_ONLY CLASS(bool devConstructor, std::byte* mem, size_t nElements, size_t byteAlignment = defaultAlignment): \
mem_(mem), nElements_(nElements), byteAlignment_(byteAlignment) { \
auto curMem = mem_; \
_ITERATE_ON_ALL(_ASSIGN_SOA_COLUMN_OR_SCALAR, ~, __VA_ARGS__) \
} \
\
/* AoS-like accessor to individual elements */ \
struct const_element { \
SOA_HOST_DEVICE_INLINE \
const_element(CLASS const& soa, int index) : \
soa_(soa), \
index_(index) \
{ } \
\
_ITERATE_ON_ALL(_DECLARE_SOA_CONST_ELEMENT_ACCESSOR, ~, __VA_ARGS__) \
\
private: \
CLASS const& soa_; \
const int index_; \
}; \
\
struct element { \
SOA_HOST_DEVICE_INLINE \
element(size_t index, \
/* Declare parameters */ \
_ITERATE_ON_ALL_COMMA(_DECLARE_ELEMENT_VALUE_ARG, index, __VA_ARGS__) \
): \
_ITERATE_ON_ALL_COMMA(_DECLARE_ELEMENT_VALUE_MEMBER_INITIALISATION, index, __VA_ARGS__) \
{} \
SOA_HOST_DEVICE_INLINE \
element& operator=(const element& other) { \
_ITERATE_ON_ALL(_DECLARE_ELEMENT_VALUE_COPY, ~, __VA_ARGS__) \
return *this; \
} \
_ITERATE_ON_ALL(_DECLARE_ELEMENT_VALUE_MEMBER, ~, __VA_ARGS__) \
}; \
\
/* AoS-like accessor */ \
SOA_HOST_DEVICE_INLINE \
element operator[](size_t index) { \
rangeCheck(index); \
return element(index, \
_ITERATE_ON_ALL_COMMA(_DECLARE_ELEMENT_CONSTR_CALL, ~, __VA_ARGS__) ); \
} \
\
SOA_HOST_DEVICE_INLINE \
const element operator[](size_t index) const { \
rangeCheck(index); \
return element(index, \
_ITERATE_ON_ALL_COMMA(_DECLARE_ELEMENT_CONSTR_CALL, ~, __VA_ARGS__) ); \
} \
\
/* accessors */ \
_ITERATE_ON_ALL(_DECLARE_SOA_ACCESSOR, ~, __VA_ARGS__) \
_ITERATE_ON_ALL(_DECLARE_SOA_CONST_ACCESSOR, ~, __VA_ARGS__) \
\
/* dump the SoA internal structure */ \
template <typename T> SOA_HOST_ONLY friend void dump(); \
\
private: \
/* Range checker conditional to the macro _DO_RANGECHECK */ \
SOA_HOST_DEVICE_INLINE \
void rangeCheck(size_t index) const { \
if constexpr (_DO_RANGECHECK) { \
if (index >= nElements_) { \
printf("In " #CLASS "::rangeCheck(): index out of range: %zu with nElements: %zu\n", index, nElements_); \
assert(false); \
} \
} \
} \
\
/* data members */ \
std::byte* mem_; \
size_t nElements_; \
size_t byteAlignment_; \
_ITERATE_ON_ALL(_DECLARE_SOA_DATA_MEMBER, ~, __VA_ARGS__) \
}