Launcher interface

This is the launcher interface, the high level nmad interface used to launch sessions. More...

Files
file	nm_launcher_interface.h
	PUK_VECT_TYPE (nm_launcher_rank, int)
	PUK_VECT_TYPE (nm_launcher_subgroup, int)
static int	nm_launcher_init (int *argc, char **argv)
	Initializes nmad.
int	nm_launcher_exit (void)
	Cleans session.
int	nm_launcher_get_rank (int *rank)
	Returns process rank.
int	nm_launcher_get_size (int *size)
	Returns the number of nodes.
int	nm_launcher_get_gate (int dest, nm_gate_t *gate)
	Returns the gate for the process dest.
int	nm_launcher_get_dest (nm_gate_t p_gate, int *dest)
	Returns the dest rank for the given gate.
int	nm_launcher_get_topology (struct nm_launcher_rank_vect_s *p_ranks, struct nm_launcher_subgroup_vect_s *p_subgroups, int *n_subgroups)
	Returns topology.
void	nm_launcher_abort (int rc)
	Abort all processes.

Detailed Description

This is the launcher interface, the high level nmad interface used to launch sessions.

Function Documentation

nm_launcher_abort()

void nm_launcher_abort

(

int

rc

)

Abort all processes.

nm_launcher_exit()

int nm_launcher_exit

(

void

)

Cleans session.

Returns NM_ESUCCESS or EXIT_FAILURE.

Examples

nm_launcher_mini.c, nm_rpc_hello.c, and nm_sr_custom_data.c.

Referenced by nm_examples_exit().

nm_launcher_get_dest()

int nm_launcher_get_dest	(	nm_gate_t	p_gate,
		int *	dest
	)

Returns the dest rank for the given gate.

nm_launcher_get_gate()

int nm_launcher_get_gate	(	int	dest,
		nm_gate_t *	gate
	)

Returns the gate for the process dest.

Examples

nm_rpc_hello.c, and nm_sr_custom_data.c.

Referenced by nm_examples_init_topo(), and nm_launcher_self_gate().

nm_launcher_get_rank()

int nm_launcher_get_rank

(

int *

rank

)

Returns process rank.

Examples

nm_launcher_mini.c, nm_rpc_hello.c, and nm_sr_custom_data.c.

Referenced by nm_examples_init_topo(), and nm_launcher_self_gate().

nm_launcher_get_size()

int nm_launcher_get_size

(

int *

size

)

Returns the number of nodes.

Examples

nm_launcher_mini.c, nm_mcast_basic.c, nm_rpc_hello.c, and nm_sr_custom_data.c.

Referenced by nm_examples_init_topo().

nm_launcher_get_topology()

int nm_launcher_get_topology	(	struct nm_launcher_rank_vect_s *	p_ranks,
		struct nm_launcher_subgroup_vect_s *	p_subgroups,
		int *	n_subgroups
	)

Returns topology.

Parameters

[in]	p_ranks	ranks to consider for topology
[out]	p_subgroups	sub-group index for the rank at the same index in p_ranks

Returns

-NM_ENOTIMPL if launcher does not support topology; NM_ESUCCESS otherwise.

Note

p_leaders & p_local are allocated and initialized by the caller.

nm_launcher_init()

static int nm_launcher_init ( int *  argc, char **  argv  )

inlinestatic

Initializes nmad.

Examples

nm_launcher_mini.c, nm_rpc_hello.c, and nm_sr_custom_data.c.

Definition at line 74 of file nm_launcher_interface.h.

References nm_abi_config_check(), and nm_launcher_init_nocheck().

Referenced by nm_examples_init_topo().

Here is the call graph for this function:

PUK_VECT_TYPE() [1/2]

PUK_VECT_TYPE	(	nm_launcher_rank	,
		int
	)

PUK_VECT_TYPE() [2/2]

PUK_VECT_TYPE	(	nm_launcher_subgroup	,
		int
	)