152 lines
13 KiB
HTML
Executable File
152 lines
13 KiB
HTML
Executable File
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>MPI On Cell (Documentation): include/ppu/moc.h Source File</title>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.5.6 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="../../main.html"><span>Main Page</span></a></li>
|
|
<li><a href="../../modules.html"><span>Modules</span></a></li>
|
|
<li><a href="../../annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="../../files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>include/ppu/moc.h</h1><a href="../../db/dae/ppu_2moc_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef MOC_H_PPU</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define MOC_H_PPU</span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
|
<a name="l00004"></a>00004
|
|
<a name="l00005"></a>00005 <span class="preprocessor">#include "<a class="code" href="../../db/d62/moc__dma__ppu_8h.html">moc_dma_ppu.h</a>"</span>
|
|
<a name="l00006"></a>00006 <span class="preprocessor">#include "<a class="code" href="../../d8/de2/moc__datatype__ppu_8h.html">moc_datatype_ppu.h</a>"</span>
|
|
<a name="l00007"></a>00007 <span class="preprocessor">#include "../moc.h"</span>
|
|
<a name="l00008"></a>00008
|
|
<a name="l00009"></a>00009 <span class="preprocessor">#include <stdint.h></span>
|
|
<a name="l00010"></a>00010 <span class="preprocessor">#include <libspe2.h></span>
|
|
<a name="l00011"></a>00011
|
|
<a name="l00012"></a>00012
|
|
<a name="l00013"></a>00013 <span class="comment"></span>
|
|
<a name="l00014"></a>00014 <span class="comment">/**</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * Maximum number of possible SPU-threads.</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> **/</span>
|
|
<a name="l00017"></a><a class="code" href="../../db/dae/ppu_2moc_8h.html#a6aacc64a745d563ed72610e08ceb3ef">00017</a> <span class="preprocessor">#define MOC_SPU_THREAD_MAX 8</span>
|
|
<a name="l00018"></a>00018 <span class="preprocessor"></span>
|
|
<a name="l00019"></a>00019
|
|
<a name="l00020"></a>00020
|
|
<a name="l00021"></a>00021
|
|
<a name="l00022"></a>00022 <span class="comment"></span>
|
|
<a name="l00023"></a>00023 <span class="comment">/**</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> * \addtogroup environment_startup</span>
|
|
<a name="l00025"></a>00025 <span class="comment"> **/</span><span class="comment"></span>
|
|
<a name="l00026"></a>00026 <span class="comment">//@{</span>
|
|
<a name="l00027"></a>00027 <span class="comment"></span><span class="comment">/**</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @name PPU-only</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> **/</span><span class="comment"></span>
|
|
<a name="l00030"></a>00030 <span class="comment">//@{</span>
|
|
<a name="l00031"></a>00031 <span class="comment"></span><span class="comment"></span>
|
|
<a name="l00032"></a>00032 <span class="comment">/**</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * Returns the number of available SPUs.</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> *</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * \attention PPU-only</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> *</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * \note Must be called before \ref MOC_Init</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> *</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * \note This function should return the count of free SPUs. But this</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * doesn't really works. To get the available SPU-count the</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * function spe_cpu_info_get() from libspe2 with</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * SPE_COUNT_USABLE_SPES-flag is used. However this function can only</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> * detect if a SPU-thread is used by the calling function. There seems</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * to be no means to detect SPU-thread used by other applications.</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> *</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> *</span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * \param count \b out number of available SPUs</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> * \retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * \retval ... error-code</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> **/</span>
|
|
<a name="l00051"></a>00051 <span class="keywordtype">int</span> <a class="code" href="../../d8/d9a/group__environment__startup.html#g66028682d3c25b76e25ca57655d47625" title="Returns the number of available SPUs.">MOC_Get_avail_spu_count</a>(<span class="keywordtype">int</span>* count);
|
|
<a name="l00052"></a>00052 <span class="comment"></span>
|
|
<a name="l00053"></a>00053 <span class="comment">/**</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> * Returns the number of SPUs.</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> *</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> * \attention PPU-only</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> *</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> * \note Must be called before \ref MOC_Init</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> *</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> * \param count \b out SPU-count</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * \retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> * \retval ... error-code</span>
|
|
<a name="l00063"></a>00063 <span class="comment"> **/</span>
|
|
<a name="l00064"></a>00064 <span class="keywordtype">int</span> <a class="code" href="../../d8/d9a/group__environment__startup.html#g58c038d9978a55d6f346102dfef9acc7" title="Returns the number of SPUs.">MOC_Get_max_spu_count</a>(<span class="keywordtype">int</span>* count);
|
|
<a name="l00065"></a>00065 <span class="comment"></span>
|
|
<a name="l00066"></a>00066 <span class="comment">/**</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> * Adds a SPU-Thread.</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> *</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> * \attention PPU-only</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> *</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> * \note Must be called before calling \ref MOC_Init</span>
|
|
<a name="l00072"></a>00072 <span class="comment"> *</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> * \note The order of executions defines the order of the ranks of the SPU-Threads</span>
|
|
<a name="l00074"></a>00074 <span class="comment"> *</span>
|
|
<a name="l00075"></a>00075 <span class="comment"> * \param phandle \b in Handle of the SPE-Program</span>
|
|
<a name="l00076"></a>00076 <span class="comment"> * \param argp \b in Pointer to some user-defined information in the main-memory</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> * \retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * \retval MOC_ERR_BUFFER_OVERFLOW A Buffer-Overflow occured. Mosst likely you tried to add more</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> * SPU-threads than defined by \ref MOC_SPU_THREAD_MAX.</span>
|
|
<a name="l00080"></a>00080 <span class="comment"> * \retval MOC_ERR_INTERN Internal Error</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> **/</span>
|
|
<a name="l00082"></a>00082 <span class="keywordtype">int</span> <a class="code" href="../../d8/d9a/group__environment__startup.html#geea5b7c117adae78e954f0959fe0c447" title="Adds a SPU-Thread.">MOC_Add_spu_thread</a> ( spe_program_handle_t* phandle, <span class="keywordtype">void</span>* argp );
|
|
<a name="l00083"></a>00083 <span class="comment"></span>
|
|
<a name="l00084"></a>00084 <span class="comment">/**</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * Sets the size of the buffer used for buffered communication.</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> *</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * \attention PPU-only</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> *</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * \note Must be called before \ref MOC_Init</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> *</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> * \param size buffer-size</span>
|
|
<a name="l00092"></a>00092 <span class="comment"> * \return 0 if success, otherwise error-code</span>
|
|
<a name="l00093"></a>00093 <span class="comment"> **/</span>
|
|
<a name="l00094"></a>00094 <span class="keywordtype">int</span> <a class="code" href="../../d8/d9a/group__environment__startup.html#g0ac2f7a8d9b93b8da0408a5307f0c925" title="Sets the size of the buffer used for buffered communication.">MOC_Set_buffer_size</a> ( uint32_t size );
|
|
<a name="l00095"></a>00095 <span class="comment"></span>
|
|
<a name="l00096"></a>00096 <span class="comment">/**</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * Sets the size of the message-queues.</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> *</span>
|
|
<a name="l00099"></a>00099 <span class="comment"> * \attention PPU-only</span>
|
|
<a name="l00100"></a>00100 <span class="comment"> *</span>
|
|
<a name="l00101"></a>00101 <span class="comment"> * \note Must be called before \ref MOC_Init</span>
|
|
<a name="l00102"></a>00102 <span class="comment"> *</span>
|
|
<a name="l00103"></a>00103 <span class="comment"> * \param size queue-size</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * \return 0 if success, otherwise error-code</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> **/</span>
|
|
<a name="l00106"></a>00106 <span class="keywordtype">int</span> <a class="code" href="../../d8/d9a/group__environment__startup.html#g3e83e7a629951e6788a682aad654baf8" title="Sets the size of the message-queues.">MOC_Set_queue_size</a> ( uint8_t size );
|
|
<a name="l00107"></a>00107 <span class="comment"></span>
|
|
<a name="l00108"></a>00108 <span class="comment">/**</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> * Initialize the MPI execution environment.</span>
|
|
<a name="l00110"></a>00110 <span class="comment"> *</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> * \attention PPU-only function</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> *</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> * \note All processes must call this routine before executing any MOC-routine.</span>
|
|
<a name="l00114"></a>00114 <span class="comment"> *</span>
|
|
<a name="l00115"></a>00115 <span class="comment"> * \param argc \b in Pointer to the number of arguments</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> * \param argv \b in Pointer to the argument vector</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> * \retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
|
|
<a name="l00118"></a>00118 <span class="comment"> * \retval MOC_ERR_NO_MEMORY Insufficient Memory.</span>
|
|
<a name="l00119"></a>00119 <span class="comment"> * \retval MOC_ERR_INTERN Internal Error</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> **/</span>
|
|
<a name="l00121"></a>00121 <span class="keywordtype">int</span> <a class="code" href="../../d8/d9a/group__environment__startup.html#g9a59090c9d03e89f019e8276d4013c72" title="Initialize the MPI execution environment.">MOC_Init</a> ( <span class="keywordtype">int</span> *argc, <span class="keywordtype">char</span> ***argv );
|
|
<a name="l00122"></a>00122 <span class="comment"></span>
|
|
<a name="l00123"></a>00123 <span class="comment">//@}</span>
|
|
<a name="l00124"></a>00124 <span class="comment"></span><span class="comment">//@}</span>
|
|
<a name="l00125"></a>00125 <span class="comment"></span>
|
|
<a name="l00126"></a>00126
|
|
<a name="l00127"></a>00127
|
|
<a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/*MOC_H_*/</span>
|
|
<a name="l00129"></a>00129
|
|
</pre></div></div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 12 13:49:47 2009 for MPI On Cell (Documentation) by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="../../doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
|
|
</body>
|
|
</html>
|