Files
moslab-code/doc/source/html/cap__alloc_source.html
2025-09-12 15:55:45 +02:00

284 lines
36 KiB
HTML

<!-- HTML header for doxygen 1.9.1-->
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: l4/re/cap_alloc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('cap__alloc_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">cap_alloc</div></div>
</div><!--header-->
<div class="contents">
<a href="cap__alloc.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><span class="comment">// vi:set ft=cpp: -*- Mode: C++ -*-</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">/*</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * (c) 2009 Adam Lackorzynski &lt;adam@os.inf.tu-dresden.de&gt;,</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * Alexander Warg &lt;warg@os.inf.tu-dresden.de&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * economic rights: Technische Universität Dresden (Germany)</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> */</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">#pragma once</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;<a class="code" href="task.html">l4/sys/task</a>&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;<a class="code" href="smart__capability.html">l4/sys/smart_capability</a>&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &lt;<a class="code" href="re_2consts.html">l4/re/consts</a>&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;l4/cxx/type_traits&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4Re.html">L4Re</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classL4Re_1_1Cap__alloc.html"> 30</a></span><span class="keyword">class </span>Cap_alloc</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> operator = (Cap_alloc <span class="keyword">const</span> &amp;);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> Cap_alloc(Cap_alloc <span class="keyword">const</span> &amp;) {}</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> Cap_alloc() {}</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">public</span>:</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193"> 45</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a> <a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">alloc</a>() noexcept = 0;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> virtual <span class="keywordtype">void</span> take(<a class="code hl_namespace" href="namespaceL4.html">L4</a>::Cap&lt;<span class="keywordtype">void</span>&gt; cap) noexcept = 0;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> template&lt; typename T &gt;</div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="}">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classL4Re_1_1Cap__alloc.html#a88fcbfda3d06aa82bb0c36d6a0b60ab2"> 53</a></span> <a class="code hl_namespace" href="namespaceL4.html">L4</a>::Cap&lt;T&gt; <a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">alloc</a>() noexcept</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> { <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceL4.html#ac674c8e32808f504f4fa0aa8e5276e84">L4::cap_cast&lt;T&gt;</a>(<a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">alloc</a>()); }</div>
</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classL4Re_1_1Cap__alloc.html#ad8e36ca35881e1bc7ec3ff12e3956f10"> 62</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#ad8e36ca35881e1bc7ec3ff12e3956f10">free</a>(<a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a> cap, <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task = <a class="code hl_enumvalue" href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a>,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">unsigned</span> unmap_flags = <a class="code hl_enumvalue" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>) <span class="keyword">noexcept</span> = 0;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> release(<a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a> cap, <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task = <a class="code hl_enumvalue" href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a>,</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">unsigned</span> unmap_flags = <a class="code hl_enumvalue" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>) <span class="keyword">noexcept</span> = 0;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">virtual</span> <a class="code hl_function" href="group__l4re__cap__api.html#gadb65db1681bc65100caf66924331b85b">~Cap_alloc</a>() = 0;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>};</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> ALLOC&gt;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="keyword">struct </span>Cap_alloc_t : ALLOC, <a class="code hl_class" href="classL4Re_1_1Cap__alloc.html">L4Re::Cap_alloc</a></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>{</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> ...ARGS&gt;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> Cap_alloc_t(ARGS &amp;&amp;...args) : ALLOC(cxx::forward&lt;ARGS&gt;(args)...) {}</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a> <a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">alloc</a>() noexcept<span class="keyword"> override </span>{ <span class="keywordflow">return</span> ALLOC::alloc(); }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">void</span> take(L4::Cap&lt;void&gt; cap) <span class="keyword">noexcept</span> <span class="keyword">override</span> { ALLOC::take(cap); }</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="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> L4::Cap&lt;T&gt; <a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">alloc</a>() noexcept</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceL4.html#ac674c8e32808f504f4fa0aa8e5276e84">L4::cap_cast&lt;T&gt;</a>(<a class="code hl_function" href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">alloc</a>());</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> free(L4::Cap&lt;void&gt; cap, <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task = <a class="code hl_enumvalue" href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a>,</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">unsigned</span> unmap_flags = <a class="code hl_enumvalue" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>) <span class="keyword">noexcept</span> <span class="keyword">override</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> { ALLOC::free(cap, task, unmap_flags); }</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">bool</span> release(L4::Cap&lt;void&gt; cap, <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task,</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">unsigned</span> unmap_flags) <span class="keyword">noexcept</span> <span class="keyword">override</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> { <span class="keywordflow">return</span> ALLOC::release(cap, task, unmap_flags); }</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>(<span class="keywordtype">void</span> *) {}</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>};</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="keyword">inline</span></div>
<div class="foldopen" id="foldopen00100" data-start="{" data-end="}">
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="group__l4re__cap__api.html#gadb65db1681bc65100caf66924331b85b"> 100</a></span><a class="code hl_function" href="group__l4re__cap__api.html#gadb65db1681bc65100caf66924331b85b">Cap_alloc::~Cap_alloc</a>()</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>{}</div>
</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="keyword">extern</span> <a class="code hl_class" href="classL4Re_1_1Cap__alloc.html">Cap_alloc</a> *virt_cap_alloc;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="keyword">template</span>&lt; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Unmap_flags = L4_FP_ALL_SPACES &gt;</div>
<div class="foldopen" id="foldopen00110" data-start="{" data-end="};">
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classL4Re_1_1Smart__cap__auto.html"> 110</a></span><span class="keyword">class </span>Smart_cap_auto</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span>{</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <a class="code hl_class" href="classL4Re_1_1Cap__alloc.html">Cap_alloc</a> *_ca;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> Smart_cap_auto() : _ca(0) {}</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> Smart_cap_auto(<a class="code hl_class" href="classL4Re_1_1Cap__alloc.html">Cap_alloc</a> *ca) : _ca(ca) {}</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordtype">void</span> free(<a class="code hl_class" href="classL4_1_1Cap__base.html">L4::Cap_base</a> &amp;c)</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> {</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordflow">if</span> (c.<a class="code hl_function" href="classL4_1_1Cap__base.html#ab4937bb12579c752564f7250760d0bda">is_valid</a>() &amp;&amp; _ca)</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> _ca-&gt;free(<a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a>(c.<a class="code hl_function" href="classL4_1_1Cap__base.html#a90ff089ca2442b128c2b2b0e1c22c6d7">cap</a>()), This_task, Unmap_flags);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> invalidate(c);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> }</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keyword">static</span> <span class="keywordtype">void</span> invalidate(<a class="code hl_class" href="classL4_1_1Cap__base.html">L4::Cap_base</a> &amp;c)</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> {</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordflow">if</span> (c.<a class="code hl_function" href="classL4_1_1Cap__base.html#ab4937bb12579c752564f7250760d0bda">is_valid</a>())</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> c.<a class="code hl_function" href="classL4_1_1Cap__base.html#a44d8ff917b4024af596a5c2e9497faae">invalidate</a>();</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> }</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>};</div>
</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="keyword">template</span>&lt; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Unmap_flags = L4_FP_ALL_SPACES &gt;</div>
<div class="foldopen" id="foldopen00139" data-start="{" data-end="};">
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="classL4Re_1_1Smart__count__cap.html"> 139</a></span><span class="keyword">class </span>Smart_count_cap</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span>{</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <a class="code hl_class" href="classL4Re_1_1Cap__alloc.html">Cap_alloc</a> *_ca;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> Smart_count_cap() : _ca(<span class="keyword">nullptr</span>) {}</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> Smart_count_cap(<a class="code hl_class" href="classL4Re_1_1Cap__alloc.html">Cap_alloc</a> *ca) : _ca(ca) {}</div>
<div class="foldopen" id="foldopen00151" data-start="{" data-end="}">
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="classL4Re_1_1Smart__count__cap.html#ac293325ecf10cda46c139751f9735b28"> 151</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classL4Re_1_1Smart__count__cap.html#ac293325ecf10cda46c139751f9735b28">free</a>(<a class="code hl_class" href="classL4_1_1Cap__base.html">L4::Cap_base</a> &amp;c) <span class="keyword">noexcept</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> {</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keywordflow">if</span> (c.is_valid())</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> {</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keywordflow">if</span> (_ca &amp;&amp; _ca-&gt;release(<a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a>(c.cap()), This_task, Unmap_flags))</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> c.invalidate();</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> }</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> }</div>
</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span></div>
<div class="foldopen" id="foldopen00163" data-start="{" data-end="}">
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="classL4Re_1_1Smart__count__cap.html#acb3b3d09cb9c8ced8a5cf72468a8b1f0"> 163</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classL4Re_1_1Smart__count__cap.html#acb3b3d09cb9c8ced8a5cf72468a8b1f0">invalidate</a>(<a class="code hl_class" href="classL4_1_1Cap__base.html">L4::Cap_base</a> &amp;c) <span class="keyword">noexcept</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> {</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <span class="keywordflow">if</span> (c.is_valid())</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> c.invalidate();</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> }</div>
</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span></div>
<div class="foldopen" id="foldopen00172" data-start="{" data-end="}">
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"><a class="line" href="classL4Re_1_1Smart__count__cap.html#a4f5fee6c54e153aba5b2cf33e4c5c5ec"> 172</a></span> <a class="code hl_class" href="classL4_1_1Cap__base.html">L4::Cap_base</a> <a class="code hl_function" href="classL4Re_1_1Smart__count__cap.html#a4f5fee6c54e153aba5b2cf33e4c5c5ec">copy</a>(<a class="code hl_class" href="classL4_1_1Cap__base.html">L4::Cap_base</a> <span class="keyword">const</span> &amp;src)</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> {</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordflow">if</span> (src.<a class="code hl_function" href="classL4_1_1Cap__base.html#ab4937bb12579c752564f7250760d0bda">is_valid</a>())</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> _ca-&gt;take(<a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap&lt;void&gt;</a>(src.<a class="code hl_function" href="classL4_1_1Cap__base.html#a90ff089ca2442b128c2b2b0e1c22c6d7">cap</a>()));</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <span class="keywordflow">return</span> src;</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> }</div>
</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span>};</div>
</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span>}</div>
<div class="ttc" id="aclassL4Re_1_1Cap__alloc_html"><div class="ttname"><a href="classL4Re_1_1Cap__alloc.html">L4Re::Cap_alloc</a></div><div class="ttdoc">Capability allocator interface.</div><div class="ttdef"><b>Definition</b> <a href="#l00030">cap_alloc:31</a></div></div>
<div class="ttc" id="aclassL4Re_1_1Cap__alloc_html_a8ec47fe158e8a2acae49ceff505be193"><div class="ttname"><a href="classL4Re_1_1Cap__alloc.html#a8ec47fe158e8a2acae49ceff505be193">L4Re::Cap_alloc::alloc</a></div><div class="ttdeci">virtual L4::Cap&lt; void &gt; alloc() noexcept=0</div><div class="ttdoc">Allocate a capability.</div></div>
<div class="ttc" id="aclassL4Re_1_1Cap__alloc_html_ad8e36ca35881e1bc7ec3ff12e3956f10"><div class="ttname"><a href="classL4Re_1_1Cap__alloc.html#ad8e36ca35881e1bc7ec3ff12e3956f10">L4Re::Cap_alloc::free</a></div><div class="ttdeci">virtual void free(L4::Cap&lt; void &gt; cap, l4_cap_idx_t task=L4_INVALID_CAP, unsigned unmap_flags=L4_FP_ALL_SPACES) noexcept=0</div><div class="ttdoc">Free a capability.</div></div>
<div class="ttc" id="aclassL4Re_1_1Smart__count__cap_html_a4f5fee6c54e153aba5b2cf33e4c5c5ec"><div class="ttname"><a href="classL4Re_1_1Smart__count__cap.html#a4f5fee6c54e153aba5b2cf33e4c5c5ec">L4Re::Smart_count_cap::copy</a></div><div class="ttdeci">L4::Cap_base copy(L4::Cap_base const &amp;src)</div><div class="ttdoc">Copy operation for L4::Smart_cap (increment ref count).</div><div class="ttdef"><b>Definition</b> <a href="#l00172">cap_alloc:172</a></div></div>
<div class="ttc" id="aclassL4Re_1_1Smart__count__cap_html_ac293325ecf10cda46c139751f9735b28"><div class="ttname"><a href="classL4Re_1_1Smart__count__cap.html#ac293325ecf10cda46c139751f9735b28">L4Re::Smart_count_cap::free</a></div><div class="ttdeci">void free(L4::Cap_base &amp;c) noexcept</div><div class="ttdoc">Free operation for L4::Smart_cap (decrement ref count and delete if 0).</div><div class="ttdef"><b>Definition</b> <a href="#l00151">cap_alloc:151</a></div></div>
<div class="ttc" id="aclassL4Re_1_1Smart__count__cap_html_acb3b3d09cb9c8ced8a5cf72468a8b1f0"><div class="ttname"><a href="classL4Re_1_1Smart__count__cap.html#acb3b3d09cb9c8ced8a5cf72468a8b1f0">L4Re::Smart_count_cap::invalidate</a></div><div class="ttdeci">static void invalidate(L4::Cap_base &amp;c) noexcept</div><div class="ttdoc">Invalidate operation for L4::Smart_cap.</div><div class="ttdef"><b>Definition</b> <a href="#l00163">cap_alloc:163</a></div></div>
<div class="ttc" id="aclassL4_1_1Cap__base_html"><div class="ttname"><a href="classL4_1_1Cap__base.html">L4::Cap_base</a></div><div class="ttdoc">Base class for all kinds of capabilities.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00025">capability.h:26</a></div></div>
<div class="ttc" id="aclassL4_1_1Cap__base_html_a44d8ff917b4024af596a5c2e9497faae"><div class="ttname"><a href="classL4_1_1Cap__base.html#a44d8ff917b4024af596a5c2e9497faae">L4::Cap_base::invalidate</a></div><div class="ttdeci">void invalidate() noexcept</div><div class="ttdoc">Set this capability to invalid (L4_INVALID_CAP).</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00142">capability.h:142</a></div></div>
<div class="ttc" id="aclassL4_1_1Cap__base_html_a90ff089ca2442b128c2b2b0e1c22c6d7"><div class="ttname"><a href="classL4_1_1Cap__base.html#a90ff089ca2442b128c2b2b0e1c22c6d7">L4::Cap_base::cap</a></div><div class="ttdeci">l4_cap_idx_t cap() const noexcept</div><div class="ttdoc">Return capability selector.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00049">capability.h:49</a></div></div>
<div class="ttc" id="aclassL4_1_1Cap__base_html_ab4937bb12579c752564f7250760d0bda"><div class="ttname"><a href="classL4_1_1Cap__base.html#ab4937bb12579c752564f7250760d0bda">L4::Cap_base::is_valid</a></div><div class="ttdeci">bool is_valid() const noexcept</div><div class="ttdoc">Test whether the capability is a valid capability index (i.e., not L4_INVALID_CAP).</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00057">capability.h:57</a></div></div>
<div class="ttc" id="aclassL4_1_1Cap_html"><div class="ttname"><a href="classL4_1_1Cap.html">L4::Cap</a></div><div class="ttdoc">C++ interface for capabilities.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00223">capability.h:224</a></div></div>
<div class="ttc" id="agroup__l4__cap__api_html_ga1445e923ce73029130d569d6e69a4dd8"><div class="ttname"><a href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></div><div class="ttdeci">unsigned long l4_cap_idx_t</div><div class="ttdoc">Capability selector type.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2types_8h_source.html#l00336">types.h:336</a></div></div>
<div class="ttc" id="agroup__l4__cap__api_html_ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102"><div class="ttname"><a href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a></div><div class="ttdeci">@ L4_INVALID_CAP</div><div class="ttdoc">Invalid capability selector.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2consts_8h_source.html#l00153">consts.h:153</a></div></div>
<div class="ttc" id="agroup__l4__task__api_html_gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055"><div class="ttname"><a href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a></div><div class="ttdeci">@ L4_FP_ALL_SPACES</div><div class="ttdoc">Flag to tell the unmap operation to revoke permissions from all child mappings including the mapping ...</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2consts_8h_source.html#l00183">consts.h:183</a></div></div>
<div class="ttc" id="agroup__l4re__cap__api_html_gadb65db1681bc65100caf66924331b85b"><div class="ttname"><a href="group__l4re__cap__api.html#gadb65db1681bc65100caf66924331b85b">L4Re::Cap_alloc::~Cap_alloc</a></div><div class="ttdeci">virtual ~Cap_alloc()=0</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> <a href="#l00100">cap_alloc:100</a></div></div>
<div class="ttc" id="anamespaceL4Re_html"><div class="ttname"><a href="namespaceL4Re.html">L4Re</a></div><div class="ttdoc">L4Re C++ Interfaces.</div><div class="ttdef"><b>Definition</b> <a href="cmd__control_source.html#l00014">cmd_control:14</a></div></div>
<div class="ttc" id="anamespaceL4_html"><div class="ttname"><a href="namespaceL4.html">L4</a></div><div class="ttdoc">L4 low-level kernel interface.</div><div class="ttdef"><b>Definition</b> <a href="l4sys-l4f-groups_8dox_source.html#l00050">l4sys-l4f-groups.dox:50</a></div></div>
<div class="ttc" id="anamespaceL4_html_ac674c8e32808f504f4fa0aa8e5276e84"><div class="ttname"><a href="namespaceL4.html#ac674c8e32808f504f4fa0aa8e5276e84">L4::cap_cast</a></div><div class="ttdeci">Cap&lt; T &gt; cap_cast(Cap&lt; F &gt; const &amp;c) noexcept</div><div class="ttdoc">static_cast for capabilities.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00416">capability.h:416</a></div></div>
<div class="ttc" id="are_2consts_html"><div class="ttname"><a href="re_2consts.html">consts</a></div><div class="ttdoc">Constants.</div></div>
<div class="ttc" id="asmart__capability_html"><div class="ttname"><a href="smart__capability.html">smart_capability</a></div><div class="ttdoc">L4::Capability class.</div></div>
<div class="ttc" id="atask_html"><div class="ttname"><a href="task.html">task</a></div><div class="ttdoc">Common task related definitions.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><a href="cap__alloc.html">cap_alloc</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>