NewMadeleine

Documentation

Launcher interface

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

Files

file  nm_launcher_interface.h
 
static int nm_launcher_init (int *argc, char **argv)
 Initializes nmad. More...
 
int nm_launcher_exit (void)
 Cleans session. More...
 
int nm_launcher_get_rank (int *rank)
 Returns process rank. More...
 
int nm_launcher_get_size (int *size)
 Returns the number of nodes. More...
 
int nm_launcher_session_open (nm_session_t *p_session, const char *label)
 Open a new session. More...
 
int nm_launcher_session_close (nm_session_t p_session)
 close a session More...
 
int nm_launcher_get_gate (int dest, nm_gate_t *gate)
 Returns the gate for the process dest. More...
 
int nm_launcher_get_dest (nm_gate_t p_gate, int *dest)
 Returns the dest rank for the given gate. More...
 
void nm_launcher_abort (int rc)
 Abort all processes. More...
 

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

Here is the caller graph for this function:

◆ 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().

Here is the caller graph for this function:

◆ 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().

Here is the caller graph for this function:

◆ 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().

Here is the caller graph for this function:

◆ 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 67 of file nm_launcher_interface.h.

References nm_abi_config_capture(), and nm_launcher_init_checked().

Referenced by nm_examples_init_topo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nm_launcher_session_close()

int nm_launcher_session_close ( nm_session_t  p_session)

close a session

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

Referenced by nm_examples_exit().

Here is the caller graph for this function:

◆ nm_launcher_session_open()

int nm_launcher_session_open ( nm_session_t p_session,
const char *  label 
)

Open a new session.

All nodes must give the same string for 'label'

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

Referenced by nm_examples_init_topo().

Here is the caller graph for this function: