teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

l4re-base-25.08.0

Browse Source
This commit is contained in:
Viktor Reusch
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

252
doc/source/html/group__l4re__cap__api.html Normal file
View File

@@ -0,0 +1,252 @@
<!-- 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: L4Re Capability API</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('group__l4re__cap__api.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">L4Re Capability API <div class="ingroups"><a class="el" href="group__api__l4re.html">L4Re C++ Interface</a> &raquo; <a class="el" href="group__api__l4re__util.html">L4Re Util C++ Interface</a></div></div></div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4Re Capability API:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4re__cap__api.svg" width="532" height="47"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:L4Re_3A_3ACap_5Falloc" id="r_L4Re_3A_3ACap_5Falloc"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Cap__alloc.html">L4Re::Cap_alloc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Capability allocator interface. <a href="classL4Re_1_1Cap__alloc.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4Re_3A_3ASmart_5Fcap_5Fauto_3C_20Unmap_5Fflags_20_3E" id="r_L4Re_3A_3ASmart_5Fcap_5Fauto_3C_20Unmap_5Fflags_20_3E"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Smart__cap__auto.html">L4Re::Smart_cap_auto&lt; Unmap_flags &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for <a class="el" href="namespaceL4Re.html#a44b5a2cf415294d2f2cc5ffce0614981" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a> and <a class="el" href="namespaceL4Re.html#a3c900d7dd040edd4ed72e837eda69d89" title="Unique capability that implements automatic free and unmap+delete of the capability selector.">Unique_del_cap</a>. <a href="classL4Re_1_1Smart__cap__auto.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4Re_3A_3ASmart_5Fcount_5Fcap_3C_20Unmap_5Fflags_20_3E" id="r_L4Re_3A_3ASmart_5Fcount_5Fcap_3C_20Unmap_5Fflags_20_3E"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Smart__count__cap.html">L4Re::Smart_count_cap&lt; Unmap_flags &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for Ref_cap and Ref_del_cap. <a href="classL4Re_1_1Smart__count__cap.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4Re_3A_3AUtil_3A_3ASmart_5Fcap_5Fauto_3C_20Unmap_5Fflags_20_3E" id="r_L4Re_3A_3AUtil_3A_3ASmart_5Fcap_5Fauto_3C_20Unmap_5Fflags_20_3E"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">L4Re::Util::Smart_cap_auto&lt; Unmap_flags &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for <a class="el" href="namespaceL4Re_1_1Util.html#a0efccd325a19246334922e58dd973914" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a> and <a class="el" href="namespaceL4Re_1_1Util.html#a13a4df2df2fdffc06880b49fb10b0c74" title="Unique capability that implements automatic free and unmap+delete of the capability selector.">Unique_del_cap</a>. <a href="classL4Re_1_1Util_1_1Smart__cap__auto.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4Re_3A_3AUtil_3A_3ASmart_5Fcount_5Fcap_3C_20Unmap_5Fflags_20_3E" id="r_L4Re_3A_3AUtil_3A_3ASmart_5Fcount_5Fcap_3C_20Unmap_5Fflags_20_3E"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">L4Re::Util::Smart_count_cap&lt; Unmap_flags &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for <a class="el" href="structL4Re_1_1Util_1_1Ref__cap.html" title="Automatic capability that implements automatic free and unmap of the capability selector.">Ref_cap</a> and <a class="el" href="structL4Re_1_1Util_1_1Ref__del__cap.html" title="Automatic capability that implements automatic free and unmap+delete of the capability selector.">Ref_del_cap</a>. <a href="classL4Re_1_1Util_1_1Smart__count__cap.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4Re_3A_3AUtil_3A_3ARef_5Fcap_3C_20T_20_3E" id="r_L4Re_3A_3AUtil_3A_3ARef_5Fcap_3C_20T_20_3E"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Util_1_1Ref__cap.html">L4Re::Util::Ref_cap&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatic capability that implements automatic free and unmap of the capability selector. <a href="structL4Re_1_1Util_1_1Ref__cap.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4Re_3A_3AUtil_3A_3ARef_5Fdel_5Fcap_3C_20T_20_3E" id="r_L4Re_3A_3AUtil_3A_3ARef_5Fdel_5Fcap_3C_20T_20_3E"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Util_1_1Ref__del__cap.html">L4Re::Util::Ref_del_cap&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatic capability that implements automatic free and unmap+delete of the capability selector. <a href="structL4Re_1_1Util_1_1Ref__del__cap.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab8a4837ecc6fdba70d41a6ac49e30c0b" id="r_gab8a4837ecc6fdba70d41a6ac49e30c0b"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:gab8a4837ecc6fdba70d41a6ac49e30c0b template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structL4Re_1_1Util_1_1Ref__cap.html">Ref_cap</a>&lt; T &gt;::Cap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab8a4837ecc6fdba70d41a6ac49e30c0b">L4Re::Util::make_ref_cap</a> ()</td></tr>
<tr class="memdesc:gab8a4837ecc6fdba70d41a6ac49e30c0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability slot and wrap it in a <a class="el" href="structL4Re_1_1Util_1_1Ref__cap.html" title="Automatic capability that implements automatic free and unmap of the capability selector.">Ref_cap</a>. <br /></td></tr>
<tr class="memitem:ga6fb7c363bb892bc6ad18283ab8b51479" id="r_ga6fb7c363bb892bc6ad18283ab8b51479"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:ga6fb7c363bb892bc6ad18283ab8b51479 template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structL4Re_1_1Util_1_1Ref__del__cap.html">Ref_del_cap</a>&lt; T &gt;::Cap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6fb7c363bb892bc6ad18283ab8b51479">L4Re::Util::make_ref_del_cap</a> ()</td></tr>
<tr class="memdesc:ga6fb7c363bb892bc6ad18283ab8b51479"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability slot and wrap it in a <a class="el" href="structL4Re_1_1Util_1_1Ref__del__cap.html" title="Automatic capability that implements automatic free and unmap+delete of the capability selector.">Ref_del_cap</a>. <br /></td></tr>
<tr class="memitem:gadb65db1681bc65100caf66924331b85b" id="r_gadb65db1681bc65100caf66924331b85b"><td class="memItemLeft" align="right" valign="top"><a id="gadb65db1681bc65100caf66924331b85b" name="gadb65db1681bc65100caf66924331b85b"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>L4Re::Cap_alloc::~Cap_alloc</b> ()=0</td></tr>
<tr class="memdesc:gadb65db1681bc65100caf66924331b85b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-var-members" class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga29e3dbeb3c8ed0609519c9df212c9c52" id="r_ga29e3dbeb3c8ed0609519c9df212c9c52"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4Re_1_1Util_1_1__Cap__alloc.html">_Cap_alloc</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga29e3dbeb3c8ed0609519c9df212c9c52">L4Re::Util::cap_alloc</a></td></tr>
<tr class="memdesc:ga29e3dbeb3c8ed0609519c9df212c9c52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Capability allocator. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="gab8a4837ecc6fdba70d41a6ac49e30c0b" name="gab8a4837ecc6fdba70d41a6ac49e30c0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab8a4837ecc6fdba70d41a6ac49e30c0b">&#9670;&#160;</a></span>make_ref_cap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structL4Re_1_1Util_1_1Ref__cap.html">Ref_cap</a>&lt; T &gt;::Cap L4Re::Util::make_ref_cap </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a capability slot and wrap it in a <a class="el" href="structL4Re_1_1Util_1_1Ref__cap.html" title="Automatic capability that implements automatic free and unmap of the capability selector.">Ref_cap</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of capability the slot is used for. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="util_2cap__alloc_source.html#l00195">195</a> of file <a class="el" href="util_2cap__alloc_source.html">cap_alloc</a>.</p>
<p class="reference">References <a class="el" href="#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.</p>
</div>
</div>
<a id="ga6fb7c363bb892bc6ad18283ab8b51479" name="ga6fb7c363bb892bc6ad18283ab8b51479"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6fb7c363bb892bc6ad18283ab8b51479">&#9670;&#160;</a></span>make_ref_del_cap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structL4Re_1_1Util_1_1Ref__del__cap.html">Ref_del_cap</a>&lt; T &gt;::Cap L4Re::Util::make_ref_del_cap </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a capability slot and wrap it in a <a class="el" href="structL4Re_1_1Util_1_1Ref__del__cap.html" title="Automatic capability that implements automatic free and unmap+delete of the capability selector.">Ref_del_cap</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of capability the slot is used for. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="util_2cap__alloc_source.html#l00204">204</a> of file <a class="el" href="util_2cap__alloc_source.html">cap_alloc</a>.</p>
<p class="reference">References <a class="el" href="#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.</p>
</div>
</div>
<a name="doc-var-members" id="doc-var-members"></a><h2 id="header-doc-var-members" class="groupheader">Variable Documentation</h2>
<a id="ga29e3dbeb3c8ed0609519c9df212c9c52" name="ga29e3dbeb3c8ed0609519c9df212c9c52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29e3dbeb3c8ed0609519c9df212c9c52">&#9670;&#160;</a></span>cap_alloc</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classL4Re_1_1Util_1_1__Cap__alloc.html">_Cap_alloc</a>&amp; L4Re::Util::cap_alloc</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel extern">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Capability allocator. </p>
<p>This is the instance of the capability allocator that is used by usual applications.</p>
<p>The capability allocator uses the <a class="el" href="classL4Re_1_1Util_1_1Counting__cap__alloc.html" title="Internal reference-counting cap allocator.">Counting_cap_alloc</a>, a reference-counting thread-safe capability allocator, that keeps a reference counter for each managed capability selector. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2l4re_2c_09_09_2mem_alloc_2ma_09rm_8cc-example.html#_a1">examples/libs/l4re/c++/mem_alloc/ma+rm.cc</a>, <a class="el" href="examples_2libs_2l4re_2c_09_09_2shared_ds_2ds_clnt_8cc-example.html#_a4">examples/libs/l4re/c++/shared_ds/ds_clnt.cc</a>, <a class="el" href="examples_2libs_2l4re_2c_09_09_2shared_ds_2ds_srv_8cc-example.html#_a9">examples/libs/l4re/c++/shared_ds/ds_srv.cc</a>, and <a class="el" href="examples_2libs_2l4re_2streammap_2client_8cc-example.html#_a13">examples/libs/l4re/streammap/client.cc</a>.</dd>
</dl>
<p class="reference">Referenced by <a class="el" href="br__manager_source.html#l00054">L4Re::Util::Br_manager::alloc_buffer_demand()</a>, <a class="el" href="util_2cap__alloc_source.html#l00104">L4Re::Util::Smart_count_cap&lt; Unmap_flags &gt;::copy()</a>, <a class="el" href="util_2cap__alloc_source.html#l00051">L4Re::Util::Smart_cap_auto&lt; Unmap_flags &gt;::free()</a>, <a class="el" href="util_2cap__alloc_source.html#l00083">L4Re::Util::Smart_count_cap&lt; Unmap_flags &gt;::free()</a>, <a class="el" href="util_2event_source.html#l00059">L4Re::Util::Event_t&lt; Default_event_payload &gt;::init()</a>, <a class="el" href="util_2event_source.html#l00112">L4Re::Util::Event_t&lt; Default_event_payload &gt;::init_poll()</a>, <a class="el" href="util_2cap__alloc_source.html#l00195">make_ref_cap()</a>, <a class="el" href="util_2cap__alloc_source.html#l00204">make_ref_del_cap()</a>, <a class="el" href="util_2shared__cap_source.html#l00060">make_shared_cap()</a>, <a class="el" href="util_2shared__cap_source.html#l00110">make_shared_del_cap()</a>, <a class="el" href="util_2unique__cap_source.html#l00055">make_unique_cap()</a>, <a class="el" href="util_2unique__cap_source.html#l00098">make_unique_del_cap()</a>, <a class="el" href="br__manager_source.html#l00094">L4Re::Util::Br_manager::realloc_rcv_cap()</a>, and <a class="el" href="object__registry_source.html#l00262">L4Re::Util::Object_registry::unregister_obj()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</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="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>