diff options
Diffstat (limited to 'doc/ref/core.internal/html/atm_8h_source.html')
| -rw-r--r-- | doc/ref/core.internal/html/atm_8h_source.html | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/doc/ref/core.internal/html/atm_8h_source.html b/doc/ref/core.internal/html/atm_8h_source.html new file mode 100644 index 0000000000..7cfe4b08e2 --- /dev/null +++ b/doc/ref/core.internal/html/atm_8h_source.html @@ -0,0 +1,195 @@ +<!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.6"/> +<title>GRPC Core: include/grpc/support/atm.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="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">GRPC Core +  <span id="projectnumber">0.10.0.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_cad3142e04109052413f2d2a2d1813b0.html">support</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">atm.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="atm_8h.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">/*</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015, Google Inc.</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modification, are permitted provided that the following conditions are</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * met:</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * * Redistributions of source code must retain the above copyright</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * * Redistributions in binary form must reproduce the above</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * in the documentation and/or other materials provided with the</span></div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * distribution.</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * * Neither the name of Google Inc. nor the names of its</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * contributors may be used to endorse or promote products derived from</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * this software without specific prior written permission.</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</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 GRPC_SUPPORT_ATM_H</span></div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define GRPC_SUPPORT_ATM_H</span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/* This interface provides atomic operations and barriers.</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> It is internal to gpr support code and should not be used outside it.</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> If an operation with acquire semantics precedes another memory access by the</span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> same thread, the operation will precede that other access as seen by other</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> threads.</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> If an operation with release semantics follows another memory access by the</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> same thread, the operation will follow that other access as seen by other</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> threads.</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> Routines with "acq" or "full" in the name have acquire semantics. Routines</span></div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> with "rel" or "full" in the name have release semantics. Routines with</span></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> "no_barrier" in the name have neither acquire not release semantics.</span></div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> The routines may be implemented as macros.</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> // Atomic operations act on an intergral_type gpr_atm that is guaranteed to</span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> // be the same size as a pointer.</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> typedef gpr_intptr gpr_atm;</span></div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> // A memory barrier, providing both acquire and release semantics, but not</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> // otherwise acting on memory.</span></div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> void gpr_atm_full_barrier(void);</span></div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> // Atomically return *p, with acquire semantics.</span></div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> gpr_atm gpr_atm_acq_load(gpr_atm *p);</span></div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span></div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> // Atomically set *p = value, with release semantics.</span></div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> void gpr_atm_rel_store(gpr_atm *p, gpr_atm value);</span></div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> // Atomically add delta to *p, and return the old value of *p, with</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> // the barriers specified.</span></div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> gpr_atm gpr_atm_no_barrier_fetch_add(gpr_atm *p, gpr_atm delta);</span></div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> gpr_atm gpr_atm_full_fetch_add(gpr_atm *p, gpr_atm delta);</span></div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> // Atomically, if *p==o, set *p=n and return non-zero otherwise return 0,</span></div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> // with the barriers specified if the operation succeeds.</span></div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> int gpr_atm_no_barrier_cas(gpr_atm *p, gpr_atm o, gpr_atm n);</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> int gpr_atm_acq_cas(gpr_atm *p, gpr_atm o, gpr_atm n);</span></div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> int gpr_atm_rel_cas(gpr_atm *p, gpr_atm o, gpr_atm n);</span></div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">*/</span></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> <span class="preprocessor">#include <<a class="code" href="port__platform_8h.html">grpc/support/port_platform.h</a>></span></div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#if defined(GPR_GCC_ATOMIC)</span></div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="atm__gcc__atomic_8h.html">grpc/support/atm_gcc_atomic.h</a>></span></div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#elif defined(GPR_GCC_SYNC)</span></div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="atm__gcc__sync_8h.html">grpc/support/atm_gcc_sync.h</a>></span></div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#elif defined(GPR_WIN32_ATOMIC)</span></div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="atm__win32_8h.html">grpc/support/atm_win32.h</a>></span></div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#else</span></div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span><span class="preprocessor">#error could not determine platform for atm</span></div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif </span><span class="comment">/* GRPC_SUPPORT_ATM_H */</span><span class="preprocessor"></span></div> +<div class="ttc" id="port__platform_8h_html"><div class="ttname"><a href="port__platform_8h.html">port_platform.h</a></div></div> +<div class="ttc" id="atm__win32_8h_html"><div class="ttname"><a href="atm__win32_8h.html">atm_win32.h</a></div></div> +<div class="ttc" id="atm__gcc__atomic_8h_html"><div class="ttname"><a href="atm__gcc__atomic_8h.html">atm_gcc_atomic.h</a></div></div> +<div class="ttc" id="atm__gcc__sync_8h_html"><div class="ttname"><a href="atm__gcc__sync_8h.html">atm_gcc_sync.h</a></div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Wed Aug 5 2015 08:17:07 for GRPC Core by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |