Intra-node execution environment

Interface to configure the intra-node execution environment. More...

Functions
void	starneig_node_init (int cores, int gpus, starneig_flag_t flags)
	Initializes the intra-node execution environment. More...
int	starneig_node_initialized ()
	Checks whether the intra-node execution environment is initialized. More...
int	starneig_node_get_cores ()
	Returns the number of cores (threads) per MPI rank. More...
void	starneig_node_set_cores (int cores)
	Changes the number of CPUs cores (threads) to use per MPI rank. More...
int	starneig_node_get_gpus ()
	Returns the number of GPUs per MPI rank. More...
void	starneig_node_set_gpus (int gpus)
	Changes the number of GPUs to use per MPI rank. More...
void	starneig_node_finalize ()
	Deallocates resources associated with the intra-node configuration.

Library initialization flags
typedef unsigned	starneig_flag_t
	Library initialization flag data type.
#define	STARNEIG_DEFAULT   0x0
	Default initialization flag. More...
#define	STARNEIG_HINT_SM   0x0
	Initializes the library for shared memory computation. More...
#define	STARNEIG_HINT_DM   0x1
	Initializes the library for distributed memory computation. More...
#define	STARNEIG_FXT_DISABLE   0x2
	Disables FXT traces. More...
#define	STARNEIG_AWAKE_WORKERS   0x4
	Keeps worker threads awake. More...
#define	STARNEIG_AWAKE_MPI_WORKER   0x8
	Keeps StarPU-MPI communication thread awake. More...
#define	STARNEIG_FAST_DM   (STARNEIG_HINT_DM | STARNEIG_AWAKE_WORKERS | STARNEIG_AWAKE_MPI_WORKER)
	Enables fast StarPU-MPI mode. More...
#define	STARNEIG_NO_VERBOSE   0x10
	Disables verbose messages. More...
#define	STARNEIG_NO_MESSAGES   (STARNEIG_NO_VERBOSE | 0x20)
	Disables messages. More...

Distributed memory
void	starneig_mpi_set_comm (MPI_Comm comm)
	Sets a MPI communicator for the library. More...
MPI_Comm	starneig_mpi_get_comm ()
	Returns the library MPI communicator. More...

Detailed Description

Interface to configure the intra-node execution environment.

Macro Definition Documentation

STARNEIG_DEFAULT

#define STARNEIG_DEFAULT   0x0

Default initialization flag.

The library defaults to the shared memory mode.

STARNEIG_HINT_SM

#define STARNEIG_HINT_SM   0x0

Initializes the library for shared memory computation.

The library will automatically reconfigure itself for distributed memory computation.

Examples:

gep_sm_eigenvectors.c, gep_sm_full_chain.c, sep_sm_eigenvectors.c, and sep_sm_full_chain.c.

STARNEIG_HINT_DM

#define STARNEIG_HINT_DM   0x1

Initializes the library for distributed memory computation.

The library will automatically reconfigure itself for shared memory computation.

Examples:

sep_dm_full_chain.c.

STARNEIG_FXT_DISABLE

#define STARNEIG_FXT_DISABLE   0x2

Disables FXT traces.

This flag does not work reliably with all StarPU versions.

STARNEIG_AWAKE_WORKERS

#define STARNEIG_AWAKE_WORKERS   0x4

Keeps worker threads awake.

Keeps the StarPU worker threads awake between interface function calls.

Examples:

gep_sm_full_chain.c.

STARNEIG_AWAKE_MPI_WORKER

#define STARNEIG_AWAKE_MPI_WORKER   0x8

Keeps StarPU-MPI communication thread awake.

Keeps the StarPU-MPI communication thread awake between interface function calls.

STARNEIG_FAST_DM

#define STARNEIG_FAST_DM   (STARNEIG_HINT_DM | STARNEIG_AWAKE_WORKERS | STARNEIG_AWAKE_MPI_WORKER)

Enables fast StarPU-MPI mode.

Keeps the worker threads and StarPU-MPI communication thread awake between interface function calls.

Examples:

gep_dm_full_chain.c.

STARNEIG_NO_VERBOSE

#define STARNEIG_NO_VERBOSE   0x10

Disables verbose messages.

Disables all additional verbose messages.

STARNEIG_NO_MESSAGES

#define STARNEIG_NO_MESSAGES   (STARNEIG_NO_VERBOSE | 0x20)

Disables messages.

Disables all messages (including verbose).

Function Documentation

starneig_node_init()

void starneig_node_init	(	int	cores,
		int	gpus,
		starneig_flag_t	flags
	)

Initializes the intra-node execution environment.

The interface function initializes StarPU (and cuBLAS) and pauses all worker The cores argument specifies the total number of used CPU cores. In distributed memory mode, one CPU core is automatically allocated for the StarPU-MPI communication thread. One or more CPU cores are automatically allocated for GPU devices.

Parameters

[in]	cores	The number of cores (threads) to use per MPI rank. Can be set to -1 in which case the library determines the value.
[in]	gpus	The number of GPUs to use per MPI rank. Can be set to -1 in which case the library determines the value.
[in]	flags	Initialization flags.

Examples:

gep_dm_full_chain.c, gep_sm_eigenvectors.c, gep_sm_full_chain.c, sep_dm_full_chain.c, sep_sm_eigenvectors.c, and sep_sm_full_chain.c.

starneig_node_initialized()

int starneig_node_initialized

(

)

Checks whether the intra-node execution environment is initialized.

Returns

Non-zero if the environment is initialized, 0 otherwise.

starneig_node_get_cores()

int starneig_node_get_cores

(

)

Returns the number of cores (threads) per MPI rank.

Returns

The number of cores (threads) per MPI rank.

starneig_node_set_cores()

void starneig_node_set_cores

(

int

cores

)

Changes the number of CPUs cores (threads) to use per MPI rank.

Parameters

cores

The number of CPUs to use per MPI rank.

starneig_node_get_gpus()

int starneig_node_get_gpus

(

)

Returns the number of GPUs per MPI rank.

Returns

The number of GPUs per MPI rank.

starneig_node_set_gpus()

void starneig_node_set_gpus

(

int

gpus

)

Changes the number of GPUs to use per MPI rank.

Parameters

gpus	The number of GPUs to use per MPI rank.

starneig_mpi_set_comm()

void starneig_mpi_set_comm

(

MPI_Comm

comm

)

Sets a MPI communicator for the library.

Should be called before the starneig_node_init() interface function.

Parameters

[in]

comm

The library MPI communicator.

starneig_mpi_get_comm()

MPI_Comm starneig_mpi_get_comm

(

)

Returns the library MPI communicator.

Returns

The library MPI communicator.