Dummy sink that discards all pages.

The RPageNullSink class is for internal testing only and can be used to measure the software overhead of serializing elements into pages, without actually writing them onto disk or even serializing the RNTuple headers and footers.

Definition at line 35 of file RPageNullSink.hxx.

Public Types
using	Callback_t = std::function<void(RPageSink &)>
using	ColumnHandle_t = RColumnHandle
	The column handle identifies a column with the current open page storage.
using	SealedPageSequence_t = std::deque<RSealedPage>

Public Member Functions
	RPageNullSink (std::string_view ntupleName, const ROOT::RNTupleWriteOptions &options)
ColumnHandle_t	AddColumn (ROOT::DescriptorId_t, ROOT::Internal::RColumn &column) final
	Register a new column.
std::unique_ptr< RPageSink >	CloneAsHidden (std::string_view, const RNTupleWriteOptions &) const final
	Creates a new sink with the same underlying storage as this but writing to a different RNTuple named name.
void	CommitAttributeSet (std::string_view, const ROOT::Internal::RNTupleLink &) final
	Adds the given anchor information (name + locator) into the main RNTuple's descriptor as an attribute set linked to it with the given name.
virtual std::uint64_t	CommitCluster (ROOT::NTupleSize_t nNewEntries)
	Finalize the current cluster and create a new one for the following data.
void	CommitClusterGroup () final
	Write out the page locations (page list envelope) for all the committed clusters since the last call of CommitClusterGroup (or the beginning of writing).
RNTupleLink	CommitDataset ()
	Run the registered callbacks and finalize the current cluster and the entrire data set.
ROOT::Internal::RNTupleLink	CommitDatasetImpl () final
void	CommitPage (ColumnHandle_t, const ROOT::Internal::RPage &page) final
	Write a page to the storage. The column must have been added before.
void	CommitSealedPage (ROOT::DescriptorId_t, const RSealedPage &page) final
	Write a preprocessed page to storage. The column must have been added before.
void	CommitSealedPageV (std::span< RSealedPageGroup > ranges) final
	Write a vector of preprocessed pages to storage. The corresponding columns must have been added before.
void	CommitStagedClusters (std::span< RStagedCluster >) final
	Commit staged clusters, logically appending them to the ntuple descriptor.
void	CommitSuppressedColumn (ColumnHandle_t) final
	Commits a suppressed column for the current cluster.
void	ConnectFields (const std::vector< ROOT::RFieldBase * > &fields, ROOT::NTupleSize_t firstEntry)
void	DropColumn (ColumnHandle_t) final
	Unregisters a column.
ROOT::DescriptorId_t	GetColumnId (ColumnHandle_t columnHandle) const
const ROOT::RNTupleDescriptor &	GetDescriptor () const final
	Return the RNTupleDescriptor being constructed.
virtual ROOT::Experimental::Detail::RNTupleMetrics &	GetMetrics ()
	Returns the default metrics object.
ROOT::NTupleSize_t	GetNEntries () const final
const std::string &	GetNTupleName () const
	Returns the NTuple name.
virtual RSinkGuard	GetSinkGuard ()
EPageStorageType	GetType () final
	Whether the concrete implementation is a sink or a source.
const ROOT::RNTupleWriteOptions &	GetWriteOptions () const
	Returns the sink's write options.
void	Init (RNTupleModel &model)
	Physically creates the storage container to hold the ntuple (e.g., a keys a TFile or an S3 bucket) Init() associates column handles to the columns referenced by the model.
void	InitImpl (ROOT::RNTupleModel &model) final
bool	IsInitialized () const
void	RegisterOnCommitDatasetCallback (Callback_t callback)
	The registered callback is executed at the beginning of CommitDataset();.
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 larger than zero.
void	SetTaskScheduler (RTaskScheduler *taskScheduler)
RStagedCluster	StageCluster (ROOT::NTupleSize_t) final
	Stage the current cluster and create a new one for the following data.
void	UpdateExtraTypeInfo (const ROOT::RExtraTypeInfoDescriptor &) final
	Adds an extra type information record to schema.
void	UpdateSchema (const ROOT::Internal::RNTupleModelChangeset &changeset, ROOT::NTupleSize_t firstEntry) final
	Incorporate incremental changes to the model into the ntuple descriptor.

Static Public Member Functions
static RSealedPage	SealPage (const RSealPageConfig &config)
	Seal a page using the provided info.

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

Protected Member Functions
RSealedPage	SealPage (const ROOT::Internal::RPage &page, const ROOT::Internal::RColumnElementBase &element)
	Helper for streaming a page.
void	WaitForAllTasks ()

Protected Attributes
bool	fIsInitialized = false
	Flag if sink was initialized.
ROOT::Experimental::Detail::RNTupleMetrics	fMetrics
std::string	fNTupleName
std::unique_ptr< ROOT::RNTupleWriteOptions >	fOptions
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

Private Attributes
std::uint64_t	fNBytesCurrentCluster = 0
ROOT::DescriptorId_t	fNColumns = 0
std::vector< Callback_t >	fOnDatasetCommitCallbacks
std::vector< unsigned char >	fSealPageBuffer
	Used as destination buffer in the simple SealPage overload.
RWritePageMemoryManager	fWritePageMemoryManager
	Used in ReservePage to maintain the page buffer budget.

#include <ROOT/RPageNullSink.hxx>

Inheritance diagram for ROOT::Experimental::Internal::RPageNullSink:

Member Typedef Documentation

◆ Callback_t

using ROOT::Internal::RPageSink::Callback_t = std::function<void(RPageSink &)>

inherited

Definition at line 258 of file RPageStorage.hxx.

◆ ColumnHandle_t

using ROOT::Internal::RPageStorage::ColumnHandle_t = RColumnHandle

inherited

The column handle identifies a column with the current open page storage.

Definition at line 180 of file RPageStorage.hxx.

◆ SealedPageSequence_t

using ROOT::Internal::RPageStorage::SealedPageSequence_t = std::deque<RSealedPage>

inherited

Definition at line 130 of file RPageStorage.hxx.

Constructor & Destructor Documentation

◆ RPageNullSink()

ROOT::Experimental::Internal::RPageNullSink::RPageNullSink	(	std::string_view	ntupleName,
		const ROOT::RNTupleWriteOptions &	options )

inline

Definition at line 40 of file RPageNullSink.hxx.

Member Function Documentation

◆ AddColumn()

ColumnHandle_t ROOT::Experimental::Internal::RPageNullSink::AddColumn	(	ROOT::DescriptorId_t	fieldId,
		ROOT::Internal::RColumn &	column )

inlinefinalvirtual

Register a new column.

When reading, the column must exist in the ntuple on disk corresponding to the metadata. When writing, every column can only be attached once.

Implements ROOT::Internal::RPageStorage.

Definition at line 44 of file RPageNullSink.hxx.

◆ CloneAsHidden()

std::unique_ptr< RPageSink > ROOT::Experimental::Internal::RPageNullSink::CloneAsHidden	(	std::string_view	name,
		const RNTupleWriteOptions &	opts ) const

inlinefinalvirtual

Creates a new sink with the same underlying storage as this but writing to a different RNTuple named name.

Only one of the two sinks can safely write at the same time. The RNTuple written by this cloned sink will be stored in a hidden key (this is a convenient assumption we make now since this method is only used to create attribute RNTuples).

Implements ROOT::Internal::RPageSink.

Definition at line 110 of file RPageNullSink.hxx.

◆ CommitAttributeSet()

void ROOT::Experimental::Internal::RPageNullSink::CommitAttributeSet	(	std::string_view	attrSetName,
		const ROOT::Internal::RNTupleLink &	attrAnchorInfo )

inlinefinalvirtual

Adds the given anchor information (name + locator) into the main RNTuple's descriptor as an attribute set linked to it with the given name.

The attribute set must have already been written to storage via RNTupleAttrSetWriter::Commit(). Note that, by RNTuple specs, this is only legal to call on a non-attribute RNTuple's sink.

Implements ROOT::Internal::RPageSink.

Definition at line 108 of file RPageNullSink.hxx.

◆ CommitCluster()

virtual std::uint64_t ROOT::Internal::RPageSink::CommitCluster ( ROOT::NTupleSize_t nNewEntries )

inlinevirtualinherited

Finalize the current cluster and create a new one for the following data.

Returns the number of bytes written to storage (excluding metadata).

Reimplemented in ROOT::Internal::RPageSinkBuf.

Definition at line 379 of file RPageStorage.hxx.

◆ CommitClusterGroup()

void ROOT::Experimental::Internal::RPageNullSink::CommitClusterGroup ( )

inlinefinalvirtual

Write out the page locations (page list envelope) for all the committed clusters since the last call of CommitClusterGroup (or the beginning of writing).

Implements ROOT::Internal::RPageSink.

Definition at line 106 of file RPageNullSink.hxx.

◆ CommitDataset()

ROOT::Internal::RNTupleLink ROOT::Internal::RPageSink::CommitDataset ( )

inherited

Run the registered callbacks and finalize the current cluster and the entrire data set.

Definition at line 774 of file RPageStorage.cxx.

◆ CommitDatasetImpl()

ROOT::Internal::RNTupleLink ROOT::Experimental::Internal::RPageNullSink::CommitDatasetImpl ( )

inlinefinalvirtual

Implements ROOT::Internal::RPageSink.

Definition at line 107 of file RPageNullSink.hxx.

◆ CommitPage()

void ROOT::Experimental::Internal::RPageNullSink::CommitPage	(	ColumnHandle_t	columnHandle,
		const ROOT::Internal::RPage &	page )

inlinefinalvirtual

Write a page to the storage. The column must have been added before.

Implements ROOT::Internal::RPageSink.

Definition at line 81 of file RPageNullSink.hxx.

◆ CommitSealedPage()

void ROOT::Experimental::Internal::RPageNullSink::CommitSealedPage	(	ROOT::DescriptorId_t	physicalColumnId,
		const RSealedPage &	sealedPage )

inlinefinalvirtual

Write a preprocessed page to storage. The column must have been added before.

Implements ROOT::Internal::RPageSink.

Definition at line 85 of file RPageNullSink.hxx.

◆ CommitSealedPageV()

void ROOT::Experimental::Internal::RPageNullSink::CommitSealedPageV ( std::span< RSealedPageGroup > ranges )

inlinefinalvirtual

Write a vector of preprocessed pages to storage. The corresponding columns must have been added before.

Implements ROOT::Internal::RPageSink.

Definition at line 89 of file RPageNullSink.hxx.

◆ CommitStagedClusters()

void ROOT::Experimental::Internal::RPageNullSink::CommitStagedClusters ( std::span< RStagedCluster > clusters )

inlinefinalvirtual

Commit staged clusters, logically appending them to the ntuple descriptor.

Implements ROOT::Internal::RPageSink.

Definition at line 105 of file RPageNullSink.hxx.

◆ CommitSuppressedColumn()

void ROOT::Experimental::Internal::RPageNullSink::CommitSuppressedColumn ( ColumnHandle_t columnHandle )

inlinefinalvirtual

Commits a suppressed column for the current cluster.

Can be called anytime before CommitCluster(). For any given column and cluster, there must be no calls to both CommitSuppressedColumn() and page commits.

Implements ROOT::Internal::RPageSink.

Definition at line 80 of file RPageNullSink.hxx.

◆ ConnectFields()

void ROOT::Experimental::Internal::RPageNullSink::ConnectFields	(	const std::vector< ROOT::RFieldBase * > &	fields,
		ROOT::NTupleSize_t	firstEntry )

inline

Definition at line 57 of file RPageNullSink.hxx.

◆ DropColumn()

void ROOT::Internal::RPageSink::DropColumn ( ColumnHandle_t columnHandle )

inlinefinalvirtualinherited

Unregisters a column.

A page source decreases the reference counter for the corresponding active column. For a page sink, dropping columns is currently a no-op.

Implements ROOT::Internal::RPageStorage.

Definition at line 307 of file RPageStorage.hxx.

◆ GetColumnId()

ROOT::DescriptorId_t ROOT::Internal::RPageStorage::GetColumnId ( ColumnHandle_t columnHandle ) const

inlineinherited

Definition at line 188 of file RPageStorage.hxx.

◆ GetDescriptor()

const ROOT::RNTupleDescriptor & ROOT::Experimental::Internal::RPageNullSink::GetDescriptor ( ) const

inlinefinalvirtual

Return the RNTupleDescriptor being constructed.

Implements ROOT::Internal::RPageSink.

Definition at line 49 of file RPageNullSink.hxx.

◆ GetMetrics()

virtual ROOT::Experimental::Detail::RNTupleMetrics & ROOT::Internal::RPageStorage::GetMetrics ( )

inlinevirtualinherited

Returns the default metrics object.

Subclasses might alternatively provide their own metrics object by overriding this.

Definition at line 192 of file RPageStorage.hxx.

◆ GetNEntries()

ROOT::NTupleSize_t ROOT::Experimental::Internal::RPageNullSink::GetNEntries ( ) const

inlinefinalvirtual

Implements ROOT::Internal::RPageSink.

Definition at line 55 of file RPageNullSink.hxx.

◆ GetNTupleName()

const std::string & ROOT::Internal::RPageStorage::GetNTupleName ( ) const

inlineinherited

Returns the NTuple name.

Definition at line 195 of file RPageStorage.hxx.

◆ GetSinkGuard()

virtual RSinkGuard ROOT::Internal::RPageSink::GetSinkGuard ( )

inlinevirtualinherited

Definition at line 433 of file RPageStorage.hxx.

◆ GetType()

EPageStorageType ROOT::Internal::RPageSink::GetType ( )

inlinefinalvirtualinherited

Whether the concrete implementation is a sink or a source.

Implements ROOT::Internal::RPageStorage.

Definition at line 303 of file RPageStorage.hxx.

◆ GetWriteOptions()

const ROOT::RNTupleWriteOptions & ROOT::Internal::RPageSink::GetWriteOptions ( ) const

inlineinherited

Returns the sink's write options.

Definition at line 305 of file RPageStorage.hxx.

◆ Init()

void ROOT::Internal::RPageSink::Init ( RNTupleModel & model )

inlineinherited

Physically creates the storage container to hold the ntuple (e.g., a keys a TFile or an S3 bucket) Init() associates column handles to the columns referenced by the model.

Definition at line 318 of file RPageStorage.hxx.

◆ InitImpl()

void ROOT::Experimental::Internal::RPageNullSink::InitImpl ( ROOT::RNTupleModel & model )

inlinefinalvirtual

Implements ROOT::Internal::RPageSink.

Definition at line 69 of file RPageNullSink.hxx.

◆ IsInitialized()

bool ROOT::Internal::RPageSink::IsInitialized ( ) const

inlineinherited

Definition at line 309 of file RPageStorage.hxx.

◆ RegisterOnCommitDatasetCallback()

void ROOT::Internal::RPageSink::RegisterOnCommitDatasetCallback ( Callback_t callback )

inlineinherited

The registered callback is executed at the beginning of CommitDataset();.

Definition at line 402 of file RPageStorage.hxx.

◆ ReservePage()

ROOT::Internal::RPage ROOT::Internal::RPageSink::ReservePage	(	ColumnHandle_t	columnHandle,
		std::size_t	nElements )

virtualinherited

Get a new, empty page for the given column that can be filled with up to nElements; nElements must be larger than zero.

Reimplemented in ROOT::Internal::RPageSinkBuf.

Definition at line 781 of file RPageStorage.cxx.

◆ SealPage() [1/2]

ROOT::Internal::RPageStorage::RSealedPage ROOT::Internal::RPageSink::SealPage	(	const ROOT::Internal::RPage &	page,
		const ROOT::Internal::RColumnElementBase &	element )

protectedinherited

Helper for streaming a page.

This is commonly used in derived, concrete page sinks. Note that if compressionSetting is 0 (uncompressed) and the page is mappable and not checksummed, the returned sealed page will point directly to the input page buffer. Otherwise, the sealed page references fSealPageBuffer. Thus, the buffer pointed to by the RSealedPage should never be freed.

Definition at line 757 of file RPageStorage.cxx.

◆ SealPage() [2/2]

ROOT::Internal::RPageStorage::RSealedPage ROOT::Internal::RPageSink::SealPage ( const RSealPageConfig & config )

staticinherited

Seal a page using the provided info.

Definition at line 719 of file RPageStorage.cxx.

◆ SetTaskScheduler()

void ROOT::Internal::RPageStorage::SetTaskScheduler ( RTaskScheduler * taskScheduler )

inlineinherited

Definition at line 197 of file RPageStorage.hxx.

◆ StageCluster()

RStagedCluster ROOT::Experimental::Internal::RPageNullSink::StageCluster ( ROOT::NTupleSize_t nNewEntries )

inlinefinalvirtual

Stage the current cluster and create a new one for the following data.

Returns the object that must be passed to CommitStagedClusters to logically append the staged cluster to the ntuple descriptor.

Implements ROOT::Internal::RPageSink.

Definition at line 98 of file RPageNullSink.hxx.

◆ UpdateExtraTypeInfo()

void ROOT::Experimental::Internal::RPageNullSink::UpdateExtraTypeInfo ( const ROOT::RExtraTypeInfoDescriptor & extraTypeInfo )

inlinefinalvirtual

Adds an extra type information record to schema.

The extra type information will be written to the extension header. The information in the record will be merged with the existing information, e.g. duplicate streamer info records will be removed. This method is called by the "on commit dataset" callback registered by specific fields (e.g., streamer field) and during merging.

Implements ROOT::Internal::RPageSink.

Definition at line 78 of file RPageNullSink.hxx.

◆ UpdateSchema()

void ROOT::Experimental::Internal::RPageNullSink::UpdateSchema	(	const ROOT::Internal::RNTupleModelChangeset &	changeset,
		ROOT::NTupleSize_t	firstEntry )

inlinefinalvirtual

Incorporate incremental changes to the model into the ntuple descriptor.

This happens, e.g. if new fields were added after the initial call to RPageSink::Init(RNTupleModel &). firstEntry specifies the global index for the first stored element in the added columns.

Implements ROOT::Internal::RPageSink.

Definition at line 74 of file RPageNullSink.hxx.

◆ WaitForAllTasks()

void ROOT::Internal::RPageStorage::WaitForAllTasks ( )

inlineprotectedinherited

Definition at line 153 of file RPageStorage.hxx.

Member Data Documentation

◆ fIsInitialized

bool ROOT::Internal::RPageSink::fIsInitialized = false

protectedinherited

Flag if sink was initialized.

Definition at line 279 of file RPageStorage.hxx.

◆ fMetrics

ROOT::Experimental::Detail::RNTupleMetrics ROOT::Internal::RPageStorage::fMetrics

protectedinherited

Definition at line 146 of file RPageStorage.hxx.

◆ fNBytesCurrentCluster

std::uint64_t ROOT::Experimental::Internal::RPageNullSink::fNBytesCurrentCluster = 0

private

Definition at line 37 of file RPageNullSink.hxx.

◆ fNColumns

ROOT::DescriptorId_t ROOT::Experimental::Internal::RPageNullSink::fNColumns = 0

private

Definition at line 36 of file RPageNullSink.hxx.

◆ fNTupleName

std::string ROOT::Internal::RPageStorage::fNTupleName

protectedinherited

Definition at line 151 of file RPageStorage.hxx.

◆ fOnDatasetCommitCallbacks

std::vector<Callback_t> ROOT::Internal::RPageSink::fOnDatasetCommitCallbacks

privateinherited

Definition at line 288 of file RPageStorage.hxx.

◆ fOptions

std::unique_ptr<ROOT::RNTupleWriteOptions> ROOT::Internal::RPageSink::fOptions

protectedinherited

Definition at line 276 of file RPageStorage.hxx.

◆ fPageAllocator

std::unique_ptr<ROOT::Internal::RPageAllocator> ROOT::Internal::RPageStorage::fPageAllocator

protectedinherited

For the time being, we will use the heap allocator for all sources and sinks. This may change in the future.

Definition at line 149 of file RPageStorage.hxx.

◆ fSealPageBuffer

std::vector<unsigned char> ROOT::Internal::RPageSink::fSealPageBuffer

privateinherited

Used as destination buffer in the simple SealPage overload.

Definition at line 289 of file RPageStorage.hxx.

◆ fTaskScheduler

RTaskScheduler* ROOT::Internal::RPageStorage::fTaskScheduler = nullptr

protectedinherited

Definition at line 152 of file RPageStorage.hxx.

◆ fWritePageMemoryManager

RWritePageMemoryManager ROOT::Internal::RPageSink::fWritePageMemoryManager

privateinherited

Used in ReservePage to maintain the page buffer budget.

Definition at line 292 of file RPageStorage.hxx.

◆ kNBytesPageChecksum

std::size_t ROOT::Internal::RPageStorage::kNBytesPageChecksum = sizeof(std::uint64_t)

staticconstexprinherited

The page checksum is a 64bit xxhash3.

Definition at line 73 of file RPageStorage.hxx.

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

tree/ntuple/inc/ROOT/RPageNullSink.hxx

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Callback_t

◆ ColumnHandle_t

◆ SealedPageSequence_t

Constructor & Destructor Documentation

◆ RPageNullSink()

Member Function Documentation

◆ AddColumn()

◆ CloneAsHidden()

◆ CommitAttributeSet()

◆ CommitCluster()

◆ CommitClusterGroup()

◆ CommitDataset()

◆ CommitDatasetImpl()

◆ CommitPage()

◆ CommitSealedPage()

◆ CommitSealedPageV()

◆ CommitStagedClusters()

◆ CommitSuppressedColumn()

◆ ConnectFields()

◆ DropColumn()

◆ GetColumnId()

◆ GetDescriptor()

◆ GetMetrics()

◆ GetNEntries()

◆ GetNTupleName()

◆ GetSinkGuard()

◆ GetType()

◆ GetWriteOptions()

◆ Init()

◆ InitImpl()

◆ IsInitialized()

◆ RegisterOnCommitDatasetCallback()

◆ ReservePage()

◆ SealPage() [1/2]

◆ SealPage() [2/2]

◆ SetTaskScheduler()

◆ StageCluster()

◆ UpdateExtraTypeInfo()

◆ UpdateSchema()

◆ WaitForAllTasks()

Member Data Documentation

◆ fIsInitialized

◆ fMetrics

◆ fNBytesCurrentCluster

◆ fNColumns

◆ fNTupleName

◆ fOnDatasetCommitCallbacks

◆ fOptions

◆ fPageAllocator

◆ fSealPageBuffer

◆ fTaskScheduler

◆ fWritePageMemoryManager

◆ kNBytesPageChecksum