Google Git
Sign in
chromium/external/github.com/ibmruntimes/zoslib/refs/heads/upstream/allocs-tracking/./docs/zos-savstack_8h_source.html
blob: fc80d891e6faec38fd00d7b54dfa3477a96e3fc1 [file] [edit]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>zoslib: include/zos-savstack.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">zoslib
</div>
<div id="projectbrief">z/OS C/C++ Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">zos-savstack.h</div></div>
</div><!--header-->
<div class="contents">
<a href="zos-savstack_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed Materials - Property of IBM</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// ZOSLIB</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// (C) Copyright IBM Corp. 2022. All Rights Reserved.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// US Government Users Restricted Rights - Use, duplication</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#ifndef ZOS_SAVSTACK_H_</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#define ZOS_SAVSTACK_H_</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;<a class="code" href="zos-macros_8h.html">zos-macros.h</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="edcwccwi_8h.html">edcwccwi.h</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// ----------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// LESavStackAsync</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">// https://www.ibm.com/docs/en/zos/2.4.0?topic=applications-saving-stack-pointer</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">//</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">// Before entry into JS code, save the current stack pointer SP that&#39;s stored</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">// at CEELCA_SAVSTACK_ASYNC, and replace it with a pointer to dynamic storage</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">// area DSA. After exit from JS, restore the stack pointer back into</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">// CEELCA_SAVSTACK_ASYNC. This class keeps track of the old and new SPs so</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// they can be saved and restored, including when a signal occurs.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">//</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// save(x) is called before entry into JS to save x, the current SP at</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// address __LE_SAVSTACK_ASYNC_ADDR, into map_&#39;s key __LE_SAVSTACK_ASYNC_ADDR</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">//</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">// restore() is called after JS to restore into __LE_SAVSTACK_ASYNC_ADDR the</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// SP saved in the map&#39;s key __LE_SAVSTACK_ASYNC_ADDR.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">//</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">// restoreAll() is called from a signal handler to restore the SP from each</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// thread into its corresponding __LE_SAVSTACK_ASYNC_ADDR.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">class </span><a class="code hl_define" href="zos-macros_8h.html#aed7e0d9f32e1ea73439ac0386ffaaa8d">__Z_EXPORT</a> LESavStackAsync {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> LESavStackAsync&amp; getInstance() {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">static</span> LESavStackAsync instance;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">return</span> instance;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">void</span> save(<span class="keywordtype">void</span>* new_sp[1]) {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::lock_guard&lt;std::mutex&gt; lock(mutex_);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> *old_sp = *__LE_SAVSTACK_ASYNC_ADDR;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> *__LE_SAVSTACK_ASYNC_ADDR = new_sp;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Store SP (r4) into new_sp[0]:</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">asm</span>(<span class="stringliteral">&quot; lgr %0,4\n&quot;</span> : <span class="stringliteral">&quot;=r&quot;</span>(new_sp[0])::);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> map_[__LE_SAVSTACK_ASYNC_ADDR] = old_sp;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> restore() {</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> std::lock_guard&lt;std::mutex&gt; lock(mutex_);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> *__LE_SAVSTACK_ASYNC_ADDR = map_[__LE_SAVSTACK_ASYNC_ADDR];</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> map_.erase(__LE_SAVSTACK_ASYNC_ADDR);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> }</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">void</span> restoreAll() {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::lock_guard&lt;std::mutex&gt; lock(mutex_);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span> it = map_.cbegin();</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> it != map_.cend(); ) {</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> *(it-&gt;first) = it-&gt;second;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> it = map_.erase(it);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> }</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> LESavStackAsync(<span class="keyword">const</span> LESavStackAsync&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> LESavStackAsync&amp; operator=(<span class="keyword">const</span> LESavStackAsync&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> LESavStackAsync(LESavStackAsync&amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> LESavStackAsync&amp; operator=(LESavStackAsync&amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> LESavStackAsync() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> std::map&lt;void **, void *&gt; map_;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> std::mutex mutex_;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>};</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="preprocessor">#endif </span><span class="comment">// __cplusplus</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#endif </span><span class="comment">// ZOS_SAVSTACK_H_</span></div>
<div class="ttc" id="aedcwccwi_8h_html"><div class="ttname"><a href="edcwccwi_8h.html">edcwccwi.h</a></div></div>
<div class="ttc" id="azos-macros_8h_html"><div class="ttname"><a href="zos-macros_8h.html">zos-macros.h</a></div></div>
<div class="ttc" id="azos-macros_8h_html_aed7e0d9f32e1ea73439ac0386ffaaa8d"><div class="ttname"><a href="zos-macros_8h.html#aed7e0d9f32e1ea73439ac0386ffaaa8d">__Z_EXPORT</a></div><div class="ttdeci">#define __Z_EXPORT</div><div class="ttdef"><b>Definition</b> zos-macros.h:13</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>