<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: compatibility.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a14797_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">parallel/compatibility.h</div> </div> </div><!--header--> <div class="contents"> <a href="a14797.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2007-2015 Free Software Foundation, Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This file is part of the GNU ISO C++ Library. This library is free</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// software; you can redistribute it and/or modify it under the terms</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// of the GNU General Public License as published by the Free Software</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Foundation; either version 3, or (at your option) any later</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// version.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// This library is distributed in the hope that it will be useful, but</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// General Public License for more details.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Under Section 7 of GPL version 3, you are granted additional</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// permissions described in the GCC Runtime Library Exception, version</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 3.1, as published by the Free Software Foundation.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// You should have received a copy of the GNU General Public License and</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// a copy of the GCC Runtime Library Exception along with this program;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/** @file parallel/compatibility.h</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @brief Compatibility layer, mostly concerned with atomic operations.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * This file is a GNU parallel extension to the Standard C++ Library</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * and contains implementation details for the library's internal use.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Written by Felix Putze.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef _GLIBCXX_PARALLEL_COMPATIBILITY_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define _GLIBCXX_PARALLEL_COMPATIBILITY_H 1</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <<a class="code" href="a00914.html">parallel/types.h</a>></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <<a class="code" href="a14758.html">parallel/base.h</a>></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#if !defined(_WIN32) || defined (__CYGWIN__)</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <sched.h></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifdef __MINGW32__</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// Including <windows.h> will drag in all the windows32 names. Since</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// that can cause user code portability problems, we just declare the</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// one needed function here.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> __attribute((dllimport)) <span class="keywordtype">void</span> __attribute__((stdcall)) Sleep (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">namespace </span><a class="code" href="a01519.html">__gnu_parallel</a></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Tp></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">inline</span> _Tp</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  __add_omp(<span class="keyword">volatile</span> _Tp* __ptr, _Tp __addend)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  int64_t __res;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#pragma omp critical</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  __res = *__ptr;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  *(__ptr) += __addend;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> __res;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /** @brief Add a value to a variable, atomically.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> *</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @param __ptr Pointer to a signed integer.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @param __addend Value to add.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Tp></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">inline</span> _Tp</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="a01519.html#a56a5a84c8a6049cd3cc83968c6eae088"> 74</a></span>  <a class="code" href="a01519.html#a56a5a84c8a6049cd3cc83968c6eae088">__fetch_and_add</a>(<span class="keyword">volatile</span> _Tp* __ptr, _Tp __addend)</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">if</span> (__atomic_always_lock_free(<span class="keyword">sizeof</span>(_Tp), __ptr))</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span> __atomic_fetch_add(__ptr, __addend, __ATOMIC_ACQ_REL);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> __add_omp(__ptr, __addend);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Tp></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  __cas_omp(<span class="keyword">volatile</span> _Tp* __ptr, _Tp __comparand, _Tp __replacement)</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> __res = <span class="keyword">false</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#pragma omp critical</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">if</span> (*__ptr == __comparand)</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  *__ptr = __replacement;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  __res = <span class="keyword">true</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> __res;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /** @brief Compare-and-swap</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> *</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * Compare @c *__ptr and @c __comparand. If equal, let @c</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * *__ptr=__replacement and return @c true, return @c false otherwise.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> *</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param __ptr Pointer to signed integer.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param __comparand Compare value.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param __replacement Replacement value.</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Tp></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="a01519.html#accd4441e0f846fee44966195a91e9e68"> 108</a></span>  <a class="code" href="a01519.html#accd4441e0f846fee44966195a91e9e68">__compare_and_swap</a>(<span class="keyword">volatile</span> _Tp* __ptr, _Tp __comparand, _Tp __replacement)</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span> (__atomic_always_lock_free(<span class="keyword">sizeof</span>(_Tp), __ptr))</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> __atomic_compare_exchange_n(__ptr, &__comparand, __replacement,</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">false</span>, __ATOMIC_ACQ_REL,</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  __ATOMIC_RELAXED);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> __cas_omp(__ptr, __comparand, __replacement);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /** @brief Yield control to another thread, without waiting for</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * the end of the time slice.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> */</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span></div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="a01519.html#aaa76236af73146ae89f726921bc3f2cb"> 121</a></span>  <a class="code" href="a01519.html#aaa76236af73146ae89f726921bc3f2cb">__yield</a>()</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#if defined (_WIN32) && !defined (__CYGWIN__)</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  Sleep(0);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  sched_yield();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> } <span class="comment">// end namespace</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#endif </span><span class="comment">/* _GLIBCXX_PARALLEL_COMPATIBILITY_H */</span><span class="preprocessor"></span></div><div class="ttc" id="a01519_html"><div class="ttname"><a href="a01519.html">__gnu_parallel</a></div><div class="ttdoc">GNU parallel code for public use. </div><div class="ttdef"><b>Definition:</b> <a href="a00815_source.html#l00058">balanced_quicksort.h:58</a></div></div> <div class="ttc" id="a14758_html"><div class="ttname"><a href="a14758.html">base.h</a></div><div class="ttdoc">Sequential helper functions. This file is a GNU parallel extension to the Standard C++ Library...</div></div> <div class="ttc" id="a01519_html_a56a5a84c8a6049cd3cc83968c6eae088"><div class="ttname"><a href="a01519.html#a56a5a84c8a6049cd3cc83968c6eae088">__gnu_parallel::__fetch_and_add</a></div><div class="ttdeci">_Tp __fetch_and_add(volatile _Tp *__ptr, _Tp __addend)</div><div class="ttdoc">Add a value to a variable, atomically. </div><div class="ttdef"><b>Definition:</b> <a href="a14797_source.html#l00074">parallel/compatibility.h:74</a></div></div> <div class="ttc" id="a01519_html_accd4441e0f846fee44966195a91e9e68"><div class="ttname"><a href="a01519.html#accd4441e0f846fee44966195a91e9e68">__gnu_parallel::__compare_and_swap</a></div><div class="ttdeci">bool __compare_and_swap(volatile _Tp *__ptr, _Tp __comparand, _Tp __replacement)</div><div class="ttdoc">Compare-and-swap. </div><div class="ttdef"><b>Definition:</b> <a href="a14797_source.html#l00108">parallel/compatibility.h:108</a></div></div> <div class="ttc" id="a01519_html_aaa76236af73146ae89f726921bc3f2cb"><div class="ttname"><a href="a01519.html#aaa76236af73146ae89f726921bc3f2cb">__gnu_parallel::__yield</a></div><div class="ttdeci">void __yield()</div><div class="ttdoc">Yield control to another thread, without waiting for the end of the time slice. </div><div class="ttdef"><b>Definition:</b> <a href="a14797_source.html#l00121">parallel/compatibility.h:121</a></div></div> <div class="ttc" id="a00914_html"><div class="ttname"><a href="a00914.html">types.h</a></div><div class="ttdoc">Basic types and typedefs. This file is a GNU parallel extension to the Standard C++ Library...</div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_3a83f109ff04170a1f8448445d1bdcba.html">include</a></li><li class="navelem"><a class="el" href="dir_2f1ac407c3bb97b79c0150323d069a39.html">parallel</a></li><li class="navelem"><a class="el" href="a14797.html">compatibility.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>