Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RNTupleSerialize.cxx
Go to the documentation of this file.
1/// \file RNTupleSerialize.cxx
2/// \ingroup NTuple ROOT7
3/// \author Jakob Blomer <jblomer@cern.ch>
4/// \author Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>
5/// \date 2021-08-02
6/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
7/// is welcome!
8
9/*************************************************************************
10 * Copyright (C) 1995-2021, Rene Brun and Fons Rademakers. *
11 * All rights reserved. *
12 * *
13 * For the licensing terms see $ROOTSYS/LICENSE. *
14 * For the list of contributors see $ROOTSYS/README/CREDITS. *
15 *************************************************************************/
16
18#include <ROOT/RError.hxx>
21#include <ROOT/RNTupleUtil.hxx>
22
23#include <RVersion.h>
24#include <TBufferFile.h>
25#include <TClass.h>
26#include <TList.h>
27#include <TStreamerInfo.h>
29#include <xxhash.h>
30
31#include <cassert>
32#include <cmath>
33#include <cstring> // for memcpy
34#include <deque>
35#include <functional>
36#include <limits>
37#include <set>
38#include <unordered_map>
39
40namespace {
42
43std::uint32_t SerializeField(const ROOT::Experimental::RFieldDescriptor &fieldDesc,
45 ROOT::Experimental::DescriptorId_t onDiskProjectionSourceId, void *buffer)
46{
47
48 auto base = reinterpret_cast<unsigned char *>(buffer);
49 auto pos = base;
50 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
51
52 pos += RNTupleSerializer::SerializeRecordFramePreamble(*where);
53
54 pos += RNTupleSerializer::SerializeUInt32(fieldDesc.GetFieldVersion(), *where);
55 pos += RNTupleSerializer::SerializeUInt32(fieldDesc.GetTypeVersion(), *where);
56 pos += RNTupleSerializer::SerializeUInt32(onDiskParentId, *where);
57 pos += RNTupleSerializer::SerializeFieldStructure(fieldDesc.GetStructure(), *where);
58
59 std::uint16_t flags = 0;
60 if (fieldDesc.GetNRepetitions() > 0)
61 flags |= RNTupleSerializer::kFlagRepetitiveField;
62 if (fieldDesc.IsProjectedField())
63 flags |= RNTupleSerializer::kFlagProjectedField;
64 if (fieldDesc.GetTypeChecksum().has_value())
65 flags |= RNTupleSerializer::kFlagHasTypeChecksum;
66 pos += RNTupleSerializer::SerializeUInt16(flags, *where);
67
68 pos += RNTupleSerializer::SerializeString(fieldDesc.GetFieldName(), *where);
69 pos += RNTupleSerializer::SerializeString(fieldDesc.GetTypeName(), *where);
70 pos += RNTupleSerializer::SerializeString(fieldDesc.GetTypeAlias(), *where);
71 pos += RNTupleSerializer::SerializeString(fieldDesc.GetFieldDescription(), *where);
72
73 if (flags & RNTupleSerializer::kFlagRepetitiveField) {
74 pos += RNTupleSerializer::SerializeUInt64(fieldDesc.GetNRepetitions(), *where);
75 }
76 if (flags & RNTupleSerializer::kFlagProjectedField) {
77 pos += RNTupleSerializer::SerializeUInt32(onDiskProjectionSourceId, *where);
78 }
79 if (flags & RNTupleSerializer::kFlagHasTypeChecksum) {
80 pos += RNTupleSerializer::SerializeUInt32(fieldDesc.GetTypeChecksum().value(), *where);
81 }
82
83 auto size = pos - base;
84 RNTupleSerializer::SerializeFramePostscript(base, size);
85
86 return size;
87}
88
89// clang-format off
90/// Serialize, in order, fields enumerated in `fieldList` to `buffer`. `firstOnDiskId` specifies the on-disk ID for the
91/// first element in the `fieldList` sequence. Before calling this function `RContext::MapSchema()` should have been
92/// called on `context` in order to map in-memory field IDs to their on-disk counterpart.
93/// \return The number of bytes written to the output buffer; if `buffer` is `nullptr` no data is serialized and the
94/// required buffer size is returned
95// clang-format on
96std::uint32_t SerializeFieldList(const ROOT::Experimental::RNTupleDescriptor &desc,
97 std::span<const ROOT::Experimental::DescriptorId_t> fieldList,
98 std::size_t firstOnDiskId,
100{
102
103 auto base = reinterpret_cast<unsigned char *>(buffer);
104 auto pos = base;
105 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
106
107 auto fieldZeroId = desc.GetFieldZeroId();
108 ROOT::Experimental::DescriptorId_t onDiskFieldId = firstOnDiskId;
109 for (auto fieldId : fieldList) {
110 const auto &f = desc.GetFieldDescriptor(fieldId);
111 auto onDiskParentId =
112 (f.GetParentId() == fieldZeroId) ? onDiskFieldId : context.GetOnDiskFieldId(f.GetParentId());
113 auto onDiskProjectionSourceId =
114 f.IsProjectedField() ? context.GetOnDiskFieldId(f.GetProjectionSourceId()) : kInvalidDescriptorId;
115 pos += SerializeField(f, onDiskParentId, onDiskProjectionSourceId, *where);
116 ++onDiskFieldId;
117 }
118
119 return pos - base;
120}
121
122ROOT::RResult<std::uint32_t> DeserializeField(const void *buffer, std::uint64_t bufSize,
124{
126
127 auto base = reinterpret_cast<const unsigned char *>(buffer);
128 auto bytes = base;
129 std::uint64_t frameSize;
130 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - base); };
131 auto result = RNTupleSerializer::DeserializeFrameHeader(bytes, bufSize, frameSize);
132 if (!result)
133 return R__FORWARD_ERROR(result);
134 bytes += result.Unwrap();
135
136 std::uint32_t fieldVersion;
137 std::uint32_t typeVersion;
138 std::uint32_t parentId;
139 // initialize properly for call to SerializeFieldStructure()
140 ENTupleStructure structure{ENTupleStructure::kLeaf};
141 std::uint16_t flags;
142 if (fnFrameSizeLeft() < 3 * sizeof(std::uint32_t) + RNTupleSerializer::SerializeFieldStructure(structure, nullptr) +
143 sizeof(std::uint16_t)) {
144 return R__FAIL("field record frame too short");
145 }
146 bytes += RNTupleSerializer::DeserializeUInt32(bytes, fieldVersion);
147 bytes += RNTupleSerializer::DeserializeUInt32(bytes, typeVersion);
148 bytes += RNTupleSerializer::DeserializeUInt32(bytes, parentId);
149 result = RNTupleSerializer::DeserializeFieldStructure(bytes, structure);
150 if (!result)
151 return R__FORWARD_ERROR(result);
152 bytes += result.Unwrap();
153 bytes += RNTupleSerializer::DeserializeUInt16(bytes, flags);
154 fieldDesc.FieldVersion(fieldVersion).TypeVersion(typeVersion).ParentId(parentId).Structure(structure);
155
156 std::string fieldName;
157 std::string typeName;
158 std::string aliasName;
159 std::string description;
160 result = RNTupleSerializer::DeserializeString(bytes, fnFrameSizeLeft(), fieldName).Unwrap();
161 if (!result)
162 return R__FORWARD_ERROR(result);
163 bytes += result.Unwrap();
164 result = RNTupleSerializer::DeserializeString(bytes, fnFrameSizeLeft(), typeName).Unwrap();
165 if (!result)
166 return R__FORWARD_ERROR(result);
167 bytes += result.Unwrap();
168 result = RNTupleSerializer::DeserializeString(bytes, fnFrameSizeLeft(), aliasName).Unwrap();
169 if (!result)
170 return R__FORWARD_ERROR(result);
171 bytes += result.Unwrap();
172 result = RNTupleSerializer::DeserializeString(bytes, fnFrameSizeLeft(), description).Unwrap();
173 if (!result)
174 return R__FORWARD_ERROR(result);
175 bytes += result.Unwrap();
176 fieldDesc.FieldName(fieldName).TypeName(typeName).TypeAlias(aliasName).FieldDescription(description);
177
178 if (flags & RNTupleSerializer::kFlagRepetitiveField) {
179 if (fnFrameSizeLeft() < sizeof(std::uint64_t))
180 return R__FAIL("field record frame too short");
181 std::uint64_t nRepetitions;
182 bytes += RNTupleSerializer::DeserializeUInt64(bytes, nRepetitions);
183 fieldDesc.NRepetitions(nRepetitions);
184 }
185
186 if (flags & RNTupleSerializer::kFlagProjectedField) {
187 if (fnFrameSizeLeft() < sizeof(std::uint32_t))
188 return R__FAIL("field record frame too short");
189 std::uint32_t projectionSourceId;
190 bytes += RNTupleSerializer::DeserializeUInt32(bytes, projectionSourceId);
191 fieldDesc.ProjectionSourceId(projectionSourceId);
192 }
193
194 if (flags & RNTupleSerializer::kFlagHasTypeChecksum) {
195 if (fnFrameSizeLeft() < sizeof(std::uint32_t))
196 return R__FAIL("field record frame too short");
197 std::uint32_t typeChecksum;
198 bytes += RNTupleSerializer::DeserializeUInt32(bytes, typeChecksum);
199 fieldDesc.TypeChecksum(typeChecksum);
200 }
201
202 return frameSize;
203}
204
205std::uint32_t SerializePhysicalColumn(const ROOT::Experimental::RColumnDescriptor &columnDesc,
207 void *buffer)
208{
209 R__ASSERT(!columnDesc.IsAliasColumn());
210
211 auto base = reinterpret_cast<unsigned char *>(buffer);
212 auto pos = base;
213 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
214
215 pos += RNTupleSerializer::SerializeRecordFramePreamble(*where);
216
217 pos += RNTupleSerializer::SerializeColumnType(columnDesc.GetType(), *where);
218 pos += RNTupleSerializer::SerializeUInt16(columnDesc.GetBitsOnStorage(), *where);
219 pos += RNTupleSerializer::SerializeUInt32(context.GetOnDiskFieldId(columnDesc.GetFieldId()), *where);
220 std::uint16_t flags = 0;
221 if (columnDesc.IsDeferredColumn())
222 flags |= RNTupleSerializer::kFlagDeferredColumn;
223 if (columnDesc.GetValueRange().has_value())
224 flags |= RNTupleSerializer::kFlagHasValueRange;
225 std::int64_t firstElementIdx = columnDesc.GetFirstElementIndex();
226 if (columnDesc.IsSuppressedDeferredColumn())
227 firstElementIdx = -firstElementIdx;
228 pos += RNTupleSerializer::SerializeUInt16(flags, *where);
229 pos += RNTupleSerializer::SerializeUInt16(columnDesc.GetRepresentationIndex(), *where);
230 if (flags & RNTupleSerializer::kFlagDeferredColumn)
231 pos += RNTupleSerializer::SerializeInt64(firstElementIdx, *where);
232 if (flags & RNTupleSerializer::kFlagHasValueRange) {
233 auto [min, max] = *columnDesc.GetValueRange();
234 std::uint64_t intMin, intMax;
235 static_assert(sizeof(min) == sizeof(intMin) && sizeof(max) == sizeof(intMax));
236 memcpy(&intMin, &min, sizeof(min));
237 memcpy(&intMax, &max, sizeof(max));
238 pos += RNTupleSerializer::SerializeUInt64(intMin, *where);
239 pos += RNTupleSerializer::SerializeUInt64(intMax, *where);
240 }
241
242 pos += RNTupleSerializer::SerializeFramePostscript(buffer ? base : nullptr, pos - base);
243
244 return pos - base;
245}
246
247std::uint32_t SerializeColumnsOfFields(const ROOT::Experimental::RNTupleDescriptor &desc,
248 std::span<const ROOT::Experimental::DescriptorId_t> fieldList,
250 void *buffer)
251{
252 auto base = reinterpret_cast<unsigned char *>(buffer);
253 auto pos = base;
254 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
255
256 for (auto parentId : fieldList) {
257 for (const auto &c : desc.GetColumnIterable(parentId)) {
258 if (c.IsAliasColumn())
259 continue;
260
261 pos += SerializePhysicalColumn(c, context, *where);
262 }
263 }
264
265 return pos - base;
266}
267
268ROOT::RResult<std::uint32_t> DeserializeColumn(const void *buffer, std::uint64_t bufSize,
270{
272
273 auto base = reinterpret_cast<const unsigned char *>(buffer);
274 auto bytes = base;
275 std::uint64_t frameSize;
276 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - base); };
277 auto result = RNTupleSerializer::DeserializeFrameHeader(bytes, bufSize, frameSize);
278 if (!result)
279 return R__FORWARD_ERROR(result);
280 bytes += result.Unwrap();
281
282 // Initialize properly for SerializeColumnType
283 EColumnType type{EColumnType::kIndex32};
284 std::uint16_t bitsOnStorage;
285 std::uint32_t fieldId;
286 std::uint16_t flags;
287 std::uint16_t representationIndex;
288 std::int64_t firstElementIdx = 0;
289 if (fnFrameSizeLeft() <
290 RNTupleSerializer::SerializeColumnType(type, nullptr) + sizeof(std::uint16_t) + 2 * sizeof(std::uint32_t)) {
291 return R__FAIL("column record frame too short");
292 }
293 result = RNTupleSerializer::DeserializeColumnType(bytes, type);
294 if (!result)
295 return R__FORWARD_ERROR(result);
296 bytes += result.Unwrap();
297 bytes += RNTupleSerializer::DeserializeUInt16(bytes, bitsOnStorage);
298 bytes += RNTupleSerializer::DeserializeUInt32(bytes, fieldId);
299 bytes += RNTupleSerializer::DeserializeUInt16(bytes, flags);
300 bytes += RNTupleSerializer::DeserializeUInt16(bytes, representationIndex);
301 if (flags & RNTupleSerializer::kFlagDeferredColumn) {
302 if (fnFrameSizeLeft() < sizeof(std::uint64_t))
303 return R__FAIL("column record frame too short");
304 bytes += RNTupleSerializer::DeserializeInt64(bytes, firstElementIdx);
305 }
306 if (flags & RNTupleSerializer::kFlagHasValueRange) {
307 if (fnFrameSizeLeft() < 2 * sizeof(std::uint64_t))
308 return R__FAIL("field record frame too short");
309 std::uint64_t minInt, maxInt;
310 bytes += RNTupleSerializer::DeserializeUInt64(bytes, minInt);
311 bytes += RNTupleSerializer::DeserializeUInt64(bytes, maxInt);
312 double min, max;
313 memcpy(&min, &minInt, sizeof(min));
314 memcpy(&max, &maxInt, sizeof(max));
315 columnDesc.ValueRange(min, max);
316 }
317
318 columnDesc.FieldId(fieldId).BitsOnStorage(bitsOnStorage).Type(type).RepresentationIndex(representationIndex);
319 columnDesc.FirstElementIndex(std::abs(firstElementIdx));
320 if (firstElementIdx < 0)
321 columnDesc.SetSuppressedDeferred();
322
323 return frameSize;
324}
325
326std::uint32_t SerializeExtraTypeInfo(const ROOT::Experimental::RExtraTypeInfoDescriptor &desc, void *buffer)
327{
328 auto base = reinterpret_cast<unsigned char *>(buffer);
329 auto pos = base;
330 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
331
332 pos += RNTupleSerializer::SerializeRecordFramePreamble(*where);
333
334 pos += RNTupleSerializer::SerializeExtraTypeInfoId(desc.GetContentId(), *where);
335 pos += RNTupleSerializer::SerializeUInt32(desc.GetTypeVersion(), *where);
336 pos += RNTupleSerializer::SerializeString(desc.GetTypeName(), *where);
337 pos += RNTupleSerializer::SerializeString(desc.GetContent(), *where);
338
339 auto size = pos - base;
340 RNTupleSerializer::SerializeFramePostscript(base, size);
341
342 return size;
343}
344
345std::uint32_t SerializeExtraTypeInfoList(const ROOT::Experimental::RNTupleDescriptor &ntplDesc, void *buffer)
346{
347 auto base = reinterpret_cast<unsigned char *>(buffer);
348 auto pos = base;
349 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
350
351 for (const auto &extraTypeInfoDesc : ntplDesc.GetExtraTypeInfoIterable()) {
352 pos += SerializeExtraTypeInfo(extraTypeInfoDesc, *where);
353 }
354
355 return pos - base;
356}
357
359DeserializeExtraTypeInfo(const void *buffer, std::uint64_t bufSize,
361{
363
364 auto base = reinterpret_cast<const unsigned char *>(buffer);
365 auto bytes = base;
366 std::uint64_t frameSize;
367 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - base); };
368 auto result = RNTupleSerializer::DeserializeFrameHeader(bytes, bufSize, frameSize);
369 if (!result)
370 return R__FORWARD_ERROR(result);
371 bytes += result.Unwrap();
372
373 EExtraTypeInfoIds contentId{EExtraTypeInfoIds::kInvalid};
374 std::uint32_t typeVersion;
375 if (fnFrameSizeLeft() < 2 * sizeof(std::uint32_t)) {
376 return R__FAIL("extra type info record frame too short");
377 }
378 result = RNTupleSerializer::DeserializeExtraTypeInfoId(bytes, contentId);
379 if (!result)
380 return R__FORWARD_ERROR(result);
381 bytes += result.Unwrap();
382 bytes += RNTupleSerializer::DeserializeUInt32(bytes, typeVersion);
383
384 std::string typeName;
385 std::string content;
386 result = RNTupleSerializer::DeserializeString(bytes, fnFrameSizeLeft(), typeName).Unwrap();
387 if (!result)
388 return R__FORWARD_ERROR(result);
389 bytes += result.Unwrap();
390 result = RNTupleSerializer::DeserializeString(bytes, fnFrameSizeLeft(), content).Unwrap();
391 if (!result)
392 return R__FORWARD_ERROR(result);
393 bytes += result.Unwrap();
394
395 desc.ContentId(contentId).TypeVersion(typeVersion).TypeName(typeName).Content(content);
396
397 return frameSize;
398}
399
400std::uint32_t SerializeLocatorPayloadLarge(const ROOT::Experimental::RNTupleLocator &locator, unsigned char *buffer)
401{
402 if (buffer) {
403 RNTupleSerializer::SerializeUInt64(locator.GetNBytesOnStorage(), buffer);
404 RNTupleSerializer::SerializeUInt64(locator.GetPosition<std::uint64_t>(), buffer + sizeof(std::uint64_t));
405 }
406 return sizeof(std::uint64_t) + sizeof(std::uint64_t);
407}
408
409void DeserializeLocatorPayloadLarge(const unsigned char *buffer, ROOT::Experimental::RNTupleLocator &locator)
410{
411 std::uint64_t nBytesOnStorage;
412 std::uint64_t position;
413 RNTupleSerializer::DeserializeUInt64(buffer, nBytesOnStorage);
414 RNTupleSerializer::DeserializeUInt64(buffer + sizeof(std::uint64_t), position);
415 locator.SetNBytesOnStorage(nBytesOnStorage);
416 locator.SetPosition(position);
417}
418
419std::uint32_t SerializeLocatorPayloadObject64(const ROOT::Experimental::RNTupleLocator &locator, unsigned char *buffer)
420{
422 const uint32_t sizeofNBytesOnStorage = (locator.GetNBytesOnStorage() > std::numeric_limits<std::uint32_t>::max())
423 ? sizeof(std::uint64_t)
424 : sizeof(std::uint32_t);
425 if (buffer) {
426 if (sizeofNBytesOnStorage == sizeof(std::uint32_t)) {
427 RNTupleSerializer::SerializeUInt32(locator.GetNBytesOnStorage(), buffer);
428 } else {
429 RNTupleSerializer::SerializeUInt64(locator.GetNBytesOnStorage(), buffer);
430 }
431 RNTupleSerializer::SerializeUInt64(data.GetLocation(), buffer + sizeofNBytesOnStorage);
432 }
433 return sizeofNBytesOnStorage + sizeof(std::uint64_t);
434}
435
436void DeserializeLocatorPayloadObject64(const unsigned char *buffer, std::uint32_t sizeofLocatorPayload,
438{
439 std::uint64_t location;
440 if (sizeofLocatorPayload == 12) {
441 std::uint32_t nBytesOnStorage;
442 RNTupleSerializer::DeserializeUInt32(buffer, nBytesOnStorage);
443 locator.SetNBytesOnStorage(nBytesOnStorage);
444 RNTupleSerializer::DeserializeUInt64(buffer + sizeof(std::uint32_t), location);
445 } else if (sizeofLocatorPayload == 16) {
446 std::uint64_t nBytesOnStorage;
447 RNTupleSerializer::DeserializeUInt64(buffer, nBytesOnStorage);
448 locator.SetNBytesOnStorage(nBytesOnStorage);
449 RNTupleSerializer::DeserializeUInt64(buffer + sizeof(std::uint64_t), location);
450 } else {
451 throw ROOT::RException(R__FAIL("invalid DAOS locator payload size: " + std::to_string(sizeofLocatorPayload)));
452 }
454}
455
456std::uint32_t SerializeAliasColumn(const ROOT::Experimental::RColumnDescriptor &columnDesc,
458 void *buffer)
459{
460 R__ASSERT(columnDesc.IsAliasColumn());
461
462 auto base = reinterpret_cast<unsigned char *>(buffer);
463 auto pos = base;
464 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
465
466 pos += RNTupleSerializer::SerializeRecordFramePreamble(*where);
467
468 pos += RNTupleSerializer::SerializeUInt32(context.GetOnDiskColumnId(columnDesc.GetPhysicalId()), *where);
469 pos += RNTupleSerializer::SerializeUInt32(context.GetOnDiskFieldId(columnDesc.GetFieldId()), *where);
470
471 pos += RNTupleSerializer::SerializeFramePostscript(buffer ? base : nullptr, pos - base);
472
473 return pos - base;
474}
475
476std::uint32_t SerializeAliasColumnsOfFields(const ROOT::Experimental::RNTupleDescriptor &desc,
477 std::span<const ROOT::Experimental::DescriptorId_t> fieldList,
479 void *buffer)
480{
481 auto base = reinterpret_cast<unsigned char *>(buffer);
482 auto pos = base;
483 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
484
485 for (auto parentId : fieldList) {
486 for (const auto &c : desc.GetColumnIterable(parentId)) {
487 if (!c.IsAliasColumn())
488 continue;
489
490 pos += SerializeAliasColumn(c, context, *where);
491 }
492 }
493
494 return pos - base;
495}
496
497ROOT::RResult<std::uint32_t> DeserializeAliasColumn(const void *buffer, std::uint64_t bufSize,
498 std::uint32_t &physicalColumnId, std::uint32_t &fieldId)
499{
500 auto base = reinterpret_cast<const unsigned char *>(buffer);
501 auto bytes = base;
502 std::uint64_t frameSize;
503 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - base); };
504 auto result = RNTupleSerializer::DeserializeFrameHeader(bytes, bufSize, frameSize);
505 if (!result)
506 return R__FORWARD_ERROR(result);
507 bytes += result.Unwrap();
508
509 if (fnFrameSizeLeft() < 2 * sizeof(std::uint32_t)) {
510 return R__FAIL("alias column record frame too short");
511 }
512
513 bytes += RNTupleSerializer::DeserializeUInt32(bytes, physicalColumnId);
514 bytes += RNTupleSerializer::DeserializeUInt32(bytes, fieldId);
515
516 return frameSize;
517}
518
519} // anonymous namespace
520
522 std::uint64_t length,
523 std::uint64_t &xxhash3, void *buffer)
524{
525 if (buffer != nullptr) {
526 xxhash3 = XXH3_64bits(data, length);
527 SerializeUInt64(xxhash3, buffer);
528 }
529 return 8;
530}
531
533 std::uint64_t length,
534 std::uint64_t &xxhash3)
535{
536 auto checksumReal = XXH3_64bits(data, length);
537 DeserializeUInt64(data + length, xxhash3);
538 if (xxhash3 != checksumReal)
539 return R__FAIL("XxHash-3 checksum mismatch");
540 return RResult<void>::Success();
541}
542
545{
546 std::uint64_t xxhash3;
547 return R__FORWARD_RESULT(VerifyXxHash3(data, length, xxhash3));
548}
549
550std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeInt16(std::int16_t val, void *buffer)
551{
552 if (buffer != nullptr) {
553 auto bytes = reinterpret_cast<unsigned char *>(buffer);
554 bytes[0] = (val & 0x00FF);
555 bytes[1] = (val & 0xFF00) >> 8;
556 }
557 return 2;
558}
559
560std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::DeserializeInt16(const void *buffer, std::int16_t &val)
561{
562 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
563 val = std::int16_t(bytes[0]) + (std::int16_t(bytes[1]) << 8);
564 return 2;
565}
566
567std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeUInt16(std::uint16_t val, void *buffer)
568{
569 return SerializeInt16(val, buffer);
570}
571
572std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::DeserializeUInt16(const void *buffer, std::uint16_t &val)
573{
574 return DeserializeInt16(buffer, *reinterpret_cast<std::int16_t *>(&val));
575}
576
577std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeInt32(std::int32_t val, void *buffer)
578{
579 if (buffer != nullptr) {
580 auto bytes = reinterpret_cast<unsigned char *>(buffer);
581 bytes[0] = (val & 0x000000FF);
582 bytes[1] = (val & 0x0000FF00) >> 8;
583 bytes[2] = (val & 0x00FF0000) >> 16;
584 bytes[3] = (val & 0xFF000000) >> 24;
585 }
586 return 4;
587}
588
589std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::DeserializeInt32(const void *buffer, std::int32_t &val)
590{
591 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
592 val = std::int32_t(bytes[0]) + (std::int32_t(bytes[1]) << 8) + (std::int32_t(bytes[2]) << 16) +
593 (std::int32_t(bytes[3]) << 24);
594 return 4;
595}
596
597std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeUInt32(std::uint32_t val, void *buffer)
598{
599 return SerializeInt32(val, buffer);
600}
601
602std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::DeserializeUInt32(const void *buffer, std::uint32_t &val)
603{
604 return DeserializeInt32(buffer, *reinterpret_cast<std::int32_t *>(&val));
605}
606
607std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeInt64(std::int64_t val, void *buffer)
608{
609 if (buffer != nullptr) {
610 auto bytes = reinterpret_cast<unsigned char *>(buffer);
611 bytes[0] = (val & 0x00000000000000FF);
612 bytes[1] = (val & 0x000000000000FF00) >> 8;
613 bytes[2] = (val & 0x0000000000FF0000) >> 16;
614 bytes[3] = (val & 0x00000000FF000000) >> 24;
615 bytes[4] = (val & 0x000000FF00000000) >> 32;
616 bytes[5] = (val & 0x0000FF0000000000) >> 40;
617 bytes[6] = (val & 0x00FF000000000000) >> 48;
618 bytes[7] = (val & 0xFF00000000000000) >> 56;
619 }
620 return 8;
621}
622
623std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::DeserializeInt64(const void *buffer, std::int64_t &val)
624{
625 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
626 val = std::int64_t(bytes[0]) + (std::int64_t(bytes[1]) << 8) + (std::int64_t(bytes[2]) << 16) +
627 (std::int64_t(bytes[3]) << 24) + (std::int64_t(bytes[4]) << 32) + (std::int64_t(bytes[5]) << 40) +
628 (std::int64_t(bytes[6]) << 48) + (std::int64_t(bytes[7]) << 56);
629 return 8;
630}
631
632std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeUInt64(std::uint64_t val, void *buffer)
633{
634 return SerializeInt64(val, buffer);
635}
636
637std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::DeserializeUInt64(const void *buffer, std::uint64_t &val)
638{
639 return DeserializeInt64(buffer, *reinterpret_cast<std::int64_t *>(&val));
640}
641
642std::uint32_t ROOT::Experimental::Internal::RNTupleSerializer::SerializeString(const std::string &val, void *buffer)
643{
644 if (buffer) {
645 auto pos = reinterpret_cast<unsigned char *>(buffer);
646 pos += SerializeUInt32(val.length(), pos);
647 memcpy(pos, val.data(), val.length());
648 }
649 return sizeof(std::uint32_t) + val.length();
650}
651
653 std::uint64_t bufSize,
654 std::string &val)
655{
656 if (bufSize < sizeof(std::uint32_t))
657 return R__FAIL("string buffer too short");
658 bufSize -= sizeof(std::uint32_t);
659
660 auto base = reinterpret_cast<const unsigned char *>(buffer);
661 auto bytes = base;
662 std::uint32_t length;
663 bytes += DeserializeUInt32(buffer, length);
664 if (bufSize < length)
665 return R__FAIL("string buffer too short");
666
667 val.resize(length);
668 memcpy(&val[0], bytes, length);
669 return sizeof(std::uint32_t) + length;
670}
671
672std::uint32_t
674{
676
677 switch (type) {
678 case EColumnType::kBit: return SerializeUInt16(0x00, buffer);
679 case EColumnType::kByte: return SerializeUInt16(0x01, buffer);
680 case EColumnType::kChar: return SerializeUInt16(0x02, buffer);
681 case EColumnType::kInt8: return SerializeUInt16(0x03, buffer);
682 case EColumnType::kUInt8: return SerializeUInt16(0x04, buffer);
683 case EColumnType::kInt16: return SerializeUInt16(0x05, buffer);
684 case EColumnType::kUInt16: return SerializeUInt16(0x06, buffer);
685 case EColumnType::kInt32: return SerializeUInt16(0x07, buffer);
686 case EColumnType::kUInt32: return SerializeUInt16(0x08, buffer);
687 case EColumnType::kInt64: return SerializeUInt16(0x09, buffer);
688 case EColumnType::kUInt64: return SerializeUInt16(0x0A, buffer);
689 case EColumnType::kReal16: return SerializeUInt16(0x0B, buffer);
690 case EColumnType::kReal32: return SerializeUInt16(0x0C, buffer);
691 case EColumnType::kReal64: return SerializeUInt16(0x0D, buffer);
692 case EColumnType::kIndex32: return SerializeUInt16(0x0E, buffer);
693 case EColumnType::kIndex64: return SerializeUInt16(0x0F, buffer);
694 case EColumnType::kSwitch: return SerializeUInt16(0x10, buffer);
695 case EColumnType::kSplitInt16: return SerializeUInt16(0x11, buffer);
696 case EColumnType::kSplitUInt16: return SerializeUInt16(0x12, buffer);
697 case EColumnType::kSplitInt32: return SerializeUInt16(0x13, buffer);
698 case EColumnType::kSplitUInt32: return SerializeUInt16(0x14, buffer);
699 case EColumnType::kSplitInt64: return SerializeUInt16(0x15, buffer);
700 case EColumnType::kSplitUInt64: return SerializeUInt16(0x16, buffer);
701 case EColumnType::kSplitReal32: return SerializeUInt16(0x18, buffer);
702 case EColumnType::kSplitReal64: return SerializeUInt16(0x19, buffer);
703 case EColumnType::kSplitIndex32: return SerializeUInt16(0x1A, buffer);
704 case EColumnType::kSplitIndex64: return SerializeUInt16(0x1B, buffer);
705 case EColumnType::kReal32Trunc: return SerializeUInt16(0x1C, buffer);
706 case EColumnType::kReal32Quant: return SerializeUInt16(0x1D, buffer);
707 default:
708 if (type == kTestFutureType)
709 return SerializeUInt16(0x99, buffer);
710 throw RException(R__FAIL("ROOT bug: unexpected column type"));
711 }
712}
713
717{
719 std::uint16_t onDiskType;
720 auto result = DeserializeUInt16(buffer, onDiskType);
721
722 switch (onDiskType) {
723 case 0x00: type = EColumnType::kBit; break;
724 case 0x01: type = EColumnType::kByte; break;
725 case 0x02: type = EColumnType::kChar; break;
726 case 0x03: type = EColumnType::kInt8; break;
727 case 0x04: type = EColumnType::kUInt8; break;
728 case 0x05: type = EColumnType::kInt16; break;
729 case 0x06: type = EColumnType::kUInt16; break;
730 case 0x07: type = EColumnType::kInt32; break;
731 case 0x08: type = EColumnType::kUInt32; break;
732 case 0x09: type = EColumnType::kInt64; break;
733 case 0x0A: type = EColumnType::kUInt64; break;
734 case 0x0B: type = EColumnType::kReal16; break;
735 case 0x0C: type = EColumnType::kReal32; break;
736 case 0x0D: type = EColumnType::kReal64; break;
737 case 0x0E: type = EColumnType::kIndex32; break;
738 case 0x0F: type = EColumnType::kIndex64; break;
739 case 0x10: type = EColumnType::kSwitch; break;
740 case 0x11: type = EColumnType::kSplitInt16; break;
741 case 0x12: type = EColumnType::kSplitUInt16; break;
742 case 0x13: type = EColumnType::kSplitInt32; break;
743 case 0x14: type = EColumnType::kSplitUInt32; break;
744 case 0x15: type = EColumnType::kSplitInt64; break;
745 case 0x16: type = EColumnType::kSplitUInt64; break;
746 case 0x18: type = EColumnType::kSplitReal32; break;
747 case 0x19: type = EColumnType::kSplitReal64; break;
748 case 0x1A: type = EColumnType::kSplitIndex32; break;
749 case 0x1B: type = EColumnType::kSplitIndex64; break;
750 case 0x1C: type = EColumnType::kReal32Trunc; break;
751 case 0x1D: type = EColumnType::kReal32Quant; break;
752 // case 0x99 => kTestFutureType missing on purpose
753 default:
754 // may be a column type introduced by a future version
756 break;
757 }
758 return result;
759}
760
761std::uint32_t
763 void *buffer)
764{
766 switch (structure) {
767 case ENTupleStructure::kLeaf: return SerializeUInt16(0x00, buffer);
768 case ENTupleStructure::kCollection: return SerializeUInt16(0x01, buffer);
769 case ENTupleStructure::kRecord: return SerializeUInt16(0x02, buffer);
770 case ENTupleStructure::kVariant: return SerializeUInt16(0x03, buffer);
771 case ENTupleStructure::kStreamer: return SerializeUInt16(0x04, buffer);
772 default:
774 return SerializeUInt16(0x99, buffer);
775 throw RException(R__FAIL("ROOT bug: unexpected field structure type"));
776 }
777}
778
780 const void *buffer, ROOT::Experimental::ENTupleStructure &structure)
781{
783 std::uint16_t onDiskValue;
784 auto result = DeserializeUInt16(buffer, onDiskValue);
785 switch (onDiskValue) {
786 case 0x00: structure = ENTupleStructure::kLeaf; break;
787 case 0x01: structure = ENTupleStructure::kCollection; break;
788 case 0x02: structure = ENTupleStructure::kRecord; break;
789 case 0x03: structure = ENTupleStructure::kVariant; break;
790 case 0x04: structure = ENTupleStructure::kStreamer; break;
791 // case 0x99 => kTestFutureFieldStructure intentionally missing
792 default: structure = ENTupleStructure::kUnknown;
793 }
794 return result;
795}
796
797std::uint32_t
799 void *buffer)
800{
802 switch (id) {
803 case EExtraTypeInfoIds::kStreamerInfo: return SerializeUInt32(0x00, buffer);
804 default: throw RException(R__FAIL("ROOT bug: unexpected extra type info id"));
805 }
806}
807
811{
813 std::uint32_t onDiskValue;
814 auto result = DeserializeUInt32(buffer, onDiskValue);
815 switch (onDiskValue) {
816 case 0x00: id = EExtraTypeInfoIds::kStreamerInfo; break;
817 default:
819 R__LOG_DEBUG(0, NTupleLog()) << "Unknown extra type info id: " << onDiskValue;
820 }
821 return result;
822}
823
824std::uint32_t
826{
827 auto base = reinterpret_cast<unsigned char *>(buffer);
828 auto pos = base;
829 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
830
831 pos += SerializeUInt64(envelopeType, *where);
832 // The 48bits size information is filled in the postscript
833 return pos - base;
834}
835
837 std::uint64_t size,
838 std::uint64_t &xxhash3)
839{
840 if (size < sizeof(std::uint64_t))
841 throw RException(R__FAIL("envelope size too small"));
842 if (size >= static_cast<uint64_t>(1) << 48)
843 throw RException(R__FAIL("envelope size too big"));
844 if (envelope) {
845 std::uint64_t typeAndSize;
846 DeserializeUInt64(envelope, typeAndSize);
847 typeAndSize |= (size + 8) << 16;
848 SerializeUInt64(typeAndSize, envelope);
849 }
850 return SerializeXxHash3(envelope, size, xxhash3, envelope ? (envelope + size) : nullptr);
851}
852
854 std::uint64_t size)
855{
856 std::uint64_t xxhash3;
857 return SerializeEnvelopePostscript(envelope, size, xxhash3);
858}
859
862 std::uint16_t expectedType, std::uint64_t &xxhash3)
863{
864 const std::uint64_t minEnvelopeSize = sizeof(std::uint64_t) + sizeof(std::uint64_t);
865 if (bufSize < minEnvelopeSize)
866 return R__FAIL("invalid envelope buffer, too short");
867
868 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
869 auto base = bytes;
870
871 std::uint64_t typeAndSize;
872 bytes += DeserializeUInt64(bytes, typeAndSize);
873
874 std::uint16_t envelopeType = typeAndSize & 0xFFFF;
875 if (envelopeType != expectedType) {
876 return R__FAIL("envelope type mismatch: expected " + std::to_string(expectedType) + ", found " +
877 std::to_string(envelopeType));
878 }
879
880 std::uint64_t envelopeSize = typeAndSize >> 16;
881 if (bufSize < envelopeSize)
882 return R__FAIL("envelope buffer size too small");
883 if (envelopeSize < minEnvelopeSize)
884 return R__FAIL("invalid envelope, too short");
885
886 auto result = VerifyXxHash3(base, envelopeSize - 8, xxhash3);
887 if (!result)
888 return R__FORWARD_ERROR(result);
889
890 return sizeof(typeAndSize);
891}
892
895 std::uint16_t expectedType)
896{
897 std::uint64_t xxhash3;
898 return R__FORWARD_RESULT(DeserializeEnvelope(buffer, bufSize, expectedType, xxhash3));
899}
900
902{
903 // Marker: multiply the final size with 1
904 return SerializeInt64(1, buffer);
905}
906
907std::uint32_t
909{
910 auto base = reinterpret_cast<unsigned char *>(buffer);
911 auto pos = base;
912 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
913
914 // Marker: multiply the final size with -1
915 pos += SerializeInt64(-1, *where);
916 pos += SerializeUInt32(nitems, *where);
917 return pos - base;
918}
919
921{
922 auto preambleSize = sizeof(std::int64_t);
923 if (size < preambleSize)
924 throw RException(R__FAIL("frame too short: " + std::to_string(size)));
925 if (frame) {
926 std::int64_t marker;
927 DeserializeInt64(frame, marker);
928 if ((marker < 0) && (size < (sizeof(std::uint32_t) + preambleSize)))
929 throw RException(R__FAIL("frame too short: " + std::to_string(size)));
930 SerializeInt64(marker * static_cast<int64_t>(size), frame);
931 }
932 return 0;
933}
934
937 std::uint64_t &frameSize, std::uint32_t &nitems)
938{
939 std::uint64_t minSize = sizeof(std::int64_t);
940 if (bufSize < minSize)
941 return R__FAIL("frame too short");
942
943 std::int64_t *ssize = reinterpret_cast<std::int64_t *>(&frameSize);
944 DeserializeInt64(buffer, *ssize);
945
946 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
947 bytes += minSize;
948
949 if (*ssize >= 0) {
950 // Record frame
951 nitems = 1;
952 } else {
953 // List frame
954 minSize += sizeof(std::uint32_t);
955 if (bufSize < minSize)
956 return R__FAIL("frame too short");
957 bytes += DeserializeUInt32(bytes, nitems);
958 *ssize = -(*ssize);
959 }
960
961 if (frameSize < minSize)
962 return R__FAIL("corrupt frame size");
963 if (bufSize < frameSize)
964 return R__FAIL("frame too short");
965
966 return bytes - reinterpret_cast<const unsigned char *>(buffer);
967}
968
971 std::uint64_t &frameSize)
972{
973 std::uint32_t nitems;
974 return R__FORWARD_RESULT(DeserializeFrameHeader(buffer, bufSize, frameSize, nitems));
975}
976
977std::uint32_t
979 void *buffer)
980{
981 if (flags.empty())
982 return SerializeUInt64(0, buffer);
983
984 if (buffer) {
985 auto bytes = reinterpret_cast<unsigned char *>(buffer);
986
987 for (unsigned i = 0; i < flags.size(); ++i) {
988 if (flags[i] & 0x8000000000000000)
989 throw RException(R__FAIL("feature flag out of bounds"));
990
991 // The MSb indicates that another Int64 follows; set this bit to 1 for all except the last element
992 if (i == (flags.size() - 1))
993 SerializeUInt64(flags[i], bytes);
994 else
995 bytes += SerializeUInt64(flags[i] | 0x8000000000000000, bytes);
996 }
997 }
998 return (flags.size() * sizeof(std::int64_t));
999}
1000
1003 std::vector<std::uint64_t> &flags)
1004{
1005 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
1006
1007 flags.clear();
1008 std::uint64_t f;
1009 do {
1010 if (bufSize < sizeof(std::uint64_t))
1011 return R__FAIL("feature flag buffer too short");
1012 bytes += DeserializeUInt64(bytes, f);
1013 bufSize -= sizeof(std::uint64_t);
1014 flags.emplace_back(f & ~0x8000000000000000);
1015 } while (f & 0x8000000000000000);
1016
1017 return (flags.size() * sizeof(std::uint64_t));
1018}
1019
1020std::uint32_t
1022{
1024 throw RException(R__FAIL("locator is not serializable"));
1025
1026 std::uint32_t size = 0;
1027 if ((locator.GetType() == RNTupleLocator::kTypeFile) &&
1028 (locator.GetNBytesOnStorage() <= std::numeric_limits<std::int32_t>::max())) {
1029 size += SerializeUInt32(locator.GetNBytesOnStorage(), buffer);
1030 size += SerializeUInt64(locator.GetPosition<std::uint64_t>(),
1031 buffer ? reinterpret_cast<unsigned char *>(buffer) + size : nullptr);
1032 return size;
1033 }
1034
1035 std::uint8_t locatorType = 0;
1036 auto payloadp = buffer ? reinterpret_cast<unsigned char *>(buffer) + sizeof(std::int32_t) : nullptr;
1037 switch (locator.GetType()) {
1039 size += SerializeLocatorPayloadLarge(locator, payloadp);
1040 locatorType = 0x01;
1041 break;
1043 size += SerializeLocatorPayloadObject64(locator, payloadp);
1044 locatorType = 0x02;
1045 break;
1046 default:
1047 if (locator.GetType() == kTestLocatorType) {
1048 // For the testing locator, use the same payload as Object64. We're not gonna really read it back anyway.
1049 size += SerializeLocatorPayloadObject64(locator, payloadp);
1050 locatorType = 0x7e;
1051 } else {
1052 throw RException(R__FAIL("locator has unknown type"));
1053 }
1054 }
1055 std::int32_t head = sizeof(std::int32_t) + size;
1056 head |= locator.GetReserved() << 16;
1057 head |= static_cast<int>(locatorType & 0x7F) << 24;
1058 head = -head;
1059 size += RNTupleSerializer::SerializeInt32(head, buffer);
1060 return size;
1061}
1062
1065 RNTupleLocator &locator)
1066{
1067 if (bufSize < sizeof(std::int32_t))
1068 return R__FAIL("too short locator");
1069
1070 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
1071 std::int32_t head;
1072
1073 bytes += DeserializeInt32(bytes, head);
1074 bufSize -= sizeof(std::int32_t);
1075 if (head < 0) {
1076 head = -head;
1077 const int type = head >> 24;
1078 const std::uint32_t payloadSize = (static_cast<std::uint32_t>(head) & 0x0000FFFF) - sizeof(std::int32_t);
1079 if (bufSize < payloadSize)
1080 return R__FAIL("too short locator");
1081
1082 locator.SetReserved(static_cast<std::uint32_t>(head >> 16) & 0xFF);
1083 switch (type) {
1084 case 0x01:
1086 DeserializeLocatorPayloadLarge(bytes, locator);
1087 break;
1088 case 0x02:
1090 DeserializeLocatorPayloadObject64(bytes, payloadSize, locator);
1091 break;
1092 default: locator.SetType(RNTupleLocator::kTypeUnknown);
1093 }
1094 bytes += payloadSize;
1095 } else {
1096 if (bufSize < sizeof(std::uint64_t))
1097 return R__FAIL("too short locator");
1098 std::uint64_t offset;
1099 bytes += DeserializeUInt64(bytes, offset);
1101 locator.SetNBytesOnStorage(head);
1102 locator.SetPosition(offset);
1103 }
1104
1105 return bytes - reinterpret_cast<const unsigned char *>(buffer);
1106}
1107
1108std::uint32_t
1110{
1111 auto size = SerializeUInt64(envelopeLink.fLength, buffer);
1112 size += SerializeLocator(envelopeLink.fLocator, buffer ? reinterpret_cast<unsigned char *>(buffer) + size : nullptr);
1113 return size;
1114}
1115
1118 REnvelopeLink &envelopeLink)
1119{
1120 if (bufSize < sizeof(std::int64_t))
1121 return R__FAIL("too short envelope link");
1122
1123 auto bytes = reinterpret_cast<const unsigned char *>(buffer);
1124 bytes += DeserializeUInt64(bytes, envelopeLink.fLength);
1125 bufSize -= sizeof(std::uint64_t);
1126 auto result = DeserializeLocator(bytes, bufSize, envelopeLink.fLocator);
1127 if (!result)
1128 return R__FORWARD_ERROR(result);
1129 bytes += result.Unwrap();
1130 return bytes - reinterpret_cast<const unsigned char *>(buffer);
1131}
1132
1133std::uint32_t
1135 void *buffer)
1136{
1137 if (clusterSummary.fNEntries >= (static_cast<std::uint64_t>(1) << 56)) {
1138 throw RException(R__FAIL("number of entries in cluster exceeds maximum of 2^56"));
1139 }
1140
1141 auto base = reinterpret_cast<unsigned char *>(buffer);
1142 auto pos = base;
1143 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
1144
1145 auto frame = pos;
1146 pos += SerializeRecordFramePreamble(*where);
1147 pos += SerializeUInt64(clusterSummary.fFirstEntry, *where);
1148 const std::uint64_t nEntriesAndFlags =
1149 (static_cast<std::uint64_t>(clusterSummary.fFlags) << 56) | clusterSummary.fNEntries;
1150 pos += SerializeUInt64(nEntriesAndFlags, *where);
1151
1152 auto size = pos - frame;
1153 pos += SerializeFramePostscript(frame, size);
1154 return size;
1155}
1156
1159 RClusterSummary &clusterSummary)
1160{
1161 auto base = reinterpret_cast<const unsigned char *>(buffer);
1162 auto bytes = base;
1163 std::uint64_t frameSize;
1164 auto result = DeserializeFrameHeader(bytes, bufSize, frameSize);
1165 if (!result)
1166 return R__FORWARD_ERROR(result);
1167 bytes += result.Unwrap();
1168
1169 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - base); };
1170 if (fnFrameSizeLeft() < 2 * sizeof(std::uint64_t))
1171 return R__FAIL("too short cluster summary");
1172
1173 bytes += DeserializeUInt64(bytes, clusterSummary.fFirstEntry);
1174 std::uint64_t nEntriesAndFlags;
1175 bytes += DeserializeUInt64(bytes, nEntriesAndFlags);
1176
1177 const std::uint64_t nEntries = (nEntriesAndFlags << 8) >> 8;
1178 const std::uint8_t flags = nEntriesAndFlags >> 56;
1179
1180 if (flags & 0x01) {
1181 return R__FAIL("sharded cluster flag set in cluster summary; sharded clusters are currently unsupported.");
1182 }
1183
1184 clusterSummary.fNEntries = nEntries;
1185 clusterSummary.fFlags = flags;
1186
1187 return frameSize;
1188}
1189
1190std::uint32_t
1192{
1193 auto base = reinterpret_cast<unsigned char *>(buffer);
1194 auto pos = base;
1195 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
1196
1197 auto frame = pos;
1198 pos += SerializeRecordFramePreamble(*where);
1199 pos += SerializeUInt64(clusterGroup.fMinEntry, *where);
1200 pos += SerializeUInt64(clusterGroup.fEntrySpan, *where);
1201 pos += SerializeUInt32(clusterGroup.fNClusters, *where);
1202 pos += SerializeEnvelopeLink(clusterGroup.fPageListEnvelopeLink, *where);
1203 auto size = pos - frame;
1204 pos += SerializeFramePostscript(frame, size);
1205 return size;
1206}
1207
1210 RClusterGroup &clusterGroup)
1211{
1212 auto base = reinterpret_cast<const unsigned char *>(buffer);
1213 auto bytes = base;
1214
1215 std::uint64_t frameSize;
1216 auto result = DeserializeFrameHeader(bytes, bufSize, frameSize);
1217 if (!result)
1218 return R__FORWARD_ERROR(result);
1219 bytes += result.Unwrap();
1220
1221 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - base); };
1222 if (fnFrameSizeLeft() < sizeof(std::uint32_t) + 2 * sizeof(std::uint64_t))
1223 return R__FAIL("too short cluster group");
1224
1225 bytes += DeserializeUInt64(bytes, clusterGroup.fMinEntry);
1226 bytes += DeserializeUInt64(bytes, clusterGroup.fEntrySpan);
1227 bytes += DeserializeUInt32(bytes, clusterGroup.fNClusters);
1228 result = DeserializeEnvelopeLink(bytes, fnFrameSizeLeft(), clusterGroup.fPageListEnvelopeLink);
1229 if (!result)
1230 return R__FORWARD_ERROR(result);
1231
1232 return frameSize;
1233}
1234
1236 bool forHeaderExtension)
1237{
1238 auto fieldZeroId = desc.GetFieldZeroId();
1239 auto depthFirstTraversal = [&](std::span<DescriptorId_t> fieldTrees, auto doForEachField) {
1240 std::deque<DescriptorId_t> idQueue{fieldTrees.begin(), fieldTrees.end()};
1241 while (!idQueue.empty()) {
1242 auto fieldId = idQueue.front();
1243 idQueue.pop_front();
1244 // Field zero has no physical representation nor columns of its own; recurse over its subfields only
1245 if (fieldId != fieldZeroId)
1246 doForEachField(fieldId);
1247 unsigned i = 0;
1248 for (const auto &f : desc.GetFieldIterable(fieldId))
1249 idQueue.insert(idQueue.begin() + i++, f.GetId());
1250 }
1251 };
1252
1253 R__ASSERT(desc.GetNFields() > 0); // we must have at least a zero field
1254 if (!forHeaderExtension)
1255 R__ASSERT(GetHeaderExtensionOffset() == -1U);
1256
1257 std::vector<DescriptorId_t> fieldTrees;
1258 if (!forHeaderExtension) {
1259 fieldTrees.emplace_back(fieldZeroId);
1260 } else if (auto xHeader = desc.GetHeaderExtension()) {
1261 fieldTrees = xHeader->GetTopLevelFields(desc);
1262 }
1263 depthFirstTraversal(fieldTrees, [&](DescriptorId_t fieldId) { MapFieldId(fieldId); });
1264 depthFirstTraversal(fieldTrees, [&](DescriptorId_t fieldId) {
1265 for (const auto &c : desc.GetColumnIterable(fieldId)) {
1266 if (!c.IsAliasColumn()) {
1267 MapPhysicalColumnId(c.GetPhysicalId());
1268 }
1269 }
1270 });
1271
1272 if (forHeaderExtension) {
1273 // Create physical IDs for column representations that extend fields of the regular header.
1274 // First the physical columns then the alias columns.
1275 for (auto memId : desc.GetHeaderExtension()->GetExtendedColumnRepresentations()) {
1276 const auto &columnDesc = desc.GetColumnDescriptor(memId);
1277 if (!columnDesc.IsAliasColumn()) {
1278 MapPhysicalColumnId(columnDesc.GetPhysicalId());
1279 }
1280 }
1281 } else {
1282 // Anything added after this point is accounted for the header extension
1283 BeginHeaderExtension();
1284 }
1285}
1286
1288 const RNTupleDescriptor &desc,
1289 const RContext &context,
1290 bool forHeaderExtension)
1291{
1292 auto base = reinterpret_cast<unsigned char *>(buffer);
1293 auto pos = base;
1294 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
1295
1296 std::size_t nFields = 0, nColumns = 0, nAliasColumns = 0, fieldListOffset = 0;
1297 // Columns in the extension header that are attached to a field of the regular header
1298 std::vector<std::reference_wrapper<const RColumnDescriptor>> extraColumns;
1299 if (forHeaderExtension) {
1300 // A call to `RNTupleDescriptorBuilder::BeginHeaderExtension()` is not strictly required after serializing the
1301 // header, which may happen, e.g., in unit tests. Ensure an empty schema extension is serialized in this case
1302 if (auto xHeader = desc.GetHeaderExtension()) {
1303 nFields = xHeader->GetNFields();
1304 nColumns = xHeader->GetNPhysicalColumns();
1305 nAliasColumns = xHeader->GetNLogicalColumns() - xHeader->GetNPhysicalColumns();
1306 fieldListOffset = context.GetHeaderExtensionOffset();
1307
1308 extraColumns.reserve(xHeader->GetExtendedColumnRepresentations().size());
1309 for (auto columnId : xHeader->GetExtendedColumnRepresentations()) {
1310 extraColumns.emplace_back(desc.GetColumnDescriptor(columnId));
1311 }
1312 }
1313 } else {
1314 nFields = desc.GetNFields() - 1;
1315 nColumns = desc.GetNPhysicalColumns();
1316 nAliasColumns = desc.GetNLogicalColumns() - desc.GetNPhysicalColumns();
1317 }
1318 const auto nExtraTypeInfos = desc.GetNExtraTypeInfos();
1319 const auto &onDiskFields = context.GetOnDiskFieldList();
1320 R__ASSERT(onDiskFields.size() >= fieldListOffset);
1321 std::span<const DescriptorId_t> fieldList{onDiskFields.data() + fieldListOffset,
1322 onDiskFields.size() - fieldListOffset};
1323
1324 auto frame = pos;
1325 pos += SerializeListFramePreamble(nFields, *where);
1326 pos += SerializeFieldList(desc, fieldList, /*firstOnDiskId=*/fieldListOffset, context, *where);
1327 pos += SerializeFramePostscript(buffer ? frame : nullptr, pos - frame);
1328
1329 frame = pos;
1330 pos += SerializeListFramePreamble(nColumns, *where);
1331 pos += SerializeColumnsOfFields(desc, fieldList, context, *where);
1332 for (const auto &c : extraColumns) {
1333 if (!c.get().IsAliasColumn()) {
1334 pos += SerializePhysicalColumn(c.get(), context, *where);
1335 }
1336 }
1337 pos += SerializeFramePostscript(buffer ? frame : nullptr, pos - frame);
1338
1339 frame = pos;
1340 pos += SerializeListFramePreamble(nAliasColumns, *where);
1341 pos += SerializeAliasColumnsOfFields(desc, fieldList, context, *where);
1342 for (const auto &c : extraColumns) {
1343 if (c.get().IsAliasColumn()) {
1344 pos += SerializeAliasColumn(c.get(), context, *where);
1345 }
1346 }
1347 pos += SerializeFramePostscript(buffer ? frame : nullptr, pos - frame);
1348
1349 frame = pos;
1350 pos += SerializeListFramePreamble(nExtraTypeInfos, *where);
1351 pos += SerializeExtraTypeInfoList(desc, *where);
1352 pos += SerializeFramePostscript(buffer ? frame : nullptr, pos - frame);
1353
1354 return static_cast<std::uint32_t>(pos - base);
1355}
1356
1359 RNTupleDescriptorBuilder &descBuilder)
1360{
1361 auto base = reinterpret_cast<const unsigned char *>(buffer);
1362 auto bytes = base;
1363 auto fnBufSizeLeft = [&]() { return bufSize - (bytes - base); };
1365
1366 std::uint64_t frameSize;
1367 auto frame = bytes;
1368 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - frame); };
1369
1370 std::uint32_t nFields;
1371 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), frameSize, nFields);
1372 if (!result)
1373 return R__FORWARD_ERROR(result);
1374 bytes += result.Unwrap();
1375 // The zero field is always added before `DeserializeSchemaDescription()` is called
1376 const std::uint32_t fieldIdRangeBegin = descBuilder.GetDescriptor().GetNFields() - 1;
1377 for (unsigned i = 0; i < nFields; ++i) {
1378 std::uint32_t fieldId = fieldIdRangeBegin + i;
1379 RFieldDescriptorBuilder fieldBuilder;
1380 result = DeserializeField(bytes, fnFrameSizeLeft(), fieldBuilder);
1381 if (!result)
1382 return R__FORWARD_ERROR(result);
1383 bytes += result.Unwrap();
1384 if (fieldId == fieldBuilder.GetParentId())
1385 fieldBuilder.ParentId(kZeroFieldId);
1386 auto fieldDesc = fieldBuilder.FieldId(fieldId).MakeDescriptor();
1387 if (!fieldDesc)
1388 return R__FORWARD_ERROR(fieldDesc);
1389 const auto parentId = fieldDesc.Inspect().GetParentId();
1390 const auto projectionSourceId = fieldDesc.Inspect().GetProjectionSourceId();
1391 descBuilder.AddField(fieldDesc.Unwrap());
1392 auto resVoid = descBuilder.AddFieldLink(parentId, fieldId);
1393 if (!resVoid)
1394 return R__FORWARD_ERROR(resVoid);
1395 if (projectionSourceId != kInvalidDescriptorId) {
1396 resVoid = descBuilder.AddFieldProjection(projectionSourceId, fieldId);
1397 if (!resVoid)
1398 return R__FORWARD_ERROR(resVoid);
1399 }
1400 }
1401 bytes = frame + frameSize;
1402
1403 // As columns are added in order of representation index and column index, determine the column index
1404 // for the currently deserialized column from the columns already added.
1405 auto fnNextColumnIndex = [&descBuilder](DescriptorId_t fieldId, std::uint16_t representationIndex) -> std::uint32_t {
1406 const auto &existingColumns = descBuilder.GetDescriptor().GetFieldDescriptor(fieldId).GetLogicalColumnIds();
1407 if (existingColumns.empty())
1408 return 0;
1409 const auto &lastColumnDesc = descBuilder.GetDescriptor().GetColumnDescriptor(existingColumns.back());
1410 return (representationIndex == lastColumnDesc.GetRepresentationIndex()) ? (lastColumnDesc.GetIndex() + 1) : 0;
1411 };
1412
1413 std::uint32_t nColumns;
1414 frame = bytes;
1415 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), frameSize, nColumns);
1416 if (!result)
1417 return R__FORWARD_ERROR(result);
1418 bytes += result.Unwrap();
1419
1420 if (descBuilder.GetDescriptor().GetNLogicalColumns() > descBuilder.GetDescriptor().GetNPhysicalColumns())
1421 descBuilder.ShiftAliasColumns(nColumns);
1422
1423 const std::uint32_t columnIdRangeBegin = descBuilder.GetDescriptor().GetNPhysicalColumns();
1424 for (unsigned i = 0; i < nColumns; ++i) {
1425 std::uint32_t columnId = columnIdRangeBegin + i;
1426 RColumnDescriptorBuilder columnBuilder;
1427 result = DeserializeColumn(bytes, fnFrameSizeLeft(), columnBuilder);
1428 if (!result)
1429 return R__FORWARD_ERROR(result);
1430 bytes += result.Unwrap();
1431
1432 columnBuilder.Index(fnNextColumnIndex(columnBuilder.GetFieldId(), columnBuilder.GetRepresentationIndex()));
1433 columnBuilder.LogicalColumnId(columnId);
1434 columnBuilder.PhysicalColumnId(columnId);
1435 auto columnDesc = columnBuilder.MakeDescriptor();
1436 if (!columnDesc)
1437 return R__FORWARD_ERROR(columnDesc);
1438 auto resVoid = descBuilder.AddColumn(columnDesc.Unwrap());
1439 if (!resVoid)
1440 return R__FORWARD_ERROR(resVoid);
1441 }
1442 bytes = frame + frameSize;
1443
1444 std::uint32_t nAliasColumns;
1445 frame = bytes;
1446 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), frameSize, nAliasColumns);
1447 if (!result)
1448 return R__FORWARD_ERROR(result);
1449 bytes += result.Unwrap();
1450 const std::uint32_t aliasColumnIdRangeBegin = descBuilder.GetDescriptor().GetNLogicalColumns();
1451 for (unsigned i = 0; i < nAliasColumns; ++i) {
1452 std::uint32_t physicalId;
1453 std::uint32_t fieldId;
1454 result = DeserializeAliasColumn(bytes, fnFrameSizeLeft(), physicalId, fieldId);
1455 if (!result)
1456 return R__FORWARD_ERROR(result);
1457 bytes += result.Unwrap();
1458
1459 RColumnDescriptorBuilder columnBuilder;
1460 columnBuilder.LogicalColumnId(aliasColumnIdRangeBegin + i).PhysicalColumnId(physicalId).FieldId(fieldId);
1461 const auto &physicalColumnDesc = descBuilder.GetDescriptor().GetColumnDescriptor(physicalId);
1462 columnBuilder.BitsOnStorage(physicalColumnDesc.GetBitsOnStorage());
1463 columnBuilder.ValueRange(physicalColumnDesc.GetValueRange());
1464 columnBuilder.Type(physicalColumnDesc.GetType());
1465 columnBuilder.RepresentationIndex(physicalColumnDesc.GetRepresentationIndex());
1466 columnBuilder.Index(fnNextColumnIndex(columnBuilder.GetFieldId(), columnBuilder.GetRepresentationIndex()));
1467
1468 auto aliasColumnDesc = columnBuilder.MakeDescriptor();
1469 if (!aliasColumnDesc)
1470 return R__FORWARD_ERROR(aliasColumnDesc);
1471 auto resVoid = descBuilder.AddColumn(aliasColumnDesc.Unwrap());
1472 if (!resVoid)
1473 return R__FORWARD_ERROR(resVoid);
1474 }
1475 bytes = frame + frameSize;
1476
1477 std::uint32_t nExtraTypeInfos;
1478 frame = bytes;
1479 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), frameSize, nExtraTypeInfos);
1480 if (!result)
1481 return R__FORWARD_ERROR(result);
1482 bytes += result.Unwrap();
1483 for (unsigned i = 0; i < nExtraTypeInfos; ++i) {
1484 RExtraTypeInfoDescriptorBuilder extraTypeInfoBuilder;
1485 result = DeserializeExtraTypeInfo(bytes, fnFrameSizeLeft(), extraTypeInfoBuilder);
1486 if (!result)
1487 return R__FORWARD_ERROR(result);
1488 bytes += result.Unwrap();
1489
1490 auto extraTypeInfoDesc = extraTypeInfoBuilder.MoveDescriptor();
1491 // We ignore unknown extra type information
1492 if (extraTypeInfoDesc)
1493 descBuilder.AddExtraTypeInfo(extraTypeInfoDesc.Unwrap());
1494 }
1495 bytes = frame + frameSize;
1496
1497 return bytes - base;
1498}
1499
1503{
1504 RContext context;
1505
1506 auto base = reinterpret_cast<unsigned char *>(buffer);
1507 auto pos = base;
1508 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
1509
1510 pos += SerializeEnvelopePreamble(kEnvelopeTypeHeader, *where);
1511 // So far we don't make use of feature flags
1512 pos += SerializeFeatureFlags(desc.GetFeatureFlags(), *where);
1513 pos += SerializeString(desc.GetName(), *where);
1514 pos += SerializeString(desc.GetDescription(), *where);
1515 pos += SerializeString(std::string("ROOT v") + ROOT_RELEASE, *where);
1516
1517 context.MapSchema(desc, /*forHeaderExtension=*/false);
1518 pos += SerializeSchemaDescription(*where, desc, context);
1519
1520 std::uint64_t size = pos - base;
1521 std::uint64_t xxhash3 = 0;
1522 size += SerializeEnvelopePostscript(base, size, xxhash3);
1523
1524 context.SetHeaderSize(size);
1525 context.SetHeaderXxHash3(xxhash3);
1526 return context;
1527}
1528
1529std::uint32_t
1531 std::span<DescriptorId_t> physClusterIDs,
1532 const RContext &context)
1533{
1534 auto base = reinterpret_cast<unsigned char *>(buffer);
1535 auto pos = base;
1536 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
1537
1538 pos += SerializeEnvelopePreamble(kEnvelopeTypePageList, *where);
1539
1540 pos += SerializeUInt64(context.GetHeaderXxHash3(), *where);
1541
1542 // Cluster summaries
1543 const auto nClusters = physClusterIDs.size();
1544 auto clusterSummaryFrame = pos;
1545 pos += SerializeListFramePreamble(nClusters, *where);
1546 for (auto clusterId : physClusterIDs) {
1547 const auto &clusterDesc = desc.GetClusterDescriptor(context.GetMemClusterId(clusterId));
1548 RClusterSummary summary{clusterDesc.GetFirstEntryIndex(), clusterDesc.GetNEntries(), 0};
1549 pos += SerializeClusterSummary(summary, *where);
1550 }
1551 pos += SerializeFramePostscript(buffer ? clusterSummaryFrame : nullptr, pos - clusterSummaryFrame);
1552
1553 // Page locations
1554 auto topMostFrame = pos;
1555 pos += SerializeListFramePreamble(nClusters, *where);
1556
1557 for (auto clusterId : physClusterIDs) {
1558 const auto &clusterDesc = desc.GetClusterDescriptor(context.GetMemClusterId(clusterId));
1559 // Get an ordered set of physical column ids
1560 std::set<DescriptorId_t> onDiskColumnIds;
1561 for (const auto &columnRange : clusterDesc.GetColumnRangeIterable())
1562 onDiskColumnIds.insert(context.GetOnDiskColumnId(columnRange.fPhysicalColumnId));
1563
1564 auto outerFrame = pos;
1565 pos += SerializeListFramePreamble(onDiskColumnIds.size(), *where);
1566 for (auto onDiskId : onDiskColumnIds) {
1567 auto memId = context.GetMemColumnId(onDiskId);
1568 const auto &columnRange = clusterDesc.GetColumnRange(memId);
1569
1570 auto innerFrame = pos;
1571 if (columnRange.fIsSuppressed) {
1572 // Empty page range
1573 pos += SerializeListFramePreamble(0, *where);
1574 pos += SerializeInt64(kSuppressedColumnMarker, *where);
1575 } else {
1576 const auto &pageRange = clusterDesc.GetPageRange(memId);
1577 pos += SerializeListFramePreamble(pageRange.fPageInfos.size(), *where);
1578
1579 for (const auto &pi : pageRange.fPageInfos) {
1580 std::int32_t nElements = pi.fHasChecksum ? -static_cast<std::int32_t>(pi.fNElements) : pi.fNElements;
1581 pos += SerializeUInt32(nElements, *where);
1582 pos += SerializeLocator(pi.fLocator, *where);
1583 }
1584 pos += SerializeInt64(columnRange.fFirstElementIndex, *where);
1585 pos += SerializeUInt32(columnRange.fCompressionSettings, *where);
1586 }
1587
1588 pos += SerializeFramePostscript(buffer ? innerFrame : nullptr, pos - innerFrame);
1589 }
1590 pos += SerializeFramePostscript(buffer ? outerFrame : nullptr, pos - outerFrame);
1591 }
1592
1593 pos += SerializeFramePostscript(buffer ? topMostFrame : nullptr, pos - topMostFrame);
1594 std::uint64_t size = pos - base;
1595 size += SerializeEnvelopePostscript(base, size);
1596 return size;
1597}
1598
1599std::uint32_t
1602 const RContext &context)
1603{
1604 auto base = reinterpret_cast<unsigned char *>(buffer);
1605 auto pos = base;
1606 void **where = (buffer == nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
1607
1608 pos += SerializeEnvelopePreamble(kEnvelopeTypeFooter, *where);
1609
1610 // So far we don't make use of footer feature flags
1611 pos += SerializeFeatureFlags(std::vector<std::uint64_t>(), *where);
1612 pos += SerializeUInt64(context.GetHeaderXxHash3(), *where);
1613
1614 // Schema extension, i.e. incremental changes with respect to the header
1615 auto frame = pos;
1616 pos += SerializeRecordFramePreamble(*where);
1617 pos += SerializeSchemaDescription(*where, desc, context, /*forHeaderExtension=*/true);
1618 pos += SerializeFramePostscript(buffer ? frame : nullptr, pos - frame);
1619
1620 // Cluster groups
1621 frame = pos;
1622 const auto nClusterGroups = desc.GetNClusterGroups();
1623 pos += SerializeListFramePreamble(nClusterGroups, *where);
1624 for (unsigned int i = 0; i < nClusterGroups; ++i) {
1625 const auto &cgDesc = desc.GetClusterGroupDescriptor(context.GetMemClusterGroupId(i));
1626 RClusterGroup clusterGroup;
1627 clusterGroup.fMinEntry = cgDesc.GetMinEntry();
1628 clusterGroup.fEntrySpan = cgDesc.GetEntrySpan();
1629 clusterGroup.fNClusters = cgDesc.GetNClusters();
1630 clusterGroup.fPageListEnvelopeLink.fLength = cgDesc.GetPageListLength();
1631 clusterGroup.fPageListEnvelopeLink.fLocator = cgDesc.GetPageListLocator();
1632 pos += SerializeClusterGroup(clusterGroup, *where);
1633 }
1634 pos += SerializeFramePostscript(buffer ? frame : nullptr, pos - frame);
1635
1636 std::uint32_t size = pos - base;
1637 size += SerializeEnvelopePostscript(base, size);
1638 return size;
1639}
1640
1643 RNTupleDescriptorBuilder &descBuilder)
1644{
1645 auto base = reinterpret_cast<const unsigned char *>(buffer);
1646 auto bytes = base;
1647 auto fnBufSizeLeft = [&]() { return bufSize - (bytes - base); };
1649
1650 std::uint64_t xxhash3{0};
1651 result = DeserializeEnvelope(bytes, fnBufSizeLeft(), kEnvelopeTypeHeader, xxhash3);
1652 if (!result)
1653 return R__FORWARD_ERROR(result);
1654 bytes += result.Unwrap();
1655 descBuilder.SetOnDiskHeaderXxHash3(xxhash3);
1656
1657 std::vector<std::uint64_t> featureFlags;
1658 result = DeserializeFeatureFlags(bytes, fnBufSizeLeft(), featureFlags);
1659 if (!result)
1660 return R__FORWARD_ERROR(result);
1661 bytes += result.Unwrap();
1662 for (std::size_t i = 0; i < featureFlags.size(); ++i) {
1663 if (!featureFlags[i])
1664 continue;
1665 unsigned int bit = 0;
1666 while (!(featureFlags[i] & (static_cast<uint64_t>(1) << bit)))
1667 bit++;
1668 return R__FAIL("unsupported format feature: " + std::to_string(i * 64 + bit));
1669 }
1670
1671 std::string name;
1672 std::string description;
1673 std::string writer;
1674 result = DeserializeString(bytes, fnBufSizeLeft(), name);
1675 if (!result)
1676 return R__FORWARD_ERROR(result);
1677 bytes += result.Unwrap();
1678 result = DeserializeString(bytes, fnBufSizeLeft(), description);
1679 if (!result)
1680 return R__FORWARD_ERROR(result);
1681 bytes += result.Unwrap();
1682 result = DeserializeString(bytes, fnBufSizeLeft(), writer);
1683 if (!result)
1684 return R__FORWARD_ERROR(result);
1685 bytes += result.Unwrap();
1686 descBuilder.SetNTuple(name, description);
1687
1688 // Zero field
1689 descBuilder.AddField(
1690 RFieldDescriptorBuilder().FieldId(kZeroFieldId).Structure(ENTupleStructure::kRecord).MakeDescriptor().Unwrap());
1691 result = DeserializeSchemaDescription(bytes, fnBufSizeLeft(), descBuilder);
1692 if (!result)
1693 return R__FORWARD_ERROR(result);
1694
1695 return RResult<void>::Success();
1696}
1697
1700 RNTupleDescriptorBuilder &descBuilder)
1701{
1702 auto base = reinterpret_cast<const unsigned char *>(buffer);
1703 auto bytes = base;
1704 auto fnBufSizeLeft = [&]() { return bufSize - (bytes - base); };
1706
1707 result = DeserializeEnvelope(bytes, fnBufSizeLeft(), kEnvelopeTypeFooter);
1708 if (!result)
1709 return R__FORWARD_ERROR(result);
1710 bytes += result.Unwrap();
1711
1712 std::vector<std::uint64_t> featureFlags;
1713 result = DeserializeFeatureFlags(bytes, fnBufSizeLeft(), featureFlags);
1714 if (!result)
1715 return R__FORWARD_ERROR(result);
1716 bytes += result.Unwrap();
1717 for (auto f : featureFlags) {
1718 if (f)
1719 R__LOG_WARNING(NTupleLog()) << "Unsupported feature flag! " << f;
1720 }
1721
1722 std::uint64_t xxhash3{0};
1723 if (fnBufSizeLeft() < static_cast<int>(sizeof(std::uint64_t)))
1724 return R__FAIL("footer too short");
1725 bytes += DeserializeUInt64(bytes, xxhash3);
1726 if (xxhash3 != descBuilder.GetDescriptor().GetOnDiskHeaderXxHash3())
1727 return R__FAIL("XxHash-3 mismatch between header and footer");
1728
1729 std::uint64_t frameSize;
1730 auto frame = bytes;
1731 auto fnFrameSizeLeft = [&]() { return frameSize - (bytes - frame); };
1732
1733 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), frameSize);
1734 if (!result)
1735 return R__FORWARD_ERROR(result);
1736 bytes += result.Unwrap();
1737 if (fnFrameSizeLeft() > 0) {
1738 descBuilder.BeginHeaderExtension();
1739 result = DeserializeSchemaDescription(bytes, fnFrameSizeLeft(), descBuilder);
1740 if (!result)
1741 return R__FORWARD_ERROR(result);
1742 }
1743 bytes = frame + frameSize;
1744
1745 std::uint32_t nClusterGroups;
1746 frame = bytes;
1747 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), frameSize, nClusterGroups);
1748 if (!result)
1749 return R__FORWARD_ERROR(result);
1750 bytes += result.Unwrap();
1751 for (std::uint32_t groupId = 0; groupId < nClusterGroups; ++groupId) {
1752 RClusterGroup clusterGroup;
1753 result = DeserializeClusterGroup(bytes, fnFrameSizeLeft(), clusterGroup);
1754 if (!result)
1755 return R__FORWARD_ERROR(result);
1756 bytes += result.Unwrap();
1757
1759 RClusterGroupDescriptorBuilder clusterGroupBuilder;
1760 clusterGroupBuilder.ClusterGroupId(groupId)
1763 .MinEntry(clusterGroup.fMinEntry)
1764 .EntrySpan(clusterGroup.fEntrySpan)
1765 .NClusters(clusterGroup.fNClusters);
1766 descBuilder.AddClusterGroup(clusterGroupBuilder.MoveDescriptor().Unwrap());
1767 }
1768 bytes = frame + frameSize;
1769
1770 return RResult<void>::Success();
1771}
1772
1774 std::uint64_t bufSize,
1775 DescriptorId_t clusterGroupId,
1776 RNTupleDescriptor &desc)
1777{
1778 auto base = reinterpret_cast<const unsigned char *>(buffer);
1779 auto bytes = base;
1780 auto fnBufSizeLeft = [&]() { return bufSize - (bytes - base); };
1782
1783 result = DeserializeEnvelope(bytes, fnBufSizeLeft(), kEnvelopeTypePageList);
1784 if (!result)
1785 return R__FORWARD_ERROR(result);
1786 bytes += result.Unwrap();
1787
1788 std::uint64_t xxhash3{0};
1789 if (fnBufSizeLeft() < static_cast<int>(sizeof(std::uint64_t)))
1790 return R__FAIL("page list too short");
1791 bytes += DeserializeUInt64(bytes, xxhash3);
1792 if (xxhash3 != desc.GetOnDiskHeaderXxHash3())
1793 return R__FAIL("XxHash-3 mismatch between header and page list");
1794
1795 std::vector<RClusterDescriptorBuilder> clusterBuilders;
1796 DescriptorId_t firstClusterId{0};
1797 for (DescriptorId_t i = 0; i < clusterGroupId; ++i) {
1798 firstClusterId = firstClusterId + desc.GetClusterGroupDescriptor(i).GetNClusters();
1799 }
1800
1801 std::uint64_t clusterSummaryFrameSize;
1802 auto clusterSummaryFrame = bytes;
1803 auto fnClusterSummaryFrameSizeLeft = [&]() { return clusterSummaryFrameSize - (bytes - clusterSummaryFrame); };
1804
1805 std::uint32_t nClusterSummaries;
1806 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), clusterSummaryFrameSize, nClusterSummaries);
1807 if (!result)
1808 return R__FORWARD_ERROR(result);
1809 bytes += result.Unwrap();
1810 for (auto clusterId = firstClusterId; clusterId < firstClusterId + nClusterSummaries; ++clusterId) {
1811 RClusterSummary clusterSummary;
1812 result = DeserializeClusterSummary(bytes, fnClusterSummaryFrameSizeLeft(), clusterSummary);
1813 if (!result)
1814 return R__FORWARD_ERROR(result);
1815 bytes += result.Unwrap();
1816
1818 builder.ClusterId(clusterId).FirstEntryIndex(clusterSummary.fFirstEntry).NEntries(clusterSummary.fNEntries);
1819 clusterBuilders.emplace_back(std::move(builder));
1820 }
1821 bytes = clusterSummaryFrame + clusterSummaryFrameSize;
1822
1823 std::uint64_t topMostFrameSize;
1824 auto topMostFrame = bytes;
1825 auto fnTopMostFrameSizeLeft = [&]() { return topMostFrameSize - (bytes - topMostFrame); };
1826
1827 std::uint32_t nClusters;
1828 result = DeserializeFrameHeader(bytes, fnBufSizeLeft(), topMostFrameSize, nClusters);
1829 if (!result)
1830 return R__FORWARD_ERROR(result);
1831 bytes += result.Unwrap();
1832
1833 if (nClusters != nClusterSummaries)
1834 return R__FAIL("mismatch between number of clusters and number of cluster summaries");
1835
1836 std::vector<RClusterDescriptor> clusters;
1837 for (std::uint32_t i = 0; i < nClusters; ++i) {
1838 std::uint64_t outerFrameSize;
1839 auto outerFrame = bytes;
1840 auto fnOuterFrameSizeLeft = [&]() { return outerFrameSize - (bytes - outerFrame); };
1841
1842 std::uint32_t nColumns;
1843 result = DeserializeFrameHeader(bytes, fnTopMostFrameSizeLeft(), outerFrameSize, nColumns);
1844 if (!result)
1845 return R__FORWARD_ERROR(result);
1846 bytes += result.Unwrap();
1847
1848 for (std::uint32_t j = 0; j < nColumns; ++j) {
1849 std::uint64_t innerFrameSize;
1850 auto innerFrame = bytes;
1851 auto fnInnerFrameSizeLeft = [&]() { return innerFrameSize - (bytes - innerFrame); };
1852
1853 std::uint32_t nPages;
1854 result = DeserializeFrameHeader(bytes, fnOuterFrameSizeLeft(), innerFrameSize, nPages);
1855 if (!result)
1856 return R__FORWARD_ERROR(result);
1857 bytes += result.Unwrap();
1858
1860 pageRange.fPhysicalColumnId = j;
1861 for (std::uint32_t k = 0; k < nPages; ++k) {
1862 if (fnInnerFrameSizeLeft() < static_cast<int>(sizeof(std::uint32_t)))
1863 return R__FAIL("inner frame too short");
1864 std::int32_t nElements;
1865 bool hasChecksum = false;
1866 RNTupleLocator locator;
1867 bytes += DeserializeInt32(bytes, nElements);
1868 if (nElements < 0) {
1869 nElements = -nElements;
1870 hasChecksum = true;
1871 }
1872 result = DeserializeLocator(bytes, fnInnerFrameSizeLeft(), locator);
1873 if (!result)
1874 return R__FORWARD_ERROR(result);
1875 pageRange.fPageInfos.push_back({static_cast<std::uint32_t>(nElements), locator, hasChecksum});
1876 bytes += result.Unwrap();
1877 }
1878
1879 if (fnInnerFrameSizeLeft() < static_cast<int>(sizeof(std::int64_t)))
1880 return R__FAIL("page list frame too short");
1881 std::int64_t columnOffset;
1882 bytes += DeserializeInt64(bytes, columnOffset);
1883 if (columnOffset < 0) {
1884 if (nPages > 0)
1885 return R__FAIL("unexpected non-empty page list");
1886 clusterBuilders[i].MarkSuppressedColumnRange(j);
1887 } else {
1888 if (fnInnerFrameSizeLeft() < static_cast<int>(sizeof(std::uint32_t)))
1889 return R__FAIL("page list frame too short");
1890 std::uint32_t compressionSettings;
1891 bytes += DeserializeUInt32(bytes, compressionSettings);
1892 clusterBuilders[i].CommitColumnRange(j, columnOffset, compressionSettings, pageRange);
1893 }
1894
1895 bytes = innerFrame + innerFrameSize;
1896 } // loop over columns
1897
1898 bytes = outerFrame + outerFrameSize;
1899
1900 auto voidRes = clusterBuilders[i].CommitSuppressedColumnRanges(desc);
1901 if (!voidRes)
1902 return R__FORWARD_ERROR(voidRes);
1903 clusterBuilders[i].AddExtendedColumnRanges(desc);
1904 clusters.emplace_back(clusterBuilders[i].MoveDescriptor().Unwrap());
1905 } // loop over clusters
1906 desc.AddClusterGroupDetails(clusterGroupId, clusters);
1907
1908 return RResult<void>::Success();
1909}
1910
1912{
1913 TList streamerInfos;
1914 for (auto si : infos) {
1915 assert(si.first == si.second->GetNumber());
1916 streamerInfos.Add(si.second);
1917 }
1919 buffer.WriteObject(&streamerInfos);
1920 assert(buffer.Length() > 0);
1921 return std::string{buffer.Buffer(), static_cast<UInt_t>(buffer.Length())};
1922}
1923
1926{
1927 StreamerInfoMap_t infoMap;
1928
1929 TBufferFile buffer(TBuffer::kRead, extraTypeInfoContent.length(), const_cast<char *>(extraTypeInfoContent.data()),
1930 false /* adopt */);
1931 auto infoList = reinterpret_cast<TList *>(buffer.ReadObject(TList::Class()));
1932 infoList->SetOwner(); // delete the TStreamerInfo items of the list
1933
1934 TObjLink *lnk = infoList->FirstLink();
1935 while (lnk) {
1936 auto info = reinterpret_cast<TStreamerInfo *>(lnk->GetObject());
1937 info->BuildCheck();
1938 infoMap[info->GetNumber()] = info->GetClass()->GetStreamerInfo();
1939 assert(info->GetNumber() == infoMap[info->GetNumber()]->GetNumber());
1940 lnk = lnk->Next();
1941 }
1942
1943 delete infoList;
1944
1945 return infoMap;
1946}
#define R__FORWARD_ERROR(res)
Short-hand to return an RResult<T> in an error state (i.e. after checking)
Definition RError.hxx:303
#define R__FORWARD_RESULT(res)
Short-hand to return an RResult<T> value from a subroutine to the calling stack frame.
Definition RError.hxx:301
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
Definition RError.hxx:299
#define R__LOG_WARNING(...)
Definition RLogger.hxx:363
#define R__LOG_DEBUG(DEBUGLEVEL,...)
Definition RLogger.hxx:365
#define f(i)
Definition RSha256.hxx:104
#define c(i)
Definition RSha256.hxx:101
#define ROOT_RELEASE
Definition RVersion.hxx:44
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
#define R__ASSERT(e)
Checks condition e and reports a fatal error if it's false.
Definition TError.h:125
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void data
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h offset
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t result
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h length
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t nitems
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t bytes
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
char name[80]
Definition TGX11.cxx:110
The available trivial, native content types of a column.
A helper class for piece-wise construction of an RClusterDescriptor.
RClusterDescriptorBuilder & ClusterId(DescriptorId_t clusterId)
RClusterDescriptorBuilder & NEntries(std::uint64_t nEntries)
RClusterDescriptorBuilder & FirstEntryIndex(std::uint64_t firstEntryIndex)
A helper class for piece-wise construction of an RClusterGroupDescriptor.
RClusterGroupDescriptorBuilder & PageListLocator(const RNTupleLocator &pageListLocator)
RClusterGroupDescriptorBuilder & MinEntry(std::uint64_t minEntry)
RClusterGroupDescriptorBuilder & ClusterGroupId(DescriptorId_t clusterGroupId)
RClusterGroupDescriptorBuilder & EntrySpan(std::uint64_t entrySpan)
RClusterGroupDescriptorBuilder & NClusters(std::uint32_t nClusters)
RClusterGroupDescriptorBuilder & PageListLength(std::uint64_t pageListLength)
A helper class for piece-wise construction of an RColumnDescriptor.
RColumnDescriptorBuilder & PhysicalColumnId(DescriptorId_t physicalColumnId)
RColumnDescriptorBuilder & Type(EColumnType type)
RColumnDescriptorBuilder & BitsOnStorage(std::uint16_t bitsOnStorage)
RColumnDescriptorBuilder & RepresentationIndex(std::uint16_t representationIndex)
RColumnDescriptorBuilder & FieldId(DescriptorId_t fieldId)
RColumnDescriptorBuilder & Index(std::uint32_t index)
RColumnDescriptorBuilder & FirstElementIndex(std::uint64_t firstElementIdx)
RResult< RColumnDescriptor > MakeDescriptor() const
Attempt to make a column descriptor.
RColumnDescriptorBuilder & LogicalColumnId(DescriptorId_t logicalColumnId)
RColumnDescriptorBuilder & ValueRange(double min, double max)
A helper class for piece-wise construction of an RExtraTypeInfoDescriptor.
RExtraTypeInfoDescriptorBuilder & Content(const std::string &content)
RExtraTypeInfoDescriptorBuilder & TypeVersion(std::uint32_t typeVersion)
RExtraTypeInfoDescriptorBuilder & TypeName(const std::string &typeName)
RExtraTypeInfoDescriptorBuilder & ContentId(EExtraTypeInfoIds contentId)
A helper class for piece-wise construction of an RFieldDescriptor.
RFieldDescriptorBuilder & TypeVersion(std::uint32_t typeVersion)
RFieldDescriptorBuilder & NRepetitions(std::uint64_t nRepetitions)
RFieldDescriptorBuilder & ProjectionSourceId(DescriptorId_t id)
RFieldDescriptorBuilder & FieldVersion(std::uint32_t fieldVersion)
RFieldDescriptorBuilder & Structure(const ENTupleStructure &structure)
RFieldDescriptorBuilder & TypeName(const std::string &typeName)
RFieldDescriptorBuilder & FieldName(const std::string &fieldName)
RResult< RFieldDescriptor > MakeDescriptor() const
Attempt to make a field descriptor.
RFieldDescriptorBuilder & ParentId(DescriptorId_t id)
RFieldDescriptorBuilder & TypeChecksum(const std::optional< std::uint32_t > typeChecksum)
RFieldDescriptorBuilder & TypeAlias(const std::string &typeAlias)
RFieldDescriptorBuilder & FieldId(DescriptorId_t fieldId)
RFieldDescriptorBuilder & FieldDescription(const std::string &fieldDescription)
A helper class for piece-wise construction of an RNTupleDescriptor.
RResult< void > AddExtraTypeInfo(RExtraTypeInfoDescriptor &&extraTypeInfoDesc)
RResult< void > AddColumn(RColumnDescriptor &&columnDesc)
RResult< void > AddFieldProjection(DescriptorId_t sourceId, DescriptorId_t targetId)
void BeginHeaderExtension()
Mark the beginning of the header extension; any fields and columns added after a call to this functio...
void ShiftAliasColumns(std::uint32_t offset)
If the descriptor is constructed in pieces consisting of physical and alias columns (regular and proj...
RResult< void > AddClusterGroup(RClusterGroupDescriptor &&clusterGroup)
void AddToOnDiskFooterSize(std::uint64_t size)
The real footer size also include the page list envelopes.
void SetNTuple(const std::string_view name, const std::string_view description)
RResult< void > AddFieldLink(DescriptorId_t fieldId, DescriptorId_t linkId)
The serialization context is used for the piecewise serialization of a descriptor.
DescriptorId_t GetOnDiskColumnId(DescriptorId_t memId) const
const std::vector< DescriptorId_t > & GetOnDiskFieldList() const
Return a vector containing the in-memory field ID for each on-disk counterpart, in order,...
DescriptorId_t GetOnDiskFieldId(DescriptorId_t memId) const
DescriptorId_t GetMemColumnId(DescriptorId_t onDiskId) const
std::size_t GetHeaderExtensionOffset() const
Return the offset of the first element in fOnDisk2MemFieldIDs that is part of the schema extension.
DescriptorId_t GetMemClusterGroupId(DescriptorId_t onDiskId) const
DescriptorId_t GetMemClusterId(DescriptorId_t onDiskId) const
void MapSchema(const RNTupleDescriptor &desc, bool forHeaderExtension)
Map in-memory field and column IDs to their on-disk counterparts.
A helper class for serializing and deserialization of the RNTuple binary format.
static std::uint32_t SerializeXxHash3(const unsigned char *data, std::uint64_t length, std::uint64_t &xxhash3, void *buffer)
Writes a XxHash-3 64bit checksum of the byte range given by data and length.
static std::uint32_t SerializeListFramePreamble(std::uint32_t nitems, void *buffer)
static RResult< std::uint32_t > DeserializeSchemaDescription(const void *buffer, std::uint64_t bufSize, RNTupleDescriptorBuilder &descBuilder)
static RResult< StreamerInfoMap_t > DeserializeStreamerInfos(const std::string &extraTypeInfoContent)
static std::uint32_t SerializeEnvelopePostscript(unsigned char *envelope, std::uint64_t size)
static std::uint32_t SerializeColumnType(ROOT::Experimental::EColumnType type, void *buffer)
static RContext SerializeHeader(void *buffer, const RNTupleDescriptor &desc)
static std::uint32_t SerializeFeatureFlags(const std::vector< std::uint64_t > &flags, void *buffer)
static RResult< std::uint32_t > DeserializeEnvelope(const void *buffer, std::uint64_t bufSize, std::uint16_t expectedType)
static std::uint32_t DeserializeUInt16(const void *buffer, std::uint16_t &val)
static RResult< std::uint32_t > DeserializeString(const void *buffer, std::uint64_t bufSize, std::string &val)
static RResult< std::uint32_t > DeserializeFeatureFlags(const void *buffer, std::uint64_t bufSize, std::vector< std::uint64_t > &flags)
static std::uint32_t SerializeString(const std::string &val, void *buffer)
static std::string SerializeStreamerInfos(const StreamerInfoMap_t &infos)
static RResult< std::uint32_t > DeserializeColumnType(const void *buffer, ROOT::Experimental::EColumnType &type)
static std::uint32_t SerializePageList(void *buffer, const RNTupleDescriptor &desc, std::span< DescriptorId_t > physClusterIDs, const RContext &context)
static RResult< std::uint32_t > DeserializeFrameHeader(const void *buffer, std::uint64_t bufSize, std::uint64_t &frameSize, std::uint32_t &nitems)
static RResult< std::uint32_t > DeserializeEnvelopeLink(const void *buffer, std::uint64_t bufSize, REnvelopeLink &envelopeLink)
static std::uint32_t DeserializeUInt32(const void *buffer, std::uint32_t &val)
static std::uint32_t SerializeUInt64(std::uint64_t val, void *buffer)
static std::uint32_t SerializeEnvelopePreamble(std::uint16_t envelopeType, void *buffer)
static std::uint32_t DeserializeInt16(const void *buffer, std::int16_t &val)
static std::uint32_t SerializeClusterSummary(const RClusterSummary &clusterSummary, void *buffer)
static std::uint32_t SerializeFramePostscript(void *frame, std::uint64_t size)
static std::uint32_t SerializeInt16(std::int16_t val, void *buffer)
static std::uint32_t SerializeFieldStructure(ROOT::Experimental::ENTupleStructure structure, void *buffer)
While we could just interpret the enums as ints, we make the translation explicit in order to avoid a...
static RResult< std::uint32_t > DeserializeFieldStructure(const void *buffer, ROOT::Experimental::ENTupleStructure &structure)
static std::uint32_t SerializeSchemaDescription(void *buffer, const RNTupleDescriptor &desc, const RContext &context, bool forHeaderExtension=false)
Serialize the schema description in desc into buffer.
std::map< Int_t, TVirtualStreamerInfo * > StreamerInfoMap_t
static std::uint32_t SerializeLocator(const RNTupleLocator &locator, void *buffer)
static std::uint32_t SerializeInt32(std::int32_t val, void *buffer)
static RResult< void > DeserializeFooter(const void *buffer, std::uint64_t bufSize, RNTupleDescriptorBuilder &descBuilder)
static std::uint32_t DeserializeUInt64(const void *buffer, std::uint64_t &val)
static RResult< void > DeserializeHeader(const void *buffer, std::uint64_t bufSize, RNTupleDescriptorBuilder &descBuilder)
static RResult< void > DeserializePageList(const void *buffer, std::uint64_t bufSize, DescriptorId_t clusterGroupId, RNTupleDescriptor &desc)
static std::uint32_t DeserializeInt32(const void *buffer, std::int32_t &val)
static std::uint32_t DeserializeInt64(const void *buffer, std::int64_t &val)
static RResult< std::uint32_t > DeserializeClusterGroup(const void *buffer, std::uint64_t bufSize, RClusterGroup &clusterGroup)
static RResult< std::uint32_t > DeserializeExtraTypeInfoId(const void *buffer, ROOT::Experimental::EExtraTypeInfoIds &id)
static std::uint32_t SerializeEnvelopeLink(const REnvelopeLink &envelopeLink, void *buffer)
static std::uint32_t SerializeRecordFramePreamble(void *buffer)
static std::uint32_t SerializeUInt16(std::uint16_t val, void *buffer)
static RResult< std::uint32_t > DeserializeLocator(const void *buffer, std::uint64_t bufSize, RNTupleLocator &locator)
static std::uint32_t SerializeClusterGroup(const RClusterGroup &clusterGroup, void *buffer)
static std::uint32_t SerializeFooter(void *buffer, const RNTupleDescriptor &desc, const RContext &context)
static RResult< void > VerifyXxHash3(const unsigned char *data, std::uint64_t length, std::uint64_t &xxhash3)
Expects an xxhash3 checksum in the 8 bytes following data + length and verifies it.
static std::uint32_t SerializeInt64(std::int64_t val, void *buffer)
static RResult< std::uint32_t > DeserializeClusterSummary(const void *buffer, std::uint64_t bufSize, RClusterSummary &clusterSummary)
static std::uint32_t SerializeUInt32(std::uint32_t val, void *buffer)
static std::uint32_t SerializeExtraTypeInfoId(ROOT::Experimental::EExtraTypeInfoIds id, void *buffer)
Records the partition of data into pages for a particular column in a particular cluster.
Meta-data stored for every column of an ntuple.
std::optional< RValueRange > GetValueRange() const
Field specific extra type information from the header / extenstion header.
Meta-data stored for every field of an ntuple.
const std::string & GetFieldName() const
const std::string & GetTypeName() const
const std::string & GetFieldDescription() const
const std::vector< DescriptorId_t > & GetLogicalColumnIds() const
const std::string & GetTypeAlias() const
std::optional< std::uint32_t > GetTypeChecksum() const
const std::vector< DescriptorId_t > & GetExtendedColumnRepresentations() const
The on-storage meta-data of an ntuple.
RColumnDescriptorIterable GetColumnIterable() const
const RClusterDescriptor & GetClusterDescriptor(DescriptorId_t clusterId) const
DescriptorId_t GetFieldZeroId() const
Returns the logical parent of all top-level NTuple data fields.
RResult< void > AddClusterGroupDetails(DescriptorId_t clusterGroupId, std::vector< RClusterDescriptor > &clusterDescs)
Methods to load and drop cluster group details (cluster IDs and page locations)
const RColumnDescriptor & GetColumnDescriptor(DescriptorId_t columnId) const
const RFieldDescriptor & GetFieldDescriptor(DescriptorId_t fieldId) const
const RClusterGroupDescriptor & GetClusterGroupDescriptor(DescriptorId_t clusterGroupId) const
const std::string & GetDescription() const
const RHeaderExtension * GetHeaderExtension() const
Return header extension information; if the descriptor does not have a header extension,...
RFieldDescriptorIterable GetFieldIterable(const RFieldDescriptor &fieldDesc) const
std::vector< std::uint64_t > GetFeatureFlags() const
RNTupleLocator payload that is common for object stores using 64bit location information.
Generic information about the physical location of data.
std::uint64_t GetNBytesOnStorage() const
void SetNBytesOnStorage(std::uint64_t nBytesOnStorage)
void SetReserved(std::uint8_t reserved)
void SetType(ELocatorType type)
Base class for all ROOT issued exceptions.
Definition RError.hxx:79
The class is used as a return type for operations that can fail; wraps a value of type T or an RError...
Definition RError.hxx:197
The concrete implementation of TBuffer for writing/reading to/from a ROOT file or socket.
Definition TBufferFile.h:47
TObject * ReadObject(const TClass *cl) override
Read object from I/O buffer.
void WriteObject(const TObject *obj, Bool_t cacheReuse=kTRUE) override
Write object to I/O buffer.
@ kWrite
Definition TBuffer.h:73
@ kRead
Definition TBuffer.h:73
Int_t Length() const
Definition TBuffer.h:100
char * Buffer() const
Definition TBuffer.h:96
virtual void SetOwner(Bool_t enable=kTRUE)
Set whether this collection is the owner (enable==true) of its content.
A doubly linked list.
Definition TList.h:38
static TClass * Class()
void Add(TObject *obj) override
Definition TList.h:81
Describes a persistent version of a class.
void BuildCheck(TFile *file=nullptr, Bool_t load=kTRUE) override
Check if built and consistent with the class dictionary.
constexpr RNTupleLocator::ELocatorType kTestLocatorType
constexpr ENTupleStructure kTestFutureFieldStructure
constexpr EColumnType kTestFutureType
RLogChannel & NTupleLog()
Log channel for RNTuple diagnostics.
std::uint64_t DescriptorId_t
Distriniguishes elements of the same type within a descriptor, e.g. different fields.
EExtraTypeInfoIds
Used in RExtraTypeInfoDescriptor.
ENTupleStructure
The fields in the ntuple model tree can carry different structural information about the type system.
constexpr DescriptorId_t kInvalidDescriptorId
void(off) SmallVectorTemplateBase< T
__device__ AFloat max(AFloat x, AFloat y)
Definition Kernels.cuh:207