Home Explore Help
Sign In
levovix
/
Nim
mirror of https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Tree: 1a4643a625
Branches Tags
Nim
/
sysatomics.html

sysatomics.html 84 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/sysatomics</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/sysatomics</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <details open>
    56. 

  56.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    57. 

  57.     <ul class="simple simple-toc-section">
    58. 

  58.       <li><a class="reference" href="#AtomMemModel" title="AtomMemModel = distinct cint">AtomMemModel</a></li>
    59. 

  59. <li><a class="reference" href="#AtomType" title="AtomType = SomeNumber | pointer | ptr | char | bool">AtomType</a></li>
    60. 

  60. 

  61.     </ul>
    62. 

  62.   </details>
    63. 

  63. </li>
    64. 

  64. <li>
    65. 

  65.   <details open>
    66. 

  66.     <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
    67. 

  67.     <ul class="simple simple-toc-section">
    68. 

  68.       <li><a class="reference" href="#ATOMIC_ACQ_REL" title="ATOMIC_ACQ_REL {.importc: &quot;__ATOMIC_ACQ_REL&quot;, nodecl.}: AtomMemModel">ATOMIC_ACQ_REL</a></li>
    69. 

  69. <li><a class="reference" href="#ATOMIC_ACQUIRE" title="ATOMIC_ACQUIRE {.importc: &quot;__ATOMIC_ACQUIRE&quot;, nodecl.}: AtomMemModel">ATOMIC_ACQUIRE</a></li>
    70. 

  70. <li><a class="reference" href="#ATOMIC_CONSUME" title="ATOMIC_CONSUME {.importc: &quot;__ATOMIC_CONSUME&quot;, nodecl.}: AtomMemModel">ATOMIC_CONSUME</a></li>
    71. 

  71. <li><a class="reference" href="#ATOMIC_RELAXED" title="ATOMIC_RELAXED {.importc: &quot;__ATOMIC_RELAXED&quot;, nodecl.}: AtomMemModel">ATOMIC_RELAXED</a></li>
    72. 

  72. <li><a class="reference" href="#ATOMIC_RELEASE" title="ATOMIC_RELEASE {.importc: &quot;__ATOMIC_RELEASE&quot;, nodecl.}: AtomMemModel">ATOMIC_RELEASE</a></li>
    73. 

  73. <li><a class="reference" href="#ATOMIC_SEQ_CST" title="ATOMIC_SEQ_CST {.importc: &quot;__ATOMIC_SEQ_CST&quot;, nodecl.}: AtomMemModel">ATOMIC_SEQ_CST</a></li>
    74. 

  74. 

  75.     </ul>
    76. 

  76.   </details>
    77. 

  77. </li>
    78. 

  78. <li>
    79. 

  79.   <details open>
    80. 

  80.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    81. 

  81.     <ul class="simple simple-toc-section">
    82. 

  82.       <ul class="simple nested-toc-section">atomicAddFetch
    83. 

  83.   <li><a class="reference" href="#atomicAddFetch%2Cptr.T%2CT%2CAtomMemModel" title="atomicAddFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicAddFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    84. 

  84. 

  85. </ul>
    86. 

  86. <ul class="simple nested-toc-section">atomicAlwaysLockFree
    87. 

  87.   <li><a class="reference" href="#atomicAlwaysLockFree%2Cint%2Cpointer" title="atomicAlwaysLockFree(size: int; p: pointer): bool">atomicAlwaysLockFree(size: int; p: pointer): bool</a></li>
    88. 

  88. 

  89. </ul>
    90. 

  90. <ul class="simple nested-toc-section">atomicAndFetch
    91. 

  91.   <li><a class="reference" href="#atomicAndFetch%2Cptr.T%2CT%2CAtomMemModel" title="atomicAndFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicAndFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">atomicClear
    95. 

  95.   <li><a class="reference" href="#atomicClear%2Cpointer%2CAtomMemModel" title="atomicClear(p: pointer; mem: AtomMemModel)">atomicClear(p: pointer; mem: AtomMemModel)</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">atomicCompareExchange
    99. 

  99.   <li><a class="reference" href="#atomicCompareExchange%2Cptr.T%2Cptr.T%2Cptr.T%2Cbool%2CAtomMemModel%2CAtomMemModel" title="atomicCompareExchange[T: AtomType](p, expected, desired: ptr T; weak: bool;
    100. 

  100.                                    success_memmodel: AtomMemModel;
    101. 

  101.                                    failure_memmodel: AtomMemModel): bool">atomicCompareExchange[T: AtomType](p, expected, desired: ptr T; weak: bool;
    102. 

  102.                                    success_memmodel: AtomMemModel;
    103. 

  103.                                    failure_memmodel: AtomMemModel): bool</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. <ul class="simple nested-toc-section">atomicCompareExchangeN
    107. 

  107.   <li><a class="reference" href="#atomicCompareExchangeN%2Cptr.T%2Cptr.T%2CT%2Cbool%2CAtomMemModel%2CAtomMemModel" title="atomicCompareExchangeN[T: AtomType](p, expected: ptr T; desired: T; weak: bool;
    108. 

  108.                                     success_memmodel: AtomMemModel;
    109. 

  109.                                     failure_memmodel: AtomMemModel): bool">atomicCompareExchangeN[T: AtomType](p, expected: ptr T; desired: T; weak: bool;
    110. 

  110.                                     success_memmodel: AtomMemModel;
    111. 

  111.                                     failure_memmodel: AtomMemModel): bool</a></li>
    112. 

  112. 

  113. </ul>
    114. 

  114. <ul class="simple nested-toc-section">atomicDec
    115. 

  115.   <li><a class="reference" href="#atomicDec%2Cint%2Cint" title="atomicDec(memLoc: var int; x: int = 1): int">atomicDec(memLoc: var int; x: int = 1): int</a></li>
    116. 

  116. 

  117. </ul>
    118. 

  118. <ul class="simple nested-toc-section">atomicExchange
    119. 

  119.   <li><a class="reference" href="#atomicExchange%2Cptr.T%2Cptr.T%2Cptr.T%2CAtomMemModel" title="atomicExchange[T: AtomType](p, val, ret: ptr T; mem: AtomMemModel)">atomicExchange[T: AtomType](p, val, ret: ptr T; mem: AtomMemModel)</a></li>
    120. 

  120. 

  121. </ul>
    122. 

  122. <ul class="simple nested-toc-section">atomicExchangeN
    123. 

  123.   <li><a class="reference" href="#atomicExchangeN%2Cptr.T%2CT%2CAtomMemModel" title="atomicExchangeN[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicExchangeN[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    124. 

  124. 

  125. </ul>
    126. 

  126. <ul class="simple nested-toc-section">atomicFetchAdd
    127. 

  127.   <li><a class="reference" href="#atomicFetchAdd%2Cptr.T%2CT%2CAtomMemModel" title="atomicFetchAdd[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicFetchAdd[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    128. 

  128. 

  129. </ul>
    130. 

  130. <ul class="simple nested-toc-section">atomicFetchAnd
    131. 

  131.   <li><a class="reference" href="#atomicFetchAnd%2Cptr.T%2CT%2CAtomMemModel" title="atomicFetchAnd[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicFetchAnd[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    132. 

  132. 

  133. </ul>
    134. 

  134. <ul class="simple nested-toc-section">atomicFetchNand
    135. 

  135.   <li><a class="reference" href="#atomicFetchNand%2Cptr.T%2CT%2CAtomMemModel" title="atomicFetchNand[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicFetchNand[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">atomicFetchOr
    139. 

  139.   <li><a class="reference" href="#atomicFetchOr%2Cptr.T%2CT%2CAtomMemModel" title="atomicFetchOr[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicFetchOr[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">atomicFetchSub
    143. 

  143.   <li><a class="reference" href="#atomicFetchSub%2Cptr.T%2CT%2CAtomMemModel" title="atomicFetchSub[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicFetchSub[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    144. 

  144. 

  145. </ul>
    146. 

  146. <ul class="simple nested-toc-section">atomicFetchXor
    147. 

  147.   <li><a class="reference" href="#atomicFetchXor%2Cptr.T%2CT%2CAtomMemModel" title="atomicFetchXor[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicFetchXor[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    148. 

  148. 

  149. </ul>
    150. 

  150. <ul class="simple nested-toc-section">atomicInc
    151. 

  151.   <li><a class="reference" href="#atomicInc%2Cint%2Cint" title="atomicInc(memLoc: var int; x: int = 1): int">atomicInc(memLoc: var int; x: int = 1): int</a></li>
    152. 

  152. 

  153. </ul>
    154. 

  154. <ul class="simple nested-toc-section">atomicIsLockFree
    155. 

  155.   <li><a class="reference" href="#atomicIsLockFree%2Cint%2Cpointer" title="atomicIsLockFree(size: int; p: pointer): bool">atomicIsLockFree(size: int; p: pointer): bool</a></li>
    156. 

  156. 

  157. </ul>
    158. 

  158. <ul class="simple nested-toc-section">atomicLoad
    159. 

  159.   <li><a class="reference" href="#atomicLoad%2Cptr.T%2Cptr.T%2CAtomMemModel" title="atomicLoad[T: AtomType](p, ret: ptr T; mem: AtomMemModel)">atomicLoad[T: AtomType](p, ret: ptr T; mem: AtomMemModel)</a></li>
    160. 

  160. 

  161. </ul>
    162. 

  162. <ul class="simple nested-toc-section">atomicLoadN
    163. 

  163.   <li><a class="reference" href="#atomicLoadN%2Cptr.T%2CAtomMemModel" title="atomicLoadN[T: AtomType](p: ptr T; mem: AtomMemModel): T">atomicLoadN[T: AtomType](p: ptr T; mem: AtomMemModel): T</a></li>
    164. 

  164. 

  165. </ul>
    166. 

  166. <ul class="simple nested-toc-section">atomicNandFetch
    167. 

  167.   <li><a class="reference" href="#atomicNandFetch%2Cptr.T%2CT%2CAtomMemModel" title="atomicNandFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicNandFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">atomicOrFetch
    171. 

  171.   <li><a class="reference" href="#atomicOrFetch%2Cptr.T%2CT%2CAtomMemModel" title="atomicOrFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicOrFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">atomicSignalFence
    175. 

  175.   <li><a class="reference" href="#atomicSignalFence%2CAtomMemModel" title="atomicSignalFence(mem: AtomMemModel)">atomicSignalFence(mem: AtomMemModel)</a></li>
    176. 

  176. 

  177. </ul>
    178. 

  178. <ul class="simple nested-toc-section">atomicStore
    179. 

  179.   <li><a class="reference" href="#atomicStore%2Cptr.T%2Cptr.T%2CAtomMemModel" title="atomicStore[T: AtomType](p, val: ptr T; mem: AtomMemModel)">atomicStore[T: AtomType](p, val: ptr T; mem: AtomMemModel)</a></li>
    180. 

  180. 

  181. </ul>
    182. 

  182. <ul class="simple nested-toc-section">atomicStoreN
    183. 

  183.   <li><a class="reference" href="#atomicStoreN%2Cptr.T%2CT%2CAtomMemModel" title="atomicStoreN[T: AtomType](p: ptr T; val: T; mem: AtomMemModel)">atomicStoreN[T: AtomType](p: ptr T; val: T; mem: AtomMemModel)</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">atomicSubFetch
    187. 

  187.   <li><a class="reference" href="#atomicSubFetch%2Cptr.T%2CT%2CAtomMemModel" title="atomicSubFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicSubFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    188. 

  188. 

  189. </ul>
    190. 

  190. <ul class="simple nested-toc-section">atomicTestAndSet
    191. 

  191.   <li><a class="reference" href="#atomicTestAndSet%2Cpointer%2CAtomMemModel" title="atomicTestAndSet(p: pointer; mem: AtomMemModel): bool">atomicTestAndSet(p: pointer; mem: AtomMemModel): bool</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. <ul class="simple nested-toc-section">atomicThreadFence
    195. 

  195.   <li><a class="reference" href="#atomicThreadFence%2CAtomMemModel" title="atomicThreadFence(mem: AtomMemModel)">atomicThreadFence(mem: AtomMemModel)</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. <ul class="simple nested-toc-section">atomicXorFetch
    199. 

  199.   <li><a class="reference" href="#atomicXorFetch%2Cptr.T%2CT%2CAtomMemModel" title="atomicXorFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T">atomicXorFetch[T: AtomType](p: ptr T; val: T; mem: AtomMemModel): T</a></li>
    200. 

  200. 

  201. </ul>
    202. 

  202. <ul class="simple nested-toc-section">cas
    203. 

  203.   <li><a class="reference" href="#cas%2Cptr.T%2CT%2CT" title="cas[T: bool | int | ptr](p: ptr T; oldValue, newValue: T): bool">cas[T: bool | int | ptr](p: ptr T; oldValue, newValue: T): bool</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. <ul class="simple nested-toc-section">cpuRelax
    207. 

  207.   <li><a class="reference" href="#cpuRelax" title="cpuRelax()">cpuRelax()</a></li>
    208. 

  208. 

  209. </ul>
    210. 

  210. 

  211.     </ul>
    212. 

  212.   </details>
    213. 

  213. </li>
    214. 

  214. <li>
    215. 

  215.   <details open>
    216. 

  216.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    217. 

  217.     <ul class="simple simple-toc-section">
    218. 

  218.       <ul class="simple nested-toc-section">fence
    219. 

  219.   <li><a class="reference" href="#fence.t" title="fence()">fence()</a></li>
    220. 

  220. 

  221. </ul>
    222. 

  222. 

  223.     </ul>
    224. 

  224.   </details>
    225. 

  225. </li>
    226. 

  226. 

  227. </ul>
    228. 

  228. 

  229.   </div>
    230. 

  230.   <div class="nine columns" id="content">
    231. 

  231.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    232. 

  232. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    233. 

  233. 

  234.     <div id="tocRoot"></div>
    235. 

  235.     <div class="deprecation-message">
    236. 

  236.   <b>Deprecated:</b> use `std/atomics` instead
    237. 

  237. </div>
    238. 

  238. 

  239.     <p class="module-desc">Perform the operation return the new value, all memory models are validPerform the operation return the old value, all memory models are valid</p>
    240. 

  240.     <div class="section" id="7">
    241. 

  241.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    242. 

  242.   <dl class="item">
    243. 

  243.     <div id="AtomMemModel">
    244. 

  244.   <dt><pre><a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
    245. 

  245.   <dd>
    246. 

  246.     
    247. 

  247.     
    248. 

  248.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L26" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    249. 

  249. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L26" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    250. 

  250. 

  251.   </dd>
    252. 

  252. </div>
    253. 

  253. <div id="AtomType">
    254. 

  254.   <dt><pre><a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a> <span class="Other">=</span> <a href="system.html#SomeNumber"><span class="Identifier">SomeNumber</span></a> <span class="Operator">|</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> <span class="Operator">|</span> <span class="Keyword">ptr</span> <span class="Operator">|</span> <a href="system.html#char"><span class="Identifier">char</span></a> <span class="Operator">|</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    255. 

  255.   <dd>
    256. 

  256.     
    257. 

  257.     Type Class representing valid types for use with atomic procs
    258. 

  258.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L22" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    259. 

  259. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L22" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    260. 

  260. 

  261.   </dd>
    262. 

  262. </div>
    263. 

  263. 

  264.   </dl>
    265. 

  265. </div>
    266. 

  266. <div class="section" id="8">
    267. 

  267.   <h1><a class="toc-backref" href="#8">Vars</a></h1>
    268. 

  268.   <dl class="item">
    269. 

  269.     <div id="ATOMIC_ACQ_REL">
    270. 

  270.   <dt><pre><a href="sysatomics.html#ATOMIC_ACQ_REL"><span class="Identifier">ATOMIC_ACQ_REL</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__ATOMIC_ACQ_REL&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span>.}<span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a></pre></dt>
    271. 

  271.   <dd>
    272. 

  272.     
    273. 

  273.     Full barrier in both directions and synchronizes with acquire loads and release stores in another thread.
    274. 

  274.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L41" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    275. 

  275. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L41" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    276. 

  276. 

  277.   </dd>
    278. 

  278. </div>
    279. 

  279. <div id="ATOMIC_ACQUIRE">
    280. 

  280.   <dt><pre><a href="sysatomics.html#ATOMIC_ACQUIRE"><span class="Identifier">ATOMIC_ACQUIRE</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__ATOMIC_ACQUIRE&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span>.}<span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a></pre></dt>
    281. 

  281.   <dd>
    282. 

  282.     
    283. 

  283.     Barrier to hoisting of code and synchronizes with release (or stronger) semantic stores from another thread.
    284. 

  284.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L33" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    285. 

  285. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L33" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    286. 

  286. 

  287.   </dd>
    288. 

  288. </div>
    289. 

  289. <div id="ATOMIC_CONSUME">
    290. 

  290.   <dt><pre><a href="sysatomics.html#ATOMIC_CONSUME"><span class="Identifier">ATOMIC_CONSUME</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__ATOMIC_CONSUME&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span>.}<span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a></pre></dt>
    291. 

  291.   <dd>
    292. 

  292.     
    293. 

  293.     Data dependency only for both barrier and synchronization with another thread.
    294. 

  294.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L30" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    295. 

  295. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L30" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    296. 

  296. 

  297.   </dd>
    298. 

  298. </div>
    299. 

  299. <div id="ATOMIC_RELAXED">
    300. 

  300.   <dt><pre><a href="sysatomics.html#ATOMIC_RELAXED"><span class="Identifier">ATOMIC_RELAXED</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__ATOMIC_RELAXED&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span>.}<span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a></pre></dt>
    301. 

  301.   <dd>
    302. 

  302.     
    303. 

  303.     No barriers or synchronization.
    304. 

  304.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L28" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    305. 

  305. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L28" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    306. 

  306. 

  307.   </dd>
    308. 

  308. </div>
    309. 

  309. <div id="ATOMIC_RELEASE">
    310. 

  310.   <dt><pre><a href="sysatomics.html#ATOMIC_RELEASE"><span class="Identifier">ATOMIC_RELEASE</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__ATOMIC_RELEASE&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span>.}<span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a></pre></dt>
    311. 

  311.   <dd>
    312. 

  312.     
    313. 

  313.     Barrier to sinking of code and synchronizes with acquire (or stronger) semantic loads from another thread.
    314. 

  314.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L37" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    315. 

  315. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L37" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    316. 

  316. 

  317.   </dd>
    318. 

  318. </div>
    319. 

  319. <div id="ATOMIC_SEQ_CST">
    320. 

  320.   <dt><pre><a href="sysatomics.html#ATOMIC_SEQ_CST"><span class="Identifier">ATOMIC_SEQ_CST</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__ATOMIC_SEQ_CST&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span>.}<span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a></pre></dt>
    321. 

  321.   <dd>
    322. 

  322.     
    323. 

  323.     Full barrier in both directions and synchronizes with acquire loads and release stores in all threads.
    324. 

  324.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L45" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    325. 

  325. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L45" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    326. 

  326. 

  327.   </dd>
    328. 

  328. </div>
    329. 

  329. 

  330.   </dl>
    331. 

  331. </div>
    332. 

  332. <div class="section" id="12">
    333. 

  333.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    334. 

  334.   <dl class="item">
    335. 

  335.     <div id="atomicAddFetch-procs-all">
    336. 

  336.   <div id="atomicAddFetch,ptr.T,T,AtomMemModel">
    337. 

  337.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicAddFetch%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicAddFetch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    338. 

  338.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_add_fetch&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    339. 

  339.   <dd>
    340. 

  340.     
    341. 

  341.     
    342. 

  342.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L103" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    343. 

  343. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L103" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    344. 

  344. 

  345.   </dd>
    346. 

  346. </div>
    347. 

  347. 

  348. </div>
    349. 

  349. <div id="atomicAlwaysLockFree-procs-all">
    350. 

  350.   <div id="atomicAlwaysLockFree,int,pointer">
    351. 

  351.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicAlwaysLockFree%2Cint%2Cpointer"><span class="Identifier">atomicAlwaysLockFree</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    352. 

  352.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_always_lock_free&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    353. 

  353.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    354. 

  354.   <dd>
    355. 

  355.     
    356. 

  356.     This built-in function returns true if objects of size bytes always generate lock free atomic instructions for the target architecture. size must resolve to a compile-time constant and the result also resolves to a compile-time constant. ptr is an optional pointer to the object that may be used to determine alignment. A value of 0 indicates typical alignment should be used. The compiler may also ignore this parameter.
    357. 

  357.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    358. 

  358. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    359. 

  359. 

  360.   </dd>
    361. 

  361. </div>
    362. 

  362. 

  363. </div>
    364. 

  364. <div id="atomicAndFetch-procs-all">
    365. 

  365.   <div id="atomicAndFetch,ptr.T,T,AtomMemModel">
    366. 

  366.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicAndFetch%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicAndFetch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    367. 

  367.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_and_fetch&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    368. 

  368.   <dd>
    369. 

  369.     
    370. 

  370.     
    371. 

  371.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L109" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    372. 

  372. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L109" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    373. 

  373. 

  374.   </dd>
    375. 

  375. </div>
    376. 

  376. 

  377. </div>
    378. 

  378. <div id="atomicClear-procs-all">
    379. 

  379.   <div id="atomicClear,pointer,AtomMemModel">
    380. 

  380.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicClear%2Cpointer%2CAtomMemModel"><span class="Identifier">atomicClear</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_clear&quot;</span><span class="Other">,</span>
    381. 

  381.     <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    382. 

  382.   <dd>
    383. 

  383.     
    384. 

  384.     This built-in function performs an atomic clear operation at p. After the operation, at p contains 0. ATOMIC_RELAXED, ATOMIC_SEQ_CST, ATOMIC_RELEASE
    385. 

  385.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L137" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    386. 

  386. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L137" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    387. 

  387. 

  388.   </dd>
    389. 

  389. </div>
    390. 

  390. 

  391. </div>
    392. 

  392. <div id="atomicCompareExchange-procs-all">
    393. 

  393.   <div id="atomicCompareExchange,ptr.T,ptr.T,ptr.T,bool,AtomMemModel,AtomMemModel">
    394. 

  394.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicCompareExchange%2Cptr.T%2Cptr.T%2Cptr.T%2Cbool%2CAtomMemModel%2CAtomMemModel"><span class="Identifier">atomicCompareExchange</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">,</span> <span class="Identifier">expected</span><span class="Other">,</span> <span class="Identifier">desired</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">weak</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">;</span>
    395. 

  395.                                         <span class="Identifier">success_memmodel</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">;</span>
    396. 

  396.                                         <span class="Identifier">failure_memmodel</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    397. 

  397.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_compare_exchange&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    398. 

  398.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    399. 

  399.   <dd>
    400. 

  400.     
    401. 

  401.     This proc implements the generic version of atomic_compare_exchange. The proc is virtually identical to atomic_compare_exchange_n, except the desired value is also a pointer.
    402. 

  402.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L95" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    403. 

  403. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L95" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    404. 

  404. 

  405.   </dd>
    406. 

  406. </div>
    407. 

  407. 

  408. </div>
    409. 

  409. <div id="atomicCompareExchangeN-procs-all">
    410. 

  410.   <div id="atomicCompareExchangeN,ptr.T,ptr.T,T,bool,AtomMemModel,AtomMemModel">
    411. 

  411.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicCompareExchangeN%2Cptr.T%2Cptr.T%2CT%2Cbool%2CAtomMemModel%2CAtomMemModel"><span class="Identifier">atomicCompareExchangeN</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">,</span> <span class="Identifier">expected</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">desired</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span>
    412. 

  412.     <span class="Identifier">weak</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">;</span> <span class="Identifier">success_memmodel</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">;</span> <span class="Identifier">failure_memmodel</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    413. 

  413.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_compare_exchange_n&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    414. 

  414.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    415. 

  415.   <dd>
    416. 

  416.     
    417. 

  417.     This proc implements an atomic compare and exchange operation. This compares the contents at p with the contents at expected and if equal, writes desired at p. If they are not equal, the current contents at p is written into expected. Weak is true for weak compare_exchange, and false for the strong variation. Many targets only offer the strong variation and ignore the parameter. When in doubt, use the strong variation. True is returned if desired is written at p and the execution is considered to conform to the memory model specified by success_memmodel. There are no restrictions on what memory model can be used here. False is returned otherwise, and the execution is considered to conform to failure_memmodel. This memory model cannot be __ATOMIC_RELEASE nor __ATOMIC_ACQ_REL. It also cannot be a stronger model than that specified by success_memmodel.
    418. 

  418.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L79" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    419. 

  419. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L79" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    420. 

  420. 

  421.   </dd>
    422. 

  422. </div>
    423. 

  423. 

  424. </div>
    425. 

  425. <div id="atomicDec-procs-all">
    426. 

  426.   <div id="atomicDec,int,int">
    427. 

  427.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicDec%2Cint%2Cint"><span class="Identifier">atomicDec</span></a><span class="Other">(</span><span class="Identifier">memLoc</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span>
    428. 

  428.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    429. 

  429.   <dd>
    430. 

  430.     
    431. 

  431.     Atomically decrements the integer by some <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. It returns the new value.
    432. 

  432.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L278" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    433. 

  433. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L278" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    434. 

  434. 

  435.   </dd>
    436. 

  436. </div>
    437. 

  437. 

  438. </div>
    439. 

  439. <div id="atomicExchange-procs-all">
    440. 

  440.   <div id="atomicExchange,ptr.T,ptr.T,ptr.T,AtomMemModel">
    441. 

  441.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicExchange%2Cptr.T%2Cptr.T%2Cptr.T%2CAtomMemModel"><span class="Identifier">atomicExchange</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">,</span> <span class="Identifier">ret</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.
    442. 

  442.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_exchange&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    443. 

  443.   <dd>
    444. 

  444.     
    445. 

  445.     This is the generic version of an atomic exchange. It stores the contents at val at p. The original value at p is copied into ret.
    446. 

  446.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L74" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    447. 

  447. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L74" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    448. 

  448. 

  449.   </dd>
    450. 

  450. </div>
    451. 

  451. 

  452. </div>
    453. 

  453. <div id="atomicExchangeN-procs-all">
    454. 

  454.   <div id="atomicExchangeN,ptr.T,T,AtomMemModel">
    455. 

  455.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicExchangeN%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicExchangeN</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    456. 

  456.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_exchange_n&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    457. 

  457.   <dd>
    458. 

  458.     
    459. 

  459.     This proc implements an atomic exchange operation. It writes val at p, and returns the previous contents at p. ATOMIC_RELAXED, ATOMIC_SEQ_CST, ATOMIC_ACQUIRE, ATOMIC_RELEASE, ATOMIC_ACQ_REL
    460. 

  460.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L68" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    461. 

  461. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L68" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    462. 

  462. 

  463.   </dd>
    464. 

  464. </div>
    465. 

  465. 

  466. </div>
    467. 

  467. <div id="atomicFetchAdd-procs-all">
    468. 

  468.   <div id="atomicFetchAdd,ptr.T,T,AtomMemModel">
    469. 

  469.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicFetchAdd%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicFetchAdd</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    470. 

  470.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_fetch_add&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    471. 

  471.   <dd>
    472. 

  472.     
    473. 

  473.     
    474. 

  474.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L117" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    475. 

  475. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L117" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    476. 

  476. 

  477.   </dd>
    478. 

  478. </div>
    479. 

  479. 

  480. </div>
    481. 

  481. <div id="atomicFetchAnd-procs-all">
    482. 

  482.   <div id="atomicFetchAnd,ptr.T,T,AtomMemModel">
    483. 

  483.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicFetchAnd%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicFetchAnd</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    484. 

  484.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_fetch_and&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    485. 

  485.   <dd>
    486. 

  486.     
    487. 

  487.     
    488. 

  488.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L123" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    489. 

  489. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L123" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    490. 

  490. 

  491.   </dd>
    492. 

  492. </div>
    493. 

  493. 

  494. </div>
    495. 

  495. <div id="atomicFetchNand-procs-all">
    496. 

  496.   <div id="atomicFetchNand,ptr.T,T,AtomMemModel">
    497. 

  497.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicFetchNand%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicFetchNand</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    498. 

  498.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_fetch_nand&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    499. 

  499.   <dd>
    500. 

  500.     
    501. 

  501.     
    502. 

  502.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L127" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    503. 

  503. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L127" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    504. 

  504. 

  505.   </dd>
    506. 

  506. </div>
    507. 

  507. 

  508. </div>
    509. 

  509. <div id="atomicFetchOr-procs-all">
    510. 

  510.   <div id="atomicFetchOr,ptr.T,T,AtomMemModel">
    511. 

  511.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicFetchOr%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicFetchOr</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    512. 

  512.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_fetch_or&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    513. 

  513.   <dd>
    514. 

  514.     
    515. 

  515.     
    516. 

  516.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L121" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    517. 

  517. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L121" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    518. 

  518. 

  519.   </dd>
    520. 

  520. </div>
    521. 

  521. 

  522. </div>
    523. 

  523. <div id="atomicFetchSub-procs-all">
    524. 

  524.   <div id="atomicFetchSub,ptr.T,T,AtomMemModel">
    525. 

  525.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicFetchSub%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicFetchSub</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    526. 

  526.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_fetch_sub&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    527. 

  527.   <dd>
    528. 

  528.     
    529. 

  529.     
    530. 

  530.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L119" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    531. 

  531. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L119" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    532. 

  532. 

  533.   </dd>
    534. 

  534. </div>
    535. 

  535. 

  536. </div>
    537. 

  537. <div id="atomicFetchXor-procs-all">
    538. 

  538.   <div id="atomicFetchXor,ptr.T,T,AtomMemModel">
    539. 

  539.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicFetchXor%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicFetchXor</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    540. 

  540.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_fetch_xor&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    541. 

  541.   <dd>
    542. 

  542.     
    543. 

  543.     
    544. 

  544.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L125" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    545. 

  545. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L125" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    546. 

  546. 

  547.   </dd>
    548. 

  548. </div>
    549. 

  549. 

  550. </div>
    551. 

  551. <div id="atomicInc-procs-all">
    552. 

  552.   <div id="atomicInc,int,int">
    553. 

  553.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicInc%2Cint%2Cint"><span class="Identifier">atomicInc</span></a><span class="Other">(</span><span class="Identifier">memLoc</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span>
    554. 

  554.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    555. 

  555.   <dd>
    556. 

  556.     
    557. 

  557.     Atomically increments the integer by some <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. It returns the new value.
    558. 

  558.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L267" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    559. 

  559. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L267" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    560. 

  560. 

  561.   </dd>
    562. 

  562. </div>
    563. 

  563. 

  564. </div>
    565. 

  565. <div id="atomicIsLockFree-procs-all">
    566. 

  566.   <div id="atomicIsLockFree,int,pointer">
    567. 

  567.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicIsLockFree%2Cint%2Cpointer"><span class="Identifier">atomicIsLockFree</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    568. 

  568.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_is_lock_free&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    569. 

  569.   <dd>
    570. 

  570.     
    571. 

  571.     This built-in function returns true if objects of size bytes always generate lock free atomic instructions for the target architecture. If it is not known to be lock free a call is made to a runtime routine named __atomic_is_lock_free. ptr is an optional pointer to the object that may be used to determine alignment. A value of 0 indicates typical alignment should be used. The compiler may also ignore this parameter.
    572. 

  572.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L162" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    573. 

  573. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L162" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    574. 

  574. 

  575.   </dd>
    576. 

  576. </div>
    577. 

  577. 

  578. </div>
    579. 

  579. <div id="atomicLoad-procs-all">
    580. 

  580.   <div id="atomicLoad,ptr.T,ptr.T,AtomMemModel">
    581. 

  581.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicLoad%2Cptr.T%2Cptr.T%2CAtomMemModel"><span class="Identifier">atomicLoad</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">,</span> <span class="Identifier">ret</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.
    582. 

  582.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_load&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    583. 

  583.   <dd>
    584. 

  584.     
    585. 

  585.     This is the generic version of an atomic load. It returns the contents at p in ret.
    586. 

  586.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L55" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    587. 

  587. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L55" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    588. 

  588. 

  589.   </dd>
    590. 

  590. </div>
    591. 

  591. 

  592. </div>
    593. 

  593. <div id="atomicLoadN-procs-all">
    594. 

  594.   <div id="atomicLoadN,ptr.T,AtomMemModel">
    595. 

  595.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicLoadN%2Cptr.T%2CAtomMemModel"><span class="Identifier">atomicLoadN</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    596. 

  596.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_load_n&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    597. 

  597.   <dd>
    598. 

  598.     
    599. 

  599.     This proc implements an atomic load operation. It returns the contents at p. ATOMIC_RELAXED, ATOMIC_SEQ_CST, ATOMIC_ACQUIRE, ATOMIC_CONSUME.
    600. 

  600.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L50" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    601. 

  601. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L50" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    602. 

  602. 

  603.   </dd>
    604. 

  604. </div>
    605. 

  605. 

  606. </div>
    607. 

  607. <div id="atomicNandFetch-procs-all">
    608. 

  608.   <div id="atomicNandFetch,ptr.T,T,AtomMemModel">
    609. 

  609.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicNandFetch%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicNandFetch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    610. 

  610.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_nand_fetch&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    611. 

  611.   <dd>
    612. 

  612.     
    613. 

  613.     
    614. 

  614.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L113" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    615. 

  615. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L113" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    616. 

  616. 

  617.   </dd>
    618. 

  618. </div>
    619. 

  619. 

  620. </div>
    621. 

  621. <div id="atomicOrFetch-procs-all">
    622. 

  622.   <div id="atomicOrFetch,ptr.T,T,AtomMemModel">
    623. 

  623.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicOrFetch%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicOrFetch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    624. 

  624.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_or_fetch&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    625. 

  625.   <dd>
    626. 

  626.     
    627. 

  627.     
    628. 

  628.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    629. 

  629. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    630. 

  630. 

  631.   </dd>
    632. 

  632. </div>
    633. 

  633. 

  634. </div>
    635. 

  635. <div id="atomicSignalFence-procs-all">
    636. 

  636.   <div id="atomicSignalFence,AtomMemModel">
    637. 

  637.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicSignalFence%2CAtomMemModel"><span class="Identifier">atomicSignalFence</span></a><span class="Other">(</span><span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_signal_fence&quot;</span><span class="Other">,</span>
    638. 

  638.     <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    639. 

  639.   <dd>
    640. 

  640.     
    641. 

  641.     This built-in function acts as a synchronization fence between a thread and signal handlers based in the same thread. All memory orders are valid.
    642. 

  642.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L148" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    643. 

  643. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L148" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    644. 

  644. 

  645.   </dd>
    646. 

  646. </div>
    647. 

  647. 

  648. </div>
    649. 

  649. <div id="atomicStore-procs-all">
    650. 

  650.   <div id="atomicStore,ptr.T,ptr.T,AtomMemModel">
    651. 

  651.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicStore%2Cptr.T%2Cptr.T%2CAtomMemModel"><span class="Identifier">atomicStore</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.
    652. 

  652.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_store&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    653. 

  653.   <dd>
    654. 

  654.     
    655. 

  655.     This is the generic version of an atomic store. It stores the value of val at p
    656. 

  656.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L64" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    657. 

  657. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L64" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    658. 

  658. 

  659.   </dd>
    660. 

  660. </div>
    661. 

  661. 

  662. </div>
    663. 

  663. <div id="atomicStoreN-procs-all">
    664. 

  664.   <div id="atomicStoreN,ptr.T,T,AtomMemModel">
    665. 

  665.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicStoreN%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicStoreN</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.
    666. 

  666.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_store_n&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    667. 

  667.   <dd>
    668. 

  668.     
    669. 

  669.     This proc implements an atomic store operation. It writes val at p. ATOMIC_RELAXED, ATOMIC_SEQ_CST, and ATOMIC_RELEASE.
    670. 

  670.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L59" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    671. 

  671. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L59" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    672. 

  672. 

  673.   </dd>
    674. 

  674. </div>
    675. 

  675. 

  676. </div>
    677. 

  677. <div id="atomicSubFetch-procs-all">
    678. 

  678.   <div id="atomicSubFetch,ptr.T,T,AtomMemModel">
    679. 

  679.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicSubFetch%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicSubFetch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    680. 

  680.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_sub_fetch&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    681. 

  681.   <dd>
    682. 

  682.     
    683. 

  683.     
    684. 

  684.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L105" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    685. 

  685. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L105" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    686. 

  686. 

  687.   </dd>
    688. 

  688. </div>
    689. 

  689. 

  690. </div>
    691. 

  691. <div id="atomicTestAndSet-procs-all">
    692. 

  692.   <div id="atomicTestAndSet,pointer,AtomMemModel">
    693. 

  693.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicTestAndSet%2Cpointer%2CAtomMemModel"><span class="Identifier">atomicTestAndSet</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    694. 

  694.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_test_and_set&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    695. 

  695.   <dd>
    696. 

  696.     
    697. 

  697.     This built-in function performs an atomic test-and-set operation on the byte at p. The byte is set to some implementation defined nonzero &quot;set&quot; value and the return value is true if and only if the previous contents were &quot;set&quot;. All memory models are valid.
    698. 

  698.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    699. 

  699. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    700. 

  700. 

  701.   </dd>
    702. 

  702. </div>
    703. 

  703. 

  704. </div>
    705. 

  705. <div id="atomicThreadFence-procs-all">
    706. 

  706.   <div id="atomicThreadFence,AtomMemModel">
    707. 

  707.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicThreadFence%2CAtomMemModel"><span class="Identifier">atomicThreadFence</span></a><span class="Other">(</span><span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_thread_fence&quot;</span><span class="Other">,</span>
    708. 

  708.     <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    709. 

  709.   <dd>
    710. 

  710.     
    711. 

  711.     This built-in function acts as a synchronization fence between threads based on the specified memory model. All memory orders are valid.
    712. 

  712.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L143" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    713. 

  713. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L143" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    714. 

  714. 

  715.   </dd>
    716. 

  716. </div>
    717. 

  717. 

  718. </div>
    719. 

  719. <div id="atomicXorFetch-procs-all">
    720. 

  720.   <div id="atomicXorFetch,ptr.T,T,AtomMemModel">
    721. 

  721.   <dt><pre><span class="Keyword">proc</span> <a href="#atomicXorFetch%2Cptr.T%2CT%2CAtomMemModel"><span class="Identifier">atomicXorFetch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="sysatomics.html#AtomType"><span class="Identifier">AtomType</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">mem</span><span class="Other">:</span> <a href="sysatomics.html#AtomMemModel"><span class="Identifier">AtomMemModel</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
    722. 

  722.     <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;__atomic_xor_fetch&quot;</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    723. 

  723.   <dd>
    724. 

  724.     
    725. 

  725.     
    726. 

  726.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L111" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    727. 

  727. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L111" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    728. 

  728. 

  729.   </dd>
    730. 

  730. </div>
    731. 

  731. 

  732. </div>
    733. 

  733. <div id="cas-procs-all">
    734. 

  734.   <div id="cas,ptr.T,T,T">
    735. 

  735.   <dt><pre><span class="Keyword">proc</span> <a href="#cas%2Cptr.T%2CT%2CT"><span class="Identifier">cas</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Operator">|</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Operator">|</span> <span class="Keyword">ptr</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">oldValue</span><span class="Other">,</span> <span class="Identifier">newValue</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    736. 

  736.   <dd>
    737. 

  737.     
    738. 

  738.     
    739. 

  739.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L346" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    740. 

  740. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L346" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    741. 

  741. 

  742.   </dd>
    743. 

  743. </div>
    744. 

  744. 

  745. </div>
    746. 

  746. <div id="cpuRelax-procs-all">
    747. 

  747.   <div id="cpuRelax">
    748. 

  748.   <dt><pre><span class="Keyword">proc</span> <a href="#cpuRelax"><span class="Identifier">cpuRelax</span></a><span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    749. 

  749.   <dd>
    750. 

  750.     
    751. 

  751.     
    752. 

  752.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    753. 

  753. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    754. 

  754. 

  755.   </dd>
    756. 

  756. </div>
    757. 

  757. 

  758. </div>
    759. 

  759. 

  760.   </dl>
    761. 

  761. </div>
    762. 

  762. <div class="section" id="18">
    763. 

  763.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    764. 

  764.   <dl class="item">
    765. 

  765.     <div id="fence-templates-all">
    766. 

  766.   <div id="fence.t">
    767. 

  767.   <dt><pre><span class="Keyword">template</span> <a href="#fence.t"><span class="Identifier">fence</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
    768. 

  768.   <dd>
    769. 

  769.     
    770. 

  770.     
    771. 

  771.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/sysatomics.nim#L171" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    772. 

  772. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/sysatomics.nim#L171" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    773. 

  773. 

  774.   </dd>
    775. 

  775. </div>
    776. 

  776. 

  777. </div>
    778. 

  778. 

  779.   </dl>
    780. 

  780. </div>
    781. 

  781. 

  782.   </div>
    783. 

  783. </div>
    784. 

  784. 

  785.       <div class="twelve-columns footer">
    786. 

  786.         <span class="nim-sprite"></span>
    787. 

  787.         <br>
    788. 

  788.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:42 UTC</small>
    789. 

  789.       </div>
    790. 

  790.     </div>
    791. 

  791.   </div>
    792. 

  792.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    793. 

  793.     
    794. 

  794. </body>
    795. 

  795. </html>
    796. 

  796.