Storage provider that reads ntuple pages from a file.

Definition at line 110 of file RPageStorageFile.hxx.

Classes
struct	RStructureBuffer
	Holds the uncompressed header and footer. More...

Public Member Functions
	RPageSourceFile (const RPageSourceFile &)=delete

	RPageSourceFile (RPageSourceFile &&)=delete

	RPageSourceFile (std::string_view ntupleName, std::string_view path, const ROOT::RNTupleReadOptions &options)

	RPageSourceFile (std::string_view ntupleName, std::unique_ptr< RRawFile > file, const ROOT::RNTupleReadOptions &options)

	~RPageSourceFile () override

std::vector< std::unique_ptr< ROOT::Internal::RCluster > >	LoadClusters (std::span< ROOT::Internal::RCluster::RKey > clusterKeys) final
	Populates all the pages of the given cluster ids and columns; it is possible that some columns do not contain any pages.

void	LoadSealedPage (ROOT::DescriptorId_t physicalColumnId, RNTupleLocalIndex localIndex, RSealedPage &sealedPage) final
	Read the packed and compressed bytes of a page into the memory buffer provided by `sealedPage`.

RPageSourceFile &	operator= (const RPageSourceFile &)=delete

RPageSourceFile &	operator= (RPageSourceFile &&)=delete

Public Member Functions inherited from ROOT::Internal::RPageSource
	RPageSource (const RPageSource &)=delete

	RPageSource (RPageSource &&)=delete

	RPageSource (std::string_view ntupleName, const ROOT::RNTupleReadOptions &fOptions)

	~RPageSource () override

ColumnHandle_t	AddColumn (ROOT::DescriptorId_t fieldId, ROOT::Internal::RColumn &column) override
	Register a new column.

void	Attach (ROOT::Internal::RNTupleSerializer::EDescriptorDeserializeMode mode=ROOT::Internal::RNTupleSerializer::EDescriptorDeserializeMode::kForReading)
	Open the physical storage container and deserialize header and footer.

std::unique_ptr< RPageSource >	Clone () const
	Open the same storage multiple time, e.g.

void	DropColumn (ColumnHandle_t columnHandle) override
	Unregisters a column.

REntryRange	GetEntryRange () const

ROOT::NTupleSize_t	GetNElements (ColumnHandle_t columnHandle)

ROOT::NTupleSize_t	GetNEntries ()

const ROOT::RNTupleReadOptions &	GetReadOptions () const

const RSharedDescriptorGuard	GetSharedDescriptorGuard () const
	Takes the read lock for the descriptor.

EPageStorageType	GetType () final
	Whether the concrete implementation is a sink or a source.

virtual ROOT::Internal::RPageRef	LoadPage (ColumnHandle_t columnHandle, RNTupleLocalIndex localIndex)
	Another version of `LoadPage` that allows to specify cluster-relative indexes.

virtual ROOT::Internal::RPageRef	LoadPage (ColumnHandle_t columnHandle, ROOT::NTupleSize_t globalIndex)
	Allocates and fills a page that contains the index-th element.

void	LoadStructure ()
	Loads header and footer without decompressing or deserializing them.

RPageSource &	operator= (const RPageSource &)=delete

RPageSource &	operator= (RPageSource &&)=delete

void	RegisterStreamerInfos ()
	Builds the streamer info records from the descriptor's extra type info section.

void	SetEntryRange (const REntryRange &range)
	Promise to only read from the given entry range.

RResult< ROOT::Internal::RPage >	UnsealPage (const RSealedPage &sealedPage, const ROOT::Internal::RColumnElementBase &element)

void	UnzipCluster (ROOT::Internal::RCluster *cluster)
	Parallel decompression and unpacking of the pages in the given cluster.

Public Member Functions inherited from ROOT::Internal::RPageStorage
	RPageStorage (const RPageStorage &other)=delete

	RPageStorage (RPageStorage &&other)=default

	RPageStorage (std::string_view name)

virtual	~RPageStorage ()

ROOT::DescriptorId_t	GetColumnId (ColumnHandle_t columnHandle) const

virtual ROOT::Experimental::Detail::RNTupleMetrics &	GetMetrics ()
	Returns the default metrics object.

const std::string &	GetNTupleName () const
	Returns the NTuple name.

RPageStorage &	operator= (const RPageStorage &other)=delete

RPageStorage &	operator= (RPageStorage &&other)=default

void	SetTaskScheduler (RTaskScheduler *taskScheduler)

Static Public Member Functions
static std::unique_ptr< RPageSourceFile >	CreateFromAnchor (const RNTuple &anchor, const ROOT::RNTupleReadOptions &options=ROOT::RNTupleReadOptions())
	Used from the RNTuple class to build a datasource if the anchor is already available.

Static Public Member Functions inherited from ROOT::Internal::RPageSource
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.

Protected Member Functions
ROOT::RNTupleDescriptor	AttachImpl (RNTupleSerializer::EDescriptorDeserializeMode mode) final
	`LoadStructureImpl()` has been called before `AttachImpl()` is called

std::unique_ptr< RPageSource >	CloneImpl () const final
	The cloned page source creates a new raw file and reader and opens its own file descriptor to the data.

RPageRef	LoadPageImpl (ColumnHandle_t columnHandle, const RClusterInfo &clusterInfo, ROOT::NTupleSize_t idxInCluster) final

void	LoadStructureImpl () final

Protected Member Functions inherited from ROOT::Internal::RPageSource
void	EnableDefaultMetrics (const std::string &prefix)
	Enables the default set of metrics provided by RPageSource.

RExclDescriptorGuard	GetExclDescriptorGuard ()
	Note that the underlying lock is not recursive. See `GetSharedDescriptorGuard()` for further information.

void	PrepareLoadCluster (const ROOT::Internal::RCluster::RKey &clusterKey, ROOT::Internal::ROnDiskPageMap &pageZeroMap, 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`.

virtual void	UnzipClusterImpl (ROOT::Internal::RCluster *cluster)

Protected Member Functions inherited from ROOT::Internal::RPageStorage
void	WaitForAllTasks ()

Private Member Functions
	RPageSourceFile (std::string_view ntupleName, const ROOT::RNTupleReadOptions &options)

std::unique_ptr< ROOT::Internal::RCluster >	PrepareSingleCluster (const ROOT::Internal::RCluster::RKey &clusterKey, std::vector< RRawFile::RIOVec > &readRequests)
	Helper function for LoadClusters: it prepares the memory buffer (page map) and the read requests for a given cluster and columns.

Private Attributes
std::optional< RNTuple >	fAnchor
	Either provided by CreateFromAnchor, or read from the ROOT file given the ntuple name.

std::unique_ptr< ROOT::Internal::RClusterPool >	fClusterPool
	The cluster pool asynchronously preloads the next few clusters.

ROOT::Internal::RCluster *	fCurrentCluster = nullptr
	The last cluster from which a page got loaded. Points into fClusterPool->fPool.

RNTupleDescriptorBuilder	fDescriptorBuilder
	The descriptor is created from the header and footer either in AttachImpl or in CreateFromAnchor.

std::unique_ptr< RRawFile >	fFile
	An RRawFile is used to request the necessary byte ranges from a local or a remote file.

ROOT::Internal::RMiniFileReader	fReader
	Takes the fFile to read ntuple blobs from it.

RStructureBuffer	fStructureBuffer
	Populated by LoadStructureImpl(), reset at the end of Attach()

Friends
class	ROOT::RNTuple

Additional Inherited Members
Public Types inherited from ROOT::Internal::RPageStorage
using	ColumnHandle_t = RColumnHandle
	The column handle identifies a column with the current open page storage.

using	SealedPageSequence_t = std::deque<RSealedPage>

Static Public Attributes inherited from ROOT::Internal::RPageStorage
static constexpr std::size_t	kNBytesPageChecksum = sizeof(std::uint64_t)
	The page checksum is a 64bit xxhash3.

Protected Attributes inherited from ROOT::Internal::RPageSource
RActivePhysicalColumns	fActivePhysicalColumns
	The active columns are implicitly defined by the model fields or views.

std::unique_ptr< RCounters >	fCounters

ROOT::RNTupleReadOptions	fOptions

ROOT::Internal::RPagePool	fPagePool
	Pages that are unzipped with IMT are staged into the page pool.

Protected Attributes inherited from ROOT::Internal::RPageStorage
ROOT::Experimental::Detail::RNTupleMetrics	fMetrics

std::string	fNTupleName

std::unique_ptr< ROOT::Internal::RPageAllocator >	fPageAllocator
	For the time being, we will use the heap allocator for all sources and sinks. This may change in the future.

RTaskScheduler *	fTaskScheduler = nullptr

#include <ROOT/RPageStorageFile.hxx>

Inheritance diagram for ROOT::Internal::RPageSourceFile:

[legend]

Constructor & Destructor Documentation

◆ RPageSourceFile() [1/5]

ROOT::Internal::RPageSourceFile::RPageSourceFile	(	std::string_view	ntupleName,
		const ROOT::RNTupleReadOptions &	options )

private

Definition at line 256 of file RPageStorageFile.cxx.

◆ RPageSourceFile() [2/5]

ROOT::Internal::RPageSourceFile::RPageSourceFile	(	std::string_view	ntupleName,
		std::string_view	path,
		const ROOT::RNTupleReadOptions &	options )

Definition at line 274 of file RPageStorageFile.cxx.

◆ RPageSourceFile() [3/5]

ROOT::Internal::RPageSourceFile::RPageSourceFile	(	std::string_view	ntupleName,
		std::unique_ptr< RRawFile >	file,
		const ROOT::RNTupleReadOptions &	options )

Definition at line 264 of file RPageStorageFile.cxx.

◆ RPageSourceFile() [4/5]

ROOT::Internal::RPageSourceFile::RPageSourceFile ( const RPageSourceFile & )

delete

◆ RPageSourceFile() [5/5]

ROOT::Internal::RPageSourceFile::RPageSourceFile ( RPageSourceFile && )

delete

◆ ~RPageSourceFile()

ROOT::Internal::RPageSourceFile::~RPageSourceFile ( )

overridedefault

Member Function Documentation

◆ AttachImpl()

ROOT::RNTupleDescriptor ROOT::Internal::RPageSourceFile::AttachImpl ( RNTupleSerializer::EDescriptorDeserializeMode mode )

finalprotectedvirtual

LoadStructureImpl() has been called before AttachImpl() is called

Implements ROOT::Internal::RPageSource.

Definition at line 354 of file RPageStorageFile.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::Internal::RPageSource > ROOT::Internal::RPageSourceFile::CloneImpl ( ) const

finalprotectedvirtual

The cloned page source creates a new raw file and reader and opens its own file descriptor to the data.

Implements ROOT::Internal::RPageSource.

Definition at line 483 of file RPageStorageFile.cxx.

◆ CreateFromAnchor()

std::unique_ptr< ROOT::Internal::RPageSourceFile > ROOT::Internal::RPageSourceFile::CreateFromAnchor	(	const RNTuple &	anchor,
		const ROOT::RNTupleReadOptions &	options = ROOT::RNTupleReadOptions() )

static

Used from the RNTuple class to build a datasource if the anchor is already available.

Requires the RNTuple object to be streamed from a file.

Definition at line 281 of file RPageStorageFile.cxx.

◆ LoadClusters()

std::vector< std::unique_ptr< ROOT::Internal::RCluster > > ROOT::Internal::RPageSourceFile::LoadClusters ( std::span< ROOT::Internal::RCluster::RKey > clusterKeys )

finalvirtual

Populates all the pages of the given cluster ids and columns; it is possible that some columns do not contain any pages.

The page source may load more columns than the minimal necessary set from columns. To indicate which columns have been loaded, LoadClusters()must mark them withSetColumnAvailable(). That includes the ones from thecolumnsthat don't have pages; otherwise subsequent requests for the cluster would assume an incomplete cluster and trigger loading again. LoadClusters()` is typically called from the I/O thread of a cluster pool, i.e. the method runs concurrently to other methods of the page source.

Implements ROOT::Internal::RPageSource.

Definition at line 618 of file RPageStorageFile.cxx.

◆ LoadPageImpl()

ROOT::Internal::RPageRef ROOT::Internal::RPageSourceFile::LoadPageImpl	(	ColumnHandle_t	columnHandle,
		const RClusterInfo &	clusterInfo,
		ROOT::NTupleSize_t	idxInCluster )

finalprotectedvirtual

Implements ROOT::Internal::RPageSource.

Definition at line 416 of file RPageStorageFile.cxx.

◆ LoadSealedPage()

void ROOT::Internal::RPageSourceFile::LoadSealedPage	(	ROOT::DescriptorId_t	physicalColumnId,
		RNTupleLocalIndex	localIndex,
		RSealedPage &	sealedPage )

finalvirtual

Read the packed and compressed bytes of a page into the memory buffer provided by sealedPage.

The sealed page can be used subsequently in a call to RPageSink::CommitSealedPage. The fSize and fNElements member of the sealedPage parameters are always set. If sealedPage.fBuffer is nullptr, no data will be copied but the returned size information can be used by the caller to allocate a large enough buffer and call LoadSealedPage again.

Implements ROOT::Internal::RPageSource.

Definition at line 387 of file RPageStorageFile.cxx.

◆ LoadStructureImpl()

void ROOT::Internal::RPageSourceFile::LoadStructureImpl ( )

finalprotectedvirtual

Implements ROOT::Internal::RPageSource.

Definition at line 309 of file RPageStorageFile.cxx.

◆ operator=() [1/2]

RPageSourceFile & ROOT::Internal::RPageSourceFile::operator= ( const RPageSourceFile & )

delete

◆ operator=() [2/2]

RPageSourceFile & ROOT::Internal::RPageSourceFile::operator= ( RPageSourceFile && )

delete

◆ PrepareSingleCluster()

std::unique_ptr< ROOT::Internal::RCluster > ROOT::Internal::RPageSourceFile::PrepareSingleCluster	(	const ROOT::Internal::RCluster::RKey &	clusterKey,
		std::vector< RRawFile::RIOVec > &	readRequests )

private

Helper function for LoadClusters: it prepares the memory buffer (page map) and the read requests for a given cluster and columns.

The reead requests are appended to the provided vector. This way, requests can be collected for multiple clusters before sending them to RRawFile::ReadV().

Definition at line 492 of file RPageStorageFile.cxx.

Friends And Related Symbol Documentation

◆ ROOT::RNTuple

friend class ROOT::RNTuple

friend

Definition at line 111 of file RPageStorageFile.hxx.

Member Data Documentation

◆ fAnchor

std::optional<RNTuple> ROOT::Internal::RPageSourceFile::fAnchor

private

Either provided by CreateFromAnchor, or read from the ROOT file given the ntuple name.

Definition at line 129 of file RPageStorageFile.hxx.

◆ fClusterPool

std::unique_ptr<ROOT::Internal::RClusterPool> ROOT::Internal::RPageSourceFile::fClusterPool

private

The cluster pool asynchronously preloads the next few clusters.

Definition at line 139 of file RPageStorageFile.hxx.

◆ fCurrentCluster

ROOT::Internal::RCluster* ROOT::Internal::RPageSourceFile::fCurrentCluster = nullptr

private

The last cluster from which a page got loaded. Points into fClusterPool->fPool.

Definition at line 131 of file RPageStorageFile.hxx.

◆ fDescriptorBuilder

RNTupleDescriptorBuilder ROOT::Internal::RPageSourceFile::fDescriptorBuilder

private

The descriptor is created from the header and footer either in AttachImpl or in CreateFromAnchor.

Definition at line 137 of file RPageStorageFile.hxx.

◆ fFile

std::unique_ptr<RRawFile> ROOT::Internal::RPageSourceFile::fFile

private

An RRawFile is used to request the necessary byte ranges from a local or a remote file.

Definition at line 133 of file RPageStorageFile.hxx.

◆ fReader

ROOT::Internal::RMiniFileReader ROOT::Internal::RPageSourceFile::fReader

private

Takes the fFile to read ntuple blobs from it.

Definition at line 135 of file RPageStorageFile.hxx.

◆ fStructureBuffer

RStructureBuffer ROOT::Internal::RPageSourceFile::fStructureBuffer

private

Populated by LoadStructureImpl(), reset at the end of Attach()

Definition at line 141 of file RPageStorageFile.hxx.

Libraries for ROOT::Internal::RPageSourceFile:

[legend]

The documentation for this class was generated from the following files:

tree/ntuple/inc/ROOT/RPageStorageFile.hxx
tree/ntuple/src/RPageStorageFile.cxx

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPageSourceFile() [1/5]

◆ RPageSourceFile() [2/5]

◆ RPageSourceFile() [3/5]

◆ RPageSourceFile() [4/5]

◆ RPageSourceFile() [5/5]

◆ ~RPageSourceFile()

Member Function Documentation

◆ AttachImpl()

◆ CloneImpl()

◆ CreateFromAnchor()

◆ LoadClusters()

◆ LoadPageImpl()

◆ LoadSealedPage()

◆ LoadStructureImpl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PrepareSingleCluster()

Friends And Related Symbol Documentation

◆ ROOT::RNTuple

Member Data Documentation

◆ fAnchor

◆ fClusterPool

◆ fCurrentCluster

◆ fDescriptorBuilder

◆ fFile

◆ fReader

◆ fStructureBuffer