Storage provider that reads ntuple pages from a file.

Definition at line 102 of file RPageStorageFile.hxx.

Classes
struct	RClusterInfo
	Summarizes cluster-level information that are necessary to populate a certain page. More...

Public Member Functions
	RPageSourceFile (const RPageSourceFile &)=delete

	RPageSourceFile (RPageSourceFile &&)=delete

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

	~RPageSourceFile () override

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

std::vector< std::unique_ptr< RCluster > >	LoadClusters (std::span< 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 (DescriptorId_t physicalColumnId, const RClusterIndex &clusterIndex, RSealedPage &sealedPage) final
	Read the packed and compressed bytes of a page into the memory buffer provided by selaedPage.

RPageSourceFile &	operator= (const RPageSourceFile &)=delete

RPageSourceFile &	operator= (RPageSourceFile &&)=delete

RPage	PopulatePage (ColumnHandle_t columnHandle, const RClusterIndex &clusterIndex) final
	Another version of PopulatePage that allows to specify cluster-relative indexes.

RPage	PopulatePage (ColumnHandle_t columnHandle, NTupleSize_t globalIndex) final
	Allocates and fills a page that contains the index-th element.

void	ReleasePage (RPage &page) final
	Every page store needs to be able to free pages it handed out.

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

	RPageSource (RPageSource &&)=delete

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

	~RPageSource () override

ColumnHandle_t	AddColumn (DescriptorId_t fieldId, const RColumn &column) override
	Register a new column.

void	Attach ()
	Open the physical storage container for the tree.

void	DropColumn (ColumnHandle_t columnHandle) override
	Unregisters a column.

ColumnId_t	GetColumnId (ColumnHandle_t columnHandle)

RNTupleMetrics &	GetMetrics () override
	Returns the default metrics object. Subclasses might alternatively override the method and provide their own metrics object.

NTupleSize_t	GetNElements (ColumnHandle_t columnHandle)

NTupleSize_t	GetNEntries ()

const 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.

RPageSource &	operator= (const RPageSource &)=delete

RPageSource &	operator= (RPageSource &&)=delete

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

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

	RPageStorage (RPageStorage &&other)=default

	RPageStorage (std::string_view name)

virtual	~RPageStorage ()

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

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

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

void	SetTaskScheduler (RTaskScheduler *taskScheduler)

Protected Member Functions
RNTupleDescriptor	AttachImpl () final

void	UnzipClusterImpl (RCluster *cluster) final

Protected Member Functions inherited from ROOT::Experimental::Detail::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 RCluster::RKey &clusterKey, ROnDiskPageMap &pageZeroMap, std::function< void(DescriptorId_t, NTupleSize_t, const RClusterDescriptor::RPageRange::RPageInfo &)> perPageFunc)
	Prepare a page range read for the column set in `clusterKey`.

RPage	UnsealPage (const RSealedPage &sealedPage, const RColumnElementBase &element, DescriptorId_t physicalColumnId)
	Helper for unstreaming a page.

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

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

void	InitDescriptor (const Internal::RFileNTupleAnchor &anchor)
	Deserialized header and footer into a minimal descriptor held by fDescriptorBuilder.

RPage	PopulatePageFromCluster (ColumnHandle_t columnHandle, const RClusterInfo &clusterInfo, ClusterSize_t::ValueType idxInCluster)

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

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

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

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

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

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

std::shared_ptr< RPagePool >	fPagePool
	Populated pages might be shared; the page pool might, at some point, be used by multiple page sources.

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

Friends
class	ROOT::Experimental::RNTuple

Additional Inherited Members
Public Types inherited from ROOT::Experimental::Detail::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 Member Functions inherited from ROOT::Experimental::Detail::RPageSource
static std::unique_ptr< RPageSource >	Create (std::string_view ntupleName, std::string_view location, const RNTupleReadOptions &options=RNTupleReadOptions())
	Guess the concrete derived page source from the file name (location)

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

std::unique_ptr< RCounters >	fCounters

std::unique_ptr< RNTupleDecompressor >	fDecompressor
	Helper to unzip pages and header/footer; comprises a 16MB (kMAXZIPBUF) unzip buffer.

RNTupleMetrics	fMetrics
	Wraps the I/O counters and is observed by the RNTupleReader metrics.

RNTupleReadOptions	fOptions

Protected Attributes inherited from ROOT::Experimental::Detail::RPageStorage
std::string	fNTupleName

RTaskScheduler *	fTaskScheduler = nullptr

#include <ROOT/RPageStorageFile.hxx>

Inheritance diagram for ROOT::Experimental::Detail::RPageSourceFile:

[legend]

Constructor & Destructor Documentation

◆ RPageSourceFile() [1/4]

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

private

Definition at line 193 of file RPageStorageFile.cxx.

◆ RPageSourceFile() [2/4]

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

Definition at line 204 of file RPageStorageFile.cxx.

◆ RPageSourceFile() [3/4]

ROOT::Experimental::Detail::RPageSourceFile::RPageSourceFile ( const RPageSourceFile & )

delete

◆ RPageSourceFile() [4/4]

ROOT::Experimental::Detail::RPageSourceFile::RPageSourceFile ( RPageSourceFile && )

delete

◆ ~RPageSourceFile()

ROOT::Experimental::Detail::RPageSourceFile::~RPageSourceFile ( )

overridedefault

Member Function Documentation

◆ AttachImpl()

ROOT::Experimental::RNTupleDescriptor ROOT::Experimental::Detail::RPageSourceFile::AttachImpl ( )

finalprotectedvirtual

Implements ROOT::Experimental::Detail::RPageSource.

Definition at line 243 of file RPageStorageFile.cxx.

◆ Clone()

std::unique_ptr< ROOT::Experimental::Detail::RPageSource > ROOT::Experimental::Detail::RPageSourceFile::Clone ( ) const

finalvirtual

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

The meta-data (header and footer) is reread and parsed by the clone.

Implements ROOT::Experimental::Detail::RPageSource.

Definition at line 416 of file RPageStorageFile.cxx.

◆ CreateFromAnchor()

std::unique_ptr< ROOT::Experimental::Detail::RPageSourceFile > ROOT::Experimental::Detail::RPageSourceFile::CreateFromAnchor	(	const Internal::RFileNTupleAnchor &	anchor,
		std::string_view	path,
		const RNTupleReadOptions &	options
	)

staticprivate

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

Definition at line 231 of file RPageStorageFile.cxx.

◆ InitDescriptor()

void ROOT::Experimental::Detail::RPageSourceFile::InitDescriptor ( const Internal::RFileNTupleAnchor & anchor )

private

Deserialized header and footer into a minimal descriptor held by fDescriptorBuilder.

Definition at line 213 of file RPageStorageFile.cxx.

◆ LoadClusters()

std::vector< std::unique_ptr< ROOT::Experimental::Detail::RCluster > > ROOT::Experimental::Detail::RPageSourceFile::LoadClusters ( std::span< 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 with SetColumnAvailable(). That includes the ones from the columns that 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::Experimental::Detail::RPageSource.

Definition at line 536 of file RPageStorageFile.cxx.

◆ LoadSealedPage()

void ROOT::Experimental::Detail::RPageSourceFile::LoadSealedPage	(	DescriptorId_t	physicalColumnId,
		const RClusterIndex &	clusterIndex,
		RSealedPage &	sealedPage
	)

finalvirtual

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

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::Experimental::Detail::RPageSource.

Definition at line 272 of file RPageStorageFile.cxx.

◆ operator=() [1/2]

RPageSourceFile & ROOT::Experimental::Detail::RPageSourceFile::operator= ( const RPageSourceFile & )

delete

◆ operator=() [2/2]

RPageSourceFile & ROOT::Experimental::Detail::RPageSourceFile::operator= ( RPageSourceFile && )

delete

◆ PopulatePage() [1/2]

ROOT::Experimental::Detail::RPage ROOT::Experimental::Detail::RPageSourceFile::PopulatePage	(	ColumnHandle_t	columnHandle,
		const RClusterIndex &	clusterIndex
	)

finalvirtual

Another version of PopulatePage that allows to specify cluster-relative indexes.

Implements ROOT::Experimental::Detail::RPageSource.

Definition at line 388 of file RPageStorageFile.cxx.

◆ PopulatePage() [2/2]

ROOT::Experimental::Detail::RPage ROOT::Experimental::Detail::RPageSourceFile::PopulatePage	(	ColumnHandle_t	columnHandle,
		NTupleSize_t	globalIndex
	)

finalvirtual

Allocates and fills a page that contains the index-th element.

Implements ROOT::Experimental::Detail::RPageSource.

Definition at line 362 of file RPageStorageFile.cxx.

◆ PopulatePageFromCluster()

ROOT::Experimental::Detail::RPage ROOT::Experimental::Detail::RPageSourceFile::PopulatePageFromCluster	(	ColumnHandle_t	columnHandle,
		const RClusterInfo &	clusterInfo,
		ClusterSize_t::ValueType	idxInCluster
	)

private

Definition at line 299 of file RPageStorageFile.cxx.

◆ PrepareSingleCluster()

std::unique_ptr< ROOT::Experimental::Detail::RCluster > ROOT::Experimental::Detail::RPageSourceFile::PrepareSingleCluster	(	const RCluster::RKey &	clusterKey,
		std::vector< ROOT::Internal::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 425 of file RPageStorageFile.cxx.

◆ ReleasePage()

void ROOT::Experimental::Detail::RPageSourceFile::ReleasePage ( RPage & page )

finalvirtual

Every page store needs to be able to free pages it handed out.

But Sinks and sources have different means of allocating pages.

Implements ROOT::Experimental::Detail::RPageStorage.

Definition at line 411 of file RPageStorageFile.cxx.

◆ UnzipClusterImpl()

void ROOT::Experimental::Detail::RPageSourceFile::UnzipClusterImpl ( RCluster * cluster )

finalprotectedvirtual

Reimplemented from ROOT::Experimental::Detail::RPageSource.

Definition at line 559 of file RPageStorageFile.cxx.

Friends And Related Symbol Documentation

◆ ROOT::Experimental::RNTuple

friend class ROOT::Experimental::RNTuple

friend

Definition at line 103 of file RPageStorageFile.hxx.

Member Data Documentation

◆ fClusterPool

std::unique_ptr<RClusterPool> ROOT::Experimental::Detail::RPageSourceFile::fClusterPool

private

The cluster pool asynchronously preloads the next few clusters.

Definition at line 127 of file RPageStorageFile.hxx.

◆ fCurrentCluster

RCluster* ROOT::Experimental::Detail::RPageSourceFile::fCurrentCluster = nullptr

private

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

Definition at line 119 of file RPageStorageFile.hxx.

◆ fDescriptorBuilder

RNTupleDescriptorBuilder ROOT::Experimental::Detail::RPageSourceFile::fDescriptorBuilder

private

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

Definition at line 125 of file RPageStorageFile.hxx.

◆ fFile

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

private

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

Definition at line 121 of file RPageStorageFile.hxx.

◆ fPagePool

std::shared_ptr<RPagePool> ROOT::Experimental::Detail::RPageSourceFile::fPagePool

private

Populated pages might be shared; the page pool might, at some point, be used by multiple page sources.

Definition at line 117 of file RPageStorageFile.hxx.

◆ fReader

Internal::RMiniFileReader ROOT::Experimental::Detail::RPageSourceFile::fReader

private

Takes the fFile to read ntuple blobs from it.

Definition at line 123 of file RPageStorageFile.hxx.

Libraries for ROOT::Experimental::Detail::RPageSourceFile:

[legend]

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

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

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPageSourceFile() [1/4]

◆ RPageSourceFile() [2/4]

◆ RPageSourceFile() [3/4]

◆ RPageSourceFile() [4/4]

◆ ~RPageSourceFile()

Member Function Documentation

◆ AttachImpl()

◆ Clone()

◆ CreateFromAnchor()

◆ InitDescriptor()

◆ LoadClusters()

◆ LoadSealedPage()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PopulatePage() [1/2]

◆ PopulatePage() [2/2]

◆ PopulatePageFromCluster()

◆ PrepareSingleCluster()

◆ ReleasePage()

◆ UnzipClusterImpl()

Friends And Related Symbol Documentation

◆ ROOT::Experimental::RNTuple

Member Data Documentation

◆ fClusterPool

◆ fCurrentCluster

◆ fDescriptorBuilder

◆ fFile

◆ fPagePool

◆ fReader