Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2330

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/spinlock.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/spinlock.h</h1><a href="spinlock_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2006 by Frank Richter</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_CSUTIL_SPINLOCK_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_SPINLOCK_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef CS_PLATFORM_WIN32</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include &lt;pthread.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;sched.h&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#endif</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="keyword">namespace </span>CS
<a name="l00034"></a>00034 {
<a name="l00035"></a><a class="code" href="classCS_1_1SpinLock.html">00035</a>   <span class="keyword">class </span><a class="code" href="classCS_1_1SpinLock.html">SpinLock</a>
<a name="l00036"></a>00036   {
<a name="l00037"></a>00037 <span class="preprocessor">  #ifdef CS_PLATFORM_WIN32</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>    <span class="keyword">typedef</span> DWORD ThreadID;
<a name="l00039"></a>00039 <span class="preprocessor">  #else</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>    <span class="keyword">typedef</span> pthread_t ThreadID;
<a name="l00041"></a>00041 <span class="preprocessor">  #endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">  #if defined (CS_PROCESSOR_X86) &amp;&amp; defined (CS_COMPILER_GCC)</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>    <span class="keyword">volatile</span> ThreadID threadid;
<a name="l00044"></a>00044     <span class="keyword">volatile</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> l;
<a name="l00045"></a>00045 <span class="preprocessor">  #elif defined(CS_PLATFORM_WIN32)</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>    <span class="keyword">volatile</span> ThreadID threadid;
<a name="l00047"></a>00047     <span class="keyword">volatile</span> LONG l;
<a name="l00048"></a>00048 <span class="preprocessor">  #else</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>    pthread_mutex_t l;
<a name="l00050"></a>00050 <span class="preprocessor">  #endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>    
<a name="l00052"></a>00052     <span class="keyword">volatile</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> c;
<a name="l00053"></a>00053     
<a name="l00054"></a>00054     <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> spinsPerYield = 63;
<a name="l00055"></a>00055     
<a name="l00056"></a>00056 <span class="preprocessor">  #if defined(CS_PLATFORM_WIN32)</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>    CS_FORCEINLINE ThreadID CurrentThreadID()
<a name="l00058"></a>00058     { <span class="keywordflow">return</span> GetCurrentThreadId(); }
<a name="l00059"></a>00059 <span class="preprocessor">  #else</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span>    CS_FORCEINLINE ThreadID CurrentThreadID()
<a name="l00061"></a>00061     { <span class="keywordflow">return</span> pthread_self(); }
<a name="l00062"></a>00062 <span class="preprocessor">  #endif  </span>
<a name="l00063"></a>00063 <span class="preprocessor"></span>    
<a name="l00064"></a>00064     <span class="comment">// Spinlock implementation from ptmalloc3's malloc.c</span>
<a name="l00065"></a>00065 <span class="preprocessor">  #if defined (CS_PROCESSOR_X86) &amp;&amp; defined (CS_COMPILER_GCC)</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span>    CS_FORCEINLINE <span class="keywordtype">bool</span> DoLockWait()
<a name="l00067"></a>00067     {
<a name="l00068"></a>00068       ThreadID mythreadid = CurrentThreadID();
<a name="l00069"></a>00069       <span class="keywordflow">if</span>(mythreadid == threadid)
<a name="l00070"></a>00070         ++c;
<a name="l00071"></a>00071       <span class="keywordflow">else</span> 
<a name="l00072"></a>00072       {
<a name="l00073"></a>00073         <span class="keywordtype">int</span> spins = 0;
<a name="l00074"></a>00074         <span class="keywordflow">for</span> (;;) {
<a name="l00075"></a>00075           <span class="keywordtype">int</span> ret;
<a name="l00076"></a>00076           __asm__ __volatile__ (<span class="stringliteral">"lock; cmpxchgl %2,(%1)"</span> : <span class="stringliteral">"=a"</span> (ret) : <span class="stringliteral">"r"</span> (&amp;l), <span class="stringliteral">"r"</span> (1), <span class="stringliteral">"a"</span> (0));
<a name="l00077"></a>00077           <span class="keywordflow">if</span>(!ret) 
<a name="l00078"></a>00078           {
<a name="l00079"></a>00079             <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a>(!threadid);
<a name="l00080"></a>00080             threadid = mythreadid;
<a name="l00081"></a>00081             c = 1;
<a name="l00082"></a>00082             <span class="keywordflow">break</span>;
<a name="l00083"></a>00083           }
<a name="l00084"></a>00084           <span class="keywordflow">if</span> ((++spins &amp; spinsPerYield) == 0) {
<a name="l00085"></a>00085 <span class="preprocessor">    #if defined (__SVR4) &amp;&amp; defined (__sun) </span><span class="comment">/* solaris */</span>
<a name="l00086"></a>00086             thr_yield();
<a name="l00087"></a>00087 <span class="preprocessor">    #elif defined(linux) || defined(CS_PLATFORM_MACOSX)</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span>            sched_yield();
<a name="l00089"></a>00089 <span class="preprocessor">    #elif defined(CS_PLATFORM_WIN32)</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span>            SleepEx (0, FALSE);
<a name="l00091"></a>00091 <span class="preprocessor">    #else  </span><span class="comment">/* no-op yield on unknown systems */</span>
<a name="l00092"></a>00092             ;
<a name="l00093"></a>00093 <span class="preprocessor">    #endif </span><span class="comment">/* solaris, linux, CS_PLATFORM_MACOSX, CS_PLATFORM_WIN32 */</span>
<a name="l00094"></a>00094           }
<a name="l00095"></a>00095         }
<a name="l00096"></a>00096       }
<a name="l00097"></a>00097       <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00098"></a>00098     }
<a name="l00099"></a>00099     CS_FORCEINLINE <span class="keywordtype">bool</span> DoLockTry()
<a name="l00100"></a>00100     {
<a name="l00101"></a>00101       <span class="keywordtype">int</span> ret;
<a name="l00102"></a>00102       __asm__ __volatile__ (<span class="stringliteral">"lock; cmpxchgl %2,(%1)"</span> : <span class="stringliteral">"=a"</span> (ret) : <span class="stringliteral">"r"</span> (&amp;l), <span class="stringliteral">"r"</span> (1), <span class="stringliteral">"a"</span> (0));
<a name="l00103"></a>00103       <span class="keywordflow">if</span>(!ret){
<a name="l00104"></a>00104         <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a>(!threadid);
<a name="l00105"></a>00105         threadid = CurrentThreadID();
<a name="l00106"></a>00106         c=1;
<a name="l00107"></a>00107         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00108"></a>00108       }
<a name="l00109"></a>00109       <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00110"></a>00110     }
<a name="l00111"></a>00111     CS_FORCEINLINE <span class="keywordtype">void</span> DoRelease()
<a name="l00112"></a>00112     {
<a name="l00113"></a>00113       <span class="keywordtype">int</span> ret;
<a name="l00114"></a>00114       <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a>(CurrentThreadID() == threadid);
<a name="l00115"></a>00115       <span class="keywordflow">if</span> (!--c) {
<a name="l00116"></a>00116         threadid=0;
<a name="l00117"></a>00117         __asm__ __volatile__ (<span class="stringliteral">"xchgl %2,(%1)"</span> : <span class="stringliteral">"=r"</span> (ret) : <span class="stringliteral">"r"</span> (&amp;l), <span class="stringliteral">"0"</span> (0));
<a name="l00118"></a>00118       }
<a name="l00119"></a>00119     }
<a name="l00120"></a>00120     CS_FORCEINLINE <span class="keywordtype">void</span> Init() { threadid = 0; c = 0; l = 0; }
<a name="l00121"></a>00121     CS_FORCEINLINE <span class="keywordtype">void</span> Destroy() {}
<a name="l00122"></a>00122     <span class="comment">//------------------------------------------------------------------------</span>
<a name="l00123"></a>00123 <span class="preprocessor">  #elif defined(CS_PLATFORM_WIN32)</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span>    CS_FORCEINLINE <span class="keywordtype">bool</span> DoLockWait()
<a name="l00125"></a>00125     {
<a name="l00126"></a>00126       ThreadID mythreadid = CurrentThreadID();
<a name="l00127"></a>00127       <span class="keywordflow">if</span>(mythreadid == threadid)
<a name="l00128"></a>00128         ++c;
<a name="l00129"></a>00129       <span class="keywordflow">else</span> {
<a name="l00130"></a>00130         <span class="keywordtype">int</span> spins = 0;
<a name="l00131"></a>00131         <span class="keywordflow">for</span> (;;) {
<a name="l00132"></a>00132           <span class="keywordflow">if</span> (!_InterlockedExchange(&amp;l, 1)) {
<a name="l00133"></a>00133             <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a>(!threadid);
<a name="l00134"></a>00134             threadid = mythreadid;
<a name="l00135"></a>00135             c = 1;
<a name="l00136"></a>00136             <span class="keywordflow">break</span>;
<a name="l00137"></a>00137           }
<a name="l00138"></a>00138           <span class="keywordflow">if</span> ((++spins &amp; spinsPerYield) == 0)
<a name="l00139"></a>00139             SleepEx (0, FALSE);
<a name="l00140"></a>00140         }
<a name="l00141"></a>00141       }
<a name="l00142"></a>00142       <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00143"></a>00143     }
<a name="l00144"></a>00144     CS_FORCEINLINE <span class="keywordtype">bool</span> DoLockTry()
<a name="l00145"></a>00145     {
<a name="l00146"></a>00146       <span class="keywordflow">if</span> (!_InterlockedExchange (&amp;l, 1)) {
<a name="l00147"></a>00147         <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a> (!threadid);
<a name="l00148"></a>00148         threadid = CurrentThreadID();
<a name="l00149"></a>00149         c = 1;
<a name="l00150"></a>00150         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00151"></a>00151       }
<a name="l00152"></a>00152       <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00153"></a>00153     }
<a name="l00154"></a>00154     CS_FORCEINLINE <span class="keywordtype">void</span> DoRelease()
<a name="l00155"></a>00155     {
<a name="l00156"></a>00156       <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a> (CurrentThreadID() == threadid);
<a name="l00157"></a>00157       <span class="keywordflow">if</span> (!--c) {
<a name="l00158"></a>00158         threadid = 0;
<a name="l00159"></a>00159         _InterlockedExchange (&amp;l, 0);
<a name="l00160"></a>00160       }
<a name="l00161"></a>00161     }
<a name="l00162"></a>00162     CS_FORCEINLINE <span class="keywordtype">void</span> Init() { threadid = 0; c = 0; l = 0; }
<a name="l00163"></a>00163     CS_FORCEINLINE <span class="keywordtype">void</span> Destroy() {}
<a name="l00164"></a>00164     <span class="comment">//------------------------------------------------------------------------</span>
<a name="l00165"></a>00165 <span class="preprocessor">  #else</span>
<a name="l00166"></a>00166 <span class="preprocessor"></span>    CS_FORCEINLINE <span class="keywordtype">bool</span> DoLockWait()
<a name="l00167"></a>00167     {
<a name="l00168"></a>00168       <span class="keywordflow">if</span>(!pthread_mutex_lock(&amp;l)){
<a name="l00169"></a>00169         c++;
<a name="l00170"></a>00170         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00171"></a>00171       }
<a name="l00172"></a>00172       <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00173"></a>00173     }
<a name="l00174"></a>00174     CS_FORCEINLINE <span class="keywordtype">bool</span> DoLockTry()
<a name="l00175"></a>00175     {
<a name="l00176"></a>00176       <span class="keywordflow">if</span>(!pthread_mutex_trylock(&amp;l)){
<a name="l00177"></a>00177         c++;
<a name="l00178"></a>00178         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00179"></a>00179       }
<a name="l00180"></a>00180       <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00181"></a>00181     }
<a name="l00182"></a>00182     CS_FORCEINLINE <span class="keywordtype">void</span> DoRelease()
<a name="l00183"></a>00183     {
<a name="l00184"></a>00184        --c;
<a name="l00185"></a>00185       pthread_mutex_unlock(&amp;l);
<a name="l00186"></a>00186     }
<a name="l00187"></a>00187     CS_FORCEINLINE <span class="keywordtype">void</span> Init() 
<a name="l00188"></a>00188     {
<a name="l00189"></a>00189       pthread_mutexattr_t attr;
<a name="l00190"></a>00190       c=0;
<a name="l00191"></a>00191       <span class="keywordflow">if</span>(pthread_mutexattr_init (&amp;attr)) <span class="keywordflow">return</span>;
<a name="l00192"></a>00192       <span class="keywordflow">if</span>(pthread_mutexattr_settype (&amp;attr, PTHREAD_MUTEX_RECURSIVE)) <span class="keywordflow">return</span>;
<a name="l00193"></a>00193       <span class="keywordflow">if</span>(pthread_mutex_init (&amp;l, &amp;attr)) <span class="keywordflow">return</span>;
<a name="l00194"></a>00194       pthread_mutexattr_destroy (&amp;attr);
<a name="l00195"></a>00195     }
<a name="l00196"></a>00196     CS_FORCEINLINE <span class="keywordtype">void</span> Destroy() {}
<a name="l00197"></a>00197 <span class="preprocessor">#endif</span>
<a name="l00198"></a>00198 <span class="preprocessor"></span>  <span class="keyword">public</span>:
<a name="l00199"></a><a class="code" href="classCS_1_1SpinLock.html#b2f26e062610239a36bae5679c7d5513">00199</a>     <a class="code" href="classCS_1_1SpinLock.html#b2f26e062610239a36bae5679c7d5513">SpinLock</a>()
<a name="l00200"></a>00200     { Init(); }
<a name="l00201"></a><a class="code" href="classCS_1_1SpinLock.html#1c342efda4ae6b79059b6e7eda224d9f">00201</a>     <a class="code" href="classCS_1_1SpinLock.html#1c342efda4ae6b79059b6e7eda224d9f">~SpinLock</a>() { Destroy(); }
<a name="l00202"></a>00202   
<a name="l00203"></a><a class="code" href="classCS_1_1SpinLock.html#af6d17a8895b4067c3bef07f0282a1e3">00203</a>     CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1SpinLock.html#af6d17a8895b4067c3bef07f0282a1e3">LockWait</a>()
<a name="l00204"></a>00204     { <span class="keywordflow">return</span> DoLockWait(); }
<a name="l00205"></a><a class="code" href="classCS_1_1SpinLock.html#160c1d907e2c0d1fb54d990eff33461d">00205</a>     CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1SpinLock.html#160c1d907e2c0d1fb54d990eff33461d">LockTry</a>()
<a name="l00206"></a>00206     { <span class="keywordflow">return</span> DoLockTry(); }
<a name="l00207"></a><a class="code" href="classCS_1_1SpinLock.html#3d09278a40ea95cd926c8c82a08f990c">00207</a>     CS_FORCEINLINE <span class="keywordtype">void</span> <a class="code" href="classCS_1_1SpinLock.html#3d09278a40ea95cd926c8c82a08f990c">Release</a>()
<a name="l00208"></a>00208     { DoRelease(); }
<a name="l00209"></a>00209   };
<a name="l00210"></a>00210 } <span class="comment">// namespace CS</span>
<a name="l00211"></a>00211 
<a name="l00214"></a>00214 <span class="preprocessor">#endif // __CS_CSUTIL_SPINLOCK_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional