Base class for input and output parallel archives. More...

#include <parallel_archive.h>

Collaboration diagram for madness::archive::BaseParallelArchive< Archive >:

[legend]

Public Member Functions
template<typename X = Archive>
	BaseParallelArchive (typename std::enable_if_t< std::is_same< X, BinaryFstreamInputArchive >::value\|\|std::is_same< X, BinaryFstreamOutputArchive >::value, int > nio=0)
	Default constructor. More...

	BaseParallelArchive (World &world, Archive &ar, int nio)

template<typename objT >
void	broadcast (objT &obj, ProcessID root) const
	Same as `world.gop.broadcast_serializable(obj, root)`. More...

void	close ()
	Closes the parallel archive. More...

bool	dofence () const
	Check if we should fence around a read/write operation. More...

World *	get_world () const
	Returns a pointer to the world. More...

ProcessID	io_node (ProcessID rank) const
	Returns the process doing I/O for given node. More...

bool	is_io_node () const
	Returns true if this node is doing physical I/O. More...

Archive &	local_archive () const
	Returns a reference to the local archive. More...

ProcessID	my_io_node () const
	Returns the process doing I/O for this node. More...

int	num_io_clients () const
	Returns the number of I/O clients for this node, including self (zero if not an I/O node). More...

template<typename X = Archive>
std::enable_if_t< std::is_same< X, BinaryFstreamInputArchive >::value\|\|std::is_same< X, BinaryFstreamOutputArchive >::value, void >	open (World &world, const char *filename, int nwriter=1)
	Opens the parallel archive. More...

void	remove ()
	Removes the files associated with the current archive. More...

void	set_dofence (bool dofence)
	Set the flag for fencing around a read/write operation. More...

void	set_nclient (World &world)

Static Public Member Functions
template<typename X = Archive>
static std::enable_if_t< std::is_same< X, BinaryFstreamInputArchive >::value\|\|std::is_same< X, BinaryFstreamOutputArchive >::value, bool >	exists (World &world, const char *filename)
	Returns true if the named, unopened archive exists on disk with read access. More...

template<typename X = Archive>
static std::enable_if_t< std::is_same< X, BinaryFstreamInputArchive >::value\|\|std::is_same< X, BinaryFstreamOutputArchive >::value, void >	remove (World &world, const char *filename)
	Deletes the files associated with the archive of the given name. More...

Static Public Attributes
static const bool	is_parallel_archive = true
	Mark this class as a parallel archive. More...

Private Attributes
Archive	ar
	The local archive. More...

bool	do_fence =true
	If true (default), a read/write of parallel objects fences before and after I/O. More...

char	fname [256]
	Name of the archive. More...

int	nclient
	Number of clients of this node, including self. Zero if not I/O node. More...

int	nio
	Number of I/O nodes (always includes node zero). More...

World *	world
	The world. More...

Detailed Description

template<typename Archive>
class madness::archive::BaseParallelArchive< Archive >

Base class for input and output parallel archives.

Template Parameters

Archive The local archive. Only tested for BinaryFstreamInputArchive and BinaryFstreamOutputArchive.

Todo:: Should this class derive from BaseArchive?

Constructor & Destructor Documentation

◆ BaseParallelArchive() [1/2]

template<typename Archive >

madness::archive::BaseParallelArchive< Archive >::BaseParallelArchive	(	World &	world,
		Archive &	ar,
		int	nio
	)

inline

References madness::archive::BaseParallelArchive< Archive >::fname, madness::archive::BaseParallelArchive< Archive >::set_nclient(), and madness::archive::BaseParallelArchive< Archive >::world.

◆ BaseParallelArchive() [2/2]

template<typename Archive >

template<typename X = Archive>

madness::archive::BaseParallelArchive< Archive >::BaseParallelArchive ( typename std::enable_if_t< std::is_same< X, BinaryFstreamInputArchive >::value||std::is_same< X, BinaryFstreamOutputArchive >::value, int > nio = 0 )

inline

Default constructor.

Member Function Documentation

◆ broadcast()

template<typename Archive >

template<typename objT >

void madness::archive::BaseParallelArchive< Archive >::broadcast	(	objT &	obj,
		ProcessID	root
	)		const

inline

Same as world.gop.broadcast_serializable(obj, root).

Template Parameters

objT	Type of object to broadcast.

Parameters

[in]	obj	The object to broadcast.
[in]	root	The root process for broadcasting.

References madness::WorldGopInterface::broadcast_serializable(), madness::archive::BaseParallelArchive< Archive >::get_world(), and madness::World::gop.

Referenced by madness::archive::ArchiveImpl< ParallelInputArchive< localarchiveT >, archive_array< T > >::wrap_load(), and madness::archive::ArchiveImpl< ParallelInputArchive< localarchiveT >, T >::wrap_load().

◆ close()

template<typename Archive >

void madness::archive::BaseParallelArchive< Archive >::close ( )

inline

Closes the parallel archive.

References madness::archive::BaseParallelArchive< Archive >::ar, madness::archive::BaseParallelArchive< Archive >::is_io_node(), MADNESS_CHECK, and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by test13(), test_io(), and test_serialize().

◆ dofence()

template<typename Archive >

bool madness::archive::BaseParallelArchive< Archive >::dofence ( ) const

inline

Check if we should fence around a read/write operation.

Returns: True if we should fence; false otherwise.

References madness::archive::BaseParallelArchive< Archive >::do_fence.

Referenced by madness::archive::ArchiveLoadImpl< ParallelInputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::load(), madness::archive::BaseParallelArchive< Archive >::set_dofence(), and madness::archive::ArchiveStoreImpl< ParallelOutputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::store().

◆ exists()

template<typename Archive >

template<typename X = Archive>

static std::enable_if_t<std::is_same<X,BinaryFstreamInputArchive>::value \|\| std::is_same<X,BinaryFstreamOutputArchive>::value, bool> madness::archive::BaseParallelArchive< Archive >::exists	(	World &	world,
		const char *	filename
	)

inlinestatic

Returns true if the named, unopened archive exists on disk with read access.

This is a collective operation.

Parameters

[in]	world	The world.
[in]	filename	Name of the file.

Returns: True if the named, unopened archive exists and is readable.

References madness::WorldGopInterface::broadcast(), bufsize, madness::filename, madness::World::gop, MADNESS_CHECK, madness::World::rank(), status, and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::BaseParallelArchive< Archive >::open().

◆ get_world()

template<typename Archive >

World* madness::archive::BaseParallelArchive< Archive >::get_world ( ) const

inline

Returns a pointer to the world.

Returns: A pointer to the world.

References MADNESS_CHECK, and madness::archive::BaseParallelArchive< Archive >::world.

◆ io_node()

template<typename Archive >

ProcessID madness::archive::BaseParallelArchive< Archive >::io_node ( ProcessID rank ) const

inline

Returns the process doing I/O for given node.

Currently assigned in a round-robin fashion to the first nio processes, except on IBM BG/P where we use every 64th.

Parameters

[in] rank The node to check.

Returns: The process doing I/O for process rank.

References madness::archive::BaseParallelArchive< Archive >::nio.

Referenced by madness::archive::BaseParallelArchive< Archive >::my_io_node(), madness::archive::BaseParallelArchive< Archive >::set_nclient(), and madness::archive::ArchiveStoreImpl< ParallelOutputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::store().

◆ is_io_node()

template<typename Archive >

bool madness::archive::BaseParallelArchive< Archive >::is_io_node ( ) const

inline

Returns true if this node is doing physical I/O.

Returns: True if this node is doing physical I/O.

References MADNESS_CHECK, madness::archive::BaseParallelArchive< Archive >::my_io_node(), madness::World::rank(), and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::BaseParallelArchive< Archive >::close(), madness::archive::ParallelOutputArchive< localarchiveT >::flush(), madness::archive::ArchiveLoadImpl< ParallelInputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::load(), madness::archive::BaseParallelArchive< Archive >::local_archive(), madness::archive::BaseParallelArchive< Archive >::open(), and madness::archive::ArchiveStoreImpl< ParallelOutputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::store().

◆ local_archive()

template<typename Archive >

Archive& madness::archive::BaseParallelArchive< Archive >::local_archive ( ) const

inline

Returns a reference to the local archive.

Exceptions

MadnessException If not an I/O node.

Returns: A reference to the local archive.

References madness::archive::BaseParallelArchive< Archive >::ar, madness::archive::BaseParallelArchive< Archive >::is_io_node(), MADNESS_CHECK, and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::ParallelOutputArchive< localarchiveT >::flush(), madness::archive::ArchiveLoadImpl< ParallelInputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::load(), madness::archive::ArchiveStoreImpl< ParallelOutputArchive< ContainerRecordOutputArchive >, WorldContainer< keyT, valueT > >::store(), madness::archive::ArchiveStoreImpl< ParallelOutputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::store(), madness::archive::ArchiveStoreImpl< ParallelOutputArchive< VectorOutputArchive >, WorldContainer< keyT, valueT > >::store(), madness::archive::ArchiveImpl< ParallelInputArchive< localarchiveT >, archive_array< T > >::wrap_load(), madness::archive::ArchiveImpl< ParallelInputArchive< localarchiveT >, T >::wrap_load(), madness::archive::ArchiveImpl< ParallelOutputArchive< localarchiveT >, archive_array< T > >::wrap_store(), and madness::archive::ArchiveImpl< ParallelOutputArchive< localarchiveT >, T >::wrap_store().

◆ my_io_node()

template<typename Archive >

ProcessID madness::archive::BaseParallelArchive< Archive >::my_io_node ( ) const

inline

Returns the process doing I/O for this node.

Returns: The process doing I/O for this node.

References madness::archive::BaseParallelArchive< Archive >::io_node(), MADNESS_CHECK, madness::World::rank(), and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::BaseParallelArchive< Archive >::is_io_node(), and madness::archive::ArchiveStoreImpl< ParallelOutputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::store().

◆ num_io_clients()

template<typename Archive >

int madness::archive::BaseParallelArchive< Archive >::num_io_clients ( ) const

inline

Returns the number of I/O clients for this node, including self (zero if not an I/O node).

Returns: The number of I/O clients for this node, including self (zero if not an I/O node).

References MADNESS_CHECK, madness::archive::BaseParallelArchive< Archive >::nclient, and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::ArchiveStoreImpl< ParallelOutputArchive< localarchiveT >, WorldContainer< keyT, valueT > >::store().

◆ open()

template<typename Archive >

template<typename X = Archive>

std::enable_if_t<std::is_same<X,BinaryFstreamInputArchive>::value \|\| std::is_same<X,BinaryFstreamOutputArchive>::value, void> madness::archive::BaseParallelArchive< Archive >::open	(	World &	world,
		const char *	filename,
		int	nwriter = `1`
	)

inline

Opens the parallel archive.

Attention: When writing to a new archive, the number of writers specified is used. When reading from an existing archive, the number of ionodes is adjusted to to be the same as the number that wrote the original archive. Presently, we don't have logic to handle reading an archive using fewer processes originally used to write it. If you want to fix this have a look in worlddc.h for the only spot that currently needs changing to make that work.

Note: The default number of I/O nodes is one and there is an arbitrary maximum of 50 set. On IBM BG/P the maximum is nproc/64.

Parameters

[in]	world	The world.
[in]	filename	Name of the file.
[in]	nwriter	The number of writers.

References madness::archive::BaseParallelArchive< Archive >::ar, madness::WorldGopInterface::broadcast(), bufsize, madness::archive::BaseParallelArchive< Archive >::exists(), madness::filename, madness::archive::BaseParallelArchive< Archive >::fname, madness::World::gop, madness::archive::BaseParallelArchive< Archive >::is_io_node(), MADNESS_CHECK, madness::archive::BaseParallelArchive< Archive >::nio, madness::World::rank(), madness::archive::BaseParallelArchive< Archive >::set_nclient(), madness::World::size(), and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::ParallelInputArchive< localarchiveT >::ParallelInputArchive(), madness::archive::ParallelOutputArchive< localarchiveT >::ParallelOutputArchive(), and test13().

◆ remove() [1/2]

template<typename Archive >

void madness::archive::BaseParallelArchive< Archive >::remove ( )

inline

Removes the files associated with the current archive.

References madness::archive::BaseParallelArchive< Archive >::fname, MADNESS_CHECK, and madness::archive::BaseParallelArchive< Archive >::world.

Referenced by madness::archive::BaseParallelArchive< Archive >::remove().

◆ remove() [2/2]

template<typename Archive >

template<typename X = Archive>

static std::enable_if_t<std::is_same<X,BinaryFstreamInputArchive>::value \|\| std::is_same<X,BinaryFstreamOutputArchive>::value, void> madness::archive::BaseParallelArchive< Archive >::remove	(	World &	world,
		const char *	filename
	)