DASH Library Runtime Interface

Functions controlling the initialization and finalization of the DASH library. More...

Functions
void	dash::init (int *argc, char ***argv)
	Initialize the DASH library and the underlying runtime system. More...
void	dash::finalize ()
	Finalize the DASH library and the underlying runtime system. More...
bool	dash::is_initialized ()
	Check whether DASH has been initialized already. More...
bool	dash::is_multithreaded ()
	Check whether DASH has been initialized with support for multi-threaded access. More...
global_unit_t	dash::myid ()
	Shortcut to query the global unit ID of the calling unit. More...
size_t	dash::size ()
	Return the number of units in the global team. More...
void	dash::barrier ()
	A global barrier involving all units. More...
void	dash::abort ()
	Immediately abort the application run. More...
void	dash::abort (int errorcode)
	Immediately abort the application run with the return value errorcode. More...

Detailed Description

Functions controlling the initialization and finalization of the DASH library.

The library has to be initialized using dash::init before any other DASH functionality can be used and should be finalized using dash::finalize before program exit.

Function Documentation

abort() [1/2]

void dash::abort

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Immediately abort the application run.

See also

dash::finalize

abort() [2/2]

void dash::abort

(

int

errorcode

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Immediately abort the application run with the return value errorcode.

See also

dash::finalize

barrier()

void dash::barrier

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

A global barrier involving all units.

See also

dash::Team::barrier

dash::Team::All

Examples:

ex.01.hello-mpi/main.cpp, ex.04.memalloc/main.cpp, ex.06.std-algo/main.cpp, ex.08.io-hdf5/main.cpp, ex.10.radixsort/main.cpp, ex.11.halo-stencil/main.cpp, and ex.11.simple-stencil/main.cpp.

Referenced by dash::Array< signal_t >::allocate(), dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::ArrayRef(), dash::Coarray< T, IndexType, Arrangement, LocalMemSpaceT >::Coarray(), dash::Coarray< T, IndexType, Arrangement, LocalMemSpaceT >::deallocate(), dash::Team::free(), dash::Team::is_member(), MyHash< Key >::MyHash(), and dash::coarray::sync_all().

finalize()

void dash::finalize

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Finalize the DASH library and the underlying runtime system.

Examples:

ex.01.hello-mpi/main.cpp, ex.01.hello/main.cpp, ex.02.array-csr/main.cpp, ex.02.array-ctors/main.cpp, ex.02.array-delayed/main.cpp, ex.02.array-local/main.cpp, ex.02.array/main.cpp, ex.03.globref/main.cpp, ex.04.memalloc/main.cpp, ex.05.min_element/main.cpp, ex.06.pattern-block-visualizer/main.cpp, ex.06.std-algo/main.cpp, ex.08.io-hdf5/main.cpp, ex.09.view-1dim/main.cpp, ex.10.radixsort/main.cpp, ex.11.halo-stencil/main.cpp, and ex.11.simple-stencil/main.cpp.

init()

void dash::init	(	int *	argc,
		char ***	argv
	)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Initialize the DASH library and the underlying runtime system.

Parameters

argc	Pointer to the argc argument to main.
argv	Pointer to the argv argument to main.

Examples:

ex.01.hello-mpi/main.cpp, ex.01.hello/main.cpp, ex.02.array-csr/main.cpp, ex.02.array-ctors/main.cpp, ex.02.array-delayed/main.cpp, ex.02.array-local/main.cpp, ex.02.array/main.cpp, ex.03.globref/main.cpp, ex.04.memalloc/main.cpp, ex.05.min_element/main.cpp, ex.06.pattern-block-visualizer/main.cpp, ex.06.std-algo/main.cpp, ex.08.io-hdf5/main.cpp, ex.09.view-1dim/main.cpp, ex.10.radixsort/main.cpp, ex.11.halo-stencil/main.cpp, and ex.11.simple-stencil/main.cpp.

Referenced by dash::util::LocalityDomain::leader_unit(), and MyHash< Key >::MyHash().

is_initialized()

bool dash::is_initialized

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Check whether DASH has been initialized already.

Returns

True if DASH has been initialized successfully. False if DASH is not initialized properly or has been finalized.

Referenced by dash::List< ElementType, LocalMemorySpace >::allocate(), dash::Array< signal_t >::allocate(), dash::Coarray< T, IndexType, Arrangement, LocalMemSpaceT >::Coarray(), dash::Coevent::Coevent(), dash::Comutex::Comutex(), dash::List< ElementType, LocalMemorySpace >::deallocate(), dash::Shared< ElementType >::init(), and dash::Shared< ElementType >::Shared().

is_multithreaded()

bool dash::is_multithreaded

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Check whether DASH has been initialized with support for multi-threaded access.

Returns

True if DASH and the underlying runtime has been compiled with support for thread-concurrent access. False otherwise.

Referenced by dash::io::hdf5::InputStream::InputStream().

myid()

global_unit_t dash::myid

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Shortcut to query the global unit ID of the calling unit.

Returns

The unit ID of the calling unit relative to dash::Team::All

See also

dash::Team::GlobalUnitID

dash::Team::All

Examples:

ex.01.hello-mpi/main.cpp, ex.01.hello/main.cpp, ex.02.array-csr/main.cpp, ex.02.array-ctors/main.cpp, ex.02.array-local/main.cpp, ex.02.array/main.cpp, ex.03.globref/main.cpp, ex.04.memalloc/main.cpp, ex.05.min_element/main.cpp, ex.06.pattern-block-visualizer/main.cpp, ex.06.std-algo/main.cpp, ex.08.io-hdf5/main.cpp, ex.09.view-1dim/main.cpp, ex.10.radixsort/main.cpp, ex.11.halo-stencil/main.cpp, and ex.11.simple-stencil/main.cpp.

Referenced by dash::equal(), dash::find_if(), dash::ShiftTilePattern< NumDimensions, Arrangement, IndexType >::global(), dash::Team::GlobalUnitID(), dash::BlockPattern< 1, Arrangement, IndexType >::is_local(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::is_local(), dash::ShiftTilePattern< NumDimensions, Arrangement, IndexType >::is_local(), dash::Team::is_member(), MyHash< Key >::MyHash(), dash::Coarray< T, IndexType, Arrangement, LocalMemSpaceT >::operator reference(), dash::reduce(), dash::coarray::sync_images(), and dash::coarray::this_image().

size()

size_t dash::size

(

)

#include </tmp/tmporruphar/dash/include/dash/Init.h>

Return the number of units in the global team.

Returns

The number of units available. -1 if DASH is not initialized (anymore).

See also

dash::Team::size

dash::Team::All

Examples:

ex.01.hello-mpi/main.cpp, ex.01.hello/main.cpp, ex.02.array-csr/main.cpp, ex.02.array-ctors/main.cpp, ex.02.array-delayed/main.cpp, ex.02.array-local/main.cpp, ex.02.array/main.cpp, ex.03.globref/main.cpp, ex.04.memalloc/main.cpp, ex.06.std-algo/main.cpp, ex.09.view-1dim/main.cpp, and ex.10.radixsort/main.cpp.

Referenced by dash::Matrix< _element_type, _rank::value, IndexType, _pattern_type >::allocate(), dash::Coarray< T, IndexType, Arrangement, LocalMemSpaceT >::Coarray(), dash::HashLocal< Key >::HashLocal(), dash::halo::StencilOperatorBoundary< Self_t >::iterator_at(), dash::LocalMatrixRef< ElementT, NumDimensions, NumDimensions, PatternT, LocalMemSpaceT >::LocalMatrixRef(), dash::CSRPattern< 1, Arrangement, IndexType >::ndim(), dash::DynamicPattern< 1, Arrangement, IndexType >::ndim(), dash::coarray::num_images(), dash::GlobHeapLocalPtr< value_type, index_type >::operator[](), dash::GlobHeapLocalPtr< value_type, index_type >::pos(), dash::ViewSpec< NumDimensions, int >::set_rank(), and dash::size().