impl_2codegen_2atm_8h.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: include/grpc/impl/codegen/atm.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Core
  25. &#160;<span id="projectnumber">15.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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_4b3e2ed696753daba329e2683e0f6479.html">impl</a></li><li class="navelem"><a class="el" href="dir_7a167954ab48275cc692d783196d1f28.html">codegen</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#func-members">Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">atm.h File Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <div class="textblock"><code>#include &lt;<a class="el" href="impl_2codegen_2port__platform_8h_source.html">grpc/impl/codegen/port_platform.h</a>&gt;</code><br />
  74. </div>
  75. <p><a href="impl_2codegen_2atm_8h_source.html">Go to the source code of this file.</a></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  78. Functions</h2></td></tr>
  79. <tr class="memitem:acd924aafc13347097cc06c74c8b5a68d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2atm_8h.html#acd924aafc13347097cc06c74c8b5a68d">gpr_atm_no_barrier_clamped_add</a> (<a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a> *value, <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a> delta, <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a> min, <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a> max)</td></tr>
  80. <tr class="memdesc:acd924aafc13347097cc06c74c8b5a68d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This interface provides atomic operations and barriers. <a href="impl_2codegen_2atm_8h.html#acd924aafc13347097cc06c74c8b5a68d">More...</a><br /></td></tr>
  81. <tr class="separator:acd924aafc13347097cc06c74c8b5a68d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. </table>
  83. <h2 class="groupheader">Function Documentation</h2>
  84. <a id="acd924aafc13347097cc06c74c8b5a68d"></a>
  85. <h2 class="memtitle"><span class="permalink"><a href="#acd924aafc13347097cc06c74c8b5a68d">&#9670;&nbsp;</a></span>gpr_atm_no_barrier_clamped_add()</h2>
  86. <div class="memitem">
  87. <div class="memproto">
  88. <table class="memname">
  89. <tr>
  90. <td class="memname"><a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a> gpr_atm_no_barrier_clamped_add </td>
  91. <td>(</td>
  92. <td class="paramtype"><a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a> *&#160;</td>
  93. <td class="paramname"><em>value</em>, </td>
  94. </tr>
  95. <tr>
  96. <td class="paramkey"></td>
  97. <td></td>
  98. <td class="paramtype"><a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a>&#160;</td>
  99. <td class="paramname"><em>delta</em>, </td>
  100. </tr>
  101. <tr>
  102. <td class="paramkey"></td>
  103. <td></td>
  104. <td class="paramtype"><a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a>&#160;</td>
  105. <td class="paramname"><em>min</em>, </td>
  106. </tr>
  107. <tr>
  108. <td class="paramkey"></td>
  109. <td></td>
  110. <td class="paramtype"><a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a0a6314f31fcae0666a93961bed98af51">gpr_atm</a>&#160;</td>
  111. <td class="paramname"><em>max</em>&#160;</td>
  112. </tr>
  113. <tr>
  114. <td></td>
  115. <td>)</td>
  116. <td></td><td></td>
  117. </tr>
  118. </table>
  119. </div><div class="memdoc">
  120. <p>This interface provides atomic operations and barriers. </p>
  121. <p>It is internal to gpr support code and should not be used outside it.</p>
  122. <p>If an operation with acquire semantics precedes another memory access by the same thread, the operation will precede that other access as seen by other threads.</p>
  123. <p>If an operation with release semantics follows another memory access by the same thread, the operation will follow that other access as seen by other threads.</p>
  124. <p>Routines with "acq" or "full" in the name have acquire semantics. Routines with "rel" or "full" in the name have release semantics. Routines with "no_barrier" in the name have neither acquire not release semantics.</p>
  125. <p>The routines may be implemented as macros.</p>
  126. <p>Atomic operations act on an intergral_type gpr_atm that is guaranteed to be the same size as a pointer. typedef intptr_t gpr_atm;</p>
  127. <p>A memory barrier, providing both acquire and release semantics, but not otherwise acting on memory. void <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#a95f86e51ae9a479026bd237cb792193e">gpr_atm_full_barrier(void)</a>;</p>
  128. <p>Atomically return *p, with acquire semantics. gpr_atm <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a44607f95f7ee40eba592c7fe10960a06">gpr_atm_acq_load(gpr_atm *p)</a>; gpr_atm <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#aa647aa9c97294a6709bbf2ac401cd9a6">gpr_atm_no_barrier_load(gpr_atm *p)</a>;</p>
  129. <p>Atomically set *p = value, with release semantics. void <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a42e3982d45ae4cec439a12b8fcd618e9">gpr_atm_rel_store(gpr_atm *p, gpr_atm value)</a>;</p>
  130. <p>Atomically add delta to *p, and return the old value of *p, with the barriers specified. gpr_atm <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#ae337dc477a6a45ac3d91e41e8f3f2f8c">gpr_atm_no_barrier_fetch_add(gpr_atm *p, gpr_atm delta)</a>; gpr_atm <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#abada8771b338845e4c6ef93c8392582c">gpr_atm_full_fetch_add(gpr_atm *p, gpr_atm delta)</a>;</p>
  131. <p>Atomically, if *p==o, set *p=n and return non-zero otherwise return 0, with the barriers specified if the operation succeeds. int <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#ad39536b08912ac4a0770655ed334d260">gpr_atm_no_barrier_cas(gpr_atm *p, gpr_atm o, gpr_atm n)</a>; int <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#a1a90e5777158aaa53624822f1f87dd90">gpr_atm_acq_cas(gpr_atm *p, gpr_atm o, gpr_atm n)</a>; int <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#ae7c3b215cda868ee9ee778822000c3f2">gpr_atm_rel_cas(gpr_atm *p, gpr_atm o, gpr_atm n)</a>; int <a class="el" href="impl_2codegen_2atm__gcc__sync_8h.html#a9d29f224b49d4de8bb2b0d7feae64fcb">gpr_atm_full_cas(gpr_atm *p, gpr_atm o, gpr_atm n)</a>;</p>
  132. <p>Atomically, set *p=n and return the old value of *p gpr_atm <a class="el" href="impl_2codegen_2atm__gcc__atomic_8h.html#a724691b6d48f35bbd9f575c82fdfb526">gpr_atm_full_xchg(gpr_atm *p, gpr_atm n)</a>; Adds <em>delta</em> to <em>*value</em>, clamping the result to the range specified by <em>min</em> and <em>max</em>. Returns the new value. </p>
  133. </div>
  134. </div>
  135. </div><!-- contents -->
  136. <!-- start footer part -->
  137. <hr class="footer"/><address class="footer"><small>
  138. Generated on Wed Mar 3 2021 19:17:10 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  139. <img class="footer" src="doxygen.png" alt="doxygen"/>
  140. </a> 1.8.17
  141. </small></address>
  142. </body>
  143. </html>