Streams Manipulation

Utilities for streams manipulation. More...

Data Structures
struct	TMP_VMPI_Stream_desc
	Temporary stream description struct. More...

Functions
int	VMPI_Enabled ()
	indicates if VMPI is enabled More...
int	VMPI_Init (int *argc, char ***argv)
	Initializes VMPI. More...
int	VMPI_Release ()
	Releases VMPI. More...
int	VMPI_Stream_init (VMPI_Stream *st, size_t block_size, VMPI_Stream_load_balance lb)
	Initializes a stream should be called before any *open call. More...
int	VMPI_Stream_open (VMPI_Stream *st, int dest, char *mode)
	Open a stream to dest rank, dest should do the symmetrical call. More...
int	VMPI_Stream_open_map (VMPI_Stream *st, VMPI_Map *map, char *mode)
	Open a stream according to a mapping. More...
int	VMPI_Stream_close (VMPI_Stream *st)
	Closes a stream and sends EOF to remote endpoints. More...
int	VMPI_Stream_join (VMPI_Stream *dest, VMPI_Stream *src)
	Join two streams in the same set. More...
int	VMPI_Stream_push_stream (VMPI_Stream *st, int dest, int remote_tag, int local_tag, VMPI_Stream_mode mode)
	pushes a stream More...

Detailed Description

Utilities for streams manipulation.

Function Documentation

int VMPI_Enabled

(

)

indicates if VMPI is enabled

Returns

1 if enabled, 0 otherwise

Definition at line 50 of file VMPI.c.

Here is the caller graph for this function:

int VMPI_Init	(	int *	argc,
		char ***	argv
	)

Initializes VMPI.

Parameters

argc
argv

Returns

a VMPI_Return_Status

Definition at line 758 of file VMPI.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int VMPI_Release

(

)

Releases VMPI.

Returns

a VMPI_Return_Status

Definition at line 840 of file VMPI.c.

Here is the caller graph for this function:

int VMPI_Stream_close

(

VMPI_Stream *

st

)

Closes a stream and sends EOF to remote endpoints.

Parameters

st	target stream

Returns

0 on success, 1 if PMPI_Send fails, 2 if malloc fails

Definition at line 316 of file VMPI_stream.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int VMPI_Stream_init	(	VMPI_Stream *	st,
		size_t	block_size,
		VMPI_Stream_load_balance	lb
	)

Initializes a stream should be called before any *open call.

Parameters

st	target stream
block_size	size of a data block
lb	load balancing policy

Returns

0 on success

Definition at line 26 of file VMPI_stream.c.

Here is the caller graph for this function:

int VMPI_Stream_join	(	VMPI_Stream *	dest,
		VMPI_Stream *	src
	)

Join two streams in the same set.

Parameters

dest	the destination stream (where src will be joined)
src	the source stream (the stream to be joined into dest)

Returns

?

Warning

Afert this call the src handler shall not be used anymore

Todo:

Clean release of src

Definition at line 187 of file VMPI_stream.c.

Here is the call graph for this function:

int VMPI_Stream_open	(	VMPI_Stream *	st,
		int	dest,
		char *	mode
	)

Open a stream to dest rank, dest should do the symmetrical call.

Parameters

st	target stream
dest	target rank
mode	read, write or both

Returns

0 on success

Definition at line 221 of file VMPI_stream.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int VMPI_Stream_open_map	(	VMPI_Stream *	st,
		VMPI_Map *	map,
		char *	mode
	)

Open a stream according to a mapping.

Parameters

st	target stream
map	mapping to refer to
mode	read, write or both

Returns

0 on success

Definition at line 303 of file VMPI_stream.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int VMPI_Stream_push_stream	(	VMPI_Stream *	st,
		int	dest,
		int	remote_tag,
		int	local_tag,
		VMPI_Stream_mode	mode
	)

pushes a stream

Parameters

st	the stream to push
dest	the task where to push the stream
remote_tag	the tag of the remote task
local_tag	the local tag
mode	the mode of the stream

Returns

0 on success, 2 on allocation error

Todo:

[DOC] Explainations on VMPI_Stream_push_stream...

Definition at line 58 of file VMPI_stream.c.

Here is the caller graph for this function: