|
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
|
#ifndef DataFormats_SoATemplate_interface_SoALayout_h
#define DataFormats_SoATemplate_interface_SoALayout_h
/*
* 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".
*/
#include "FWCore/Reflection/interface/reflex.h"
#include "SoACommon.h"
#include "SoAView.h"
/* dump SoA fields information; these should expand to, for columns:
* Example:
* GENERATE_SOA_LAYOUT(SoA,
* // predefined static scalars
* // size_t size;
* // size_t alignment;
*
* // columns: one value per element
* SOA_COLUMN(double, x),
* SOA_COLUMN(double, y),
* SOA_COLUMN(double, z),
* SOA_EIGEN_COLUMN(Eigen::Vector3d, a),
* SOA_EIGEN_COLUMN(Eigen::Vector3d, b),
* SOA_EIGEN_COLUMN(Eigen::Vector3d, r),
* SOA_COLUMN(uint16_t, colour),
* SOA_COLUMN(int32_t, value),
* SOA_COLUMN(double *, py),
* SOA_COLUMN(uint32_t, count),
* SOA_COLUMN(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
*
*/
// clang-format off
#define _DECLARE_SOA_STREAM_INFO_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE( \
VALUE_TYPE, \
/* Dump scalar */ \
_soa_impl_os << " Scalar " BOOST_PP_STRINGIZE(NAME) " at offset " << _soa_impl_offset \
<< " has size " << sizeof(CPP_TYPE) \
<< " and padding " << ((sizeof(CPP_TYPE) - 1) / alignment + 1) * alignment - sizeof(CPP_TYPE) \
<< std::endl; \
_soa_impl_offset += ((sizeof(CPP_TYPE) - 1) / alignment + 1) * alignment; \
, \
/* Dump column */ \
_soa_impl_os << " Column " BOOST_PP_STRINGIZE(NAME) " at offset " << _soa_impl_offset << " has size " \
<< sizeof(CPP_TYPE) * elements_ << " and padding " \
<< cms::soa::alignSize(elements_ * sizeof(CPP_TYPE), alignment) - (elements_ * sizeof(CPP_TYPE)) \
<< std::endl; \
_soa_impl_offset += cms::soa::alignSize(elements_ * sizeof(CPP_TYPE), alignment); \
, \
/* Dump Eigen column */ \
_soa_impl_os << " Eigen value " BOOST_PP_STRINGIZE(NAME) " at offset " << _soa_impl_offset << " has dimension " \
<< "(" << CPP_TYPE::RowsAtCompileTime << " x " << CPP_TYPE::ColsAtCompileTime << ")" \
<< " and per column size " \
<< sizeof(CPP_TYPE::Scalar) * elements_ \
<< " and padding " \
<< cms::soa::alignSize(elements_ * sizeof(CPP_TYPE::Scalar), alignment) \
- (elements_ * sizeof(CPP_TYPE::Scalar)) \
<< std::endl; \
_soa_impl_offset += cms::soa::alignSize(elements_ * sizeof(CPP_TYPE::Scalar), alignment) \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
)
// clang-format on
#define _DECLARE_SOA_STREAM_INFO(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_DECLARE_SOA_STREAM_INFO_IMPL TYPE_NAME)
/**
* Metadata member computing column pitch
*/
// clang-format off
#define _DEFINE_METADATA_MEMBERS_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
byte_size_type BOOST_PP_CAT(NAME, Pitch()) const { \
return cms::soa::alignSize(sizeof(CPP_TYPE), ParentClass::alignment); \
} \
using BOOST_PP_CAT(TypeOf_, NAME) = CPP_TYPE; \
constexpr static cms::soa::SoAColumnType BOOST_PP_CAT(ColumnTypeOf_, NAME) = cms::soa::SoAColumnType::scalar; \
SOA_HOST_DEVICE SOA_INLINE \
CPP_TYPE const* BOOST_PP_CAT(addressOf_, NAME)() const { \
return parent_.metadata().BOOST_PP_CAT(parametersOf_, NAME)().addr_; \
} \
using BOOST_PP_CAT(ParametersTypeOf_, NAME) = \
cms::soa::SoAParameters_ColumnType<cms::soa::SoAColumnType::scalar>::DataType<CPP_TYPE>; \
SOA_HOST_DEVICE SOA_INLINE \
BOOST_PP_CAT(ParametersTypeOf_, NAME) BOOST_PP_CAT(parametersOf_, NAME)() const { \
return BOOST_PP_CAT(ParametersTypeOf_, NAME) (parent_.BOOST_PP_CAT(NAME, _), parent_.metadata().size()); \
} \
SOA_HOST_DEVICE SOA_INLINE \
CPP_TYPE* BOOST_PP_CAT(addressOf_, NAME)() { \
return parent_.metadata().BOOST_PP_CAT(parametersOf_, NAME)().addr_; \
}, \
/* Column */ \
using BOOST_PP_CAT(ParametersTypeOf_, NAME) = \
cms::soa::SoAParameters_ColumnType<cms::soa::SoAColumnType::column>::DataType<CPP_TYPE>; \
SOA_HOST_DEVICE SOA_INLINE \
BOOST_PP_CAT(ParametersTypeOf_, NAME) BOOST_PP_CAT(parametersOf_, NAME)() const { \
return BOOST_PP_CAT(ParametersTypeOf_, NAME) (parent_.BOOST_PP_CAT(NAME, _), parent_.metadata().size()); \
} \
SOA_HOST_DEVICE SOA_INLINE \
CPP_TYPE const* BOOST_PP_CAT(addressOf_, NAME)() const { \
return parent_.metadata().BOOST_PP_CAT(parametersOf_, NAME)().addr_; \
} \
SOA_HOST_DEVICE SOA_INLINE \
CPP_TYPE* BOOST_PP_CAT(addressOf_, NAME)() { \
return parent_.metadata().BOOST_PP_CAT(parametersOf_, NAME)().addr_; \
} \
SOA_HOST_DEVICE SOA_INLINE \
byte_size_type BOOST_PP_CAT(NAME, Pitch()) const { \
return cms::soa::alignSize(parent_.elements_ * sizeof(CPP_TYPE), ParentClass::alignment); \
} \
using BOOST_PP_CAT(TypeOf_, NAME) = CPP_TYPE; \
constexpr static cms::soa::SoAColumnType BOOST_PP_CAT(ColumnTypeOf_, NAME) = cms::soa::SoAColumnType::column;, \
/* Eigen column */ \
using BOOST_PP_CAT(ParametersTypeOf_, NAME) = \
cms::soa::SoAParameters_ColumnType<cms::soa::SoAColumnType::eigen>::DataType<CPP_TYPE>; \
SOA_HOST_DEVICE SOA_INLINE \
BOOST_PP_CAT(ParametersTypeOf_, NAME) BOOST_PP_CAT(parametersOf_, NAME)() const { \
return BOOST_PP_CAT(ParametersTypeOf_, NAME) ( \
parent_.BOOST_PP_CAT(NAME, _), \
parent_.BOOST_PP_CAT(NAME, Stride_), \
parent_.metadata().size()); \
} \
SOA_HOST_DEVICE SOA_INLINE \
byte_size_type BOOST_PP_CAT(NAME, Pitch()) const { \
return cms::soa::alignSize(parent_.elements_ * sizeof(CPP_TYPE::Scalar), ParentClass::alignment) \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
} \
using BOOST_PP_CAT(TypeOf_, NAME) = CPP_TYPE ; \
constexpr static cms::soa::SoAColumnType BOOST_PP_CAT(ColumnTypeOf_, NAME) = cms::soa::SoAColumnType::eigen; \
SOA_HOST_DEVICE SOA_INLINE \
CPP_TYPE::Scalar const* BOOST_PP_CAT(addressOf_, NAME)() const { \
return parent_.metadata().BOOST_PP_CAT(parametersOf_, NAME)().addr_; \
} \
SOA_HOST_DEVICE SOA_INLINE \
CPP_TYPE::Scalar* BOOST_PP_CAT(addressOf_, NAME)() { \
return parent_.metadata().BOOST_PP_CAT(parametersOf_, NAME)().addr_; \
} \
)
// clang-format on
#define _DEFINE_METADATA_MEMBERS(R, DATA, TYPE_NAME) _DEFINE_METADATA_MEMBERS_IMPL TYPE_NAME
// clang-format off
#define _DECLARE_MEMBER_TRIVIAL_CONSTRUCTION_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
(BOOST_PP_CAT(NAME, _)(nullptr)), \
/* Column */ \
(BOOST_PP_CAT(NAME, _)(nullptr)), \
/* Eigen column */ \
(BOOST_PP_CAT(NAME, Stride_)(0)) \
(BOOST_PP_CAT(NAME, ElementsWithPadding_)(0)) \
(BOOST_PP_CAT(NAME, _)(nullptr)) \
)
// clang-format on
#define _DECLARE_MEMBER_TRIVIAL_CONSTRUCTION(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_MEMBER_TRIVIAL_CONSTRUCTION_IMPL TYPE_NAME)
// clang-format off
#define _DECLARE_MEMBER_COPY_CONSTRUCTION_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
(BOOST_PP_CAT(NAME, _){_soa_impl_other.BOOST_PP_CAT(NAME, _)}), \
/* Column */ \
(BOOST_PP_CAT(NAME, _){_soa_impl_other.BOOST_PP_CAT(NAME, _)}), \
/* Eigen column */ \
(BOOST_PP_CAT(NAME, Stride_){_soa_impl_other.BOOST_PP_CAT(NAME, Stride_)}) \
(BOOST_PP_CAT(NAME, ElementsWithPadding_){_soa_impl_other.BOOST_PP_CAT(NAME, ElementsWithPadding_)}) \
(BOOST_PP_CAT(NAME, _){_soa_impl_other.BOOST_PP_CAT(NAME, _)}) \
)
// clang-format on
#define _DECLARE_MEMBER_COPY_CONSTRUCTION(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_MEMBER_COPY_CONSTRUCTION_IMPL TYPE_NAME)
// clang-format off
#define _DECLARE_MEMBER_ASSIGNMENT_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
BOOST_PP_CAT(NAME, _) = _soa_impl_other.BOOST_PP_CAT(NAME, _);, \
/* Column */ \
BOOST_PP_CAT(NAME, _) = _soa_impl_other.BOOST_PP_CAT(NAME, _);, \
/* Eigen column */ \
BOOST_PP_CAT(NAME, ElementsWithPadding_) = _soa_impl_other.BOOST_PP_CAT(NAME, ElementsWithPadding_); \
BOOST_PP_CAT(NAME, _) = _soa_impl_other.BOOST_PP_CAT(NAME, _); \
BOOST_PP_CAT(NAME, Stride_) = _soa_impl_other.BOOST_PP_CAT(NAME, Stride_); \
)
// clang-format on
#define _DECLARE_MEMBER_ASSIGNMENT(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_DECLARE_MEMBER_ASSIGNMENT_IMPL TYPE_NAME)
/**
* Declare the value_element data members
*/
// clang-format off
#define _DEFINE_VALUE_ELEMENT_MEMBERS_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar (empty) */ \
, \
/* Column */ \
CPP_TYPE NAME; \
, \
/* Eigen column */ \
CPP_TYPE NAME; \
)
// clang-format on
#define _DEFINE_VALUE_ELEMENT_MEMBERS(R, DATA, TYPE_NAME) _DEFINE_VALUE_ELEMENT_MEMBERS_IMPL TYPE_NAME
/**
* List of data members in the value_element constructor arguments
*/
// clang-format off
#define _VALUE_ELEMENT_CTOR_ARGS_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar (empty) */ \
, \
/* Column */ \
(CPP_TYPE NAME), \
/* Eigen column */ \
(CPP_TYPE NAME) \
)
// clang-format on
#define _VALUE_ELEMENT_CTOR_ARGS(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_VALUE_ELEMENT_CTOR_ARGS_IMPL TYPE_NAME)
/**
* List-initalise the value_element data members
*/
// clang-format off
#define _VALUE_ELEMENT_INITIALIZERS_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar (empty) */ \
, \
/* Column */ \
(NAME{NAME}), \
/* Eigen column */ \
(NAME{NAME}) \
)
// clang-format on
#define _VALUE_ELEMENT_INITIALIZERS(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_VALUE_ELEMENT_INITIALIZERS_IMPL TYPE_NAME)
/**
* Freeing of the ROOT-allocated column or scalar buffer
*/
// clang-format off
#define _ROOT_FREE_SOA_COLUMN_OR_SCALAR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
delete[] BOOST_PP_CAT(NAME, _); \
BOOST_PP_CAT(NAME, _) = nullptr; \
// clang-format on
#define _ROOT_FREE_SOA_COLUMN_OR_SCALAR(R, DATA, TYPE_NAME) _ROOT_FREE_SOA_COLUMN_OR_SCALAR_IMPL TYPE_NAME
/**
* Computation of the column or scalar pointer location in the memory layout (at SoA construction time)
*/
// clang-format off
#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*>(_soa_impl_curMem); \
_soa_impl_curMem += cms::soa::alignSize(sizeof(CPP_TYPE), alignment); \
, \
/* Column */ \
BOOST_PP_CAT(NAME, _) = reinterpret_cast<CPP_TYPE*>(_soa_impl_curMem); \
_soa_impl_curMem += cms::soa::alignSize(elements_ * sizeof(CPP_TYPE), alignment); \
, \
/* Eigen column */ \
BOOST_PP_CAT(NAME, Stride_) = cms::soa::alignSize(elements_ * sizeof(CPP_TYPE::Scalar), alignment) \
/ sizeof(CPP_TYPE::Scalar); \
BOOST_PP_CAT(NAME, ElementsWithPadding_) = BOOST_PP_CAT(NAME, Stride_) \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
BOOST_PP_CAT(NAME, _) = reinterpret_cast<CPP_TYPE::Scalar*>(_soa_impl_curMem); \
_soa_impl_curMem += cms::soa::alignSize(elements_ * sizeof(CPP_TYPE::Scalar), alignment) \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
) \
if constexpr (alignmentEnforcement == AlignmentEnforcement::enforced) \
if (reinterpret_cast<intptr_t>(BOOST_PP_CAT(NAME, _)) % alignment) \
throw std::runtime_error("In layout constructor: misaligned column: " #NAME);
// clang-format on
#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
*/
// clang-format off
#define _ACCUMULATE_SOA_ELEMENT_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
_soa_impl_ret += cms::soa::alignSize(sizeof(CPP_TYPE), alignment); \
, \
/* Column */ \
_soa_impl_ret += cms::soa::alignSize(elements * sizeof(CPP_TYPE), alignment); \
, \
/* Eigen column */ \
_soa_impl_ret += cms::soa::alignSize(elements * sizeof(CPP_TYPE::Scalar), alignment) \
* CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; \
)
// clang-format on
#define _ACCUMULATE_SOA_ELEMENT(R, DATA, TYPE_NAME) _ACCUMULATE_SOA_ELEMENT_IMPL TYPE_NAME
/**
* Direct access to column pointer and indexed access
*/
// clang-format off
#define _DECLARE_SOA_ACCESSOR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE& NAME() { return *BOOST_PP_CAT(NAME, _); } \
, \
/* Column */ \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE* NAME() { return BOOST_PP_CAT(NAME, _); } \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE& NAME(size_type _soa_impl_index) { \
return BOOST_PP_CAT(NAME, _)[_soa_impl_index]; \
} \
, \
/* Eigen column */ \
/* TODO: implement*/ \
BOOST_PP_EMPTY() \
)
// clang-format on
#define _DECLARE_SOA_ACCESSOR(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_DECLARE_SOA_ACCESSOR_IMPL TYPE_NAME)
/**
* Direct access to column pointer (const) and indexed access.
*/
// clang-format off
#define _DECLARE_SOA_CONST_ACCESSOR_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE NAME() const { return *(BOOST_PP_CAT(NAME, _)); } \
, \
/* Column */ \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE const* NAME() const { return BOOST_PP_CAT(NAME, _); } \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE NAME(size_type _soa_impl_index) const { \
return *(BOOST_PP_CAT(NAME, _) + _soa_impl_index); \
} \
, \
/* Eigen column */ \
SOA_HOST_DEVICE SOA_INLINE CPP_TYPE::Scalar const* NAME() const { return BOOST_PP_CAT(NAME, _); } \
SOA_HOST_DEVICE SOA_INLINE size_type BOOST_PP_CAT(NAME, Stride)() { return BOOST_PP_CAT(NAME, Stride_); } \
)
// clang-format on
#define _DECLARE_SOA_CONST_ACCESSOR(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_DECLARE_SOA_CONST_ACCESSOR_IMPL TYPE_NAME)
/**
* SoA member ROOT streamer read (column pointers).
*/
// clang-format off
#define _STREAMER_READ_SOA_DATA_MEMBER_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
memcpy(BOOST_PP_CAT(NAME, _), onfile.BOOST_PP_CAT(NAME, _), sizeof(CPP_TYPE)); \
, \
/* Column */ \
memcpy(BOOST_PP_CAT(NAME, _), onfile.BOOST_PP_CAT(NAME, _), sizeof(CPP_TYPE) * onfile.elements_); \
, \
/* Eigen column */ \
memcpy(BOOST_PP_CAT(NAME, _), onfile.BOOST_PP_CAT(NAME, _), \
sizeof(CPP_TYPE::Scalar) * BOOST_PP_CAT(NAME, ElementsWithPadding_)); \
)
// clang-format on
#define _STREAMER_READ_SOA_DATA_MEMBER(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_STREAMER_READ_SOA_DATA_MEMBER_IMPL TYPE_NAME)
/**
* SoA class member declaration (column pointers).
*/
// clang-format off
#define _DECLARE_SOA_DATA_MEMBER_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar */ \
CPP_TYPE* BOOST_PP_CAT(NAME, _) EDM_REFLEX_SIZE(scalar_) = nullptr; \
, \
/* Column */ \
CPP_TYPE * BOOST_PP_CAT(NAME, _) EDM_REFLEX_SIZE(elements_) = nullptr; \
, \
/* Eigen column */ \
byte_size_type BOOST_PP_CAT(NAME, Stride_) = 0; \
size_type BOOST_PP_CAT(NAME, ElementsWithPadding_) = 0; /* For ROOT serialization */ \
CPP_TYPE::Scalar * BOOST_PP_CAT(NAME, _) EDM_REFLEX_SIZE(BOOST_PP_CAT(NAME, ElementsWithPadding_)) = nullptr; \
)
// clang-format on
#define _DECLARE_SOA_DATA_MEMBER(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_DECLARE_SOA_DATA_MEMBER_IMPL TYPE_NAME)
#define _COPY_VIEW_COLUMNS_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE( \
VALUE_TYPE, /* Scalar */ \
memcpy(BOOST_PP_CAT(this->metadata().addressOf_, NAME)(), \
BOOST_PP_CAT(view.metadata().addressOf_, NAME)(), \
sizeof(CPP_TYPE)); \
, /* Column */ \
memcpy(BOOST_PP_CAT(this->metadata().addressOf_, NAME)(), \
BOOST_PP_CAT(view.metadata().addressOf_, NAME)(), \
view.metadata().size() * sizeof(CPP_TYPE)); \
, /* Eigen column */ \
for (unsigned int i = 0; i < CPP_TYPE::RowsAtCompileTime * CPP_TYPE::ColsAtCompileTime; i++) { \
memcpy(BOOST_PP_CAT(this->metadata().addressOf_, NAME)() + i * BOOST_PP_CAT(NAME, Stride_), \
&view[0].NAME().coeff(i), \
view.metadata().size() * sizeof(CPP_TYPE::Scalar)); \
})
#define _COPY_VIEW_COLUMNS(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_COPY_VIEW_COLUMNS_IMPL TYPE_NAME)
#ifdef DEBUG
#define _DO_RANGECHECK true
#else
#define _DO_RANGECHECK false
#endif
/*
* A macro defining a SoA layout (collection of scalars and columns of equal lengths)
*/
// clang-format off
#define GENERATE_SOA_LAYOUT(CLASS, ...) \
template <CMS_SOA_BYTE_SIZE_TYPE ALIGNMENT = cms::soa::CacheLineSize::defaultSize, \
bool ALIGNMENT_ENFORCEMENT = cms::soa::AlignmentEnforcement::relaxed> \
struct CLASS { \
/* these could be moved to an external type trait to free up the symbol names */ \
using self_type = CLASS; \
using AlignmentEnforcement = cms::soa::AlignmentEnforcement; \
\
/* 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. \
*/ \
using size_type = cms::soa::size_type; \
using byte_size_type = cms::soa::byte_size_type; \
constexpr static byte_size_type defaultAlignment = 128; \
constexpr static byte_size_type alignment = ALIGNMENT; \
constexpr static bool alignmentEnforcement = ALIGNMENT_ENFORCEMENT; \
constexpr static byte_size_type conditionalAlignment = \
alignmentEnforcement == cms::soa::AlignmentEnforcement::enforced ? alignment : 0; \
/* Those typedefs avoid having commas in macros (which is problematic) */ \
template <cms::soa::SoAColumnType COLUMN_TYPE, class C> \
using SoAValueWithConf = cms::soa::SoAValue<COLUMN_TYPE, C, conditionalAlignment>; \
\
template <cms::soa::SoAColumnType COLUMN_TYPE, class C> \
using SoAConstValueWithConf = cms::soa::SoAConstValue<COLUMN_TYPE, C, conditionalAlignment>; \
\
template <CMS_SOA_BYTE_SIZE_TYPE VIEW_ALIGNMENT = cms::soa::CacheLineSize::defaultSize, \
bool VIEW_ALIGNMENT_ENFORCEMENT = cms::soa::AlignmentEnforcement::relaxed, \
bool RESTRICT_QUALIFY = cms::soa::RestrictQualify::Default, \
bool RANGE_CHECKING = cms::soa::RangeChecking::Default> \
struct ViewTemplateFreeParams; \
\
/* dump the SoA internal structure */ \
SOA_HOST_ONLY \
void soaToStreamInternal(std::ostream & _soa_impl_os) const { \
_soa_impl_os << #CLASS "(" << elements_ << " elements, byte alignement= " << alignment << ", @"<< mem_ <<"): " \
<< std::endl; \
_soa_impl_os << " sizeof(" #CLASS "): " << sizeof(CLASS) << std::endl; \
byte_size_type _soa_impl_offset = 0; \
_ITERATE_ON_ALL(_DECLARE_SOA_STREAM_INFO, ~, __VA_ARGS__) \
_soa_impl_os << "Final offset = " << _soa_impl_offset << " computeDataSize(...): " << computeDataSize(elements_) \
<< std::endl; \
_soa_impl_os << std::endl; \
} \
\
/* Helper function used by caller to externally allocate the storage */ \
static constexpr byte_size_type computeDataSize(size_type elements) { \
byte_size_type _soa_impl_ret = 0; \
_ITERATE_ON_ALL(_ACCUMULATE_SOA_ELEMENT, ~, __VA_ARGS__) \
return _soa_impl_ret; \
} \
\
/** \
* Helper/friend class allowing SoA introspection. \
*/ \
struct Metadata { \
friend CLASS; \
SOA_HOST_DEVICE SOA_INLINE size_type size() const { return parent_.elements_; } \
SOA_HOST_DEVICE SOA_INLINE byte_size_type byteSize() const { return parent_.byteSize_; } \
SOA_HOST_DEVICE SOA_INLINE byte_size_type alignment() const { return CLASS::alignment; } \
SOA_HOST_DEVICE SOA_INLINE std::byte* data() { return parent_.mem_; } \
SOA_HOST_DEVICE SOA_INLINE const std::byte* data() const { return parent_.mem_; } \
SOA_HOST_DEVICE SOA_INLINE std::byte* nextByte() const { return parent_.mem_ + parent_.byteSize_; } \
SOA_HOST_DEVICE SOA_INLINE CLASS cloneToNewAddress(std::byte* _soa_impl_addr) const { \
return CLASS(_soa_impl_addr, parent_.elements_); \
} \
\
_ITERATE_ON_ALL(_DEFINE_METADATA_MEMBERS, ~, __VA_ARGS__) \
\
struct value_element { \
SOA_HOST_DEVICE SOA_INLINE value_element \
BOOST_PP_IF( \
BOOST_PP_SEQ_SIZE(_ITERATE_ON_ALL(_VALUE_ELEMENT_CTOR_ARGS, ~, __VA_ARGS__) ), \
(_ITERATE_ON_ALL_COMMA(_VALUE_ELEMENT_CTOR_ARGS, ~, __VA_ARGS__)):, \
()) \
BOOST_PP_TUPLE_ENUM(BOOST_PP_IF( \
BOOST_PP_SEQ_SIZE(_ITERATE_ON_ALL(_VALUE_ELEMENT_CTOR_ARGS, ~, __VA_ARGS__)), \
BOOST_PP_SEQ_TO_TUPLE(_ITERATE_ON_ALL(_VALUE_ELEMENT_INITIALIZERS, ~, __VA_ARGS__)), \
() \
) \
) \
{} \
\
_ITERATE_ON_ALL(_DEFINE_VALUE_ELEMENT_MEMBERS, ~, __VA_ARGS__) \
}; \
\
Metadata& operator=(const Metadata&) = delete; \
Metadata(const Metadata&) = delete; \
\
private: \
SOA_HOST_DEVICE SOA_INLINE Metadata(const CLASS& _soa_impl_parent) : parent_(_soa_impl_parent) {} \
const CLASS& parent_; \
using ParentClass = CLASS; \
}; \
\
friend Metadata; \
\
SOA_HOST_DEVICE SOA_INLINE const Metadata metadata() const { return Metadata(*this); } \
SOA_HOST_DEVICE SOA_INLINE Metadata metadata() { return Metadata(*this); } \
\
/* Generate the ConstView template */ \
_GENERATE_SOA_TRIVIAL_CONST_VIEW(CLASS, \
SOA_VIEW_LAYOUT_LIST( \
SOA_VIEW_LAYOUT(BOOST_PP_CAT(CLASS, _parametrized) , BOOST_PP_CAT(instance_, CLASS))), \
SOA_VIEW_VALUE_LIST(_ITERATE_ON_ALL_COMMA( \
_VIEW_FIELD_FROM_LAYOUT, BOOST_PP_CAT(instance_, CLASS), __VA_ARGS__))) \
\
template <bool RESTRICT_QUALIFY, bool RANGE_CHECKING> \
using ConstViewTemplate = ConstViewTemplateFreeParams<ALIGNMENT, ALIGNMENT_ENFORCEMENT, RESTRICT_QUALIFY, \
RANGE_CHECKING>; \
\
using ConstView = ConstViewTemplate<cms::soa::RestrictQualify::Default, cms::soa::RangeChecking::Default>; \
\
/* Generate the mutable View template */ \
_GENERATE_SOA_TRIVIAL_VIEW(CLASS, \
SOA_VIEW_LAYOUT_LIST( \
SOA_VIEW_LAYOUT(BOOST_PP_CAT(CLASS, _parametrized), BOOST_PP_CAT(instance_, CLASS))), \
SOA_VIEW_VALUE_LIST(_ITERATE_ON_ALL_COMMA( \
_VIEW_FIELD_FROM_LAYOUT, BOOST_PP_CAT(instance_, CLASS), __VA_ARGS__)), \
__VA_ARGS__) \
\
template <bool RESTRICT_QUALIFY, bool RANGE_CHECKING> \
using ViewTemplate = ViewTemplateFreeParams<ALIGNMENT, ALIGNMENT_ENFORCEMENT, RESTRICT_QUALIFY, RANGE_CHECKING>; \
\
using View = ViewTemplate<cms::soa::RestrictQualify::Default, cms::soa::RangeChecking::Default>; \
\
/* Trivial constuctor */ \
CLASS() \
: mem_(nullptr), \
elements_(0), \
byteSize_(0), \
_ITERATE_ON_ALL_COMMA(_DECLARE_MEMBER_TRIVIAL_CONSTRUCTION, ~, __VA_ARGS__) {} \
\
/* Constructor relying on user provided storage (implementation shared with ROOT streamer) */ \
SOA_HOST_ONLY CLASS(std::byte* mem, size_type elements) : mem_(mem), elements_(elements), byteSize_(0) { \
organizeColumnsFromBuffer(); \
} \
\
/* Explicit copy constructor and assignment operator */ \
SOA_HOST_ONLY CLASS(CLASS const& _soa_impl_other) \
: mem_(_soa_impl_other.mem_), \
elements_(_soa_impl_other.elements_), \
byteSize_(_soa_impl_other.byteSize_), \
_ITERATE_ON_ALL_COMMA(_DECLARE_MEMBER_COPY_CONSTRUCTION, ~, __VA_ARGS__) {} \
\
SOA_HOST_ONLY CLASS& operator=(CLASS const& _soa_impl_other) { \
mem_ = _soa_impl_other.mem_; \
elements_ = _soa_impl_other.elements_; \
byteSize_ = _soa_impl_other.byteSize_; \
_ITERATE_ON_ALL(_DECLARE_MEMBER_ASSIGNMENT, ~, __VA_ARGS__) \
return *this; \
} \
\
SOA_HOST_ONLY void deepCopy(ConstView const& view) { \
if (elements_ < view.metadata().size()) \
throw std::runtime_error( \
"In "#CLASS "::deepCopy method: number of elements mismatch "); \
_ITERATE_ON_ALL(_COPY_VIEW_COLUMNS, ~, __VA_ARGS__) \
} \
\
/* ROOT read streamer */ \
template <typename T> \
void ROOTReadStreamer(T & onfile) { \
_ITERATE_ON_ALL(_STREAMER_READ_SOA_DATA_MEMBER, ~, __VA_ARGS__) \
} \
\
/* ROOT allocation cleanup */ \
void ROOTStreamerCleaner() { \
/* This function should only be called from the PortableCollection ROOT streamer */ \
_ITERATE_ON_ALL(_ROOT_FREE_SOA_COLUMN_OR_SCALAR, ~, __VA_ARGS__) \
} \
\
/* Dump the SoA internal structure */ \
template <typename T> \
SOA_HOST_ONLY friend void dump(); \
\
private: \
/* Helper method for the user provided storage constructor and ROOT streamer */ \
void organizeColumnsFromBuffer() { \
if constexpr (alignmentEnforcement == cms::soa::AlignmentEnforcement::enforced) \
if (reinterpret_cast<intptr_t>(mem_) % alignment) \
throw std::runtime_error("In " #CLASS "::" #CLASS ": misaligned buffer"); \
auto _soa_impl_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 */ \
byteSize_ = computeDataSize(elements_); \
if (mem_ + byteSize_ != _soa_impl_curMem) \
throw std::runtime_error("In " #CLASS "::" #CLASS ": unexpected end pointer."); \
} \
\
/* Data members */ \
std::byte* mem_ EDM_REFLEX_TRANSIENT; \
size_type elements_; \
size_type const scalar_ = 1; \
byte_size_type byteSize_ EDM_REFLEX_TRANSIENT; \
_ITERATE_ON_ALL(_DECLARE_SOA_DATA_MEMBER, ~, __VA_ARGS__) \
/* Making the code conditional is problematic in macros as the commas will interfere with parameter lisings */ \
/* So instead we make the code unconditional with paceholder names which are protected by a private protection. */ \
/* This will be handled later as we handle the integration of the view as a subclass of the layout. */ \
\
};
// clang-format on
#endif // DataFormats_SoATemplate_interface_SoALayout_h
|