Files
2017-10-26 19:57:24 +02:00

71 lines
5.3 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/spu/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&nbsp;Page</span></a></li>
<li><a href="../../modules.html"><span>Modules</span></a></li>
<li><a href="../../annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="../../files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>include/spu/moc.h</h1><a href="../../d0/d3a/spu_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_SPU</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define MOC_H_SPU</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="../../dd/d9c/moc__dma__spu_8h.html">moc_dma_spu.h</a>"</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include "<a class="code" href="../../d0/d1d/moc__datatype__spu_8h.html">moc_datatype_spu.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 &lt;stdint.h&gt;</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">/**</span>
<a name="l00014"></a>00014 <span class="comment"> * \addtogroup environment_startup</span>
<a name="l00015"></a>00015 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">//@{</span>
<a name="l00017"></a>00017 <span class="comment"></span><span class="comment">/**</span>
<a name="l00018"></a>00018 <span class="comment"> * @name SPU-only</span>
<a name="l00019"></a>00019 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">//@{</span>
<a name="l00021"></a>00021 <span class="comment"></span><span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment">/**</span>
<a name="l00023"></a>00023 <span class="comment"> * Initialize the MPI execution environment.</span>
<a name="l00024"></a>00024 <span class="comment"> * </span>
<a name="l00025"></a>00025 <span class="comment"> * \anchor moc_init_spu</span>
<a name="l00026"></a>00026 <span class="comment"> * </span>
<a name="l00027"></a>00027 <span class="comment"> * \attention SPU-only function</span>
<a name="l00028"></a>00028 <span class="comment"> * </span>
<a name="l00029"></a>00029 <span class="comment"> * \note All processes must call this routine before executing any MOC-routine.</span>
<a name="l00030"></a>00030 <span class="comment"> * </span>
<a name="l00031"></a>00031 <span class="comment"> * \todo Copying of user-defined information from main-memory to local buffer not implemented</span>
<a name="l00032"></a>00032 <span class="comment"> * </span>
<a name="l00033"></a>00033 <span class="comment"> * \param argp \b in Pointer to user-defined information in the main-memory</span>
<a name="l00034"></a>00034 <span class="comment"> * \param length \b in Length of the user-defined information in bytes</span>
<a name="l00035"></a>00035 <span class="comment"> * \param buffer \b out Buffer into which the user-defined information should be copied</span>
<a name="l00036"></a>00036 <span class="comment"> * \retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
<a name="l00037"></a>00037 <span class="comment"> * \retval MOC_ERR_NO_MEMORY Insufficient Memory.</span>
<a name="l00038"></a>00038 <span class="comment"> * \retval MOC_ERR_INTERN Internal Error</span>
<a name="l00039"></a>00039 <span class="comment"> **/</span>
<a name="l00040"></a>00040 <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">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> argp, <span class="keywordtype">int</span> length, <span class="keywordtype">void</span>* buffer);
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">//@}</span>
<a name="l00043"></a>00043 <span class="comment"></span><span class="comment">//@}</span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="preprocessor">#endif </span><span class="comment">/*MOC_H_*/</span>
<a name="l00048"></a>00048
</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&nbsp;
<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>