Storage provider that writes ntuple pages to into a DAOS container.

Currently, an object is allocated for ntuple metadata (anchor/header/footer). Objects can correspond to pages or clusters of pages depending on the RNTuple-DAOS mapping strategy.

Definition at line 100 of file RPageStorageDaos.hxx.

Public Member Functions
	RPageSinkDaos (std::string_view ntupleName, std::string_view uri, const ROOT::RNTupleWriteOptions &options)

	~RPageSinkDaos () override

std::unique_ptr< ROOT::Internal::RPageSink >	CloneAsHidden (std::string_view name, const ROOT::RNTupleWriteOptions &opts) const final
	Creates a new sink with the same underlying storage as this but writing to a different RNTuple named `name`.

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

	RPagePersistentSink (RPagePersistentSink &&)=default

	RPagePersistentSink (std::string_view ntupleName, const ROOT::RNTupleWriteOptions &options)

	~RPagePersistentSink () override

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

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 set linked to it with the given name.

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

void	CommitPage (ColumnHandle_t columnHandle, const ROOT::Internal::RPage &page) final
	Write a page to the storage. The column must have been added before.

void	CommitSealedPage (ROOT::DescriptorId_t physicalColumnId, const RPageStorage::RSealedPage &sealedPage) final
	Write a preprocessed page to storage. The column must have been added before.

void	CommitSealedPageV (std::span< RPageStorage::RSealedPageGroup > ranges) final
	Write a vector of preprocessed pages to storage. The corresponding columns must have been added before.

void	CommitStagedClusters (std::span< RStagedCluster > clusters) final
	Commit staged clusters, logically appending them to the ntuple descriptor.

void	CommitSuppressedColumn (ColumnHandle_t columnHandle) final
	Commits a suppressed column for the current cluster.

const ROOT::RNTupleDescriptor &	GetDescriptor () const final
	Return the RNTupleDescriptor being constructed.

ROOT::NTupleSize_t	GetNEntries () const final

std::unique_ptr< RNTupleModel >	InitFromDescriptor (const ROOT::RNTupleDescriptor &descriptor, bool copyClusters)
	Initialize sink based on an existing descriptor and fill into the descriptor builder, optionally copying over the descriptor's clusters to this sink's descriptor.

RPagePersistentSink &	operator= (const RPagePersistentSink &)=delete

RPagePersistentSink &	operator= (RPagePersistentSink &&)=default

RStagedCluster	StageCluster (ROOT::NTupleSize_t nNewEntries) final
	Stage the current cluster and create a new one for the following data.

void	UpdateExtraTypeInfo (const ROOT::RExtraTypeInfoDescriptor &extraTypeInfo) final
	Adds an extra type information record to schema.

void	UpdateSchema (const ROOT::Internal::RNTupleModelChangeset &changeset, ROOT::NTupleSize_t firstEntry) override
	Incorporate incremental changes to the model into the ntuple descriptor.

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

	RPageSink (RPageSink &&)=default

	RPageSink (std::string_view ntupleName, const ROOT::RNTupleWriteOptions &options)

	~RPageSink () override

virtual std::uint64_t	CommitCluster (ROOT::NTupleSize_t nNewEntries)
	Finalize the current cluster and create a new one for the following data.

RNTupleLink	CommitDataset ()
	Run the registered callbacks and finalize the current cluster and the entrire data set.

void	DropColumn (ColumnHandle_t) final
	Unregisters a column.

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.

bool	IsInitialized () const

RPageSink &	operator= (const RPageSink &)=delete

RPageSink &	operator= (RPageSink &&)=default

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.

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)

Protected Member Functions
RNTupleLocator	CommitClusterGroupImpl (unsigned char *serializedPageList, std::uint32_t length) final
	Returns the locator of the page list envelope of the given buffer that contains the serialized page list.

RNTupleLink	CommitDatasetImpl () final

ROOT::Internal::RNTupleLink	CommitDatasetImpl (unsigned char *serializedFooter, std::uint32_t length) final

virtual RNTupleLink	CommitDatasetImpl (unsigned char *serializedFooter, std::uint32_t length)=0

RNTupleLocator	CommitPageImpl (ColumnHandle_t columnHandle, const ROOT::Internal::RPage &page) final

RNTupleLocator	CommitSealedPageImpl (ROOT::DescriptorId_t physicalColumnId, const RPageStorage::RSealedPage &sealedPage) final

std::vector< RNTupleLocator >	CommitSealedPageVImpl (std::span< RPageStorage::RSealedPageGroup > ranges, const std::vector< bool > &mask) final
	Vector commit of preprocessed pages.

void	InitImpl (RNTupleModel &model) final
	Updates the descriptor and calls InitImpl() that handles the backend-specific details (file, DAOS, etc.)

void	InitImpl (unsigned char *serializedHeader, std::uint32_t length) final

virtual void	InitImpl (unsigned char *serializedHeader, std::uint32_t length)=0

std::uint64_t	StageClusterImpl () final
	Returns the number of bytes written to storage (excluding metadata)

void	WriteNTupleAnchor ()

void	WriteNTupleFooter (const void *data, size_t nbytes, size_t lenFooter)

void	WriteNTupleHeader (const void *data, size_t nbytes, size_t lenHeader)

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

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

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

Private Attributes
std::atomic< std::uint64_t >	fClusterGroupId {0}
	Cluster group counter for the next committed cluster pagelist; incremented in `CommitClusterGroupImpl()`

std::unique_ptr< RDaosContainer >	fDaosContainer
	Underlying DAOS container.

std::uint64_t	fNBytesCurrentCluster {0}
	Tracks the number of bytes committed to the current cluster.

RDaosNTupleAnchor	fNTupleAnchor

ntuple_index_t	fNTupleIndex {0}

std::atomic< std::uint64_t >	fPageId {0}
	Page identifier for the next committed page; it is automatically incremented in `CommitSealedPageImpl()`

std::string	fURI
	A URI to a DAOS pool of the form 'daos://pool-label/container-label'.

Additional Inherited Members
Public Types inherited from ROOT::Internal::RPageSink
using	Callback_t = std::function<void(RPageSink &)>

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

Static Public Member Functions inherited from ROOT::Internal::RPageSink
static RSealedPage	SealPage (const RSealPageConfig &config)
	Seal a page using the provided info.

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::RPagePersistentSink
std::unique_ptr< RCounters >	fCounters

ROOT::Internal::RNTupleDescriptorBuilder	fDescriptorBuilder

RFeatures	fFeatures

Protected Attributes inherited from ROOT::Internal::RPageSink
bool	fIsInitialized = false
	Flag if sink was initialized.

std::unique_ptr< ROOT::RNTupleWriteOptions >	fOptions

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/RPageStorageDaos.hxx>

Inheritance diagram for ROOT::Experimental::Internal::RPageSinkDaos:

[legend]

Constructor & Destructor Documentation

◆ RPageSinkDaos()

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

Definition at line 260 of file RPageStorageDaos.cxx.

◆ ~RPageSinkDaos()

ROOT::Experimental::Internal::RPageSinkDaos::~RPageSinkDaos ( )

overridedefault

Member Function Documentation

◆ CloneAsHidden()

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

finalvirtual

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 454 of file RPageStorageDaos.cxx.

◆ CommitClusterGroupImpl()

ROOT::RNTupleLocator ROOT::Experimental::Internal::RPageSinkDaos::CommitClusterGroupImpl	(	unsigned char *	serializedPageList,
		std::uint32_t	length )

finalprotectedvirtual

Returns the locator of the page list envelope of the given buffer that contains the serialized page list.

Typically, the implementation takes care of compressing and writing the provided buffer.

Implements ROOT::Internal::RPagePersistentSink.

Definition at line 392 of file RPageStorageDaos.cxx.

◆ CommitDatasetImpl() [1/3]

ROOT::Internal::RNTupleLink ROOT::Internal::RPagePersistentSink::CommitDatasetImpl ( )

finalprotectedvirtual

Returns: The locator and length of the written anchor.

Reimplemented from ROOT::Internal::RPagePersistentSink.

Definition at line 556 of file RPageStorage.cxx.

◆ CommitDatasetImpl() [2/3]

ROOT::Internal::RNTupleLink ROOT::Experimental::Internal::RPageSinkDaos::CommitDatasetImpl	(	unsigned char *	serializedFooter,
		std::uint32_t	length )

finalprotectedvirtual

Implements ROOT::Internal::RPagePersistentSink.

Definition at line 413 of file RPageStorageDaos.cxx.

◆ CommitDatasetImpl() [3/3]

virtual RNTupleLink ROOT::Internal::RPagePersistentSink::CommitDatasetImpl	(	unsigned char *	serializedFooter,
		std::uint32_t	length )

protectedvirtual

Implements ROOT::Internal::RPagePersistentSink.

◆ CommitPageImpl()

ROOT::RNTupleLocator ROOT::Experimental::Internal::RPageSinkDaos::CommitPageImpl	(	ColumnHandle_t	columnHandle,
		const ROOT::Internal::RPage &	page )

finalprotectedvirtual

Implements ROOT::Internal::RPagePersistentSink.

Definition at line 297 of file RPageStorageDaos.cxx.

◆ CommitSealedPageImpl()

ROOT::RNTupleLocator ROOT::Experimental::Internal::RPageSinkDaos::CommitSealedPageImpl	(	ROOT::DescriptorId_t	physicalColumnId,
		const RPageStorage::RSealedPage &	sealedPage )

finalprotectedvirtual

Implements ROOT::Internal::RPagePersistentSink.

Definition at line 312 of file RPageStorageDaos.cxx.

◆ CommitSealedPageVImpl()

std::vector< ROOT::RNTupleLocator > ROOT::Experimental::Internal::RPageSinkDaos::CommitSealedPageVImpl	(	std::span< RPageStorage::RSealedPageGroup >	ranges,
		const std::vector< bool > &	mask )

finalprotectedvirtual

Vector commit of preprocessed pages.

The ranges array specifies a range of sealed pages to be committed for each column. The returned vector contains, in order, the RNTupleLocator for each page on each range in ranges, i.e. the first N entries refer to the N pages in ranges[0], followed by M entries that refer to the M pages in ranges[1], etc. The mask allows to skip writing out certain pages. The vector has the size of all the pages. For every false value in the mask, the corresponding locator is skipped (missing) in the output vector. The default is to call CommitSealedPageImpl for each page; derived classes may provide an optimized implementation though.

Reimplemented from ROOT::Internal::RPagePersistentSink.

Definition at line 336 of file RPageStorageDaos.cxx.

◆ InitImpl() [1/3]

void ROOT::Internal::RPagePersistentSink::InitImpl ( ROOT::RNTupleModel & model )

finalprotectedvirtual

Updates the descriptor and calls InitImpl() that handles the backend-specific details (file, DAOS, etc.)

Reimplemented from ROOT::Internal::RPagePersistentSink.

Definition at line 536 of file RPageStorage.cxx.

◆ InitImpl() [2/3]

void ROOT::Experimental::Internal::RPageSinkDaos::InitImpl	(	unsigned char *	serializedHeader,
		std::uint32_t	length )

finalprotectedvirtual

Implements ROOT::Internal::RPagePersistentSink.

Definition at line 274 of file RPageStorageDaos.cxx.

◆ InitImpl() [3/3]

virtual void ROOT::Internal::RPagePersistentSink::InitImpl	(	unsigned char *	serializedHeader,
		std::uint32_t	length )

protectedvirtual

Implements ROOT::Internal::RPagePersistentSink.

◆ StageClusterImpl()

std::uint64_t ROOT::Experimental::Internal::RPageSinkDaos::StageClusterImpl ( )

finalprotectedvirtual

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

Implements ROOT::Internal::RPagePersistentSink.

Definition at line 386 of file RPageStorageDaos.cxx.

◆ WriteNTupleAnchor()

void ROOT::Experimental::Internal::RPageSinkDaos::WriteNTupleAnchor ( )

protected

Definition at line 443 of file RPageStorageDaos.cxx.

◆ WriteNTupleFooter()

void ROOT::Experimental::Internal::RPageSinkDaos::WriteNTupleFooter	(	const void *	data,
		size_t	nbytes,
		size_t	lenFooter )

protected

Definition at line 434 of file RPageStorageDaos.cxx.

◆ WriteNTupleHeader()

void ROOT::Experimental::Internal::RPageSinkDaos::WriteNTupleHeader	(	const void *	data,
		size_t	nbytes,
		size_t	lenHeader )

protected

Definition at line 425 of file RPageStorageDaos.cxx.

Member Data Documentation

◆ fClusterGroupId

std::atomic<std::uint64_t> ROOT::Experimental::Internal::RPageSinkDaos::fClusterGroupId {0}

private

Cluster group counter for the next committed cluster pagelist; incremented in CommitClusterGroupImpl()

Definition at line 110 of file RPageStorageDaos.hxx.

◆ fDaosContainer

std::unique_ptr<RDaosContainer> ROOT::Experimental::Internal::RPageSinkDaos::fDaosContainer

private

Underlying DAOS container.

An internal std::shared_ptr keep the pool connection alive. ISO C++ ensures the correct destruction order, i.e., ~RDaosContainer is invoked first (which calls daos_cont_close(); the destructor for the std::shared_ptr<RDaosPool> is invoked after (which calls daos_pool_disconect()).

Definition at line 106 of file RPageStorageDaos.hxx.

◆ fNBytesCurrentCluster

std::uint64_t ROOT::Experimental::Internal::RPageSinkDaos::fNBytesCurrentCluster {0}

private

Tracks the number of bytes committed to the current cluster.

Definition at line 114 of file RPageStorageDaos.hxx.

◆ fNTupleAnchor

RDaosNTupleAnchor ROOT::Experimental::Internal::RPageSinkDaos::fNTupleAnchor

private

Definition at line 116 of file RPageStorageDaos.hxx.

◆ fNTupleIndex

ntuple_index_t ROOT::Experimental::Internal::RPageSinkDaos::fNTupleIndex {0}

private

Definition at line 117 of file RPageStorageDaos.hxx.

◆ fPageId

std::atomic<std::uint64_t> ROOT::Experimental::Internal::RPageSinkDaos::fPageId {0}

private

Page identifier for the next committed page; it is automatically incremented in CommitSealedPageImpl()

Definition at line 108 of file RPageStorageDaos.hxx.

◆ fURI

std::string ROOT::Experimental::Internal::RPageSinkDaos::fURI

private

A URI to a DAOS pool of the form 'daos://pool-label/container-label'.

Definition at line 112 of file RPageStorageDaos.hxx.

tree/ntuple/inc/ROOT/RPageStorageDaos.hxx

tree/ntuple/src/RPageStorageDaos.cxx

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPageSinkDaos()

◆ ~RPageSinkDaos()

Member Function Documentation

◆ CloneAsHidden()

◆ CommitClusterGroupImpl()

◆ CommitDatasetImpl() [1/3]

◆ CommitDatasetImpl() [2/3]

◆ CommitDatasetImpl() [3/3]

◆ CommitPageImpl()

◆ CommitSealedPageImpl()

◆ CommitSealedPageVImpl()

◆ InitImpl() [1/3]

◆ InitImpl() [2/3]

◆ InitImpl() [3/3]

◆ StageClusterImpl()

◆ WriteNTupleAnchor()

◆ WriteNTupleFooter()

◆ WriteNTupleHeader()

Member Data Documentation

◆ fClusterGroupId

◆ fDaosContainer

◆ fNBytesCurrentCluster

◆ fNTupleAnchor

◆ fNTupleIndex

◆ fPageId

◆ fURI