Files
MPIonCell/documentation/developer/html/d7/d98/doxygen__internal__main_8doxygen-source.html
2017-10-26 19:57:24 +02:00

241 lines
22 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/internal/doxygen_internal_main.doxygen 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/internal/doxygen_internal_main.doxygen</h1><a href="../../d2/daa/doxygen__internal__main_8doxygen.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_INTERNAL_DOXYGEN_MAIN_H_</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define MOC_INTERNAL_DOXYGEN_MAIN_H_</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/**</span>
<a name="l00007"></a>00007 <span class="comment"> * \defgroup internal_main Developer Documentation</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This section deals with the internal design and functionality. For correct</span>
<a name="l00010"></a>00010 <span class="comment"> * understanding knowledge about the functionality of the Cell Broadband Engine</span>
<a name="l00011"></a>00011 <span class="comment"> * is needed. So you should read the official CBE documentation before you</span>
<a name="l00012"></a>00012 <span class="comment"> * continue.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * \note Because we had only access to a playstation, we cannot guarantee correct</span>
<a name="l00015"></a>00015 <span class="comment"> * execution on another CBE-machine than a playstation 3.</span>
<a name="l00016"></a>00016 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00017"></a>00017 <span class="comment">/**</span>
<a name="l00018"></a>00018 <span class="comment"> * \defgroup internal_core Implementation-Core</span>
<a name="l00019"></a>00019 <span class="comment"> * \ingroup internal_main</span>
<a name="l00020"></a>00020 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00021"></a>00021 <span class="comment">/**</span>
<a name="l00022"></a>00022 <span class="comment"> * \defgroup internal_am Address-Macros</span>
<a name="l00023"></a>00023 <span class="comment"> * \ingroup internal_core</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> * Predefined Macros for calculating Addresses of Message-Queue and Status-Array.</span>
<a name="l00026"></a>00026 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment">/**</span>
<a name="l00028"></a>00028 <span class="comment"> * \defgroup internal_tm Test-Macros</span>
<a name="l00029"></a>00029 <span class="comment"> * \ingroup internal_core</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * Predefined Macros for testing the validity of parameters.</span>
<a name="l00032"></a>00032 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/**</span>
<a name="l00034"></a>00034 <span class="comment"> * \defgroup internal_env Environmental Management</span>
<a name="l00035"></a>00035 <span class="comment"> * \ingroup internal_main</span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * Internals about Startup &amp; Shutdown and Error-Handling</span>
<a name="l00038"></a>00038 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">/**</span>
<a name="l00040"></a>00040 <span class="comment"> * \defgroup internal_init Startup &amp; Shutdown</span>
<a name="l00041"></a>00041 <span class="comment"> * \ingroup internal_env</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * Internals about the startup of the execution-environment and</span>
<a name="l00044"></a>00044 <span class="comment"> * SPU-Thread-Management.</span>
<a name="l00045"></a>00045 <span class="comment"> *</span>
<a name="l00046"></a>00046 <span class="comment"> * \section iinit_start Startup</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * The PPU-Process creates for every SPU-thread an own thread using the</span>
<a name="l00049"></a>00049 <span class="comment"> * pthread-library (see \ref internal_spu_thread). The rank of each prozess,</span>
<a name="l00050"></a>00050 <span class="comment"> * the overall process count, the sizes of message-queue and buffer-space</span>
<a name="l00051"></a>00051 <span class="comment"> * and the effective base address of the buffer is send to each SPU-thread via</span>
<a name="l00052"></a>00052 <span class="comment"> * mailbox-messages. The SPU-threads then send the memory-addresses of their</span>
<a name="l00053"></a>00053 <span class="comment"> * message-queues and status-arrays back to the PPU-process which writes this</span>
<a name="l00054"></a>00054 <span class="comment"> * data into the prozess-list. After all SPU-Threads have reported back to the</span>
<a name="l00055"></a>00055 <span class="comment"> * PPU-process the effective address of the PPU's process-list ist distributed</span>
<a name="l00056"></a>00056 <span class="comment"> * among the SPU-processes which then copy the process-list via DMA in their</span>
<a name="l00057"></a>00057 <span class="comment"> * local storages.</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * \section iinit_shut Shutdown</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * \subsection iinit_shut_ppu PPU</span>
<a name="l00062"></a>00062 <span class="comment"> *</span>
<a name="l00063"></a>00063 <span class="comment"> * The PPU-process waits till all SPU-threads have signalled that they are also</span>
<a name="l00064"></a>00064 <span class="comment"> * executing the finalize-function. After that a signal is send back to each</span>
<a name="l00065"></a>00065 <span class="comment"> * SPU-Thread that they can now stop execution. Then local ressources are freed</span>
<a name="l00066"></a>00066 <span class="comment"> * and the finalize-function returns.</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * \subsection iinit_shut_spu SPU</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * A mailbox-message is send to the PPU to signal that the SPU-process is now</span>
<a name="l00071"></a>00071 <span class="comment"> * executing the finalize-function. After that the SPU-process is waiting till</span>
<a name="l00072"></a>00072 <span class="comment"> * a mailbox-message from the PPU-process is received. Then local ressources are</span>
<a name="l00073"></a>00073 <span class="comment"> * freed and the finalize-function returns.</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">/**</span>
<a name="l00077"></a>00077 <span class="comment"> * \defgroup internal_spu_thread SPU-Thread Management</span>
<a name="l00078"></a>00078 <span class="comment"> * \ingroup internal_init</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> * This section deals about the creation and management of SPU-threads.</span>
<a name="l00081"></a>00081 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /**</span>
<a name="l00083"></a>00083 <span class="comment"> * \defgroup internal_error Error-Handling</span>
<a name="l00084"></a>00084 <span class="comment"> * \ingroup internal_env</span>
<a name="l00085"></a>00085 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /**</span>
<a name="l00087"></a>00087 <span class="comment"> * \defgroup internal_timer Timers and Synchronization</span>
<a name="l00088"></a>00088 <span class="comment"> * \ingroup internal_env</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * Internals about Time.</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * On the PPU "gettimeofday()" from time.h is used, because it is the only function</span>
<a name="l00093"></a>00093 <span class="comment"> * which seems to work ("clock()" from time.h always returns 0).</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * On the SPU there are two implementations. One uses also "gettimeofday()" and the</span>
<a name="l00096"></a>00096 <span class="comment"> * other uses the spu-timer-library. The reason for this lies in the fact, that the</span>
<a name="l00097"></a>00097 <span class="comment"> * spu-timer-library was marked as prototype in Cell SDK 3.0 and the future development</span>
<a name="l00098"></a>00098 <span class="comment"> * of this library was uncertain. Cell SDK 3.1 has integrated the spu-timer-library in</span>
<a name="l00099"></a>00099 <span class="comment"> * the main-library and so the gettimeofday-implementation is now obsolete.</span>
<a name="l00100"></a>00100 <span class="comment"> *</span>
<a name="l00101"></a>00101 <span class="comment"> * \note The timebase-constant which is needed to calculate time is hardcoded, because</span>
<a name="l00102"></a>00102 <span class="comment"> * there was no according function for retrieving this value in Cell SDK 3.0 and we had</span>
<a name="l00103"></a>00103 <span class="comment"> * only access to a playstation 3. Now Cell SDK 3.1 provides a function for retrieving</span>
<a name="l00104"></a>00104 <span class="comment"> * the timebase value, but we didn't use it to provide backwards-compatibility. So if</span>
<a name="l00105"></a>00105 <span class="comment"> * you plan to use MOC on another platform than playstation 3 keep in mind to check if</span>
<a name="l00106"></a>00106 <span class="comment"> * the timebase-value is correct.</span>
<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"></span>
<a name="l00110"></a>00110 <span class="comment"> /**</span>
<a name="l00111"></a>00111 <span class="comment"> * \defgroup internal_comm Groups, Context and Communicators</span>
<a name="l00112"></a>00112 <span class="comment"> * \ingroup internal_main</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * At the moment user-defined groups and communicators are not implemented and maybe never</span>
<a name="l00115"></a>00115 <span class="comment"> * will be.</span>
<a name="l00116"></a>00116 <span class="comment"> * At the moment user-defined groups and communicators are not implemented and maybe never</span>
<a name="l00117"></a>00117 <span class="comment"> * will be. Nevertheless user-defined groups and communicators have been taken into</span>
<a name="l00118"></a>00118 <span class="comment"> * consideration while making the software-design (e.g. reserved field for communicator</span>
<a name="l00119"></a>00119 <span class="comment"> * in message-envelope). So it should be not too hard to implement groups and communicators.</span>
<a name="l00120"></a>00120 <span class="comment"> * However a lot of things concerning communicators are hardcoded (e.g. parameter checks).</span>
<a name="l00121"></a>00121 <span class="comment"> *</span>
<a name="l00122"></a>00122 <span class="comment"> * To save memory only one byte is used to encode the communicator. So if one</span>
<a name="l00123"></a>00123 <span class="comment"> * day user-defined communicators are implemented there are only 256 possible</span>
<a name="l00124"></a>00124 <span class="comment"> * communicators.</span>
<a name="l00125"></a>00125 <span class="comment"> **/</span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment">/**</span>
<a name="l00129"></a>00129 <span class="comment"> * \defgroup internal_p2p_main Point-to-Point Communication</span>
<a name="l00130"></a>00130 <span class="comment"> * \ingroup internal_main</span>
<a name="l00131"></a>00131 <span class="comment"> *</span>
<a name="l00132"></a>00132 <span class="comment"> * Internals about Point-to-Point Communication.</span>
<a name="l00133"></a>00133 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment">/**</span>
<a name="l00135"></a>00135 <span class="comment"> * \defgroup internal_p2p_dma DMA-Helper Functions</span>
<a name="l00136"></a>00136 <span class="comment"> * \ingroup internal_p2p_main</span>
<a name="l00137"></a>00137 <span class="comment"> *</span>
<a name="l00138"></a>00138 <span class="comment"> * Functions wrapping DMA-Transfers.</span>
<a name="l00139"></a>00139 <span class="comment"> *</span>
<a name="l00140"></a>00140 <span class="comment"> * The Cell Broadband Engine uses Direct Memory Access (DMA) for communication. Therefore</span>
<a name="l00141"></a>00141 <span class="comment"> * data of a MOC-message is transfered using DMA operations. Because programming DMA is</span>
<a name="l00142"></a>00142 <span class="comment"> * rather complex, some functions are provided to hide this complexity. One DMA-call can</span>
<a name="l00143"></a>00143 <span class="comment"> * only tranfer a maximum of 16KByte of data and the data-size has to be a multiple of</span>
<a name="l00144"></a>00144 <span class="comment"> * 16 byte. The provided functions split the data into multiple DMA-calls if needed. If</span>
<a name="l00145"></a>00145 <span class="comment"> * the data-size requires it, an intermediate buffer is used into which a separate</span>
<a name="l00146"></a>00146 <span class="comment"> * DMA-Call transfers 16 byte containing the piece of data not fitting into the 16-byte</span>
<a name="l00147"></a>00147 <span class="comment"> * scheme. Then only the needed bytes are copied into the receive-buffer. But the latter</span>
<a name="l00148"></a>00148 <span class="comment"> * only works for a get-operation.</span>
<a name="l00149"></a>00149 <span class="comment"> *</span>
<a name="l00150"></a>00150 <span class="comment"> * The internal DMA-functions are also made publicly available via wrapping-function</span>
<a name="l00151"></a>00151 <span class="comment"> * (see chapter \ref dma_access) which provide parameter checks.</span>
<a name="l00152"></a>00152 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment">/**</span>
<a name="l00154"></a>00154 <span class="comment"> * \defgroup internal_p2p_blocking Blocking Communication</span>
<a name="l00155"></a>00155 <span class="comment"> * \ingroup internal_p2p_main</span>
<a name="l00156"></a>00156 <span class="comment"> *</span>
<a name="l00157"></a>00157 <span class="comment"> * Internals about blocking Point-to-Point Communication.</span>
<a name="l00158"></a>00158 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00159"></a>00159 <span class="comment">/**</span>
<a name="l00160"></a>00160 <span class="comment"> * \defgroup internal_p2p_synch Synchronous Communication</span>
<a name="l00161"></a>00161 <span class="comment"> * \ingroup internal_p2p_blocking</span>
<a name="l00162"></a>00162 <span class="comment"> *</span>
<a name="l00163"></a>00163 <span class="comment"> * Internals about blocking synchronous Communication.</span>
<a name="l00164"></a>00164 <span class="comment"> *</span>
<a name="l00165"></a>00165 <span class="comment"> * \image html synchronous_communication_1.png</span>
<a name="l00166"></a>00166 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment">/**</span>
<a name="l00168"></a>00168 <span class="comment"> * \defgroup internal_p2p_buffered Buffered Communication</span>
<a name="l00169"></a>00169 <span class="comment"> * \ingroup internal_p2p_blocking</span>
<a name="l00170"></a>00170 <span class="comment"> *</span>
<a name="l00171"></a>00171 <span class="comment"> * Internals about blocking buffered Communication.</span>
<a name="l00172"></a>00172 <span class="comment"> *</span>
<a name="l00173"></a>00173 <span class="comment"> * \image html buffered_communication_1.png</span>
<a name="l00174"></a>00174 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00175"></a>00175 <span class="comment">/**</span>
<a name="l00176"></a>00176 <span class="comment"> * \defgroup internal_p2p_bmalloc Buffer-Management</span>
<a name="l00177"></a>00177 <span class="comment"> * \ingroup internal_p2p_buffered</span>
<a name="l00178"></a>00178 <span class="comment"> *</span>
<a name="l00179"></a>00179 <span class="comment"> * This section shows how the buffer used for buffered communication is managed.</span>
<a name="l00180"></a>00180 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00181"></a>00181 <span class="comment">/**</span>
<a name="l00182"></a>00182 <span class="comment"> * \defgroup internal_p2p_imm Non-Blocking Communication</span>
<a name="l00183"></a>00183 <span class="comment"> * \ingroup internal_p2p_main</span>
<a name="l00184"></a>00184 <span class="comment"> *</span>
<a name="l00185"></a>00185 <span class="comment"> * Internals about non-blocking communication.</span>
<a name="l00186"></a>00186 <span class="comment"> *</span>
<a name="l00187"></a>00187 <span class="comment"> * The SPUs are very limited in usage, e.g. only one thread per SPU is supported,</span>
<a name="l00188"></a>00188 <span class="comment"> * and so it is hard to make communication non-blocking. In fact only synchronous</span>
<a name="l00189"></a>00189 <span class="comment"> * send and receive provide possibilities for non-blocking communication. Because</span>
<a name="l00190"></a>00190 <span class="comment"> * we think that the advantages of a non-blocking receive aren't worth the effort,</span>
<a name="l00191"></a>00191 <span class="comment"> * only non-blocking send is implemented at the moment. The picture below illustrates</span>
<a name="l00192"></a>00192 <span class="comment"> * a non-blocking synchronous communication call.</span>
<a name="l00193"></a>00193 <span class="comment"> *</span>
<a name="l00194"></a>00194 <span class="comment"> * \image html isyncronous_communication_1.png</span>
<a name="l00195"></a>00195 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00196"></a>00196 <span class="comment">/**</span>
<a name="l00197"></a>00197 <span class="comment"> * \defgroup internal_collective Collective Communication</span>
<a name="l00198"></a>00198 <span class="comment"> * \ingroup internal_main</span>
<a name="l00199"></a>00199 <span class="comment"> *</span>
<a name="l00200"></a>00200 <span class="comment"> * Internals about Collective Communication</span>
<a name="l00201"></a>00201 <span class="comment"> *</span>
<a name="l00202"></a>00202 <span class="comment"> * Currently there are only two operations implemented.</span>
<a name="l00203"></a>00203 <span class="comment"> *</span>
<a name="l00204"></a>00204 <span class="comment"> * \section MOC_Bcast</span>
<a name="l00205"></a>00205 <span class="comment"> *</span>
<a name="l00206"></a>00206 <span class="comment"> * The root node sends normal messages using the reserved tag MOC_BCAST_TAG, which</span>
<a name="l00207"></a>00207 <span class="comment"> * is received by all other nodes.</span>
<a name="l00208"></a>00208 <span class="comment"> *</span>
<a name="l00209"></a>00209 <span class="comment"> * \section MOC_Barrier</span>
<a name="l00210"></a>00210 <span class="comment"> *</span>
<a name="l00211"></a>00211 <span class="comment"> * All but the process with the highest rank send a special-message (special-flag set)</span>
<a name="l00212"></a>00212 <span class="comment"> * to the latter process. This process then sends another special-message back to</span>
<a name="l00213"></a>00213 <span class="comment"> * the others. After that the function returns on all calling processes.</span>
<a name="l00214"></a>00214 <span class="comment"> */</span>
<a name="l00215"></a>00215
<a name="l00216"></a>00216
<a name="l00217"></a>00217
<a name="l00218"></a>00218 <span class="preprocessor">#endif </span><span class="comment">/*MOC_DOXYGEN_MAIN_H_*/</span>
</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>