37#include <unordered_map>
54 auto base =
reinterpret_cast<unsigned char *
>(buffer);
56 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
69 std::uint16_t flags = 0;
95 auto size = pos - base;
112 auto base =
reinterpret_cast<unsigned char *
>(buffer);
114 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
118 for (
auto fieldId : fieldList) {
120 auto onDiskParentId =
121 (
f.GetParentId() == fieldZeroId) ? onDiskFieldId : context.
GetOnDiskFieldId(
f.GetParentId());
122 auto onDiskProjectionSourceId =
124 if (
auto res = SerializeField(
f, onDiskParentId, onDiskProjectionSourceId, *where)) {
140 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
142 std::uint64_t frameSize;
143 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - base); };
145 bytes += res.Unwrap();
150 std::uint32_t fieldVersion;
151 std::uint32_t typeVersion;
152 std::uint32_t parentId;
154 ENTupleStructure structure{ENTupleStructure::kPlain};
162 if (fnFrameSizeLeft() < 3 *
sizeof(std::uint32_t) +
result +
sizeof(std::uint16_t)) {
163 return R__FAIL(
"field record frame too short");
169 bytes += res.Unwrap();
176 std::string fieldName;
177 std::string typeName;
178 std::string aliasName;
179 std::string description;
181 bytes += res.Unwrap();
186 bytes += res.Unwrap();
191 bytes += res.Unwrap();
196 bytes += res.Unwrap();
203 if (fnFrameSizeLeft() <
sizeof(std::uint64_t))
204 return R__FAIL(
"field record frame too short");
205 std::uint64_t nRepetitions;
211 if (fnFrameSizeLeft() <
sizeof(std::uint32_t))
212 return R__FAIL(
"field record frame too short");
213 std::uint32_t projectionSourceId;
219 if (fnFrameSizeLeft() <
sizeof(std::uint32_t))
220 return R__FAIL(
"field record frame too short");
221 std::uint32_t typeChecksum;
239 auto base =
reinterpret_cast<unsigned char *
>(buffer);
241 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
252 std::uint16_t flags = 0;
259 firstElementIdx = -firstElementIdx;
266 std::uint64_t intMin, intMax;
267 static_assert(
sizeof(min) ==
sizeof(intMin) &&
sizeof(
max) ==
sizeof(intMax));
268 memcpy(&intMin, &min,
sizeof(min));
269 memcpy(&intMax, &max,
sizeof(max));
284 std::span<const ROOT::DescriptorId_t> fieldList,
286 void *buffer,
bool forHeaderExtension)
288 auto base =
reinterpret_cast<unsigned char *
>(buffer);
290 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
294 for (
auto parentId : fieldList) {
298 if (xHeader && xHeader->ContainsField(parentId))
302 if (
c.IsAliasColumn() || (xHeader && xHeader->ContainsExtendedColumnRepresentation(
c.GetLogicalId())))
305 if (
auto res = SerializePhysicalColumn(
c, context, *where)) {
321 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
323 std::uint64_t frameSize;
324 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - base); };
326 bytes += res.Unwrap();
333 std::uint16_t bitsOnStorage;
334 std::uint32_t fieldId;
336 std::uint16_t representationIndex;
337 std::int64_t firstElementIdx = 0;
339 2 *
sizeof(std::uint32_t)) {
340 return R__FAIL(
"column record frame too short");
343 bytes += res.Unwrap();
352 if (fnFrameSizeLeft() <
sizeof(std::uint64_t))
353 return R__FAIL(
"column record frame too short");
357 if (fnFrameSizeLeft() < 2 *
sizeof(std::uint64_t))
358 return R__FAIL(
"field record frame too short");
359 std::uint64_t minInt, maxInt;
363 memcpy(&min, &minInt,
sizeof(min));
364 memcpy(&max, &maxInt,
sizeof(max));
370 if (firstElementIdx < 0)
378 auto base =
reinterpret_cast<unsigned char *
>(buffer);
380 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
393 auto size = pos - base;
401 auto base =
reinterpret_cast<unsigned char *
>(buffer);
403 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
406 if (auto res = SerializeExtraTypeInfo(extraTypeInfoDesc, *where)) {
409 return R__FORWARD_ERROR(res);
421 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
423 std::uint64_t frameSize;
424 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - base); };
430 EExtraTypeInfoIds contentId{EExtraTypeInfoIds::kInvalid};
431 std::uint32_t typeVersion;
432 if (fnFrameSizeLeft() < 2 *
sizeof(std::uint32_t)) {
433 return R__FAIL(
"extra type info record frame too short");
441 std::string typeName;
457std::uint32_t SerializeLocatorPayloadLarge(
const ROOT::RNTupleLocator &locator,
unsigned char *buffer)
463 return sizeof(std::uint64_t) +
sizeof(std::uint64_t);
468 std::uint64_t nBytesOnStorage;
469 std::uint64_t position;
476std::uint32_t SerializeLocatorPayloadObject64(
const ROOT::RNTupleLocator &locator,
unsigned char *buffer)
479 const uint32_t sizeofNBytesOnStorage = (locator.
GetNBytesOnStorage() > std::numeric_limits<std::uint32_t>::max())
480 ?
sizeof(std::uint64_t)
481 : sizeof(std::uint32_t);
483 if (sizeofNBytesOnStorage ==
sizeof(std::uint32_t)) {
490 return sizeofNBytesOnStorage +
sizeof(std::uint64_t);
493ROOT::RResult<void> DeserializeLocatorPayloadObject64(
const unsigned char *buffer, std::uint32_t sizeofLocatorPayload,
496 std::uint64_t location;
497 if (sizeofLocatorPayload == 12) {
498 std::uint32_t nBytesOnStorage;
502 }
else if (sizeofLocatorPayload == 16) {
503 std::uint64_t nBytesOnStorage;
508 return R__FAIL(
"invalid Object64 locator payload size: " + std::to_string(sizeofLocatorPayload));
514std::uint32_t SerializeLocatorPayloadMulti(
const ROOT::RNTupleLocator &locator,
unsigned char *buffer)
518 void *bufferVoid = buffer;
521 void **where = (buffer ==
nullptr) ? &bufferVoid : reinterpret_cast<void **>(&pos);
524 pos += RNTupleSerializer::SerializeUInt64(locator.GetNBytesOnStorage(), *where);
526 pos += RNTupleSerializer::SerializeUInt32(locator.GetNBytesOnStorage(), *where);
534ROOT::RResult<void> DeserializeLocatorPayloadMulti(
const unsigned char *buffer, std::uint32_t sizeofLocatorPayload,
537 const unsigned char *pos = buffer;
538 if (sizeofLocatorPayload == 12) {
539 std::uint32_t nBytesOnStorage;
542 }
else if (sizeofLocatorPayload == 16) {
543 std::uint64_t nBytesOnStorage;
547 return R__FAIL(
"invalid Multi locator payload size: " + std::to_string(sizeofLocatorPayload));
549 std::uint32_t objectId;
562 auto base =
reinterpret_cast<unsigned char *
>(buffer);
564 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
577 std::span<const ROOT::DescriptorId_t> fieldList,
579 bool forHeaderExtension)
581 auto base =
reinterpret_cast<unsigned char *
>(buffer);
583 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&pos);
587 for (
auto parentId : fieldList) {
588 if (xHeader && xHeader->ContainsField(parentId))
592 if (!
c.IsAliasColumn() || (xHeader && xHeader->ContainsExtendedColumnRepresentation(
c.GetLogicalId())))
595 pos += SerializeAliasColumn(
c, context, *where);
603 std::uint32_t &physicalColumnId, std::uint32_t &fieldId)
605 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
607 std::uint64_t frameSize;
608 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - base); };
614 if (fnFrameSizeLeft() < 2 *
sizeof(std::uint32_t)) {
615 return R__FAIL(
"alias column record frame too short");
627 std::uint64_t &xxhash3,
void *buffer)
629 if (buffer !=
nullptr) {
637 std::uint64_t &xxhash3)
639 auto checksumReal = XXH3_64bits(
data,
length);
641 if (xxhash3 != checksumReal)
642 return R__FAIL(
"XxHash-3 checksum mismatch");
648 std::uint64_t xxhash3;
654 if (buffer !=
nullptr) {
655 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
656 bytes[0] = (val & 0x00FF);
657 bytes[1] = (val & 0xFF00) >> 8;
664 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
665 val = std::int16_t(
bytes[0]) + (std::int16_t(
bytes[1]) << 8);
681 if (buffer !=
nullptr) {
682 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
683 bytes[0] = (val & 0x000000FF);
684 bytes[1] = (val & 0x0000FF00) >> 8;
685 bytes[2] = (val & 0x00FF0000) >> 16;
686 bytes[3] = (val & 0xFF000000) >> 24;
693 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
694 val = std::int32_t(
bytes[0]) + (std::int32_t(
bytes[1]) << 8) + (std::int32_t(
bytes[2]) << 16) +
695 (std::int32_t(
bytes[3]) << 24);
711 if (buffer !=
nullptr) {
712 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
713 bytes[0] = (val & 0x00000000000000FF);
714 bytes[1] = (val & 0x000000000000FF00) >> 8;
715 bytes[2] = (val & 0x0000000000FF0000) >> 16;
716 bytes[3] = (val & 0x00000000FF000000) >> 24;
717 bytes[4] = (val & 0x000000FF00000000) >> 32;
718 bytes[5] = (val & 0x0000FF0000000000) >> 40;
719 bytes[6] = (val & 0x00FF000000000000) >> 48;
720 bytes[7] = (val & 0xFF00000000000000) >> 56;
727 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
728 val = std::int64_t(
bytes[0]) + (std::int64_t(
bytes[1]) << 8) + (std::int64_t(
bytes[2]) << 16) +
729 (std::int64_t(
bytes[3]) << 24) + (std::int64_t(
bytes[4]) << 32) + (std::int64_t(
bytes[5]) << 40) +
730 (std::int64_t(
bytes[6]) << 48) + (std::int64_t(
bytes[7]) << 56);
747 auto pos =
reinterpret_cast<unsigned char *
>(buffer);
749 memcpy(pos, val.data(), val.length());
751 return sizeof(std::uint32_t) + val.length();
757 if (bufSize <
sizeof(std::uint32_t))
758 return R__FAIL(
"string buffer too short");
759 bufSize -=
sizeof(std::uint32_t);
761 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
766 return R__FAIL(
"string buffer too short");
770 return sizeof(std::uint32_t) +
length;
809 return R__FAIL(
"unexpected column type");
816 std::uint16_t onDiskType;
819 switch (onDiskType) {
871 return R__FAIL(
"unexpected field structure type");
879 std::uint16_t onDiskValue;
881 switch (onDiskValue) {
898 default:
return R__FAIL(
"unexpected extra type info id");
905 std::uint32_t onDiskValue;
907 switch (onDiskValue) {
918 auto base =
reinterpret_cast<unsigned char *
>(buffer);
920 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
929 std::uint64_t &xxhash3)
931 if (
size <
sizeof(std::uint64_t))
932 return R__FAIL(
"envelope size too small");
933 if (
size >=
static_cast<uint64_t
>(1) << 48)
934 return R__FAIL(
"envelope size too big");
936 std::uint64_t typeAndSize;
938 typeAndSize |= (
size + 8) << 16;
947 std::uint64_t xxhash3;
953 std::uint16_t expectedType, std::uint64_t &xxhash3)
955 const std::uint64_t minEnvelopeSize =
sizeof(std::uint64_t) +
sizeof(std::uint64_t);
956 if (bufSize < minEnvelopeSize)
957 return R__FAIL(
"invalid envelope buffer, too short");
959 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
962 std::uint64_t typeAndSize;
965 std::uint16_t envelopeType = typeAndSize & 0xFFFF;
966 if (envelopeType != expectedType) {
967 return R__FAIL(
"envelope type mismatch: expected " + std::to_string(expectedType) +
", found " +
968 std::to_string(envelopeType));
971 std::uint64_t envelopeSize = typeAndSize >> 16;
972 if (bufSize < envelopeSize)
973 return R__FAIL(
"envelope buffer size too small");
974 if (envelopeSize < minEnvelopeSize)
975 return R__FAIL(
"invalid envelope, too short");
981 return sizeof(typeAndSize);
985 std::uint64_t bufSize,
986 std::uint16_t expectedType)
988 std::uint64_t xxhash3;
1000 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1002 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1013 auto preambleSize =
sizeof(std::int64_t);
1014 if (
size < preambleSize)
1015 return R__FAIL(
"frame too short: " + std::to_string(
size));
1017 std::int64_t marker;
1019 if ((marker < 0) && (
size < (
sizeof(std::uint32_t) + preambleSize)))
1020 return R__FAIL(
"frame too short: " + std::to_string(
size));
1028 std::uint64_t &frameSize, std::uint32_t &
nitems)
1030 std::uint64_t minSize =
sizeof(std::int64_t);
1031 if (bufSize < minSize)
1032 return R__FAIL(
"frame too short");
1034 std::int64_t *ssize =
reinterpret_cast<std::int64_t *
>(&frameSize);
1037 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1045 minSize +=
sizeof(std::uint32_t);
1046 if (bufSize < minSize)
1047 return R__FAIL(
"frame too short");
1052 if (frameSize < minSize)
1053 return R__FAIL(
"corrupt frame size");
1054 if (bufSize < frameSize)
1055 return R__FAIL(
"frame too short");
1057 return bytes -
reinterpret_cast<const unsigned char *
>(buffer);
1061 std::uint64_t bufSize,
1062 std::uint64_t &frameSize)
1075 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
1077 for (
unsigned i = 0; i < flags.size(); ++i) {
1078 if (flags[i] & 0x8000000000000000)
1079 return R__FAIL(
"feature flag out of bounds");
1082 if (i == (flags.size() - 1))
1088 return (flags.size() *
sizeof(std::int64_t));
1093 std::vector<std::uint64_t> &flags)
1095 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1100 if (bufSize <
sizeof(std::uint64_t))
1101 return R__FAIL(
"feature flag buffer too short");
1103 bufSize -=
sizeof(std::uint64_t);
1104 flags.emplace_back(
f & ~0x8000000000000000);
1105 }
while (
f & 0x8000000000000000);
1107 return (flags.size() *
sizeof(std::uint64_t));
1114 return R__FAIL(
"locator is not serializable");
1116 std::uint32_t
size = 0;
1121 buffer ?
reinterpret_cast<unsigned char *
>(buffer) +
size :
nullptr);
1125 std::uint8_t locatorType = 0;
1126 auto payloadp = buffer ?
reinterpret_cast<unsigned char *
>(buffer) +
sizeof(std::int32_t) :
nullptr;
1129 size += SerializeLocatorPayloadLarge(locator, payloadp);
1133 size += SerializeLocatorPayloadObject64(locator, payloadp);
1137 size += SerializeLocatorPayloadMulti(locator, payloadp);
1145 size += SerializeLocatorPayloadObject64(dummy, payloadp);
1148 return R__FAIL(
"locator has unknown type");
1151 std::int32_t head =
sizeof(std::int32_t) +
size;
1153 head |=
static_cast<int>(locatorType & 0x7F) << 24;
1160 std::uint64_t bufSize,
1163 if (bufSize <
sizeof(std::int32_t))
1164 return R__FAIL(
"too short locator");
1166 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1170 bufSize -=
sizeof(std::int32_t);
1173 const int type = head >> 24;
1174 const std::uint32_t payloadSize = (
static_cast<std::uint32_t
>(head) & 0x0000FFFF) -
sizeof(std::int32_t);
1175 if (bufSize < payloadSize)
1176 return R__FAIL(
"too short locator");
1178 locator.
SetReserved(
static_cast<std::uint32_t
>(head >> 16) & 0xFF);
1182 DeserializeLocatorPayloadLarge(
bytes, locator);
1186 auto res = DeserializeLocatorPayloadObject64(
bytes, payloadSize, locator);
1193 auto res = DeserializeLocatorPayloadMulti(
bytes, payloadSize, locator);
1200 bytes += payloadSize;
1202 if (bufSize <
sizeof(std::uint64_t))
1203 return R__FAIL(
"too short locator");
1211 return bytes -
reinterpret_cast<const unsigned char *
>(buffer);
1221 size += res.Unwrap();
1228 std::uint64_t bufSize,
1231 if (bufSize <
sizeof(std::int64_t))
1232 return R__FAIL(
"too short envelope link");
1234 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1236 bufSize -=
sizeof(std::uint64_t);
1238 bytes += res.Unwrap();
1242 return bytes -
reinterpret_cast<const unsigned char *
>(buffer);
1248 if (clusterSummary.
fNEntries >= (
static_cast<std::uint64_t
>(1) << 56)) {
1249 return R__FAIL(
"number of entries in cluster exceeds maximum of 2^56");
1252 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1254 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1259 const std::uint64_t nEntriesAndFlags =
1260 (
static_cast<std::uint64_t
>(clusterSummary.
fFlags) << 56) | clusterSummary.
fNEntries;
1263 auto size = pos - frame;
1265 pos += res.Unwrap();
1276 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1278 std::uint64_t frameSize;
1280 bytes += res.Unwrap();
1285 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - base); };
1286 if (fnFrameSizeLeft() < 2 *
sizeof(std::uint64_t))
1287 return R__FAIL(
"too short cluster summary");
1290 std::uint64_t nEntriesAndFlags;
1293 const std::uint64_t nEntries = (nEntriesAndFlags << 8) >> 8;
1294 const std::uint8_t flags = nEntriesAndFlags >> 56;
1297 return R__FAIL(
"sharded cluster flag set in cluster summary; sharded clusters are currently unsupported.");
1301 clusterSummary.
fFlags = flags;
1309 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1311 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1319 pos += res.Unwrap();
1323 auto size = pos - frame;
1332 std::uint64_t bufSize,
1335 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1338 std::uint64_t frameSize;
1340 bytes += res.Unwrap();
1345 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - base); };
1346 if (fnFrameSizeLeft() <
sizeof(std::uint32_t) + 2 *
sizeof(std::uint64_t))
1347 return R__FAIL(
"too short cluster group");
1353 bytes += res.Unwrap();
1362 bool forHeaderExtension)
1365 auto depthFirstTraversal = [&](std::span<ROOT::DescriptorId_t> fieldTrees,
auto doForEachField) {
1366 std::deque<ROOT::DescriptorId_t> idQueue{fieldTrees.begin(), fieldTrees.end()};
1367 while (!idQueue.empty()) {
1368 auto fieldId = idQueue.front();
1369 idQueue.pop_front();
1371 if (fieldId != fieldZeroId)
1372 doForEachField(fieldId);
1375 idQueue.insert(idQueue.begin() + i++,
f.GetId());
1381 std::vector<ROOT::DescriptorId_t> fieldTrees;
1382 if (!forHeaderExtension) {
1383 fieldTrees.emplace_back(fieldZeroId);
1385 fieldTrees = xHeader->GetTopMostFields(desc);
1390 if (!
c.IsAliasColumn()) {
1396 if (forHeaderExtension) {
1410 const RContext &context,
bool forHeaderExtension)
1412 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1414 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1416 std::size_t nFields = 0, nColumns = 0, nAliasColumns = 0, fieldListOffset = 0;
1418 std::vector<std::reference_wrapper<const ROOT::RColumnDescriptor>> extraColumns;
1419 if (forHeaderExtension) {
1423 nFields = xHeader->GetNFields();
1424 nColumns = xHeader->GetNPhysicalColumns();
1425 nAliasColumns = xHeader->GetNLogicalColumns() - xHeader->GetNPhysicalColumns();
1426 fieldListOffset = desc.
GetNFields() - nFields - 1;
1428 extraColumns.reserve(xHeader->GetExtendedColumnRepresentations().size());
1429 for (
auto columnId : xHeader->GetExtendedColumnRepresentations()) {
1435 nFields = desc.
GetNFields() - xHeader->GetNFields() - 1;
1438 (xHeader->GetNLogicalColumns() - xHeader->GetNPhysicalColumns());
1447 R__ASSERT(onDiskFields.size() >= fieldListOffset);
1448 std::span<const ROOT::DescriptorId_t> fieldList{onDiskFields.data() + fieldListOffset, nFields};
1452 if (
auto res = SerializeFieldList(desc, fieldList, fieldListOffset, context, *where)) {
1453 pos += res.Unwrap();
1458 pos += res.Unwrap();
1465 if (
auto res = SerializeColumnsOfFields(desc, fieldList, context, *where, forHeaderExtension)) {
1466 pos += res.Unwrap();
1470 for (
const auto &
c : extraColumns) {
1471 if (!
c.get().IsAliasColumn()) {
1472 if (
auto res = SerializePhysicalColumn(
c.get(), context, *where)) {
1473 pos += res.Unwrap();
1480 pos += res.Unwrap();
1487 pos += SerializeAliasColumnsOfFields(desc, fieldList, context, *where, forHeaderExtension);
1488 for (
const auto &
c : extraColumns) {
1489 if (
c.get().IsAliasColumn()) {
1490 pos += SerializeAliasColumn(
c.get(), context, *where);
1494 pos += res.Unwrap();
1501 if (forHeaderExtension) {
1503 if (
auto res = SerializeExtraTypeInfoList(desc, *where)) {
1504 pos += res.Unwrap();
1512 pos += res.Unwrap();
1517 return static_cast<std::uint32_t
>(pos - base);
1524 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1526 auto fnBufSizeLeft = [&]() {
return bufSize - (
bytes - base); };
1528 std::uint64_t frameSize;
1530 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - frame); };
1532 std::uint32_t nFields;
1534 bytes += res.Unwrap();
1540 for (
unsigned i = 0; i < nFields; ++i) {
1541 std::uint32_t fieldId = fieldIdRangeBegin + i;
1543 if (
auto res = DeserializeField(
bytes, fnFrameSizeLeft(), fieldBuilder)) {
1544 bytes += res.Unwrap();
1553 const auto parentId = fieldDesc.Inspect().
GetParentId();
1554 const auto projectionSourceId = fieldDesc.Inspect().GetProjectionSourceId();
1555 descBuilder.
AddField(fieldDesc.Unwrap());
1556 auto resVoid = descBuilder.
AddFieldLink(parentId, fieldId);
1565 bytes = frame + frameSize;
1570 std::uint16_t representationIndex) -> std::uint32_t {
1572 if (existingColumns.empty())
1575 return (representationIndex == lastColumnDesc.GetRepresentationIndex()) ? (lastColumnDesc.GetIndex() + 1) : 0;
1578 std::uint32_t nColumns;
1581 bytes += res.Unwrap();
1590 for (
unsigned i = 0; i < nColumns; ++i) {
1591 std::uint32_t columnId = columnIdRangeBegin + i;
1593 if (
auto res = DeserializeColumn(
bytes, fnFrameSizeLeft(), columnBuilder)) {
1594 bytes += res.Unwrap();
1605 auto resVoid = descBuilder.
AddColumn(columnDesc.Unwrap());
1609 bytes = frame + frameSize;
1611 std::uint32_t nAliasColumns;
1614 bytes += res.Unwrap();
1619 for (
unsigned i = 0; i < nAliasColumns; ++i) {
1620 std::uint32_t physicalId;
1621 std::uint32_t fieldId;
1622 if (
auto res = DeserializeAliasColumn(
bytes, fnFrameSizeLeft(), physicalId, fieldId)) {
1623 bytes += res.Unwrap();
1631 columnBuilder.
BitsOnStorage(physicalColumnDesc.GetBitsOnStorage());
1632 columnBuilder.
ValueRange(physicalColumnDesc.GetValueRange());
1633 columnBuilder.
Type(physicalColumnDesc.GetType());
1638 if (!aliasColumnDesc)
1640 auto resVoid = descBuilder.
AddColumn(aliasColumnDesc.Unwrap());
1644 bytes = frame + frameSize;
1646 std::uint32_t nExtraTypeInfos;
1649 bytes += res.Unwrap();
1653 for (
unsigned i = 0; i < nExtraTypeInfos; ++i) {
1655 if (
auto res = DeserializeExtraTypeInfo(
bytes, fnFrameSizeLeft(), extraTypeInfoBuilder)) {
1656 bytes += res.Unwrap();
1663 if (extraTypeInfoDesc)
1666 bytes = frame + frameSize;
1668 return bytes - base;
1676 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1678 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1682 pos += res.Unwrap();
1693 pos += res.Unwrap();
1698 std::uint64_t
size = pos - base;
1699 std::uint64_t xxhash3 = 0;
1701 size += res.Unwrap();
1713 std::span<ROOT::DescriptorId_t> physClusterIDs,
1716 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1718 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1725 const auto nClusters = physClusterIDs.size();
1726 auto clusterSummaryFrame = pos;
1728 for (
auto clusterId : physClusterIDs) {
1730 RClusterSummary summary{clusterDesc.GetFirstEntryIndex(), clusterDesc.GetNEntries(), 0};
1732 pos += res.Unwrap();
1738 pos += res.Unwrap();
1744 auto topMostFrame = pos;
1747 for (
auto clusterId : physClusterIDs) {
1750 std::set<ROOT::DescriptorId_t> onDiskColumnIds;
1751 for (
const auto &columnRange : clusterDesc.GetColumnRangeIterable())
1752 onDiskColumnIds.insert(context.
GetOnDiskColumnId(columnRange.GetPhysicalColumnId()));
1754 auto outerFrame = pos;
1756 for (
auto onDiskId : onDiskColumnIds) {
1758 const auto &columnRange = clusterDesc.GetColumnRange(memId);
1760 auto innerFrame = pos;
1761 if (columnRange.IsSuppressed()) {
1766 const auto &pageRange = clusterDesc.GetPageRange(memId);
1769 for (
const auto &pi : pageRange.GetPageInfos()) {
1770 std::int32_t nElements =
1771 pi.HasChecksum() ? -
static_cast<std::int32_t
>(pi.GetNElements()) : pi.GetNElements();
1774 pos += res.Unwrap();
1779 pos +=
SerializeInt64(columnRange.GetFirstElementIndex(), *where);
1780 pos +=
SerializeUInt32(columnRange.GetCompressionSettings().value(), *where);
1784 pos += res.Unwrap();
1790 pos += res.Unwrap();
1797 pos += res.Unwrap();
1801 std::uint64_t
size = pos - base;
1803 size += res.Unwrap();
1814 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1816 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1823 pos += res.Unwrap();
1833 pos += res.Unwrap();
1838 pos += res.Unwrap();
1847 for (
unsigned int i = 0; i < nClusterGroups; ++i) {
1850 clusterGroup.
fMinEntry = cgDesc.GetMinEntry();
1851 clusterGroup.
fEntrySpan = cgDesc.GetEntrySpan();
1852 clusterGroup.
fNClusters = cgDesc.GetNClusters();
1856 pos += res.Unwrap();
1862 pos += res.Unwrap();
1870 if (nAttributeSets > 0) {
1872 "back in the future (but your main data is)";
1877 pos += res.Unwrap();
1883 pos += res.Unwrap();
1888 std::uint32_t
size = pos - base;
1890 size += res.Unwrap();
1901 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1903 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&pos);
1911 pos += res.Unwrap();
1916 auto size = pos - frame;
1926 for (std::size_t i = 0; i < featureFlags.size(); ++i) {
1927 if (!featureFlags[i])
1932 return R__FAIL(
"unsupported format feature: " + std::to_string(highestBitSet));
1940 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1942 auto fnBufSizeLeft = [&]() {
return bufSize - (
bytes - base); };
1944 std::uint64_t xxhash3{0};
1946 bytes += res.Unwrap();
1952 std::vector<std::uint64_t> featureFlags;
1954 bytes += res.Unwrap();
1963 std::string description;
1966 bytes += res.Unwrap();
1971 bytes += res.Unwrap();
1976 bytes += res.Unwrap();
1998 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
2000 auto fnBufSizeLeft = [&]() {
return bufSize - (
bytes - base); };
2002 bytes += res.Unwrap();
2007 std::vector<std::uint64_t> featureFlags;
2009 bytes += res.Unwrap();
2017 std::uint64_t xxhash3{0};
2018 if (fnBufSizeLeft() <
static_cast<int>(
sizeof(std::uint64_t)))
2019 return R__FAIL(
"footer too short");
2022 return R__FAIL(
"XxHash-3 mismatch between header and footer");
2024 std::uint64_t frameSize;
2026 auto fnFrameSizeLeft = [&]() {
return frameSize - (
bytes - frame); };
2029 bytes += res.Unwrap();
2033 if (fnFrameSizeLeft() > 0) {
2039 bytes = frame + frameSize;
2042 std::uint32_t nClusterGroups;
2045 bytes += res.Unwrap();
2049 for (std::uint32_t groupId = 0; groupId < nClusterGroups; ++groupId) {
2052 bytes += res.Unwrap();
2067 bytes = frame + frameSize;
2072 if (fnBufSizeLeft() > 8) {
2073 std::uint32_t nAttributeSets;
2076 bytes += res.Unwrap();
2080 if (nAttributeSets > 0) {
2082 "back in the future (but your main data is)";
2084 for (std::uint32_t attrSetId = 0; attrSetId < nAttributeSets; ++attrSetId) {
2088 bytes += res.Unwrap();
2093 bytes = frame + frameSize;
2102 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
2104 auto fnBufSizeLeft = [&]() {
return bufSize - (
bytes - base); };
2106 std::uint64_t frameSize;
2108 bytes += res.Unwrap();
2112 if (fnBufSizeLeft() <
static_cast<int>(
sizeof(std::uint64_t)))
2113 return R__FAIL(
"record frame too short");
2114 std::uint16_t vMajor, vMinor;
2117 std::uint32_t anchorLen;
2121 bytes += res.Unwrap();
2127 bytes += res.Unwrap();
2142 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
2144 auto fnBufSizeLeft = [&]() {
return bufSize - (
bytes - base); };
2147 bytes += res.Unwrap();
2152 std::uint64_t xxhash3{0};
2153 if (fnBufSizeLeft() <
static_cast<int>(
sizeof(std::uint64_t)))
2154 return R__FAIL(
"page list too short");
2157 return R__FAIL(
"XxHash-3 mismatch between header and page list");
2159 std::vector<RClusterDescriptorBuilder> clusterBuilders;
2165 std::uint64_t clusterSummaryFrameSize;
2166 auto clusterSummaryFrame =
bytes;
2167 auto fnClusterSummaryFrameSizeLeft = [&]() {
return clusterSummaryFrameSize - (
bytes - clusterSummaryFrame); };
2169 std::uint32_t nClusterSummaries;
2171 bytes += res.Unwrap();
2175 for (
auto clusterId = firstClusterId; clusterId < firstClusterId + nClusterSummaries; ++clusterId) {
2178 bytes += res.Unwrap();
2185 clusterBuilders.emplace_back(std::move(builder));
2187 bytes = clusterSummaryFrame + clusterSummaryFrameSize;
2189 std::uint64_t topMostFrameSize;
2190 auto topMostFrame =
bytes;
2191 auto fnTopMostFrameSizeLeft = [&]() {
return topMostFrameSize - (
bytes - topMostFrame); };
2193 std::uint32_t nClusters;
2195 bytes += res.Unwrap();
2200 if (nClusters != nClusterSummaries)
2201 return R__FAIL(
"mismatch between number of clusters and number of cluster summaries");
2203 for (std::uint32_t i = 0; i < nClusters; ++i) {
2204 std::uint64_t outerFrameSize;
2205 auto outerFrame =
bytes;
2206 auto fnOuterFrameSizeLeft = [&]() {
return outerFrameSize - (
bytes - outerFrame); };
2208 std::uint32_t nColumns;
2210 bytes += res.Unwrap();
2215 for (std::uint32_t j = 0; j < nColumns; ++j) {
2216 std::uint64_t innerFrameSize;
2217 auto innerFrame =
bytes;
2218 auto fnInnerFrameSizeLeft = [&]() {
return innerFrameSize - (
bytes - innerFrame); };
2220 std::uint32_t nPages;
2222 bytes += res.Unwrap();
2229 for (std::uint32_t k = 0; k < nPages; ++k) {
2230 if (fnInnerFrameSizeLeft() <
static_cast<int>(
sizeof(std::uint32_t)))
2231 return R__FAIL(
"inner frame too short");
2232 std::int32_t nElements;
2233 bool hasChecksum =
false;
2236 if (nElements < 0) {
2237 nElements = -nElements;
2241 bytes += res.Unwrap();
2245 pageRange.
GetPageInfos().push_back({
static_cast<std::uint32_t
>(nElements), locator, hasChecksum});
2248 if (fnInnerFrameSizeLeft() <
static_cast<int>(
sizeof(std::int64_t)))
2249 return R__FAIL(
"page list frame too short");
2250 std::int64_t columnOffset;
2252 if (columnOffset < 0) {
2254 return R__FAIL(
"unexpected non-empty page list");
2255 clusterBuilders[i].MarkSuppressedColumnRange(j);
2257 if (fnInnerFrameSizeLeft() <
static_cast<int>(
sizeof(std::uint32_t)))
2258 return R__FAIL(
"page list frame too short");
2259 std::uint32_t compressionSettings;
2261 clusterBuilders[i].CommitColumnRange(j, columnOffset, compressionSettings, pageRange);
2264 bytes = innerFrame + innerFrameSize;
2267 bytes = outerFrame + outerFrameSize;
2270 return clusterBuilders;
2279 if (!clusterBuildersRes)
2282 auto clusterBuilders = clusterBuildersRes.Unwrap();
2284 std::vector<ROOT::RClusterDescriptor> clusters;
2285 clusters.reserve(clusterBuilders.size());
2290 for (
auto &builder : clusterBuilders) {
2291 if (
auto res = builder.CommitSuppressedColumnRanges(desc); !res)
2293 builder.AddExtendedColumnRanges(desc);
2294 clusters.emplace_back(builder.MoveDescriptor().Unwrap());
2298 for (
auto &builder : clusterBuilders) {
2299 if (
auto res = builder.CommitSuppressedColumnRanges(desc); !res)
2301 clusters.emplace_back(builder.MoveDescriptor().Unwrap());
2305 for (
auto &builder : clusterBuilders)
2306 clusters.emplace_back(builder.MoveDescriptor().Unwrap());
2317 TList streamerInfos;
2318 for (
auto si : infos) {
2319 assert(si.first == si.second->GetNumber());
2320 streamerInfos.
Add(si.second);
2324 assert(buffer.
Length() > 0);
2337 TObjLink *lnk = infoList->FirstLink();
2341 infoMap[info->GetNumber()] = info->GetClass()->GetStreamerInfo(info->GetClassVersion());
2342 assert(info->GetNumber() == infoMap[info->GetNumber()]->GetNumber());
#define R__FORWARD_ERROR(res)
Short-hand to return an RResult<T> in an error state (i.e. after checking)
#define R__FORWARD_RESULT(res)
Short-hand to return an RResult<T> value from a subroutine to the calling stack frame.
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
#define R__LOG_WARNING(...)
#define R__LOG_DEBUG(DEBUGLEVEL,...)
static ROOT::RResult< void > CheckFeatureFlags(const std::vector< std::uint64_t > &featureFlags)
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
unsigned int UInt_t
Unsigned integer 4 bytes (unsigned int)
#define R__ASSERT(e)
Checks condition e and reports a fatal error if it's false.
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 mode
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
A helper class for serializing and deserialization of the RNTuple binary format.
static constexpr std::uint16_t kFlagDeferredColumn
static RResult< std::uint32_t > DeserializeString(const void *buffer, std::uint64_t bufSize, std::string &val)
static constexpr std::uint16_t kFlagIsSoACollection
static std::uint32_t SerializeUInt32(std::uint32_t val, void *buffer)
static RResult< std::uint32_t > SerializeFieldStructure(ROOT::ENTupleStructure structure, void *buffer)
While we could just interpret the enums as ints, we make the translation explicit in order to avoid a...
static std::uint32_t DeserializeUInt32(const void *buffer, std::uint32_t &val)
static RResult< std::uint32_t > DeserializeFrameHeader(const void *buffer, std::uint64_t bufSize, std::uint64_t &frameSize, std::uint32_t &nitems)
static constexpr std::uint16_t kFlagRepetitiveField
static RResult< std::uint32_t > SerializeColumnType(ROOT::ENTupleColumnType type, void *buffer)
static RResult< std::uint32_t > SerializeFramePostscript(void *frame, std::uint64_t size)
static std::uint32_t SerializeUInt16(std::uint16_t val, void *buffer)
static constexpr std::uint16_t kFlagProjectedField
static std::uint32_t DeserializeInt64(const void *buffer, std::int64_t &val)
static std::uint32_t SerializeString(const std::string &val, void *buffer)
static RResult< std::uint32_t > SerializeExtraTypeInfoId(ROOT::EExtraTypeInfoIds id, void *buffer)
static std::uint32_t DeserializeUInt16(const void *buffer, std::uint16_t &val)
static constexpr std::uint16_t kFlagHasValueRange
static RResult< std::uint32_t > DeserializeColumnType(const void *buffer, ROOT::ENTupleColumnType &type)
static constexpr std::uint16_t kFlagHasTypeChecksum
static RResult< std::uint32_t > DeserializeExtraTypeInfoId(const void *buffer, ROOT::EExtraTypeInfoIds &id)
static std::uint32_t SerializeRecordFramePreamble(void *buffer)
static RResult< std::uint32_t > DeserializeFieldStructure(const void *buffer, ROOT::ENTupleStructure &structure)
static std::uint32_t SerializeInt64(std::int64_t val, void *buffer)
static std::uint32_t DeserializeUInt64(const void *buffer, std::uint64_t &val)
static std::uint32_t SerializeUInt64(std::uint64_t val, void *buffer)
The available trivial, native content types of a column.
RNTupleAttrSetDescriptorBuilder & AnchorLocator(const RNTupleLocator &loc)
RNTupleAttrSetDescriptorBuilder & SchemaVersion(std::uint16_t major, std::uint16_t minor)
RResult< ROOT::Experimental::RNTupleAttrSetDescriptor > MoveDescriptor()
Attempt to make an AttributeSet descriptor.
RNTupleAttrSetDescriptorBuilder & Name(std::string_view name)
RNTupleAttrSetDescriptorBuilder & AnchorLength(std::uint32_t length)
Metadata stored for every Attribute Set linked to an RNTuple.
std::uint16_t GetSchemaVersionMinor() const
const std::string & GetName() const
const RNTupleLocator & GetAnchorLocator() const
std::uint16_t GetSchemaVersionMajor() const
std::uint32_t GetAnchorLength() const
A helper class for piece-wise construction of an RClusterDescriptor.
RClusterDescriptorBuilder & NEntries(std::uint64_t nEntries)
RClusterDescriptorBuilder & ClusterId(ROOT::DescriptorId_t clusterId)
RClusterDescriptorBuilder & FirstEntryIndex(std::uint64_t firstEntryIndex)
A helper class for piece-wise construction of an RClusterGroupDescriptor.
RClusterGroupDescriptorBuilder & EntrySpan(std::uint64_t entrySpan)
RClusterGroupDescriptorBuilder & PageListLocator(const RNTupleLocator &pageListLocator)
RClusterGroupDescriptorBuilder & PageListLength(std::uint64_t pageListLength)
RClusterGroupDescriptorBuilder & MinEntry(std::uint64_t minEntry)
RResult< RClusterGroupDescriptor > MoveDescriptor()
RClusterGroupDescriptorBuilder & ClusterGroupId(ROOT::DescriptorId_t clusterGroupId)
RClusterGroupDescriptorBuilder & NClusters(std::uint32_t nClusters)
A helper class for piece-wise construction of an RColumnDescriptor.
ROOT::DescriptorId_t GetRepresentationIndex() const
RColumnDescriptorBuilder & SetSuppressedDeferred()
RColumnDescriptorBuilder & LogicalColumnId(ROOT::DescriptorId_t logicalColumnId)
RResult< RColumnDescriptor > MakeDescriptor() const
Attempt to make a column descriptor.
RColumnDescriptorBuilder & FieldId(ROOT::DescriptorId_t fieldId)
RColumnDescriptorBuilder & BitsOnStorage(std::uint16_t bitsOnStorage)
RColumnDescriptorBuilder & ValueRange(double min, double max)
RColumnDescriptorBuilder & Type(ROOT::ENTupleColumnType type)
RColumnDescriptorBuilder & PhysicalColumnId(ROOT::DescriptorId_t physicalColumnId)
RColumnDescriptorBuilder & FirstElementIndex(std::uint64_t firstElementIdx)
RColumnDescriptorBuilder & Index(std::uint32_t index)
RColumnDescriptorBuilder & RepresentationIndex(std::uint16_t representationIndex)
ROOT::DescriptorId_t GetFieldId() const
A helper class for piece-wise construction of an RFieldDescriptor.
RFieldDescriptorBuilder & NRepetitions(std::uint64_t nRepetitions)
RFieldDescriptorBuilder & Structure(const ROOT::ENTupleStructure &structure)
RFieldDescriptorBuilder & TypeAlias(const std::string &typeAlias)
RFieldDescriptorBuilder & ProjectionSourceId(ROOT::DescriptorId_t id)
RFieldDescriptorBuilder & TypeVersion(std::uint32_t typeVersion)
RFieldDescriptorBuilder & IsSoACollection(bool val)
ROOT::DescriptorId_t GetParentId() const
RFieldDescriptorBuilder & TypeChecksum(const std::optional< std::uint32_t > typeChecksum)
RResult< RFieldDescriptor > MakeDescriptor() const
Attempt to make a field descriptor.
RFieldDescriptorBuilder & ParentId(ROOT::DescriptorId_t id)
RFieldDescriptorBuilder & FieldDescription(const std::string &fieldDescription)
RFieldDescriptorBuilder & FieldVersion(std::uint32_t fieldVersion)
RFieldDescriptorBuilder & FieldName(const std::string &fieldName)
RFieldDescriptorBuilder & FieldId(ROOT::DescriptorId_t fieldId)
RFieldDescriptorBuilder & TypeName(const std::string &typeName)
A helper class for piece-wise construction of an RNTupleDescriptor.
void SetNTuple(const std::string_view name, const std::string_view description)
RResult< void > AddColumn(RColumnDescriptor &&columnDesc)
RResult< void > AddAttributeSet(Experimental::RNTupleAttrSetDescriptor &&attrSetDesc)
RResult< void > AddFieldProjection(ROOT::DescriptorId_t sourceId, ROOT::DescriptorId_t targetId)
RResult< void > AddExtraTypeInfo(RExtraTypeInfoDescriptor &&extraTypeInfoDesc)
void ShiftAliasColumns(std::uint32_t offset)
Shift column IDs of alias columns by offset
const RNTupleDescriptor & GetDescriptor() const
void BeginHeaderExtension()
Mark the beginning of the header extension; any fields and columns added after a call to this functio...
RResult< void > AddFieldLink(ROOT::DescriptorId_t fieldId, ROOT::DescriptorId_t linkId)
void AddField(const RFieldDescriptor &fieldDesc)
RResult< void > AddClusterGroup(RClusterGroupDescriptor &&clusterGroup)
void SetOnDiskHeaderXxHash3(std::uint64_t xxhash3)
void AddToOnDiskFooterSize(std::uint64_t size)
The real footer size also include the page list envelopes.
The serialization context is used for the piecewise serialization of a descriptor.
ROOT::DescriptorId_t GetOnDiskFieldId(ROOT::DescriptorId_t memId) const
ROOT::DescriptorId_t GetMemColumnId(ROOT::DescriptorId_t onDiskId) const
ROOT::DescriptorId_t GetMemClusterGroupId(ROOT::DescriptorId_t onDiskId) const
ROOT::DescriptorId_t GetOnDiskColumnId(ROOT::DescriptorId_t memId) const
std::uint64_t GetHeaderXxHash3() const
void MapSchema(const RNTupleDescriptor &desc, bool forHeaderExtension)
Map in-memory field and column IDs to their on-disk counterparts.
void SetHeaderSize(std::uint64_t size)
ROOT::DescriptorId_t MapPhysicalColumnId(ROOT::DescriptorId_t memId)
Map an in-memory column ID to its on-disk counterpart.
void SetHeaderXxHash3(std::uint64_t xxhash3)
ROOT::DescriptorId_t GetMemClusterId(ROOT::DescriptorId_t onDiskId) const
const std::vector< ROOT::DescriptorId_t > & GetOnDiskFieldList() const
Return a vector containing the in-memory field ID for each on-disk counterpart, in order,...
ROOT::DescriptorId_t MapFieldId(ROOT::DescriptorId_t memId)
Map an in-memory field ID to its on-disk counterpart.
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 RResult< std::vector< ROOT::Internal::RClusterDescriptorBuilder > > DeserializePageListRaw(const void *buffer, std::uint64_t bufSize, ROOT::DescriptorId_t clusterGroupId, const RNTupleDescriptor &desc)
static RResult< std::uint32_t > SerializeSchemaDescription(void *buffer, const RNTupleDescriptor &desc, const RContext &context, bool forHeaderExtension=false)
Serialize the schema description in desc into buffer.
static RResult< std::uint32_t > DeserializeString(const void *buffer, std::uint64_t bufSize, std::string &val)
static constexpr std::uint16_t kEnvelopeTypePageList
static RResult< std::uint32_t > SerializeEnvelopeLink(const REnvelopeLink &envelopeLink, void *buffer)
static std::uint32_t SerializeInt32(std::int32_t val, void *buffer)
static RResult< std::uint32_t > DeserializeEnvelopeLink(const void *buffer, std::uint64_t bufSize, REnvelopeLink &envelopeLink)
static std::uint32_t SerializeUInt32(std::uint32_t val, void *buffer)
static RResult< std::uint32_t > SerializeAttributeSet(const Experimental::RNTupleAttrSetDescriptor &attrSetDesc, void *buffer)
static RResult< std::uint32_t > SerializeFieldStructure(ROOT::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 > SerializeEnvelopePostscript(unsigned char *envelope, std::uint64_t size)
static RResult< std::uint32_t > SerializeFeatureFlags(const std::vector< std::uint64_t > &flags, void *buffer)
static std::uint32_t DeserializeUInt32(const void *buffer, std::uint32_t &val)
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 > DeserializeAttributeSet(const void *buffer, std::uint64_t bufSize, Experimental::Internal::RNTupleAttrSetDescriptorBuilder &attrSetDescBld)
static RResult< std::uint32_t > DeserializeEnvelope(const void *buffer, std::uint64_t bufSize, std::uint16_t expectedType)
static constexpr int64_t kSuppressedColumnMarker
static RResult< std::uint32_t > SerializeColumnType(ROOT::ENTupleColumnType type, void *buffer)
static std::uint32_t SerializeListFramePreamble(std::uint32_t nitems, void *buffer)
static std::uint32_t SerializeInt16(std::int16_t val, void *buffer)
static RResult< std::uint32_t > SerializeFramePostscript(void *frame, std::uint64_t size)
static constexpr std::uint16_t kEnvelopeTypeFooter
static RResult< std::uint32_t > DeserializeClusterGroup(const void *buffer, std::uint64_t bufSize, RClusterGroup &clusterGroup)
static RResult< std::uint32_t > DeserializeLocator(const void *buffer, std::uint64_t bufSize, RNTupleLocator &locator)
static std::uint32_t SerializeUInt16(std::uint16_t val, void *buffer)
static RResult< void > DeserializePageList(const void *buffer, std::uint64_t bufSize, ROOT::DescriptorId_t clusterGroupId, RNTupleDescriptor &desc, EDescriptorDeserializeMode mode)
static RResult< void > DeserializeFooter(const void *buffer, std::uint64_t bufSize, ROOT::Internal::RNTupleDescriptorBuilder &descBuilder)
static std::uint32_t DeserializeInt64(const void *buffer, std::int64_t &val)
static std::uint32_t SerializeEnvelopePreamble(std::uint16_t envelopeType, void *buffer)
static std::uint32_t DeserializeInt32(const void *buffer, std::int32_t &val)
static std::uint32_t SerializeString(const std::string &val, void *buffer)
std::map< Int_t, TVirtualStreamerInfo * > StreamerInfoMap_t
static RResult< std::uint32_t > SerializeExtraTypeInfoId(ROOT::EExtraTypeInfoIds id, void *buffer)
static RResult< StreamerInfoMap_t > DeserializeStreamerInfos(const std::string &extraTypeInfoContent)
static std::uint32_t DeserializeUInt16(const void *buffer, std::uint16_t &val)
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 RResult< std::uint32_t > SerializeClusterSummary(const RClusterSummary &clusterSummary, void *buffer)
static RResult< std::uint32_t > DeserializeColumnType(const void *buffer, ROOT::ENTupleColumnType &type)
static constexpr ROOT::DescriptorId_t kZeroFieldId
static std::uint32_t DeserializeInt16(const void *buffer, std::int16_t &val)
static RResult< std::uint32_t > DeserializeExtraTypeInfoId(const void *buffer, ROOT::EExtraTypeInfoIds &id)
static RResult< std::uint32_t > DeserializeClusterSummary(const void *buffer, std::uint64_t bufSize, RClusterSummary &clusterSummary)
EDescriptorDeserializeMode
@ kForReading
Deserializes the descriptor and performs fixup on the suppressed column ranges and on clusters,...
@ kRaw
Deserializes the descriptor as-is without performing any additional fixup.
@ kForWriting
Deserializes the descriptor and performs fixup on the suppressed column ranges.
static constexpr std::uint16_t kEnvelopeTypeHeader
static RResult< std::uint32_t > SerializeClusterGroup(const RClusterGroup &clusterGroup, void *buffer)
static std::uint32_t SerializeRecordFramePreamble(void *buffer)
static RResult< std::uint32_t > SerializePageList(void *buffer, const RNTupleDescriptor &desc, std::span< ROOT::DescriptorId_t > physClusterIDs, const RContext &context)
static RResult< std::uint32_t > DeserializeFieldStructure(const void *buffer, ROOT::ENTupleStructure &structure)
static std::uint32_t SerializeInt64(std::int64_t val, void *buffer)
static RResult< void > DeserializeHeader(const void *buffer, std::uint64_t bufSize, ROOT::Internal::RNTupleDescriptorBuilder &descBuilder)
static RResult< std::uint32_t > SerializeFooter(void *buffer, const RNTupleDescriptor &desc, const RContext &context)
static std::uint32_t DeserializeUInt64(const void *buffer, std::uint64_t &val)
static RResult< std::uint32_t > SerializeLocator(const RNTupleLocator &locator, void *buffer)
static RResult< std::uint32_t > DeserializeSchemaDescription(const void *buffer, std::uint64_t bufSize, ROOT::Internal::RNTupleDescriptorBuilder &descBuilder)
static std::uint32_t SerializeUInt64(std::uint64_t val, void *buffer)
static RResult< std::uint32_t > DeserializeFeatureFlags(const void *buffer, std::uint64_t bufSize, std::vector< std::uint64_t > &flags)
static RResult< RContext > SerializeHeader(void *buffer, const RNTupleDescriptor &desc)
static std::string SerializeStreamerInfos(const StreamerInfoMap_t &infos)
std::uint32_t GetNClusters() const
Metadata stored for every column of an RNTuple.
bool IsSuppressedDeferredColumn() const
std::optional< RValueRange > GetValueRange() const
std::uint64_t GetFirstElementIndex() const
ROOT::DescriptorId_t GetFieldId() const
bool IsAliasColumn() const
ROOT::ENTupleColumnType GetType() const
ROOT::DescriptorId_t GetPhysicalId() const
std::uint16_t GetRepresentationIndex() const
bool IsDeferredColumn() const
std::uint16_t GetBitsOnStorage() const
Metadata stored for every field of an RNTuple.
const std::string & GetTypeAlias() const
std::uint32_t GetFieldVersion() const
const std::vector< ROOT::DescriptorId_t > & GetLogicalColumnIds() const
ROOT::ENTupleStructure GetStructure() const
std::uint64_t GetNRepetitions() const
bool IsSoACollection() const
bool IsProjectedField() const
const std::string & GetFieldDescription() const
std::optional< std::uint32_t > GetTypeChecksum() const
std::uint32_t GetTypeVersion() const
const std::string & GetFieldName() const
const std::string & GetTypeName() const
The on-storage metadata of an RNTuple.
const RClusterGroupDescriptor & GetClusterGroupDescriptor(ROOT::DescriptorId_t clusterGroupId) const
const RColumnDescriptor & GetColumnDescriptor(ROOT::DescriptorId_t columnId) const
RFieldDescriptorIterable GetFieldIterable(const RFieldDescriptor &fieldDesc) const
const RFieldDescriptor & GetFieldDescriptor(ROOT::DescriptorId_t fieldId) const
std::size_t GetNExtraTypeInfos() const
RColumnDescriptorIterable GetColumnIterable() const
const std::string & GetName() const
std::vector< std::uint64_t > GetFeatureFlags() const
ROOT::DescriptorId_t GetFieldZeroId() const
Returns the logical parent of all top-level RNTuple data fields.
std::size_t GetNAttributeSets() const
RExtraTypeInfoDescriptorIterable GetExtraTypeInfoIterable() const
std::size_t GetNPhysicalColumns() const
const RHeaderExtension * GetHeaderExtension() const
Return header extension information; if the descriptor does not have a header extension,...
const RClusterDescriptor & GetClusterDescriptor(ROOT::DescriptorId_t clusterId) const
std::uint64_t GetOnDiskHeaderXxHash3() const
std::size_t GetNFields() const
RResult< void > AddClusterGroupDetails(ROOT::DescriptorId_t clusterGroupId, std::vector< RClusterDescriptor > &clusterDescs)
Methods to load and drop cluster group details (cluster IDs and page locations)
ROOT::Experimental::RNTupleAttrSetDescriptorIterable GetAttrSetIterable() const
std::size_t GetNLogicalColumns() const
std::size_t GetNClusterGroups() const
const std::string & GetDescription() const
RNTupleLocator payload for the kTypeMulti locator (type 0x03).
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
ELocatorType GetType() const
For non-disk locators, the value for the Type field.
std::uint8_t GetReserved() const
We currently only support one of the 8 available reserved bits (none are used so far).
T GetPosition() const
Note that for GetPosition() / SetPosition(), the locator type must correspond (kTypeFile,...
void SetType(ELocatorType type)
void SetPosition(std::uint64_t position)
void SetReserved(std::uint8_t reserved)
See GetReserved(): we ignore the reserved flag since we don't use it anywhere currently.
void SetNBytesOnStorage(std::uint64_t nBytesOnStorage)
The class is used as a return type for operations that can fail; wraps a value of type T or an RError...
The concrete implementation of TBuffer for writing/reading to/from a ROOT file or socket.
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.
void Add(TObject *obj) override
Wrapper around a TObject so it can be stored in a TList.
TObject * GetObject() const
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 ROOT::ENTupleStructure kTestFutureFieldStructure
std::size_t LeadingZeroes(T x)
Given an integer x, returns the number of leading 0-bits starting at the most significant bit positio...
ROOT::RLogChannel & NTupleLog()
Log channel for RNTuple diagnostics.
constexpr ENTupleColumnType kTestFutureColumnType
constexpr RNTupleLocator::ELocatorType kTestLocatorType
EExtraTypeInfoIds
Used in RExtraTypeInfoDescriptor.
std::uint64_t DescriptorId_t
Distriniguishes elements of the same type within a descriptor, e.g. different fields.
constexpr DescriptorId_t kInvalidDescriptorId
ENTupleStructure
The fields in the RNTuple data model tree can carry different structural information about the type s...
__device__ AFloat max(AFloat x, AFloat y)
REnvelopeLink fPageListEnvelopeLink
std::uint64_t fFirstEntry