MPI On Cell (Documentation): include/spu/moc.h Source File

00001 #ifndef MOC_H_SPU
00002 #define MOC_H_SPU
00003 
00004 
00005 #include "moc_dma_spu.h"
00006 #include "moc_datatype_spu.h"
00007 #include "../moc.h"
00008 
00009 #include <stdint.h>
00010 
00011 
00012 
00013 /**
00014  * \addtogroup environment_startup
00015  **/
00016 //@{
00017 /**
00018  * @name SPU-only
00019  **/
00020 //@{
00021 
00022 /**
00023  * Initialize the MPI execution environment.
00024  * 
00025  * \anchor moc_init_spu
00026  * 
00027  * \attention SPU-only function
00028  * 
00029  * \note All processes must call this routine before executing any MOC-routine.
00030  * 
00031  * \todo Copying of user-defined information from main-memory to local buffer not implemented
00032  * 
00033  * \param argp \b in Pointer to user-defined information in the main-memory
00034  * \param length \b in Length of the user-defined information in bytes
00035  * \param buffer \b out Buffer into which the user-defined information should be copied
00036  * \retval MOC_SUCCESS No error; MPI routine completed successfully.
00037  * \retval MOC_ERR_NO_MEMORY Insufficient Memory.
00038  * \retval MOC_ERR_INTERN Internal Error
00039  **/
00040 int MOC_Init (unsigned long long argp, int length, void* buffer);
00041 
00042 //@}
00043 //@}
00044 
00045 
00046 
00047 #endif /*MOC_H_*/
00048