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;
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};
156 std::uint32_t result;
158 result = res.Unwrap();
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);
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); };
428 bytes += result.Unwrap();
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");
438 bytes += result.Unwrap();
441 std::string typeName;
446 bytes += result.Unwrap();
450 bytes += result.Unwrap();
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 DAOS locator payload size: " + std::to_string(sizeofLocatorPayload));
519 auto base =
reinterpret_cast<unsigned char *
>(buffer);
521 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&
pos);
534 std::span<const ROOT::DescriptorId_t> fieldList,
536 bool forHeaderExtension)
538 auto base =
reinterpret_cast<unsigned char *
>(buffer);
540 void **where = (buffer ==
nullptr) ? &buffer : reinterpret_cast<void **>(&
pos);
544 for (
auto parentId : fieldList) {
545 if (xHeader && xHeader->ContainsField(parentId))
549 if (!
c.IsAliasColumn() || (xHeader && xHeader->ContainsExtendedColumnRepresentation(
c.GetLogicalId())))
552 pos += SerializeAliasColumn(
c, context, *where);
560 std::uint32_t &physicalColumnId, std::uint32_t &fieldId)
562 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
564 std::uint64_t frameSize;
565 auto fnFrameSizeLeft = [&]() {
return frameSize - (bytes - base); };
569 bytes += result.Unwrap();
571 if (fnFrameSizeLeft() < 2 *
sizeof(std::uint32_t)) {
572 return R__FAIL(
"alias column record frame too short");
584 std::uint64_t &xxhash3,
void *buffer)
586 if (buffer !=
nullptr) {
587 xxhash3 = XXH3_64bits(data, length);
594 std::uint64_t &xxhash3)
596 auto checksumReal = XXH3_64bits(data, length);
598 if (xxhash3 != checksumReal)
599 return R__FAIL(
"XxHash-3 checksum mismatch");
605 std::uint64_t xxhash3;
611 if (buffer !=
nullptr) {
612 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
613 bytes[0] = (val & 0x00FF);
614 bytes[1] = (val & 0xFF00) >> 8;
621 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
622 val = std::int16_t(bytes[0]) + (std::int16_t(bytes[1]) << 8);
638 if (buffer !=
nullptr) {
639 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
640 bytes[0] = (val & 0x000000FF);
641 bytes[1] = (val & 0x0000FF00) >> 8;
642 bytes[2] = (val & 0x00FF0000) >> 16;
643 bytes[3] = (val & 0xFF000000) >> 24;
650 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
651 val = std::int32_t(bytes[0]) + (std::int32_t(bytes[1]) << 8) + (std::int32_t(bytes[2]) << 16) +
652 (std::int32_t(bytes[3]) << 24);
668 if (buffer !=
nullptr) {
669 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
670 bytes[0] = (val & 0x00000000000000FF);
671 bytes[1] = (val & 0x000000000000FF00) >> 8;
672 bytes[2] = (val & 0x0000000000FF0000) >> 16;
673 bytes[3] = (val & 0x00000000FF000000) >> 24;
674 bytes[4] = (val & 0x000000FF00000000) >> 32;
675 bytes[5] = (val & 0x0000FF0000000000) >> 40;
676 bytes[6] = (val & 0x00FF000000000000) >> 48;
677 bytes[7] = (val & 0xFF00000000000000) >> 56;
684 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
685 val = std::int64_t(bytes[0]) + (std::int64_t(bytes[1]) << 8) + (std::int64_t(bytes[2]) << 16) +
686 (std::int64_t(bytes[3]) << 24) + (std::int64_t(bytes[4]) << 32) + (std::int64_t(bytes[5]) << 40) +
687 (std::int64_t(bytes[6]) << 48) + (std::int64_t(bytes[7]) << 56);
704 auto pos =
reinterpret_cast<unsigned char *
>(buffer);
706 memcpy(
pos, val.data(), val.length());
708 return sizeof(std::uint32_t) + val.length();
714 if (bufSize <
sizeof(std::uint32_t))
715 return R__FAIL(
"string buffer too short");
716 bufSize -=
sizeof(std::uint32_t);
718 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
720 std::uint32_t length;
722 if (bufSize < length)
723 return R__FAIL(
"string buffer too short");
726 memcpy(&val[0], bytes, length);
727 return sizeof(std::uint32_t) + length;
766 return R__FAIL(
"unexpected column type");
773 std::uint16_t onDiskType;
776 switch (onDiskType) {
828 return R__FAIL(
"unexpected field structure type");
836 std::uint16_t onDiskValue;
838 switch (onDiskValue) {
855 default:
return R__FAIL(
"unexpected extra type info id");
862 std::uint32_t onDiskValue;
864 switch (onDiskValue) {
875 auto base =
reinterpret_cast<unsigned char *
>(buffer);
877 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
886 std::uint64_t &xxhash3)
888 if (
size <
sizeof(std::uint64_t))
889 return R__FAIL(
"envelope size too small");
890 if (
size >=
static_cast<uint64_t
>(1) << 48)
891 return R__FAIL(
"envelope size too big");
893 std::uint64_t typeAndSize;
895 typeAndSize |= (
size + 8) << 16;
904 std::uint64_t xxhash3;
910 std::uint16_t expectedType, std::uint64_t &xxhash3)
912 const std::uint64_t minEnvelopeSize =
sizeof(std::uint64_t) +
sizeof(std::uint64_t);
913 if (bufSize < minEnvelopeSize)
914 return R__FAIL(
"invalid envelope buffer, too short");
916 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
919 std::uint64_t typeAndSize;
922 std::uint16_t envelopeType = typeAndSize & 0xFFFF;
923 if (envelopeType != expectedType) {
924 return R__FAIL(
"envelope type mismatch: expected " + std::to_string(expectedType) +
", found " +
925 std::to_string(envelopeType));
928 std::uint64_t envelopeSize = typeAndSize >> 16;
929 if (bufSize < envelopeSize)
930 return R__FAIL(
"envelope buffer size too small");
931 if (envelopeSize < minEnvelopeSize)
932 return R__FAIL(
"invalid envelope, too short");
934 auto result =
VerifyXxHash3(base, envelopeSize - 8, xxhash3);
938 return sizeof(typeAndSize);
942 std::uint64_t bufSize,
943 std::uint16_t expectedType)
945 std::uint64_t xxhash3;
957 auto base =
reinterpret_cast<unsigned char *
>(buffer);
959 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
970 auto preambleSize =
sizeof(std::int64_t);
971 if (
size < preambleSize)
972 return R__FAIL(
"frame too short: " + std::to_string(
size));
976 if ((marker < 0) && (
size < (
sizeof(std::uint32_t) + preambleSize)))
977 return R__FAIL(
"frame too short: " + std::to_string(
size));
985 std::uint64_t &frameSize, std::uint32_t &nitems)
987 std::uint64_t minSize =
sizeof(std::int64_t);
988 if (bufSize < minSize)
989 return R__FAIL(
"frame too short");
991 std::int64_t *ssize =
reinterpret_cast<std::int64_t *
>(&frameSize);
994 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1002 minSize +=
sizeof(std::uint32_t);
1003 if (bufSize < minSize)
1004 return R__FAIL(
"frame too short");
1009 if (frameSize < minSize)
1010 return R__FAIL(
"corrupt frame size");
1011 if (bufSize < frameSize)
1012 return R__FAIL(
"frame too short");
1014 return bytes -
reinterpret_cast<const unsigned char *
>(buffer);
1018 std::uint64_t bufSize,
1019 std::uint64_t &frameSize)
1021 std::uint32_t nitems;
1032 auto bytes =
reinterpret_cast<unsigned char *
>(buffer);
1034 for (
unsigned i = 0; i < flags.size(); ++i) {
1035 if (flags[i] & 0x8000000000000000)
1036 return R__FAIL(
"feature flag out of bounds");
1039 if (i == (flags.size() - 1))
1045 return (flags.size() *
sizeof(std::int64_t));
1050 std::vector<std::uint64_t> &flags)
1052 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1057 if (bufSize <
sizeof(std::uint64_t))
1058 return R__FAIL(
"feature flag buffer too short");
1060 bufSize -=
sizeof(std::uint64_t);
1061 flags.emplace_back(
f & ~0x8000000000000000);
1062 }
while (
f & 0x8000000000000000);
1064 return (flags.size() *
sizeof(std::uint64_t));
1071 return R__FAIL(
"locator is not serializable");
1073 std::uint32_t
size = 0;
1078 buffer ?
reinterpret_cast<unsigned char *
>(buffer) +
size :
nullptr);
1082 std::uint8_t locatorType = 0;
1083 auto payloadp = buffer ?
reinterpret_cast<unsigned char *
>(buffer) +
sizeof(std::int32_t) :
nullptr;
1086 size += SerializeLocatorPayloadLarge(locator, payloadp);
1090 size += SerializeLocatorPayloadObject64(locator, payloadp);
1098 size += SerializeLocatorPayloadObject64(dummy, payloadp);
1101 return R__FAIL(
"locator has unknown type");
1104 std::int32_t head =
sizeof(std::int32_t) +
size;
1106 head |=
static_cast<int>(locatorType & 0x7F) << 24;
1113 std::uint64_t bufSize,
1116 if (bufSize <
sizeof(std::int32_t))
1117 return R__FAIL(
"too short locator");
1119 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1123 bufSize -=
sizeof(std::int32_t);
1126 const int type = head >> 24;
1127 const std::uint32_t payloadSize = (
static_cast<std::uint32_t
>(head) & 0x0000FFFF) -
sizeof(std::int32_t);
1128 if (bufSize < payloadSize)
1129 return R__FAIL(
"too short locator");
1131 locator.
SetReserved(
static_cast<std::uint32_t
>(head >> 16) & 0xFF);
1135 DeserializeLocatorPayloadLarge(bytes, locator);
1139 DeserializeLocatorPayloadObject64(bytes, payloadSize, locator);
1143 bytes += payloadSize;
1145 if (bufSize <
sizeof(std::uint64_t))
1146 return R__FAIL(
"too short locator");
1147 std::uint64_t offset;
1154 return bytes -
reinterpret_cast<const unsigned char *
>(buffer);
1164 size += res.Unwrap();
1171 std::uint64_t bufSize,
1174 if (bufSize <
sizeof(std::int64_t))
1175 return R__FAIL(
"too short envelope link");
1177 auto bytes =
reinterpret_cast<const unsigned char *
>(buffer);
1179 bufSize -=
sizeof(std::uint64_t);
1181 bytes += res.Unwrap();
1185 return bytes -
reinterpret_cast<const unsigned char *
>(buffer);
1191 if (clusterSummary.
fNEntries >= (
static_cast<std::uint64_t
>(1) << 56)) {
1192 return R__FAIL(
"number of entries in cluster exceeds maximum of 2^56");
1195 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1197 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1202 const std::uint64_t nEntriesAndFlags =
1203 (
static_cast<std::uint64_t
>(clusterSummary.
fFlags) << 56) | clusterSummary.
fNEntries;
1208 pos += res.Unwrap();
1219 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1221 std::uint64_t frameSize;
1223 bytes += res.Unwrap();
1228 auto fnFrameSizeLeft = [&]() {
return frameSize - (bytes - base); };
1229 if (fnFrameSizeLeft() < 2 *
sizeof(std::uint64_t))
1230 return R__FAIL(
"too short cluster summary");
1233 std::uint64_t nEntriesAndFlags;
1236 const std::uint64_t nEntries = (nEntriesAndFlags << 8) >> 8;
1237 const std::uint8_t flags = nEntriesAndFlags >> 56;
1240 return R__FAIL(
"sharded cluster flag set in cluster summary; sharded clusters are currently unsupported.");
1244 clusterSummary.
fFlags = flags;
1252 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1254 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1262 pos += res.Unwrap();
1275 std::uint64_t bufSize,
1278 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1281 std::uint64_t frameSize;
1283 bytes += res.Unwrap();
1288 auto fnFrameSizeLeft = [&]() {
return frameSize - (bytes - base); };
1289 if (fnFrameSizeLeft() <
sizeof(std::uint32_t) + 2 *
sizeof(std::uint64_t))
1290 return R__FAIL(
"too short cluster group");
1296 bytes += res.Unwrap();
1305 bool forHeaderExtension)
1308 auto depthFirstTraversal = [&](std::span<ROOT::DescriptorId_t> fieldTrees,
auto doForEachField) {
1309 std::deque<ROOT::DescriptorId_t> idQueue{fieldTrees.begin(), fieldTrees.end()};
1310 while (!idQueue.empty()) {
1311 auto fieldId = idQueue.front();
1312 idQueue.pop_front();
1314 if (fieldId != fieldZeroId)
1315 doForEachField(fieldId);
1318 idQueue.insert(idQueue.begin() + i++,
f.GetId());
1324 std::vector<ROOT::DescriptorId_t> fieldTrees;
1325 if (!forHeaderExtension) {
1326 fieldTrees.emplace_back(fieldZeroId);
1328 fieldTrees = xHeader->GetTopMostFields(desc);
1333 if (!
c.IsAliasColumn()) {
1339 if (forHeaderExtension) {
1353 const RContext &context,
bool forHeaderExtension)
1355 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1357 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1359 std::size_t nFields = 0, nColumns = 0, nAliasColumns = 0, fieldListOffset = 0;
1361 std::vector<std::reference_wrapper<const ROOT::RColumnDescriptor>> extraColumns;
1362 if (forHeaderExtension) {
1366 nFields = xHeader->GetNFields();
1367 nColumns = xHeader->GetNPhysicalColumns();
1368 nAliasColumns = xHeader->GetNLogicalColumns() - xHeader->GetNPhysicalColumns();
1369 fieldListOffset = desc.
GetNFields() - nFields - 1;
1371 extraColumns.reserve(xHeader->GetExtendedColumnRepresentations().size());
1372 for (
auto columnId : xHeader->GetExtendedColumnRepresentations()) {
1378 nFields = desc.
GetNFields() - xHeader->GetNFields() - 1;
1381 (xHeader->GetNLogicalColumns() - xHeader->GetNPhysicalColumns());
1390 R__ASSERT(onDiskFields.size() >= fieldListOffset);
1391 std::span<const ROOT::DescriptorId_t> fieldList{onDiskFields.data() + fieldListOffset, nFields};
1395 if (
auto res = SerializeFieldList(desc, fieldList, fieldListOffset, context, *where)) {
1396 pos += res.Unwrap();
1401 pos += res.Unwrap();
1408 if (
auto res = SerializeColumnsOfFields(desc, fieldList, context, *where, forHeaderExtension)) {
1409 pos += res.Unwrap();
1413 for (
const auto &
c : extraColumns) {
1414 if (!
c.get().IsAliasColumn()) {
1415 if (
auto res = SerializePhysicalColumn(
c.get(), context, *where)) {
1416 pos += res.Unwrap();
1423 pos += res.Unwrap();
1430 pos += SerializeAliasColumnsOfFields(desc, fieldList, context, *where, forHeaderExtension);
1431 for (
const auto &
c : extraColumns) {
1432 if (
c.get().IsAliasColumn()) {
1433 pos += SerializeAliasColumn(
c.get(), context, *where);
1437 pos += res.Unwrap();
1444 if (forHeaderExtension) {
1446 if (
auto res = SerializeExtraTypeInfoList(desc, *where)) {
1447 pos += res.Unwrap();
1455 pos += res.Unwrap();
1460 return static_cast<std::uint32_t
>(
pos - base);
1467 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1469 auto fnBufSizeLeft = [&]() {
return bufSize - (bytes - base); };
1471 std::uint64_t frameSize;
1473 auto fnFrameSizeLeft = [&]() {
return frameSize - (bytes - frame); };
1475 std::uint32_t nFields;
1477 bytes += res.Unwrap();
1483 for (
unsigned i = 0; i < nFields; ++i) {
1484 std::uint32_t fieldId = fieldIdRangeBegin + i;
1486 if (
auto res = DeserializeField(bytes, fnFrameSizeLeft(), fieldBuilder)) {
1487 bytes += res.Unwrap();
1496 const auto parentId = fieldDesc.Inspect().
GetParentId();
1497 const auto projectionSourceId = fieldDesc.Inspect().GetProjectionSourceId();
1498 descBuilder.
AddField(fieldDesc.Unwrap());
1499 auto resVoid = descBuilder.
AddFieldLink(parentId, fieldId);
1508 bytes = frame + frameSize;
1513 std::uint16_t representationIndex) -> std::uint32_t {
1515 if (existingColumns.empty())
1518 return (representationIndex == lastColumnDesc.GetRepresentationIndex()) ? (lastColumnDesc.GetIndex() + 1) : 0;
1521 std::uint32_t nColumns;
1524 bytes += res.Unwrap();
1533 for (
unsigned i = 0; i < nColumns; ++i) {
1534 std::uint32_t columnId = columnIdRangeBegin + i;
1536 if (
auto res = DeserializeColumn(bytes, fnFrameSizeLeft(), columnBuilder)) {
1537 bytes += res.Unwrap();
1548 auto resVoid = descBuilder.
AddColumn(columnDesc.Unwrap());
1552 bytes = frame + frameSize;
1554 std::uint32_t nAliasColumns;
1557 bytes += res.Unwrap();
1562 for (
unsigned i = 0; i < nAliasColumns; ++i) {
1563 std::uint32_t physicalId;
1564 std::uint32_t fieldId;
1565 if (
auto res = DeserializeAliasColumn(bytes, fnFrameSizeLeft(), physicalId, fieldId)) {
1566 bytes += res.Unwrap();
1574 columnBuilder.
BitsOnStorage(physicalColumnDesc.GetBitsOnStorage());
1575 columnBuilder.
ValueRange(physicalColumnDesc.GetValueRange());
1576 columnBuilder.
Type(physicalColumnDesc.GetType());
1581 if (!aliasColumnDesc)
1583 auto resVoid = descBuilder.
AddColumn(aliasColumnDesc.Unwrap());
1587 bytes = frame + frameSize;
1589 std::uint32_t nExtraTypeInfos;
1592 bytes += res.Unwrap();
1596 for (
unsigned i = 0; i < nExtraTypeInfos; ++i) {
1598 if (
auto res = DeserializeExtraTypeInfo(bytes, fnFrameSizeLeft(), extraTypeInfoBuilder)) {
1599 bytes += res.Unwrap();
1606 if (extraTypeInfoDesc)
1609 bytes = frame + frameSize;
1611 return bytes - base;
1619 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1621 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1625 pos += res.Unwrap();
1636 pos += res.Unwrap();
1641 std::uint64_t
size =
pos - base;
1642 std::uint64_t xxhash3 = 0;
1644 size += res.Unwrap();
1656 std::span<ROOT::DescriptorId_t> physClusterIDs,
1659 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1661 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1668 const auto nClusters = physClusterIDs.size();
1669 auto clusterSummaryFrame =
pos;
1671 for (
auto clusterId : physClusterIDs) {
1673 RClusterSummary summary{clusterDesc.GetFirstEntryIndex(), clusterDesc.GetNEntries(), 0};
1675 pos += res.Unwrap();
1681 pos += res.Unwrap();
1687 auto topMostFrame =
pos;
1690 for (
auto clusterId : physClusterIDs) {
1693 std::set<ROOT::DescriptorId_t> onDiskColumnIds;
1694 for (
const auto &columnRange : clusterDesc.GetColumnRangeIterable())
1695 onDiskColumnIds.insert(context.
GetOnDiskColumnId(columnRange.GetPhysicalColumnId()));
1697 auto outerFrame =
pos;
1699 for (
auto onDiskId : onDiskColumnIds) {
1701 const auto &columnRange = clusterDesc.GetColumnRange(memId);
1703 auto innerFrame =
pos;
1704 if (columnRange.IsSuppressed()) {
1709 const auto &pageRange = clusterDesc.GetPageRange(memId);
1712 for (
const auto &pi : pageRange.GetPageInfos()) {
1713 std::int32_t nElements =
1714 pi.HasChecksum() ? -
static_cast<std::int32_t
>(pi.GetNElements()) : pi.GetNElements();
1717 pos += res.Unwrap();
1727 pos += res.Unwrap();
1733 pos += res.Unwrap();
1740 pos += res.Unwrap();
1744 std::uint64_t
size =
pos - base;
1746 size += res.Unwrap();
1757 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1759 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1766 pos += res.Unwrap();
1776 pos += res.Unwrap();
1781 pos += res.Unwrap();
1790 for (
unsigned int i = 0; i < nClusterGroups; ++i) {
1793 clusterGroup.
fMinEntry = cgDesc.GetMinEntry();
1794 clusterGroup.
fEntrySpan = cgDesc.GetEntrySpan();
1795 clusterGroup.
fNClusters = cgDesc.GetNClusters();
1799 pos += res.Unwrap();
1805 pos += res.Unwrap();
1813 if (nAttributeSets > 0) {
1815 "back in the future (but your main data is)";
1820 pos += res.Unwrap();
1826 pos += res.Unwrap();
1831 std::uint32_t
size =
pos - base;
1833 size += res.Unwrap();
1844 auto base =
reinterpret_cast<unsigned char *
>(buffer);
1846 void **where = (buffer ==
nullptr) ? &buffer :
reinterpret_cast<void **
>(&
pos);
1854 pos += res.Unwrap();
1869 for (std::size_t i = 0; i < featureFlags.size(); ++i) {
1870 if (!featureFlags[i])
1875 return R__FAIL(
"unsupported format feature: " + std::to_string(highestBitSet));
1883 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1885 auto fnBufSizeLeft = [&]() {
return bufSize - (bytes - base); };
1887 std::uint64_t xxhash3{0};
1889 bytes += res.Unwrap();
1895 std::vector<std::uint64_t> featureFlags;
1897 bytes += res.Unwrap();
1906 std::string description;
1909 bytes += res.Unwrap();
1914 bytes += res.Unwrap();
1919 bytes += res.Unwrap();
1941 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
1943 auto fnBufSizeLeft = [&]() {
return bufSize - (bytes - base); };
1945 bytes += res.Unwrap();
1950 std::vector<std::uint64_t> featureFlags;
1952 bytes += res.Unwrap();
1960 std::uint64_t xxhash3{0};
1961 if (fnBufSizeLeft() <
static_cast<int>(
sizeof(std::uint64_t)))
1962 return R__FAIL(
"footer too short");
1965 return R__FAIL(
"XxHash-3 mismatch between header and footer");
1967 std::uint64_t frameSize;
1969 auto fnFrameSizeLeft = [&]() {
return frameSize - (bytes - frame); };
1972 bytes += res.Unwrap();
1976 if (fnFrameSizeLeft() > 0) {
1982 bytes = frame + frameSize;
1985 std::uint32_t nClusterGroups;
1988 bytes += res.Unwrap();
1992 for (std::uint32_t groupId = 0; groupId < nClusterGroups; ++groupId) {
1995 bytes += res.Unwrap();
2010 bytes = frame + frameSize;
2015 if (fnBufSizeLeft() > 8) {
2016 std::uint32_t nAttributeSets;
2019 bytes += res.Unwrap();
2023 if (nAttributeSets > 0) {
2025 "back in the future (but your main data is)";
2027 for (std::uint32_t attrSetId = 0; attrSetId < nAttributeSets; ++attrSetId) {
2036 bytes = frame + frameSize;
2045 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
2047 auto fnBufSizeLeft = [&]() {
return bufSize - (bytes - base); };
2049 std::uint64_t frameSize;
2051 bytes += res.Unwrap();
2055 if (fnBufSizeLeft() <
static_cast<int>(
sizeof(std::uint64_t)))
2056 return R__FAIL(
"record frame too short");
2057 std::uint16_t vMajor, vMinor;
2060 std::uint32_t anchorLen;
2064 bytes += res.Unwrap();
2070 bytes += res.Unwrap();
2085 auto base =
reinterpret_cast<const unsigned char *
>(buffer);
2087 auto fnBufSizeLeft = [&]() {
return bufSize - (bytes - base); };
2090 bytes += res.Unwrap();
2095 std::uint64_t xxhash3{0};
2096 if (fnBufSizeLeft() <
static_cast<int>(
sizeof(std::uint64_t)))
2097 return R__FAIL(
"page list too short");
2100 return R__FAIL(
"XxHash-3 mismatch between header and page list");
2102 std::vector<RClusterDescriptorBuilder> clusterBuilders;
2108 std::uint64_t clusterSummaryFrameSize;
2109 auto clusterSummaryFrame = bytes;
2110 auto fnClusterSummaryFrameSizeLeft = [&]() {
return clusterSummaryFrameSize - (bytes - clusterSummaryFrame); };
2112 std::uint32_t nClusterSummaries;
2113 if (
auto res =
DeserializeFrameHeader(bytes, fnBufSizeLeft(), clusterSummaryFrameSize, nClusterSummaries)) {
2114 bytes += res.Unwrap();
2118 for (
auto clusterId = firstClusterId; clusterId < firstClusterId + nClusterSummaries; ++clusterId) {
2121 bytes += res.Unwrap();
2128 clusterBuilders.emplace_back(std::move(builder));
2130 bytes = clusterSummaryFrame + clusterSummaryFrameSize;
2132 std::uint64_t topMostFrameSize;
2133 auto topMostFrame = bytes;
2134 auto fnTopMostFrameSizeLeft = [&]() {
return topMostFrameSize - (bytes - topMostFrame); };
2136 std::uint32_t nClusters;
2138 bytes += res.Unwrap();
2143 if (nClusters != nClusterSummaries)
2144 return R__FAIL(
"mismatch between number of clusters and number of cluster summaries");
2146 for (std::uint32_t i = 0; i < nClusters; ++i) {
2147 std::uint64_t outerFrameSize;
2148 auto outerFrame = bytes;
2149 auto fnOuterFrameSizeLeft = [&]() {
return outerFrameSize - (bytes - outerFrame); };
2151 std::uint32_t nColumns;
2153 bytes += res.Unwrap();
2158 for (std::uint32_t j = 0; j < nColumns; ++j) {
2159 std::uint64_t innerFrameSize;
2160 auto innerFrame = bytes;
2161 auto fnInnerFrameSizeLeft = [&]() {
return innerFrameSize - (bytes - innerFrame); };
2163 std::uint32_t nPages;
2165 bytes += res.Unwrap();
2172 for (std::uint32_t k = 0; k < nPages; ++k) {
2173 if (fnInnerFrameSizeLeft() <
static_cast<int>(
sizeof(std::uint32_t)))
2174 return R__FAIL(
"inner frame too short");
2175 std::int32_t nElements;
2176 bool hasChecksum =
false;
2179 if (nElements < 0) {
2180 nElements = -nElements;
2184 bytes += res.Unwrap();
2188 pageRange.
GetPageInfos().push_back({
static_cast<std::uint32_t
>(nElements), locator, hasChecksum});
2191 if (fnInnerFrameSizeLeft() <
static_cast<int>(
sizeof(std::int64_t)))
2192 return R__FAIL(
"page list frame too short");
2193 std::int64_t columnOffset;
2195 if (columnOffset < 0) {
2197 return R__FAIL(
"unexpected non-empty page list");
2198 clusterBuilders[i].MarkSuppressedColumnRange(j);
2200 if (fnInnerFrameSizeLeft() <
static_cast<int>(
sizeof(std::uint32_t)))
2201 return R__FAIL(
"page list frame too short");
2202 std::uint32_t compressionSettings;
2204 clusterBuilders[i].CommitColumnRange(j, columnOffset, compressionSettings, pageRange);
2207 bytes = innerFrame + innerFrameSize;
2210 bytes = outerFrame + outerFrameSize;
2213 return clusterBuilders;
2222 if (!clusterBuildersRes)
2225 auto clusterBuilders = clusterBuildersRes.Unwrap();
2227 std::vector<ROOT::RClusterDescriptor> clusters;
2228 clusters.reserve(clusterBuilders.size());
2233 for (
auto &builder : clusterBuilders) {
2234 if (
auto res = builder.CommitSuppressedColumnRanges(desc); !res)
2236 builder.AddExtendedColumnRanges(desc);
2237 clusters.emplace_back(builder.MoveDescriptor().Unwrap());
2241 for (
auto &builder : clusterBuilders) {
2242 if (
auto res = builder.CommitSuppressedColumnRanges(desc); !res)
2244 clusters.emplace_back(builder.MoveDescriptor().Unwrap());
2248 for (
auto &builder : clusterBuilders)
2249 clusters.emplace_back(builder.MoveDescriptor().Unwrap());
2260 TList streamerInfos;
2261 for (
auto si : infos) {
2262 assert(si.first == si.second->GetNumber());
2263 streamerInfos.
Add(si.second);
2267 assert(buffer.
Length() > 0);
2280 TObjLink *lnk = infoList->FirstLink();
2284 infoMap[info->GetNumber()] = info->GetClass()->GetStreamerInfo(info->GetClassVersion());
2285 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.
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 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...
T Unwrap()
If the operation was successful, returns the inner type by value.
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