<!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/threading/win32_mutex.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 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 Pages</span></a></li> </ul> </div> <h1>csutil/threading/win32_mutex.h</h1><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 Marten Svanfeldt</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 Lesser 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_THREADING_WIN32_MUTEX_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_THREADING_WIN32_MUTEX_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="atomicops_8h.html" title="Basic low-level atomic operations for different processors.">csutil/threading/atomicops.h</a>"</span> <a name="l00023"></a>00023 <span class="preprocessor">#include "csutil/threading/win32_apifuncs.h"</span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#if !defined(CS_PLATFORM_WIN32)</span> <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#error "This file is only for Windows and requires you to include csysdefs.h before"</span> <a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#else</span> <a name="l00028"></a>00028 <span class="preprocessor"></span> <a name="l00029"></a>00029 <span class="keyword">namespace </span>CS <a name="l00030"></a>00030 { <a name="l00031"></a>00031 <span class="keyword">namespace </span>Threading <a name="l00032"></a>00032 { <a name="l00033"></a>00033 <span class="keyword">namespace </span>Implementation <a name="l00034"></a>00034 { <a name="l00035"></a>00035 <a name="l00039"></a>00039 <span class="keyword">class </span>MutexBase <a name="l00040"></a>00040 { <a name="l00041"></a>00041 <span class="keyword">public</span>: <a name="l00042"></a>00042 <span class="keywordtype">void</span> Initialize () <a name="l00043"></a>00043 { <a name="l00044"></a>00044 activeFlag = 0; <a name="l00045"></a>00045 semaphore = 0; <a name="l00046"></a>00046 } <a name="l00047"></a>00047 <a name="l00048"></a>00048 <span class="keywordtype">void</span> Destroy () <a name="l00049"></a>00049 { <a name="l00050"></a>00050 <span class="keywordtype">void</span>* oldSemaphore = AtomicOperations::Set (&semaphore, (<span class="keywordtype">void</span>*)0); <a name="l00051"></a>00051 <span class="keywordflow">if</span> (oldSemaphore) <a name="l00052"></a>00052 { <a name="l00053"></a>00053 Implementation::CloseHandle (semaphore); <a name="l00054"></a>00054 } <a name="l00055"></a>00055 } <a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="keywordtype">bool</span> IsLocked () <a name="l00058"></a>00058 { <a name="l00059"></a>00059 <span class="keywordflow">return</span> AtomicOperations::Read (&activeFlag) > 0; <a name="l00060"></a>00060 } <a name="l00061"></a>00061 <a name="l00062"></a>00062 <span class="keywordtype">bool</span> Lock () <a name="l00063"></a>00063 { <a name="l00064"></a>00064 <span class="keywordflow">if</span> (AtomicOperations::Increment (&activeFlag) != 1) <a name="l00065"></a>00065 { <a name="l00066"></a>00066 Implementation::WaitForSingleObject (GetSemaphore (), INFINITE); <a name="l00067"></a>00067 } <a name="l00068"></a>00068 <span class="keywordflow">return</span> IsLocked (); <a name="l00069"></a>00069 } <a name="l00070"></a>00070 <a name="l00071"></a>00071 <span class="keywordtype">bool</span> TryLock () <a name="l00072"></a>00072 { <a name="l00073"></a>00073 <span class="keywordflow">return</span> !AtomicOperations::CompareAndSet (&activeFlag, 1, 0); <a name="l00074"></a>00074 } <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="keywordtype">void</span> Unlock () <a name="l00077"></a>00077 { <a name="l00078"></a>00078 <span class="keywordflow">if</span> (AtomicOperations::Decrement (&activeFlag) > 0) <a name="l00079"></a>00079 { <a name="l00080"></a>00080 Implementation::ReleaseSemaphore (GetSemaphore (), 1, 0); <a name="l00081"></a>00081 } <a name="l00082"></a>00082 } <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="keyword">private</span>: <a name="l00085"></a>00085 <span class="keywordtype">void</span>* GetSemaphore () <a name="l00086"></a>00086 { <a name="l00087"></a>00087 <span class="keywordtype">void</span>* currentSem = AtomicOperations::Read (&semaphore); <a name="l00088"></a>00088 <span class="keywordflow">if</span> (!currentSem) <a name="l00089"></a>00089 { <a name="l00090"></a>00090 <span class="comment">//Create a new semaphore and try to set it</span> <a name="l00091"></a>00091 <span class="keywordtype">void</span>* <span class="keyword">const</span> newSem = Implementation::CreateSemaphoreA (0,0,1,0); <a name="l00092"></a>00092 <span class="keywordtype">void</span>* <span class="keyword">const</span> oldSem = AtomicOperations::CompareAndSet (&semaphore, <a name="l00093"></a>00093 newSem, 0); <a name="l00094"></a>00094 <a name="l00095"></a>00095 <span class="comment">//We already have one, use it</span> <a name="l00096"></a>00096 <span class="keywordflow">if</span> (oldSem != 0) <a name="l00097"></a>00097 { <a name="l00098"></a>00098 Implementation::CloseHandle (newSem); <a name="l00099"></a>00099 <span class="keywordflow">return</span> oldSem; <a name="l00100"></a>00100 } <a name="l00101"></a>00101 <span class="keywordflow">else</span> <a name="l00102"></a>00102 { <a name="l00103"></a>00103 <span class="comment">//We didn't have any before, so use our new semaphore</span> <a name="l00104"></a>00104 <span class="keywordflow">return</span> newSem; <a name="l00105"></a>00105 } <a name="l00106"></a>00106 } <a name="l00107"></a>00107 <span class="keywordflow">return</span> currentSem; <a name="l00108"></a>00108 } <a name="l00109"></a>00109 <a name="l00110"></a>00110 <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> activeFlag; <span class="comment">//Lock flag for mutex</span> <a name="l00111"></a>00111 <span class="keywordtype">void</span>* semaphore; <span class="comment">//Semaphore for being able to wait for</span> <a name="l00112"></a>00112 }; <a name="l00113"></a>00113 <a name="l00114"></a>00114 <a name="l00118"></a>00118 <span class="keyword">class </span>RecursiveMutexBase <a name="l00119"></a>00119 { <a name="l00120"></a>00120 <span class="keyword">public</span>: <a name="l00121"></a>00121 <span class="keywordtype">void</span> Initialize () <a name="l00122"></a>00122 { <a name="l00123"></a>00123 recursionCount = 0; <a name="l00124"></a>00124 lockingThreadID = 0; <a name="l00125"></a>00125 mutex.Initialize (); <a name="l00126"></a>00126 } <a name="l00127"></a>00127 <a name="l00128"></a>00128 <span class="keywordtype">void</span> Destroy () <a name="l00129"></a>00129 { <a name="l00130"></a>00130 mutex.Destroy (); <a name="l00131"></a>00131 } <a name="l00132"></a>00132 <a name="l00133"></a>00133 <span class="keywordtype">bool</span> IsLocked () <a name="l00134"></a>00134 { <a name="l00135"></a>00135 <span class="keywordflow">return</span> mutex.IsLocked (); <a name="l00136"></a>00136 } <a name="l00137"></a>00137 <a name="l00138"></a>00138 <span class="keywordtype">bool</span> Lock () <a name="l00139"></a>00139 { <a name="l00140"></a>00140 <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> currentThreadID = (<a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a>)Implementation::GetCurrentThreadId (); <a name="l00141"></a>00141 <span class="keywordflow">if</span> (!TryRecursiveLock (currentThreadID)) <a name="l00142"></a>00142 { <a name="l00143"></a>00143 mutex.Lock (); <a name="l00144"></a>00144 AtomicOperations::Set (&lockingThreadID, currentThreadID); <a name="l00145"></a>00145 recursionCount = 1; <a name="l00146"></a>00146 } <a name="l00147"></a>00147 <span class="keywordflow">return</span> IsLocked (); <a name="l00148"></a>00148 } <a name="l00149"></a>00149 <a name="l00150"></a>00150 <span class="keywordtype">bool</span> TryLock () <a name="l00151"></a>00151 { <a name="l00152"></a>00152 <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> currentThreadID = (<a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a>)Implementation::GetCurrentThreadId (); <a name="l00153"></a>00153 <span class="keywordflow">return</span> TryRecursiveLock (currentThreadID) || <a name="l00154"></a>00154 TryNormalLock (currentThreadID); <a name="l00155"></a>00155 } <a name="l00156"></a>00156 <a name="l00157"></a>00157 <span class="keywordtype">void</span> Unlock () <a name="l00158"></a>00158 { <a name="l00159"></a>00159 <span class="keywordflow">if</span>(!--recursionCount) <a name="l00160"></a>00160 { <a name="l00161"></a>00161 AtomicOperations::Set (&lockingThreadID, 0); <a name="l00162"></a>00162 mutex.Unlock (); <a name="l00163"></a>00163 } <a name="l00164"></a>00164 } <a name="l00165"></a>00165 <a name="l00166"></a>00166 <span class="keyword">private</span>: <a name="l00167"></a>00167 <span class="keywordtype">bool</span> TryRecursiveLock (<a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> currentThreadID) <a name="l00168"></a>00168 { <a name="l00169"></a>00169 <span class="keywordflow">if</span> (AtomicOperations::Read (&lockingThreadID) == currentThreadID) <a name="l00170"></a>00170 { <a name="l00171"></a>00171 ++recursionCount; <a name="l00172"></a>00172 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00173"></a>00173 } <a name="l00174"></a>00174 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00175"></a>00175 } <a name="l00176"></a>00176 <a name="l00177"></a>00177 <span class="keywordtype">bool</span> TryNormalLock (<a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> currentThreadID) <a name="l00178"></a>00178 { <a name="l00179"></a>00179 <span class="keywordflow">if</span> (mutex.TryLock ()) <a name="l00180"></a>00180 { <a name="l00181"></a>00181 AtomicOperations::Set (&lockingThreadID, currentThreadID); <a name="l00182"></a>00182 recursionCount = 1; <a name="l00183"></a>00183 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00184"></a>00184 } <a name="l00185"></a>00185 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00186"></a>00186 } <a name="l00187"></a>00187 <a name="l00188"></a>00188 MutexBase mutex; <span class="comment">//Non-recursive base-mutex</span> <a name="l00189"></a>00189 <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> recursionCount; <a name="l00190"></a>00190 <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> lockingThreadID; <a name="l00191"></a>00191 }; <a name="l00192"></a>00192 <a name="l00193"></a>00193 } <span class="comment">// namespace Implementation</span> <a name="l00194"></a>00194 } <span class="comment">// namespace Threading</span> <a name="l00195"></a>00195 } <span class="comment">// namespace CS</span> <a name="l00196"></a>00196 <a name="l00197"></a>00197 <span class="preprocessor">#endif // !defined(CS_PLATFORM_WIN32)</span> <a name="l00198"></a>00198 <span class="preprocessor"></span> <a name="l00199"></a>00199 <span class="preprocessor">#endif // __CS_CSUTIL_THREADING_WIN32_MUTEX_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>