include/moc.h File Reference

#include <stdint.h>
#include "moc_datatype.h"
#include "moc_error_codes.h"

Include dependency graph for moc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct imoc_dma_request_struct

struct imoc_issend_request_struct

struct MOC_Status_struct

Structure holding information about a received message. More...

struct moc_request_struct

Communication-Request (Handle). More...

Defines

#define MOC_ANY_TAG   1000

Indicates, in a receive, to accept a message with any tag value.

#define MOC_BCAST_TAG   250

Reserved Tag for Broadcast-Messages (MOC_Bcast).

#define MOC_PROC_NULL   1000

Specifies a rank that can be used to send or receive from no-one.

#define MOC_ANY_SOURCE   1001

Indicates, in a receive, to accept a message from any source.

#define MAX_DMA_CALL_SIZE   16384

Maximum byte-count which can be transferred by one DMA-transfer.

#define MAX_MOC_MESSAGE_SIZE   16777215

Maximum byte-count of a MOC-message.

#define MOC_MAX_ERROR_STRING   255

Maximal length of error-text.

#define MOC_VERSION   0

Major version-number of this MOC-Implementation.

#define MOC_SUBVERSION   9

Minor version-number of this MOC-Implementation.

#define MOC_MAX_PROCESSOR_NAME   4

The maximum length of the string returned by MOC_Get_processor_name.

#define MOC_COMM_NULL   0

Specifies a null communicator.

#define MOC_COMM_WORLD   1

Specifies a constant that contains all of the processes.

#define MOC_COMM_SELF   2

Specifies a constant that contains only the calling process.

#define MOC_SEND_TRESHOLD   4096

Indicates, at which message-size MOC_Send switches to synchronous send.

Typedefs

typedef struct MOC_Status_struct MOC_Status

Structure holding information about a received message.

typedef int MOC_Comm

Communicator-Handle.

typedef struct moc_request_struct MOC_Request

Communication-Request (Handle).

typedef struct
imoc_dma_request_struct imoc_dma_request

typedef struct
imoc_issend_request_struct imoc_issend_request

Functions

int MOC_Error_string (int errorcode, char *string, int *resultlen)

Returns an error-text for a given error code.

int MOC_Error_class (int errorcode, int *errorclass)

Converts an error code into an error class.

int MOC_Get_processor_name (char *name, int *resultlen)

Gets the name of the processor.

int MOC_Get_version (int *version, int *subversion)

Returns the major and minor version of this MOC-implementation.

int MOC_Get_count (MOC_Status *status, MOC_Datatype datatype, int *count)

Gets the number of received elements which is encoded in MOC_Status.

int MOC_Comm_rank (MOC_Comm comm, int *rank)

Determines the rank of the calling process in the communicator.

int MOC_Comm_size (MOC_Comm comm, int *size)

Determines the size of the group associated with a communictor.

double MOC_Wtime (void)

Returns a floating-point number of seconds, representing elapsed wall-clock time since some time in the past.

double MOC_Wtick (void)

Returns the resolution of Moc_Wtime in seconds.

int MOC_Send (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm)

Performs a blocking standard mode send operation.

int MOC_Recv (void *buf, int count, MOC_Datatype datatype, int source, int tag, MOC_Comm comm, MOC_Status *status)

Performs a blocking standard mode receive operation.

int MOC_Probe (int source, int tag, MOC_Comm comm, MOC_Status *status)

Waits till a message is received and returns information without actually receiving the message.

int MOC_Iprobe (int source, int tag, MOC_Comm comm, int *flag, MOC_Status *status)

Tests if a message is available and returns information without actually receiving the message.

int MOC_Ssend (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm)

Performs a blocking synchronous mode send operation.

int MOC_Bsend (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm)

Performs a blocking buffered mode send operation.

int MOC_Sendrecv (void *sendbuf, int sendcount, MOC_Datatype sendtype, int dest, int sendtag, void *recvbuf, int recvcount, MOC_Datatype recvtype, int source, int recvtag, MOC_Comm comm, MOC_Status *status)

Execute a blocking send and receive operation.

int MOC_Sendrecv_replace (void *buf, int count, MOC_Datatype datatype, int dest, int sendtag, int source, int recvtag, MOC_Comm comm, MOC_Status *status)

Execute a blocking send and receive.

int MOC_ISend (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm, MOC_Request *request)

Performs a non-blocking standard mode send operation.

int MOC_ISsend (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm, MOC_Request *request)

Performs a non-blocking synchronous mode send operation.

int MOC_Test (MOC_Request *request, int *flag, MOC_Status *status)

Tests, if a non-blocking communication has been completed.

int MOC_Wait (MOC_Request *request, MOC_Status *status)

Wait till a non-blocking communication has been completed.

int MOC_Bcast (void *buffer, int count, MOC_Datatype datatype, int root, MOC_Comm comm)

Broadcasts a message from the process with rank "root" to all other processes of the group.

int MOC_Barrier (MOC_Comm comm)

Blocks the caller until all processes in the communicator have called it; that is, the call returns at any process only after all members of the communicator have entered the call.

PPU & SPU

int MOC_Finalize (void)

Terminates MPI execution environment.

Define Documentation

#define MAX_DMA_CALL_SIZE 16384

Maximum byte-count which can be transferred by one DMA-transfer.

Definition at line 33 of file moc.h.

Referenced by IMOC_get_data(), IMOC_iget_data(), IMOC_iput_data(), and IMOC_put_data().

#define MAX_MOC_MESSAGE_SIZE 16777215

Maximum byte-count of a MOC-message.

It's only the theoretical size, because practically the SPU's local-stores can only hold much fewer bytes.

Definition at line 39 of file moc.h.

#define MOC_ANY_SOURCE 1001

Indicates, in a receive, to accept a message from any source.

Definition at line 28 of file moc.h.

Referenced by IMOC_get_entry().

#define MOC_ANY_TAG 1000

Indicates, in a receive, to accept a message with any tag value.

Definition at line 13 of file moc.h.

Referenced by IMOC_get_entry().

#define MOC_BCAST_TAG 250

Reserved Tag for Broadcast-Messages (MOC_Bcast).

Definition at line 18 of file moc.h.

Referenced by MOC_Bcast().

#define MOC_PROC_NULL 1000

Specifies a rank that can be used to send or receive from no-one.

Definition at line 23 of file moc.h.

Typedef Documentation

typedef struct imoc_dma_request_struct imoc_dma_request

typedef struct imoc_issend_request_struct imoc_issend_request


Data Structures
struct	imoc_dma_request_struct
struct	imoc_issend_request_struct
struct	MOC_Status_struct
	Structure holding information about a received message. More...
struct	moc_request_struct
	Communication-Request (Handle). More...
Defines
#define	MOC_ANY_TAG 1000
	Indicates, in a receive, to accept a message with any tag value.
#define	MOC_BCAST_TAG 250
	Reserved Tag for Broadcast-Messages (MOC_Bcast).
#define	MOC_PROC_NULL 1000
	Specifies a rank that can be used to send or receive from no-one.
#define	MOC_ANY_SOURCE 1001
	Indicates, in a receive, to accept a message from any source.
#define	MAX_DMA_CALL_SIZE 16384
	Maximum byte-count which can be transferred by one DMA-transfer.
#define	MAX_MOC_MESSAGE_SIZE 16777215
	Maximum byte-count of a MOC-message.
#define	MOC_MAX_ERROR_STRING 255
	Maximal length of error-text.
#define	MOC_VERSION 0
	Major version-number of this MOC-Implementation.
#define	MOC_SUBVERSION 9
	Minor version-number of this MOC-Implementation.
#define	MOC_MAX_PROCESSOR_NAME 4
	The maximum length of the string returned by MOC_Get_processor_name.
#define	MOC_COMM_NULL 0
	Specifies a null communicator.
#define	MOC_COMM_WORLD 1
	Specifies a constant that contains all of the processes.
#define	MOC_COMM_SELF 2
	Specifies a constant that contains only the calling process.
#define	MOC_SEND_TRESHOLD 4096
	Indicates, at which message-size MOC_Send switches to synchronous send.
Typedefs
typedef struct MOC_Status_struct	MOC_Status
	Structure holding information about a received message.
typedef int	MOC_Comm
	Communicator-Handle.
typedef struct moc_request_struct	MOC_Request
	Communication-Request (Handle).

typedef struct imoc_dma_request_struct	imoc_dma_request
typedef struct imoc_issend_request_struct	imoc_issend_request
Functions
int	MOC_Error_string (int errorcode, char string, int resultlen)
	Returns an error-text for a given error code.
int	MOC_Error_class (int errorcode, int *errorclass)
	Converts an error code into an error class.
int	MOC_Get_processor_name (char name, int resultlen)
	Gets the name of the processor.
int	MOC_Get_version (int version, int subversion)
	Returns the major and minor version of this MOC-implementation.
int	MOC_Get_count (MOC_Status status, MOC_Datatype datatype, int count)
	Gets the number of received elements which is encoded in MOC_Status.
int	MOC_Comm_rank (MOC_Comm comm, int *rank)
	Determines the rank of the calling process in the communicator.
int	MOC_Comm_size (MOC_Comm comm, int *size)
	Determines the size of the group associated with a communictor.
double	MOC_Wtime (void)
	Returns a floating-point number of seconds, representing elapsed wall-clock time since some time in the past.
double	MOC_Wtick (void)
	Returns the resolution of Moc_Wtime in seconds.
int	MOC_Send (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm)
	Performs a blocking standard mode send operation.
int	MOC_Recv (void buf, int count, MOC_Datatype datatype, int source, int tag, MOC_Comm comm, MOC_Status status)
	Performs a blocking standard mode receive operation.
int	MOC_Probe (int source, int tag, MOC_Comm comm, MOC_Status *status)
	Waits till a message is received and returns information without actually receiving the message.
int	MOC_Iprobe (int source, int tag, MOC_Comm comm, int flag, MOC_Status status)
	Tests if a message is available and returns information without actually receiving the message.
int	MOC_Ssend (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm)
	Performs a blocking synchronous mode send operation.
int	MOC_Bsend (void *buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm)
	Performs a blocking buffered mode send operation.
int	MOC_Sendrecv (void sendbuf, int sendcount, MOC_Datatype sendtype, int dest, int sendtag, void recvbuf, int recvcount, MOC_Datatype recvtype, int source, int recvtag, MOC_Comm comm, MOC_Status *status)
	Execute a blocking send and receive operation.
int	MOC_Sendrecv_replace (void buf, int count, MOC_Datatype datatype, int dest, int sendtag, int source, int recvtag, MOC_Comm comm, MOC_Status status)
	Execute a blocking send and receive.
int	MOC_ISend (void buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm, MOC_Request request)
	Performs a non-blocking standard mode send operation.
int	MOC_ISsend (void buf, int count, MOC_Datatype datatype, int dest, int tag, MOC_Comm comm, MOC_Request request)
	Performs a non-blocking synchronous mode send operation.
int	MOC_Test (MOC_Request request, int flag, MOC_Status *status)
	Tests, if a non-blocking communication has been completed.
int	MOC_Wait (MOC_Request request, MOC_Status status)
	Wait till a non-blocking communication has been completed.
int	MOC_Bcast (void *buffer, int count, MOC_Datatype datatype, int root, MOC_Comm comm)
	Broadcasts a message from the process with rank "root" to all other processes of the group.
int	MOC_Barrier (MOC_Comm comm)
	Blocks the caller until all processes in the communicator have called it; that is, the call returns at any process only after all members of the communicator have entered the call.
PPU & SPU
int	MOC_Finalize (void)
	Terminates MPI execution environment.