node.h File Reference

This file contains interface to configure the intra-node execution environment. More...

#include <starneig/configuration.h>
#include <mpi.h>

Go to the source code of this file.

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

Library initialization flags
#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...
typedef unsigned	starneig_flag_t
	Library initialization flag data type.

Detailed Description

This file contains interface to configure the intra-node execution environment.

Author

Mirko Myllykoski (mirko.nosp@m.m@cs.nosp@m..umu..nosp@m.se), Umeå University

Lars Karlsson (larsk.nosp@m.@cs..nosp@m.umu.s.nosp@m.e), Umeå University

LICENSE

Copyright (c) 2019, Umeå Universitet

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.