44#include <unordered_map>
93 return R__FAIL(
"page checksum verification failed, data corruption detected");
100 return R__FAIL(
"invalid attempt to extract non-existing page checksum");
102 assert(fBufferSize >= kNBytesPageChecksum);
105 reinterpret_cast<const unsigned char *
>(
fBuffer) + fBufferSize - kNBytesPageChecksum,
checksum);
129 for (std::size_t i = 0; i <
itr->second.size(); ++i) {
133 itr->second[i].fRefCounter--;
134 if (
itr->second[i].fRefCounter == 0) {
136 if (
itr->second.empty()) {
137 fColumnInfos.erase(
itr);
163 if (
clusterDesc.GetFirstEntryIndex() >= (fFirstEntry + fNEntries))
178std::unique_ptr<ROOT::Internal::RPageSource>
185 if (location.empty()) {
188 if (location.find(
"daos://") == 0)
190 return std::make_unique<ROOT::Experimental::Internal::RPageSourceDaos>(
ntupleName, location, options);
198 return std::make_unique<ROOT::Internal::RPageSourceFile>(
ntupleName, location, options);
219 if ((
range.fFirstEntry +
range.fNEntries) > GetNEntries()) {
229 fHasStructure =
true;
239 auto descGuard = GetExclDescriptorGuard();
241 fStructureBuffer.Reset();
243 std::vector<unsigned char> buffer;
245 buffer.resize(
cgDesc.GetPageListLength() +
cgDesc.GetPageListLocator().GetNBytesOnStorage());
250 cgDesc.GetPageListLength(), buffer.data());
260 auto clone = CloneImpl();
262 clone->GetExclDescriptorGuard().MoveIn(GetSharedDescriptorGuard()->Clone());
263 clone->fHasStructure =
true;
264 clone->fIsAttached =
true;
271 return GetSharedDescriptorGuard()->GetNEntries();
276 return GetSharedDescriptorGuard()->GetNElements(
columnHandle.fPhysicalId);
287 RNTupleAtomicTimer
timer(fCounters->fTimeWallUnzip, fCounters->fTimeCpuUnzip);
297 std::vector<std::unique_ptr<RColumnElementBase>>
allElements;
303 if (!fActivePhysicalColumns.HasColumnInfos(
columnId))
314 for (
const auto &pi :
pageRange.GetPageInfos()) {
319 sealedPage.SetBufferSize(pi.GetLocator().GetNBytesOnStorage() + pi.HasChecksum() * kNBytesPageChecksum);
346 fCounters->fNPageUnsealed.Add(
pageNo);
350 fTaskScheduler->Wait();
353 throw RException(
R__FAIL(
"page checksum verification failed, data corruption detected"));
375 pageInfo.GetLocator().GetNBytesOnStorage()));
390 GetSharedDescriptorGuard()->GetClusterDescriptor(
clusterId).GetFirstEntryIndex();
391 auto itr = fPreloadedClusters.
begin();
393 if (fPinnedClusters.count(
itr->second) > 0) {
396 fPagePool.Evict(
itr->second);
397 itr = fPreloadedClusters.erase(
itr);
401 while ((
itr != fPreloadedClusters.
end()) &&
406 while (
itr != fPreloadedClusters.
end()) {
407 if (fPinnedClusters.count(
itr->second) > 0) {
410 fPagePool.Evict(
itr->second);
411 itr = fPreloadedClusters.erase(
itr);
440 sealedPage.VerifyChecksumIfEnabled().ThrowOnError();
491 fCounters->fNPageRead.Inc();
492 fCounters->fNRead.Inc();
493 fCounters->fSzReadPayload.Add(
sealedPage.GetBufferSize());
495 if (!fCurrentCluster || (fCurrentCluster->GetId() !=
clusterId) || !fCurrentCluster->ContainsColumn(
columnId))
496 fCurrentCluster = fClusterPool.GetCluster(
clusterId, fActivePhysicalColumns.ToColumnSet());
506 auto onDiskPage = fCurrentCluster->GetOnDiskPage(key);
513 RNTupleAtomicTimer
timer(fCounters->fTimeWallUnzip, fCounters->fTimeCpuUnzip);
520 fCounters->fNPageUnsealed.Inc();
533 UpdateLastUsedCluster(
cachedPageRef.Get().GetClusterInfo().GetId());
593 fMetrics.ObserveMetrics(fClusterPool.GetMetrics());
594 fMetrics.ObserveMetrics(fPagePool.GetMetrics());
595 fCounters = std::make_unique<RCounters>(
RCounters{
598 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"szReadPayload",
"B",
"volume read from storage (required)"),
599 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"szReadOverhead",
"B",
"volume read from storage (overhead)"),
602 "number of partial clusters preloaded from storage"),
603 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"nPageRead",
"",
"number of pages read from storage"),
604 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"nPageUnsealed",
"",
"number of pages unzipped and decoded"),
605 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"timeWallRead",
"ns",
"wall clock time spent reading"),
606 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"timeWallUnzip",
"ns",
"wall clock time spent decompressing"),
609 "CPU time spent decompressing"),
611 "bwRead",
"MB/s",
"bandwidth compressed bytes read per second", fMetrics,
628 "bwReadUnzip",
"MB/s",
"bandwidth uncompressed bytes read per second", fMetrics,
642 "bwUnzip",
"MB/s",
"decompression bandwidth of uncompressed bytes per second", fMetrics,
656 "rtReadEfficiency",
"",
"ratio of payload over all bytes read", fMetrics,
662 return {
true, 1. / (1. + (1. *
szReadOverhead->GetValueAsInt()) / payload)};
668 *fMetrics.MakeCounter<
RNTupleCalcPerf *>(
"rtCompression",
"",
"ratio of compressed bytes / uncompressed bytes",
671 metrics.GetLocalCounter(
"szReadPayload")) {
729 if (fHasStreamerInfosRegistered)
732 for (
const auto &
extraTypeInfo : fDescriptor.GetExtraTypeInfoIterable()) {
740 fHasStreamerInfosRegistered =
true;
748 if (fCurrentPageSize ==
other.fCurrentPageSize)
749 return fColumn->GetOnDiskId() >
other.fColumn->GetOnDiskId();
750 return fCurrentPageSize >
other.fCurrentPageSize;
758 auto itr = fColumnsSortedByPageSize.
begin();
759 while (
itr != fColumnsSortedByPageSize.
end()) {
762 if (
itr->fCurrentPageSize ==
itr->fInitialPageSize) {
771 if (
itr != fColumnsSortedByPageSize.
end())
780 itr = fColumnsSortedByPageSize.find(next);
789 auto itr = fColumnsSortedByPageSize.find(key);
790 if (
itr == fColumnsSortedByPageSize.
end()) {
804 fColumnsSortedByPageSize.erase(
itr);
810 fColumnsSortedByPageSize.insert(
elem);
819 fColumnsSortedByPageSize.insert(
elem);
824 fColumnsSortedByPageSize.insert(
elem);
831 :
RPageStorage(
name), fOptions(options.Clone()), fWritePageMemoryManager(options.GetPageBufferBudget())
844 unsigned char *
pageBuf =
reinterpret_cast<unsigned char *
>(config.
fPage->GetBuffer());
849 if (!config.
fElement->IsMappable()) {
878 const auto nBytes =
page.GetNBytes() + GetWriteOptions().GetEnablePageChecksums() * kNBytesPageChecksum;
879 if (fSealPageBuffer.size() <
nBytes)
880 fSealPageBuffer.resize(
nBytes);
886 config.
fWriteChecksum = GetWriteOptions().GetEnablePageChecksums();
888 config.
fBuffer = fSealPageBuffer.data();
890 return SealPage(config);
895 for (
const auto &
cb : fOnDatasetCommitCallbacks)
897 return CommitDatasetImpl();
912std::unique_ptr<ROOT::Internal::RPageSink>
919 if (location.empty()) {
922 if (location.find(
"daos://") == 0) {
924 return std::make_unique<ROOT::Experimental::Internal::RPageSinkDaos>(
ntupleName, location, options);
932 return std::make_unique<ROOT::Experimental::Internal::RPageSinkS3>(
ntupleName, location, options);
934 throw RException(
R__FAIL(
"This RNTuple build does not support S3. Rebuild ROOT with the 'curl' "
935 "cmake option enabled (-Dcurl=ON) to enable the S3 backend."));
940 return std::make_unique<ROOT::Internal::RPageSinkFile>(
ntupleName, location, options);
954 auto columnId = fDescriptorBuilder.GetDescriptor().GetNPhysicalColumns();
969 fDescriptorBuilder.AddColumn(
columnBuilder.MakeDescriptor().Unwrap());
976 if (fIsInitialized) {
984 const auto &descriptor = fDescriptorBuilder.GetDescriptor();
986 if (descriptor.GetNLogicalColumns() > descriptor.GetNPhysicalColumns()) {
990 const auto &
reps =
f.GetColumnRepresentatives();
993 return reps.size() *
reps[0].size();
1005 auto fieldId = descriptor.GetNFields();
1007 fDescriptorBuilder.AddFieldLink(
f.GetParent()->GetOnDiskId(),
fieldId);
1012 auto fieldId = descriptor.GetNFields();
1016 fDescriptorBuilder.AddFieldLink(
f.GetParent()->GetOnDiskId(),
fieldId);
1020 auto targetId = descriptor.GetNLogicalColumns();
1023 .PhysicalColumnId(
source.GetLogicalId())
1025 .BitsOnStorage(
source.GetBitsOnStorage())
1026 .ValueRange(
source.GetValueRange())
1028 .Index(
source.GetIndex())
1029 .RepresentationIndex(
source.GetRepresentationIndex());
1030 fDescriptorBuilder.AddColumn(
columnBuilder.MakeDescriptor().Unwrap());
1041 for (
auto f :
changeset.fAddedProjectedFields) {
1047 const auto nColumns = descriptor.GetNPhysicalColumns();
1056 columnRange.SetFirstElementIndex(descriptor.GetColumnDescriptor(i).GetFirstElementIndex());
1058 columnRange.SetCompressionSettings(GetWriteOptions().GetCompression());
1062 fOpenPageRanges.emplace_back(std::move(
pageRange));
1067 if (fSerializationContext.GetHeaderSize() > 0)
1068 fSerializationContext.MapSchema(descriptor,
true);
1074 throw RException(
R__FAIL(
"ROOT bug: unexpected type extra info in UpdateExtraTypeInfo()"));
1081 fDescriptorBuilder.SetNTuple(fNTupleName, model.
GetDescription());
1082 fDescriptorBuilder.SetVersionForWriting();
1083 const auto &descriptor = fDescriptorBuilder.GetDescriptor();
1093 for (
auto f :
fieldZero.GetMutableSubfields())
1103 InitImpl(buffer.get(), fSerializationContext.GetHeaderSize());
1105 fDescriptorBuilder.BeginHeaderExtension();
1108std::unique_ptr<ROOT::RNTupleModel>
1113 fDescriptorBuilder.SetVersionForWriting();
1114 const auto &descriptor = fDescriptorBuilder.GetDescriptor();
1117 const auto nColumns = descriptor.GetNPhysicalColumns();
1118 R__ASSERT(fOpenColumnRanges.empty() && fOpenPageRanges.empty());
1119 fOpenColumnRanges.reserve(
nColumns);
1122 const auto &column = descriptor.GetColumnDescriptor(i);
1125 columnRange.SetFirstElementIndex(column.GetFirstElementIndex());
1127 columnRange.SetCompressionSettings(GetWriteOptions().GetCompression());
1131 fOpenPageRanges.emplace_back(std::move(
pageRange));
1140 for (
unsigned int i = 0; i < fOpenColumnRanges.size(); ++i) {
1141 R__ASSERT(fOpenColumnRanges[i].GetPhysicalColumnId() == i);
1142 if (!
cluster.ContainsColumn(i))
1147 fOpenColumnRanges[i].IncrementFirstElementIndex(
columnRange.GetNElements());
1149 fDescriptorBuilder.AddCluster(
cluster.Clone());
1158 modelOpts.SetReconstructProjections(
true);
1161 auto model = descriptor.CreateModel(
modelOpts);
1164 projectedFields.GetFieldZero().SetOnDiskId(model->GetConstFieldZero().GetOnDiskId());
1171 InitImpl(buffer.get(), fSerializationContext.GetHeaderSize());
1173 fDescriptorBuilder.BeginHeaderExtension();
1176 fIsInitialized =
true;
1186 const auto &descriptor = fDescriptorBuilder.GetDescriptor();
1194 const std::size_t
firstPhysicalIndex = fDescriptorBuilder.GetDescriptor().GetNPhysicalColumns();
1195 const std::uint16_t
reprIndex =
field.GetLogicalColumnIds().size() /
field.GetColumnCardinality();
1219 .FieldId(
field.GetId())
1228 fDescriptorBuilder.AddColumn(
columnBuilder.MakeDescriptor().Unwrap());
1246 columnRange.SetCompressionSettings(GetWriteOptions().GetCompression());
1251 fOpenPageRanges.emplace_back(std::move(
pageRange));
1253 fSerializationContext.MapPhysicalColumnId(
columnId);
1258 fDescriptorBuilder.EnsureValidDescriptor().ThrowOnError();
1271 const auto columnId = fDescriptorBuilder.GetDescriptor().GetNLogicalColumns();
1275 .FieldId(
field.GetId())
1281 .RepresentationIndex(
pointedColumn.GetRepresentationIndex());
1282 fDescriptorBuilder.AddColumn(
columnBuilder.MakeDescriptor().Unwrap());
1284 fDescriptorBuilder.EnsureValidDescriptor().ThrowOnError();
1289 fOpenColumnRanges.at(
columnHandle.fPhysicalId).SetIsSuppressed(
true);
1294 fOpenColumnRanges.at(
columnHandle.fPhysicalId).IncrementNElements(
page.GetNElements());
1299 RNTupleAtomicTimer
timer(fCounters->fTimeWallZip, fCounters->fTimeCpuZip);
1302 fCounters->fSzZip.Add(
page.GetNBytes());
1307 pageInfo.SetHasChecksum(GetWriteOptions().GetEnablePageChecksums());
1323std::vector<ROOT::RNTupleLocator>
1325 const std::vector<bool> &
mask)
1327 std::vector<ROOT::RNTupleLocator>
locators;
1330 for (
auto &
range : ranges) {
1348 std::vector<bool>
mask;
1352 std::unordered_map<std::uint64_t, RSealedPageLink>
originalPages;
1354 for (
auto &
range : ranges) {
1360 if (!fFeatures.fCanMergePages || !fOptions->GetEnableSamePageMerging()) {
1361 mask.emplace_back(
true);
1372 mask.emplace_back(
true);
1377 const auto *
p =
itr->second.fSealedPage;
1380 mask.emplace_back(
true);
1385 mask.emplace_back(
false);
1389 mask.shrink_to_fit();
1396 for (
auto &
range : ranges) {
1398 fOpenColumnRanges.at(
range.fPhysicalColumnId).IncrementNElements(
sealedPageIt->GetNElements());
1404 fOpenPageRanges.at(
range.fPhysicalColumnId).GetPageInfos().emplace_back(
pageInfo);
1416 for (
unsigned int i = 0; i < fOpenColumnRanges.size(); ++i) {
1418 columnInfo.fCompressionSettings = fOpenColumnRanges[i].GetCompressionSettings().value();
1419 if (fOpenColumnRanges[i].IsSuppressed()) {
1420 assert(fOpenPageRanges[i].GetPageInfos().empty());
1421 columnInfo.fPageRange.SetPhysicalColumnId(i);
1424 fOpenColumnRanges[i].SetNElements(0);
1425 fOpenColumnRanges[i].SetIsSuppressed(
false);
1427 std::swap(
columnInfo.fPageRange, fOpenPageRanges[i]);
1428 fOpenPageRanges[i].SetPhysicalColumnId(i);
1430 columnInfo.fNElements = fOpenColumnRanges[i].GetNElements();
1431 fOpenColumnRanges[i].SetNElements(0);
1443 clusterBuilder.ClusterId(fDescriptorBuilder.GetDescriptor().GetNActiveClusters())
1444 .FirstEntryIndex(fPrevClusterNEntries)
1454 fOpenColumnRanges[
colId].IncrementFirstElementIndex(
columnInfo.fNElements);
1458 clusterBuilder.CommitSuppressedColumnRanges(fDescriptorBuilder.GetDescriptor()).ThrowOnError();
1471 fDescriptorBuilder.AddCluster(
clusterBuilder.MoveDescriptor().Unwrap());
1472 fPrevClusterNEntries +=
cluster.fNEntries;
1478 const auto &descriptor = fDescriptorBuilder.GetDescriptor();
1480 const auto nClusters = descriptor.GetNActiveClusters();
1483 for (
auto i = fNextClusterInGroup; i <
nClusters; ++i) {
1484 physClusterIDs.emplace_back(fSerializationContext.MapClusterId(i));
1497 cgBuilder.MinEntry(0).EntrySpan(0).NClusters(0);
1499 const auto &
firstClusterDesc = descriptor.GetClusterDescriptor(fNextClusterInGroup);
1504 .NClusters(
nClusters - fNextClusterInGroup);
1506 std::vector<ROOT::DescriptorId_t>
clusterIds;
1508 for (
auto i = fNextClusterInGroup; i <
nClusters; ++i) {
1512 fDescriptorBuilder.AddClusterGroup(
cgBuilder.MoveDescriptor().Unwrap());
1530 fDescriptorBuilder.AddAttributeSet(std::move(
attrSetDesc)).ThrowOnError();
1535 if (!fInfosOfStreamerFields.empty()) {
1538 for (
const auto &
etDesc : fDescriptorBuilder.GetDescriptor().GetExtraTypeInfoIterable()) {
1545 fInfosOfStreamerFields.merge(
etInfo);
1552 fDescriptorBuilder.ReplaceExtraTypeInfo(
extraInfoBuilder.MoveDescriptor().Unwrap());
1555 const auto &descriptor = fDescriptorBuilder.GetDescriptor();
1567 fCounters = std::make_unique<RCounters>(
RCounters{
1568 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"nPageCommitted",
"",
"number of pages committed to storage"),
1569 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"szWritePayload",
"B",
"volume written for committed pages"),
1571 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"timeWallWrite",
"ns",
"wall clock time spent writing"),
1572 *fMetrics.MakeCounter<
RNTupleAtomicCounter *>(
"timeWallZip",
"ns",
"wall clock time spent compressing"),
1575 "CPU time spent compressing")});
#define R__FORWARD_ERROR(res)
Short-hand to return an RResult<T> in an error state (i.e. after checking)
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
#define R__ASSERT(e)
Checks condition e and reports a fatal error if it's false.
winID h TVirtualViewer3D TVirtualGLPainter p
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 mask
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 mode
A thread-safe integral performance counter.
A metric element that computes its floating point value from other counters.
A collection of Counter objects with a name, a unit, and a description.
A helper class for piece-wise construction of an RClusterDescriptor.
A helper class for piece-wise construction of an RClusterGroupDescriptor.
An in-memory subset of the packed and compressed pages of a cluster.
std::unordered_set< ROOT::DescriptorId_t > ColumnSet_t
A helper class for piece-wise construction of an RColumnDescriptor.
A column element encapsulates the translation between basic C++ types and their column representation...
static std::pair< std::uint16_t, std::uint16_t > GetValidBitRange(ROOT::ENTupleColumnType type)
Most types have a fixed on-disk bit width.
virtual RIdentifier GetIdentifier() const =0
A column is a storage-backed array of a simple, fixed-size type, from which pages can be mapped into ...
std::optional< std::pair< double, double > > GetValueRange() const
std::uint16_t GetRepresentationIndex() const
ROOT::Internal::RColumnElementBase * GetElement() const
ROOT::ENTupleColumnType GetType() const
ROOT::NTupleSize_t GetFirstElementIndex() const
std::size_t GetWritePageCapacity() const
std::uint16_t GetBitsOnStorage() const
std::uint32_t GetIndex() const
A helper class for piece-wise construction of an RFieldDescriptor.
static RFieldDescriptorBuilder FromField(const ROOT::RFieldBase &field)
Make a new RFieldDescriptorBuilder based off a live RNTuple field.
static std::size_t Zip(const void *from, std::size_t nbytes, int compression, void *to)
Returns the size of the compressed data, written into the provided output buffer.
static void Unzip(const void *from, size_t nbytes, size_t dataLen, void *to)
The nbytes parameter provides the size ls of the from buffer.
static unsigned int GetClusterBunchSize(const RNTupleReadOptions &options)
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< void > DeserializePageList(const void *buffer, std::uint64_t bufSize, ROOT::DescriptorId_t clusterGroupId, RNTupleDescriptor &desc, EDescriptorDeserializeMode mode)
static RResult< StreamerInfoMap_t > DeserializeStreamerInfos(const std::string &extraTypeInfoContent)
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.
EDescriptorDeserializeMode
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 > SerializeFooter(void *buffer, const RNTupleDescriptor &desc, const RContext &context)
static std::uint32_t DeserializeUInt64(const void *buffer, std::uint64_t &val)
static RResult< RContext > SerializeHeader(void *buffer, const RNTupleDescriptor &desc)
static std::string SerializeStreamerInfos(const StreamerInfoMap_t &infos)
A memory region that contains packed and compressed pages.
A page as being stored on disk, that is packed and compressed.
Uses standard C++ memory allocation for the column data pages.
Abstract interface to allocate and release pages.
RStagedCluster StageCluster(ROOT::NTupleSize_t nNewEntries) final
Stage the current cluster and create a new one for the following data.
void UpdateSchema(const ROOT::Internal::RNTupleModelChangeset &changeset, ROOT::NTupleSize_t firstEntry) override
Incorporate incremental changes to the model into the ntuple descriptor.
void CommitSealedPage(ROOT::DescriptorId_t physicalColumnId, const RPageStorage::RSealedPage &sealedPage) final
Write a preprocessed page to storage. The column must have been added before.
std::unique_ptr< RNTupleModel > InitFromDescriptor(const ROOT::RNTupleDescriptor &descriptor, bool copyClusters)
Initialize sink based on an existing descriptor and fill into the descriptor builder,...
void UpdateExtraTypeInfo(const ROOT::RExtraTypeInfoDescriptor &extraTypeInfo) final
Adds an extra type information record to schema.
void CommitAttributeSet(std::string_view attrSetName, const RNTupleLink &attrAnchorInfo) final
Adds the given anchor information (name + locator) into the main RNTuple's descriptor as an attribute...
ColumnHandle_t AddColumn(ROOT::DescriptorId_t fieldId, ROOT::Internal::RColumn &column) final
Register a new column.
virtual std::vector< RNTupleLocator > CommitSealedPageVImpl(std::span< RPageStorage::RSealedPageGroup > ranges, const std::vector< bool > &mask)
Vector commit of preprocessed pages.
RPagePersistentSink(std::string_view ntupleName, const ROOT::RNTupleWriteOptions &options)
void CommitSuppressedColumn(ColumnHandle_t columnHandle) final
Commits a suppressed column for the current cluster.
void AddAliasColumn(const ROOT::RNTupleDescriptor &desc, const ROOT::RFieldDescriptor &field, ROOT::DescriptorId_t physicalId)
Adds a new alias column pointing to an existing column with the given physical id to the given field.
void CommitStagedClusters(std::span< RStagedCluster > clusters) final
Commit staged clusters, logically appending them to the ntuple descriptor.
static std::unique_ptr< RPageSink > Create(std::string_view ntupleName, std::string_view location, const ROOT::RNTupleWriteOptions &options=ROOT::RNTupleWriteOptions())
Guess the concrete derived page source from the location.
void CommitPage(ColumnHandle_t columnHandle, const ROOT::Internal::RPage &page) final
Write a page to the storage. The column must have been added before.
RNTupleLink CommitDatasetImpl() final
~RPagePersistentSink() override
virtual void InitImpl(unsigned char *serializedHeader, std::uint32_t length)=0
void CommitClusterGroup() final
Write out the page locations (page list envelope) for all the committed clusters since the last call ...
void CommitSealedPageV(std::span< RPageStorage::RSealedPageGroup > ranges) final
Write a vector of preprocessed pages to storage. The corresponding columns must have been added befor...
void EnableDefaultMetrics(const std::string &prefix)
Enables the default set of metrics provided by RPageSink.
ROOT::DescriptorId_t AddColumnRepresentation(const ROOT::RFieldDescriptor &field, std::span< const ROOT::Internal::RColumnFormat > newRepresentation, std::uint64_t clusterOffset)
Adds a new column representation to the given field.
Abstract interface to write data into an ntuple.
RNTupleLink CommitDataset()
Run the registered callbacks and finalize the current cluster and the entrire data set.
virtual ROOT::Internal::RPage ReservePage(ColumnHandle_t columnHandle, std::size_t nElements)
Get a new, empty page for the given column that can be filled with up to nElements; nElements must be...
RSealedPage SealPage(const ROOT::Internal::RPage &page, const ROOT::Internal::RColumnElementBase &element)
Helper for streaming a page.
RPageSink(std::string_view ntupleName, const ROOT::RNTupleWriteOptions &options)
void Insert(ROOT::DescriptorId_t physicalColumnId, ROOT::Internal::RColumnElementBase::RIdentifier elementId)
ROOT::Internal::RCluster::ColumnSet_t ToColumnSet() const
void Erase(ROOT::DescriptorId_t physicalColumnId, ROOT::Internal::RColumnElementBase::RIdentifier elementId)
void LoadStructure()
Loads header and footer without decompressing or deserializing them.
virtual ROOT::Internal::RPageRef LoadPage(ColumnHandle_t columnHandle, ROOT::NTupleSize_t globalIndex)
Allocates and fills a page that contains the index-th element.
void RegisterStreamerInfos()
Builds the streamer info records from the descriptor's extra type info section.
void Attach(ROOT::Internal::RNTupleSerializer::EDescriptorDeserializeMode mode=ROOT::Internal::RNTupleSerializer::EDescriptorDeserializeMode::kForReading)
Open the physical storage container and deserialize header and footer.
ColumnHandle_t AddColumn(ROOT::DescriptorId_t fieldId, ROOT::Internal::RColumn &column) override
Register a new column.
void UnzipCluster(ROOT::Internal::RCluster *cluster)
Parallel decompression and unpacking of the pages in the given cluster.
void EnableDefaultMetrics(const std::string &prefix)
Enables the default set of metrics provided by RPageSource.
ROOT::NTupleSize_t GetNEntries()
ROOT::Internal::RPageRef LoadZeroPage(ColumnHandle_t columnHandle, const RPageSummary &pageSummary)
void UpdateLastUsedCluster(ROOT::DescriptorId_t clusterId)
Does nothing if fLastUsedCluster == clusterId.
ROOT::NTupleSize_t GetNElements(ColumnHandle_t columnHandle)
ROOT::Internal::RPageRef LoadPageFromSummary(ColumnHandle_t columnHandle, const RPageSummary &pageSummary)
void DropColumn(ColumnHandle_t columnHandle) override
Unregisters a column.
void LoadSealedPage(ROOT::DescriptorId_t physicalColumnId, RNTupleLocalIndex localIndex, RSealedPage &sealedPage)
Read the packed and compressed bytes of a page into the memory buffer provided by sealedPage.
virtual void UnzipClusterImpl(ROOT::Internal::RCluster *cluster)
RPageSource(std::string_view ntupleName, const ROOT::RNTupleReadOptions &fOptions)
void PrepareLoadCluster(const ROOT::Internal::RCluster::RKey &clusterKey, ROOT::Internal::ROnDiskPageMap &pageZeroMap, const std::function< void(ROOT::DescriptorId_t, ROOT::NTupleSize_t, const ROOT::RClusterDescriptor::RPageInfo &)> &perPageFunc)
Prepare a page range read for the column set in clusterKey.
void SetEntryRange(const REntryRange &range)
Promise to only read from the given entry range.
std::unique_ptr< RPageSource > Clone() const
Open the same storage multiple time, e.g.
static std::unique_ptr< RPageSource > Create(std::string_view ntupleName, std::string_view location, const ROOT::RNTupleReadOptions &options=ROOT::RNTupleReadOptions())
Guess the concrete derived page source from the file name (location)
static RResult< ROOT::Internal::RPage > UnsealPage(const RSealedPage &sealedPage, const ROOT::Internal::RColumnElementBase &element, ROOT::Internal::RPageAllocator &pageAlloc)
Helper for unstreaming a page.
Common functionality of an ntuple storage for both reading and writing.
RPageStorage(std::string_view name)
Stores information about the cluster in which this page resides.
A page is a slice of a column that is mapped into memory.
static const void * GetPageZeroBuffer()
Return a pointer to the page zero buffer used if there is no on-disk data for a particular deferred c...
const ROOT::RFieldBase * GetSourceField(const ROOT::RFieldBase *target) const
bool TryEvict(std::size_t targetAvailableSize, std::size_t pageSizeLimit)
Flush columns in order of allocated write page size until the sum of all write page allocations leave...
bool TryUpdate(ROOT::Internal::RColumn &column, std::size_t newWritePageSize)
Try to register the new write page size for the given column.
The window of element indexes of a particular column in a particular cluster.
Metadata for RNTuple clusters.
Base class for all ROOT issued exceptions.
A field translates read and write calls from/to underlying columns to/from tree values.
Metadata stored for every field of an RNTuple.
ROOT::ENTupleStructure GetStructure() const
ROOT::DescriptorId_t GetParentId() const
The on-storage metadata of an RNTuple.
const RColumnDescriptor & GetColumnDescriptor(ROOT::DescriptorId_t columnId) const
@ kFeatureFlag_NestedDeferredColumns
Signals that the RNTuple contains at least one deferred column that is part of a collection and was e...
Addresses a column element or field item relative to a particular cluster, instead of a global NTuple...
The RNTupleModel encapulates the schema of an RNTuple.
const std::string & GetDescription() const
Common user-tunable settings for reading RNTuples.
Common user-tunable settings for storing RNTuples.
const_iterator begin() const
const_iterator end() const
void ThrowOnError()
Short-hand method to throw an exception in the case of errors.
The class is used as a return type for operations that can fail; wraps a value of type T or an RError...
ROOT::RFieldZero & GetFieldZeroOfModel(RNTupleModel &model)
RResult< void > EnsureValidNameForRNTuple(std::string_view name, std::string_view where)
Check whether a given string is a valid name according to the RNTuple specification.
RProjectedFields & GetProjectedFieldsOfModel(RNTupleModel &model)
std::unique_ptr< RColumnElementBase > GenerateColumnElement(std::type_index inMemoryType, ROOT::ENTupleColumnType onDiskType)
void CallConnectPageSinkOnField(RFieldBase &, ROOT::Internal::RPageSink &, ROOT::NTupleSize_t firstEntry=0)
std::uint64_t DescriptorId_t
Distriniguishes elements of the same type within a descriptor, e.g. different fields.
constexpr NTupleSize_t kInvalidNTupleIndex
bool StartsWith(std::string_view string, std::string_view prefix)
std::uint64_t NTupleSize_t
Integer type long enough to hold the maximum number of entries in a column.
constexpr DescriptorId_t kInvalidDescriptorId
The identifiers that specifies the content of a (partial) cluster.
Every concrete RColumnElement type is identified by its on-disk type (column type) and the in-memory ...
The incremental changes to a RNTupleModel
On-disk pages within a page source are identified by the column and page number.
Default I/O performance counters that get registered in fMetrics.
Parameters for the SealPage() method.
bool fWriteChecksum
Adds a 8 byte little-endian xxhash3 checksum to the page payload.
std::uint32_t fCompressionSettings
Compression algorithm and level to apply.
void * fBuffer
Location for sealed output. The memory buffer has to be large enough.
const ROOT::Internal::RPage * fPage
Input page to be sealed.
bool fAllowAlias
If false, the output buffer must not point to the input page buffer, which would otherwise be an opti...
const ROOT::Internal::RColumnElementBase * fElement
Corresponds to the page's elements, for size calculation etc.
Cluster that was staged, but not yet logically appended to the RNTuple.
Default I/O performance counters that get registered in fMetrics
Used in SetEntryRange / GetEntryRange.
bool IntersectsWith(const ROOT::RClusterDescriptor &clusterDesc) const
Returns true if the given cluster has entries within the entry range.
Summarizes meta-data necessary to load a certain page. Used by LoadPageFromSummary().
A sealed page contains the bytes of a page as written to storage (packed & compressed).
RResult< void > VerifyChecksumIfEnabled() const
RResult< std::uint64_t > GetChecksum() const
Returns a failure if the sealed page has no checksum.
ROOT::Internal::RColumn * fColumn
bool operator>(const RColumnInfo &other) const
Information about a single page in the context of a cluster's page range.
Modifiers passed to CreateModel()