+

Data Structures

Here are the data structures with brief descriptions: + + + + + + + + + + + + +

error_strings_struct	Error-Strings structure
imoc_dma_request_struct
imoc_issend_request_struct
moc_internal_buffer_node_struct	Node of linked list holding information about allocated buffer-space
moc_message_envelope_struct	Message-envelope structure
moc_message_status_struct	Message-status structure
moc_node_handle_ppu_struct	Node-handle structure
moc_node_handle_spu_struct	Node-handle structure
moc_process_struct	Process-information structure
moc_request_struct	Communication-Request (Handle)
moc_spu_thread_struct	SPU-Thread structure
MOC_Status_struct	Structure holding information about a received message

+


Functions
int	MOC_Test_data (MOC_Request request, int flag)
	Tests if a MOC_IGet_data or IMOC_IPut_data is completed.


Defines
SPU-only
#define	MOC_LONG ((MOC_Datatype)32+2)
	C-Datatype long.
#define	MOC_UNSIGNED_LONG ((MOC_Datatype)32+3)
	C-Datatype unsigned long.
#define	MOC_VEC_ULLONG2 ((MOC_Datatype)128+0)
	Cell-specific Datatype vector unsigned long long (vec_ullong2).
#define	MOC_VEC_LLONG2 ((MOC_Datatype)128+1)
	Cell-specific Datatype vector signed long long (vec_llong2).
#define	MOC_VEC_DOUBLE2 ((MOC_Datatype)128+2)
	Cell-specific Datatype vector double (vec_double2).


Functions
SPU-only
int	MOC_Init (unsigned long long argp, int length, void *buffer)
	Initialize the MPI execution environment.


Modules
	Return Status
	Receiving operations return a status-object holding information about the message.
	Datatypes
	Datatypes supported by MOC.
	Synchronous Communication
	Direct blocking sending of messages without any intermediate buffer.
	Buffered Communication
	Blocking sending of messages with the use of an intermediate buffer.
	Send-Receive
	The send-receive operations combine in one call the sending of a message to one destination and the receiving of another message, from another process.
	Non-Blocking Communication
	Non-blocking sending and receiving messages.
Defines
#define	MOC_SEND_TRESHOLD 4096
	Indicates, at which message-size MOC_Send switches to synchronous send.
Functions
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_Iprobe	(	int	source,
		int	tag,
		MOC_Comm	comm,
		int *	flag,
		MOC_Status *	status
	)

	source	in source of message
	tag	in message-tag
	comm	in communicator
	flag	out boolean value telling if a message is available
	status	out status-object holding information about message

	MOC_SUCCESS	No error; MPI routine completed successfully.
	...	error-code

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

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

	buf	inout Buffer into which data should be stored
	count	in Number of elements in receive buffer (not equal to actual byte-value)
	datatype	in Datatype of each receive buffer element
	source	in Rank of source
	tag	in Tag of message
	comm	in Communicator of message
	status	inout Object holding status-information (has to be allocated by user)

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

	buf	in Pointer to buffer where data is stored
	count	in Number of elements to be send (not equal to actual byte-value)
	datatype	in Type of elements to be send
	dest	in Rank of receiving process
	tag	in Tag of message
	comm	in communicator of message


Data Fields
uint8_t	type
	Process-type (SPU or PPU).
uint8_t	reserved [7]
	reserved
uint64_t	inbox_queue_base
	effective base-address of message-queues
uint64_t	stat_array_base
	effective base-address of message-status-array
uint64_t	ps_base
	effective base-address of problem-state (Signals, mailboxes, .


Functions
int	moc_tag_reserve (unsigned int speid)
	Reserves a tag on the ppu, for communication with a given spu.
int	moc_tag_release (unsigned int speid, int tag)
	Releases a reserved tag.
Variables
static unsigned short	tags [8]


Functions
double	MOC_Wtime (void)
	Returns a floating-point number of seconds, representing elapsed wall-clock time since some time in the past.


Defines
#define	IMOC_BARRIER_TAG 1
Functions
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.


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.


Data Fields
uint8_t	rank
	rank of SPU-thread
pthread_t	pthread
	PThread-handle <.
spe_context_ptr_t	speid
	SPE-Context.
spe_stop_info_t	stop_info
	Error-Information.
uint32_t	spe_entry_adress
	Spe-entry-address.
void *	argp
	effective address of user-defined information in main-memory
void *	envp
	Pointer to environment information.
void *	buffer_base
	base-address of the SPU-Thread's buffer
uint32_t	buffer_size
	size of the SPU-Thread's buffer
uint64_t	ls_base
	Effective Basis-Address of SPU's local-storage.
uint32_t	queue_base_in_ls
	Address of message-queue in SPU's local-storage.
uint32_t	status_base_in_ls
	Address of status-array in SPU's local-storage.


Functions
int	IMOC_iget_data (void target, uint64_t source, uint32_t size, uint32_t dest, imoc_dma_request request)
	Internal wrapper-function for a non-blocking DMA-get operation.


Functions
int	IMOC_test_dma (imoc_dma_request request, int flag)
	Tests if a IMOC_iget_data or IMOC_iput_data is completed.

	comm	in commicator-handle
	rank	out rank of the calling process in group of comm

	MOC_SUCCESS	No error; MPI routine completed successfully.
	MOC_ERR_COMM	Invalid communicator. A common error is to use a null communicator in a call.

	comm	in commicator-handle
	size	out number of processes in the group of comm


Modules
	Communicator Management
	Funktions for managing communicators.


Functions
int	MOC_Wait_data (MOC_Request *request)
	Waits till a MOC_IGet_data or IMOC_IPut_data is completed.


Functions
int	MOC_Set_buffer_size (uint32_t size)
	Sets the size of the buffer used for buffered communication.

Data Structures

Summary & Conclusions

src/ppu/dma/moc_dma-test_ppu.c File Reference

Functions

include/spu/moc_datatype_spu.h File Reference

Defines

include/spu/moc.h File Reference

Functions

src/ppu/internal/dma/imoc_dma-tags_ppu.c

src/spu/internal/dma/imoc_dma-iput_spu.c

Point-to-Point Communication + +[End-User Documentation] +

Detailed Description

Modules

Defines

Functions

Define Documentation

Function Documentation

src/ppu/internal/imoc_core_ppu.c

include/internal/imoc_macros.h

include/moc_datatype.h

moc_process_struct Struct Reference + +[Implementation-Core] +

Detailed Description

Data Fields

Field Documentation

src/ppu/internal/dma/imoc_dma-tags_ppu.c File Reference

Functions

Variables

Variable Documentation

src/spu/system/moc_wtime_spu.c File Reference

Functions

include/spu/moc_dma_spu.h

Groups, Context and Communicators + +[Developer Documentation] +

src/noarch/internal/communication/imoc_get_free_entry.c

src/ppu/system/moc_finalize_ppu.c

src/ppu/communication/moc_barrier_ppu.c File Reference

Defines

Functions

Define Documentation

include/moc.h File Reference

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

src/noarch/communication/moc_probe.c File Reference

Functions

moc_spu_thread_struct Struct Reference + +[SPU-Thread Management] +

Detailed Description

Data Fields

Field Documentation

Error-Handling + +[Environmental Management] +

Detailed Description

Data Structures

PPU-only

SPU-only

Typedefs

Define Documentation

Typedef Documentation

Variable Documentation

src/ppu/internal/dma/imoc_dma-iget_ppu.c File Reference

Functions

src/spu/internal/dma/imoc_dma-test_spu.c File Reference

Functions

Communicator Management + +[Groups, Context and Communicators] +

Detailed Description

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation

src/noarch/system/moc_get_count.c

Groups, Context and Communicators + +[End-User Documentation] +

Detailed Description

Modules

src/spu/system/moc_get_proc_name_spu.c File Reference

Functions

src/ppu/communication/moc_ssend_ppu.c File Reference

Functions

Point-to-Point Communication
+ +[End-User Documentation] +

moc_process_struct Struct Reference
+ +[Implementation-Core] +

Groups, Context and Communicators
+ +[Developer Documentation] +

moc_spu_thread_struct Struct Reference
+ +[SPU-Thread Management] +

Error-Handling
+ +[Environmental Management] +

Communicator Management
+ +[Groups, Context and Communicators] +

Groups, Context and Communicators
+ +[End-User Documentation] +

Environmental Management
+ +[Developer Documentation] +

Buffered Communication
+ +[Blocking Communication] +

DMA-Helper Functions
+ +[Point-to-Point Communication] +

Send-Receive
+ +[Point-to-Point Communication] +

Test-Macros
+ +[Implementation-Core] +

Timers and Synchronization
+ +[Environmental Management] +

Buffer-Management
+ +[Buffered Communication] +


Modules
	Startup & Shutdown
	Internals about the startup of the execution-environment and SPU-Thread-Management.
	Error-Handling
	This section deals with error-messages.
	Timers and Synchronization
	Internals about Time.


Functions
int	MOC_Translate_EA_to_LS (uint64_t ea, int rank, uint32_t *ls)
	Translates an effective-address of a SPU into the corresponding local-store address.


Defines
#define	IMOC_TEST_COMM_SEND(comm)
	Tests if invalid communicator in a send-operation.
#define	IMOC_TEST_COMM_RECV(comm)
	Tests if invalid communicator in a recv-operation.
#define	IMOC_TEST_TAG_SEND(tag)
	Tests if invalid tag in a send-operation.
#define	IMOC_TEST_TAG_RECV(tag)
	Tests if invalid tag in a recv-operation.
#define	IMOC_TEST_RANK(rank)
	Tests if invalid rank.
#define	IMOC_TEST_RANK_RECV(rank)
	Tests if invalid rank in a recv-operation.
#define	IMOC_TEST_BYTECOUNT(count)
	Tests if invalid byte-count in a recv-operation.
#define	IMOC_TEST_BUFFER(buf)
	Tests if invalid buffer-pointer.
#define	IMOC_TEST_PROC_NULL(rank)
	Tests if rank is MOC_PROC_NULL and returns with MOC_SUCCESS itself.
#define	IMOC_TEST_PROC_SELF(proc)
	Tests if rank is own rank and returns with MOC_SUCCESS itself.
#define	IMOC_TEST_ALIGNMENT(address)
	Tests if address is 16-byte aligned.
PPU & SPU
#define	IMOC_EA_REMOTE_QUEUE(proc) ( (proc > node_handle.rank) ? node_handle.moc_process_list[proc].inbox_queue_base+sizeof(moc_message_envelope_t)node_handle.queue_sizenode_handle.rank : node_handle.moc_process_list[proc].inbox_queue_base+sizeof(moc_message_envelope_t)node_handle.queue_size(node_handle.rank-1) )
	Effective base-address of own remote queue at node 'rank'.
#define	IMOC_LOCAL_QUEUE(proc) ( (proc < node_handle.rank) ? node_handle.message_queue_base+node_handle.queue_size(proc) : node_handle.message_queue_base+node_handle.queue_size(proc-1) )
	Effective Base-Address of local queue responsible for node 'rank'.
#define	IMOC_EA_REMOTE_QUEUE_ENTRY(proc, index) ( (proc > node_handle.rank) ? node_handle.moc_process_list[proc].inbox_queue_base+sizeof(moc_message_envelope_t)node_handle.queue_sizenode_handle.rank+sizeof(moc_message_envelope_t)(index) : node_handle.moc_process_list[proc].inbox_queue_base+sizeof(moc_message_envelope_t)node_handle.queue_size(node_handle.rank-1)+sizeof(moc_message_envelope_t)(index) )
	Effective base-address of own remote queue-entry at node 'rank'.
#define	IMOC_LOCAL_QUEUE_ENTRY(proc, index) ( (proc < node_handle.rank) ? node_handle.message_queue_base+node_handle.queue_size(proc)+(index) : node_handle.message_queue_base+node_handle.queue_size(proc-1)+(index) )
	Effective Base-Address of local queue-entry responsible for node 'rank'.
#define	IMOC_EA_REMOTE_STATUS_ENTRY(id, rank) ( node_handle.moc_process_list[rank].stat_array_base+sizeof(moc_message_status_t)*(id) )
	Effective Address of remote status-array entry at node 'rank'.


Functions
moc_internal_buffer_node_t *	__attribute__ ((always_inline))
	void bmalloc_print_nodes() { if (!bmalloc_first_node) printf("No nodes in list\n"); else { int z = 0; moc_internal_buffer_node_t* t; for (t = bmalloc_first_node; t != 0; t = t->next_node) { printf( "Node %i: offset %u - size %u - valid %i - mid %u\n", z, node_handle.status_array_base[ t->mid ].buffer_offset, node_handle.status_array_base[ t->mid ].message_size, node_handle.status_array_base[ t->mid ].flags.bits.buffer_used, t->mid ); z++; } } }
uint64_t	IMOC_bmalloc (uint32_t size, uint8_t mid)
	Allocate buffer-space.
Variables
moc_internal_buffer_node_t *	bmalloc_first_node = 0
	Pointer to first entry of linked-list.


Modules
	Buffer-Management
	This section shows how the buffer used for buffered communication is managed.


PPU-only
int	IMOC_get_data (void *target, uint64_t source, uint32_t size, int dest)
	Internal wrapper-function for a blocking DMA-get operation.
int	IMOC_put_data (void *source, uint64_t target, uint32_t size, int dest)
	Internal wrapper-function for a blocking DMA-put operation.
int	IMOC_iget_data (void target, uint64_t source, uint32_t size, uint32_t dest, imoc_dma_request request)
	Internal wrapper-function for a non-blocking DMA-get operation.
int	IMOC_iput_data (void source, uint64_t target, uint32_t size, uint32_t dest, imoc_dma_request request)
	Internal wrapper-function for a non-blocking DMA-put operation.
int	IMOC_wait_dma (imoc_dma_request *request)
	Waits till a IMOC_iget_data or IMOC_iput_data is completed.
int	IMOC_test_dma (imoc_dma_request request, int flag)
	Tests if a IMOC_iget_data or IMOC_iput_data is completed.
int	moc_tag_reserve (unsigned int speid)
	Reserves a tag on the ppu, for communication with a given spu.
int	moc_tag_release (unsigned int speid, int tag)
	Releases a reserved tag.
SPU-only
int	IMOC_get_data (void *target, uint64_t source, uint32_t size)
	Internal wrapper-function for a blocking DMA-get operation.
int	IMOC_put_data (void *source, uint64_t target, uint32_t size)
	Internal wrapper-function for a blocking DMA-put operation.
int	IMOC_iget_data (void target, uint64_t source, uint32_t size, imoc_dma_request request)
	Internal wrapper-function for a non-blocking DMA-get operation.
int	IMOC_iput_data (void source, uint64_t target, uint32_t size, imoc_dma_request request)
	Internal wrapper-function for a blocking DMA-put operation.

int IMOC_get_data	(	void *	target,
		uint64_t	source,
		uint32_t	size
	)

	target	in ls-address of buffer
	source	in ea-address of data
	size	in size of data in byte

	target	in local-address of buffer
	source	in ea-address of data
	size	in size of data in byte
	dest	in id of source spe

int IMOC_iget_data	(	void *	target,
		uint64_t	source,
		uint32_t	size,
		imoc_dma_request *	request
	)