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

703
doc/source/html/namespaceL4Re_1_1Util.html Normal file
View File

@@ -0,0 +1,703 @@
<!-- 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::Util Namespace Reference</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('namespaceL4Re_1_1Util.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::Util Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Documentation of the <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> Runtime Environment utility functionality in C++.
<a href="#details">More...</a></p>
<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:Cap_5Falloc_5Fbase" id="r_Cap_5Falloc_5Fbase"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Cap__alloc__base.html">Cap_alloc_base</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Capability allocator. <a href="classL4Re_1_1Util_1_1Cap__alloc__base.html#details">More...</a><br /></td></tr>
<tr class="memitem:Br_5Fmanager" id="r_Br_5Fmanager"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Br__manager.html">Br_manager</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer-register (BR) manager for <a class="el" href="classL4_1_1Server.html" title="Basic server loop for handling client requests.">L4::Server</a>. <a href="classL4Re_1_1Util_1_1Br__manager.html#details">More...</a><br /></td></tr>
<tr class="memitem:Br_5Fmanager_5Fhooks" id="r_Br_5Fmanager_5Fhooks"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Util_1_1Br__manager__hooks.html">Br_manager_hooks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predefined server-loop hooks for a server loop using the <a class="el" href="classL4Re_1_1Util_1_1Br__manager.html" title="Buffer-register (BR) manager for L4::Server.">Br_manager</a>. <a href="structL4Re_1_1Util_1_1Br__manager__hooks.html#details">More...</a><br /></td></tr>
<tr class="memitem:Br_5Fmanager_5Ftimeout_5Fhooks" id="r_Br_5Fmanager_5Ftimeout_5Fhooks"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Util_1_1Br__manager__timeout__hooks.html">Br_manager_timeout_hooks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predefined server-loop hooks for a server with using the <a class="el" href="classL4Re_1_1Util_1_1Br__manager.html" title="Buffer-register (BR) manager for L4::Server.">Br_manager</a> and a timeout queue. <a href="structL4Re_1_1Util_1_1Br__manager__timeout__hooks.html#details">More...</a><br /></td></tr>
<tr class="memitem:Smart_5Fcap_5Fauto" id="r_Smart_5Fcap_5Fauto"><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">Smart_cap_auto</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for <a class="el" href="#a0efccd325a19246334922e58dd973914" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a> and <a class="el" href="#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:Smart_5Fcount_5Fcap" id="r_Smart_5Fcount_5Fcap"><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">Smart_count_cap</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:Ref_5Fcap" id="r_Ref_5Fcap"><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">Ref_cap</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:Ref_5Fdel_5Fcap" id="r_Ref_5Fdel_5Fcap"><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">Ref_del_cap</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>
<tr class="memitem:_5FCap_5Falloc" id="r__5FCap_5Falloc"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1__Cap__alloc.html">_Cap_alloc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adapter to expose the cap allocator implementation as <a class="el" href="classL4Re_1_1Cap__alloc.html" title="Capability allocator interface.">L4Re::Cap_alloc</a> compatible class. <a href="classL4Re_1_1Util_1_1__Cap__alloc.html#details">More...</a><br /></td></tr>
<tr class="memitem:Counter" id="r_Counter"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Util_1_1Counter.html">Counter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structL4Re_1_1Util_1_1Counter.html" title="Counter for Counting_cap_alloc with variable data width.">Counter</a> for <a class="el" href="classL4Re_1_1Util_1_1Counting__cap__alloc.html" title="Internal reference-counting cap allocator.">Counting_cap_alloc</a> with variable data width. <a href="structL4Re_1_1Util_1_1Counter.html#details">More...</a><br /></td></tr>
<tr class="memitem:Counter_5Fatomic" id="r_Counter_5Fatomic"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Util_1_1Counter__atomic.html">Counter_atomic</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread safe version of counter for <a class="el" href="classL4Re_1_1Util_1_1Counting__cap__alloc.html" title="Internal reference-counting cap allocator.">Counting_cap_alloc</a>. <a href="structL4Re_1_1Util_1_1Counter__atomic.html#details">More...</a><br /></td></tr>
<tr class="memitem:Counting_5Fcap_5Falloc" id="r_Counting_5Fcap_5Falloc"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Counting__cap__alloc.html">Counting_cap_alloc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal reference-counting cap allocator. <a href="classL4Re_1_1Util_1_1Counting__cap__alloc.html#details">More...</a><br /></td></tr>
<tr class="memitem:Dataspace_5Fsvr" id="r_Dataspace_5Fsvr"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Dataspace__svr.html">Dataspace_svr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classL4Re_1_1Dataspace.html" title="Interface for memory-like objects.">Dataspace</a> server class. <a href="classL4Re_1_1Util_1_1Dataspace__svr.html#details">More...</a><br /></td></tr>
<tr class="memitem:Event_5Ft" id="r_Event_5Ft"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Event__t.html">Event_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience wrapper for getting access to an event object. <a href="classL4Re_1_1Util_1_1Event__t.html#details">More...</a><br /></td></tr>
<tr class="memitem:Event_5Fbuffer_5Ft" id="r_Event_5Fbuffer_5Ft"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Event__buffer__t.html">Event_buffer_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event_buffer utility class. <a href="classL4Re_1_1Util_1_1Event__buffer__t.html#details">More...</a><br /></td></tr>
<tr class="memitem:Event_5Fbuffer_5Fconsumer_5Ft" id="r_Event_5Fbuffer_5Fconsumer_5Ft"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Event__buffer__consumer__t.html">Event_buffer_consumer_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An event buffer consumer. <a href="classL4Re_1_1Util_1_1Event__buffer__consumer__t.html#details">More...</a><br /></td></tr>
<tr class="memitem:Event_5Fsvr" id="r_Event_5Fsvr"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Event__svr.html">Event_svr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience wrapper for implementing an event server. <a href="classL4Re_1_1Util_1_1Event__svr.html#details">More...</a><br /></td></tr>
<tr class="memitem:Item_5Falloc_5Fbase" id="r_Item_5Falloc_5Fbase"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Item__alloc__base.html">Item_alloc_base</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Item allocator. <a href="classL4Re_1_1Util_1_1Item__alloc__base.html#details">More...</a><br /></td></tr>
<tr class="memitem:Object_5Fregistry" id="r_Object_5Fregistry"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Object__registry.html">Object_registry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A registry that manages server objects and their attached IPC gates for a single server loop for a specific thread. <a href="classL4Re_1_1Util_1_1Object__registry.html#details">More...</a><br /></td></tr>
<tr class="memitem:Registry_5Fserver" id="r_Registry_5Fserver"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Registry__server.html">Registry_server</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A server loop object which has a <a class="el" href="classL4Re_1_1Util_1_1Object__registry.html" title="A registry that manages server objects and their attached IPC gates for a single server loop for a sp...">Object_registry</a> included. <a href="classL4Re_1_1Util_1_1Registry__server.html#details">More...</a><br /></td></tr>
<tr class="memitem:Vcon_5Fsvr" id="r_Vcon_5Fsvr"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Vcon__svr.html">Vcon_svr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classL4Re_1_1Console.html" title="Console class.">Console</a> server template class. <a href="classL4Re_1_1Util_1_1Vcon__svr.html#details">More...</a><br /></td></tr>
<tr class="memitem:Bitmap_5Fbase" id="r_Bitmap_5Fbase"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Bitmap__base.html">Bitmap_base</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Basic bitmap abstraction. <a href="classL4Re_1_1Util_1_1Bitmap__base.html#details">More...</a><br /></td></tr>
<tr class="memitem:Bitmap" id="r_Bitmap"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4Re_1_1Util_1_1Bitmap.html">Bitmap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A static bitmap. <a href="classL4Re_1_1Util_1_1Bitmap.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a2eafa529c9c1144d7840f4e101ecf7aa" id="r_a2eafa529c9c1144d7840f4e101ecf7aa"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a2eafa529c9c1144d7840f4e101ecf7aa template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2eafa529c9c1144d7840f4e101ecf7aa">Shared_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td></tr>
<tr class="memdesc:a2eafa529c9c1144d7840f4e101ecf7aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared capability that implements automatic free and unmap of the capability selector. <br /></td></tr>
<tr class="memitem:ac50474348d548cbfa7a5e9fe4f1f0a1e" id="r_ac50474348d548cbfa7a5e9fe4f1f0a1e"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:ac50474348d548cbfa7a5e9fe4f1f0a1e template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac50474348d548cbfa7a5e9fe4f1f0a1e">shared_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td></tr>
<tr class="memdesc:ac50474348d548cbfa7a5e9fe4f1f0a1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared capability that implements automatic free and unmap of the capability selector. <br /></td></tr>
<tr class="memitem:a9b7734b755032a43b8ccf8cc6bfb4557" id="r_a9b7734b755032a43b8ccf8cc6bfb4557"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a9b7734b755032a43b8ccf8cc6bfb4557 template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b7734b755032a43b8ccf8cc6bfb4557">Shared_del_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td></tr>
<tr class="memdesc:a9b7734b755032a43b8ccf8cc6bfb4557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared capability that implements automatic free and unmap+delete of the capability selector. <br /></td></tr>
<tr class="memitem:af17f52920a3e956631ea6b3edf82e806" id="r_af17f52920a3e956631ea6b3edf82e806"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:af17f52920a3e956631ea6b3edf82e806 template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af17f52920a3e956631ea6b3edf82e806">shared_del_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td></tr>
<tr class="memdesc:af17f52920a3e956631ea6b3edf82e806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared capability that implements automatic free and unmap+delete of the capability selector. <br /></td></tr>
<tr class="memitem:a0efccd325a19246334922e58dd973914" id="r_a0efccd325a19246334922e58dd973914"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a0efccd325a19246334922e58dd973914 template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0efccd325a19246334922e58dd973914">Unique_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td></tr>
<tr class="memdesc:a0efccd325a19246334922e58dd973914"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique capability that implements automatic free and unmap of the capability selector. <br /></td></tr>
<tr class="memitem:a987984b0219186ceb761fb221e705557" id="r_a987984b0219186ceb761fb221e705557"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a987984b0219186ceb761fb221e705557 template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a987984b0219186ceb761fb221e705557">unique_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td></tr>
<tr class="memdesc:a987984b0219186ceb761fb221e705557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique capability that implements automatic free and unmap of the capability selector. <br /></td></tr>
<tr class="memitem:a13a4df2df2fdffc06880b49fb10b0c74" id="r_a13a4df2df2fdffc06880b49fb10b0c74"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a13a4df2df2fdffc06880b49fb10b0c74 template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a13a4df2df2fdffc06880b49fb10b0c74">Unique_del_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td></tr>
<tr class="memdesc:a13a4df2df2fdffc06880b49fb10b0c74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique capability that implements automatic free and unmap+delete of the capability selector. <br /></td></tr>
<tr class="memitem:a9cdcf86bc007bba92b86b66fa92a00bf" id="r_a9cdcf86bc007bba92b86b66fa92a00bf"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a9cdcf86bc007bba92b86b66fa92a00bf template"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9cdcf86bc007bba92b86b66fa92a00bf">unique_del_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td></tr>
<tr class="memdesc:a9cdcf86bc007bba92b86b66fa92a00bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique capability that implements automatic free and unmap+delete of the capability selector. <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="group__l4re__cap__api.html#gab8a4837ecc6fdba70d41a6ac49e30c0b">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="group__l4re__cap__api.html#ga6fb7c363bb892bc6ad18283ab8b51479">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:ga72ecf40d83b29caefa7ace4842ece68f" id="r_ga72ecf40d83b29caefa7ace4842ece68f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4re__util__kumem.html#ga72ecf40d83b29caefa7ace4842ece68f">kumem_alloc</a> (<a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> *mem, unsigned pages_order, <a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; <a class="el" href="classL4_1_1Task.html">L4::Task</a> &gt; task=<a class="el" href="classL4Re_1_1Env.html#a2706ca11e70845b0a29a5646c9fd54bc">L4Re::Env::env</a>() -&gt;task(), <a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; <a class="el" href="classL4Re_1_1Rm.html">L4Re::Rm</a> &gt; rm=<a class="el" href="classL4Re_1_1Env.html#a2706ca11e70845b0a29a5646c9fd54bc">L4Re::Env::env</a>() -&gt;rm()) noexcept</td></tr>
<tr class="memdesc:ga72ecf40d83b29caefa7ace4842ece68f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate state area. <br /></td></tr>
<tr class="memitem:a08b3c68edc484947355ca2b60a97e30d" id="r_a08b3c68edc484947355ca2b60a97e30d"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a08b3c68edc484947355ca2b60a97e30d template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2eafa529c9c1144d7840f4e101ecf7aa">Shared_cap</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a08b3c68edc484947355ca2b60a97e30d">make_shared_cap</a> ()</td></tr>
<tr class="memdesc:a08b3c68edc484947355ca2b60a97e30d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability slot and wrap it in a <a class="el" href="#a2eafa529c9c1144d7840f4e101ecf7aa" title="Shared capability that implements automatic free and unmap of the capability selector.">Shared_cap</a>. <br /></td></tr>
<tr class="memitem:a0812bce3621d886729f5510b4b7f9128" id="r_a0812bce3621d886729f5510b4b7f9128"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a0812bce3621d886729f5510b4b7f9128 template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a9b7734b755032a43b8ccf8cc6bfb4557">Shared_del_cap</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0812bce3621d886729f5510b4b7f9128">make_shared_del_cap</a> ()</td></tr>
<tr class="memdesc:a0812bce3621d886729f5510b4b7f9128"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability slot and wrap it in a <a class="el" href="#a9b7734b755032a43b8ccf8cc6bfb4557" title="Shared capability that implements automatic free and unmap+delete of the capability selector.">Shared_del_cap</a>. <br /></td></tr>
<tr class="memitem:a0c4ee77222764600950f2ebe23a1e45a" id="r_a0c4ee77222764600950f2ebe23a1e45a"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a0c4ee77222764600950f2ebe23a1e45a template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a0efccd325a19246334922e58dd973914">Unique_cap</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c4ee77222764600950f2ebe23a1e45a">make_unique_cap</a> ()</td></tr>
<tr class="memdesc:a0c4ee77222764600950f2ebe23a1e45a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability slot and wrap it in an <a class="el" href="#a0efccd325a19246334922e58dd973914" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a>. <br /></td></tr>
<tr class="memitem:a4c9140864b109e2582d94d5def245fd1" id="r_a4c9140864b109e2582d94d5def245fd1"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a4c9140864b109e2582d94d5def245fd1 template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a13a4df2df2fdffc06880b49fb10b0c74">Unique_del_cap</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c9140864b109e2582d94d5def245fd1">make_unique_del_cap</a> ()</td></tr>
<tr class="memdesc:a4c9140864b109e2582d94d5def245fd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability slot and wrap it in an <a class="el" href="#a13a4df2df2fdffc06880b49fb10b0c74" title="Unique capability that implements automatic free and unmap+delete of the capability selector.">Unique_del_cap</a>. <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="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">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>
<div class="textblock"><p>Documentation of the <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> Runtime Environment utility functionality in C++. </p>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
<a id="a2eafa529c9c1144d7840f4e101ecf7aa" name="a2eafa529c9c1144d7840f4e101ecf7aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2eafa529c9c1144d7840f4e101ecf7aa">&#9670;&#160;</a></span>Shared_cap</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a2eafa529c9c1144d7840f4e101ecf7aa">L4Re::Util::Shared_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared capability that implements automatic free and unmap of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>This shared capability implements a counted reference to a capability selector. The capability shall be unmapped and freed when the reference count in the allocator goes to zero.</p>
<p>Usage: </p><pre class="fragment">L4Re::Util::Shared_cap&lt;L4Re::Dataspace&gt; global_ds_cap;
{
L4Re::Util::Shared_cap&lt;L4Re::Dataspace&gt;
ds_cap = make_shared_cap&lt;L4Re::Dataspace&gt;();
// reference count for the allocated cap selector is now 1
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(4096, ds_cap.get()));
global_ds_cap = ds_cap;
// reference count is now 2
...
}
// reference count dropped to 1 (ds_cap is no longer existing).
</pre>
<p class="definition">Definition at line <a class="el" href="util_2shared__cap_source.html#l00048">48</a> of file <a class="el" href="util_2shared__cap_source.html">shared_cap</a>.</p>
</div>
</div>
<a id="ac50474348d548cbfa7a5e9fe4f1f0a1e" name="ac50474348d548cbfa7a5e9fe4f1f0a1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac50474348d548cbfa7a5e9fe4f1f0a1e">&#9670;&#160;</a></span>shared_cap</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#ac50474348d548cbfa7a5e9fe4f1f0a1e">L4Re::Util::shared_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared capability that implements automatic free and unmap of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>This shared capability implements a counted reference to a capability selector. The capability shall be unmapped and freed when the reference count in the allocator goes to zero.</p>
<p>Usage: </p><pre class="fragment">L4Re::Util::Shared_cap&lt;L4Re::Dataspace&gt; global_ds_cap;
{
L4Re::Util::Shared_cap&lt;L4Re::Dataspace&gt;
ds_cap = make_shared_cap&lt;L4Re::Dataspace&gt;();
// reference count for the allocated cap selector is now 1
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(4096, ds_cap.get()));
global_ds_cap = ds_cap;
// reference count is now 2
...
}
// reference count dropped to 1 (ds_cap is no longer existing).
</pre>
<p class="definition">Definition at line <a class="el" href="util_2shared__cap_source.html#l00051">51</a> of file <a class="el" href="util_2shared__cap_source.html">shared_cap</a>.</p>
</div>
</div>
<a id="a9b7734b755032a43b8ccf8cc6bfb4557" name="a9b7734b755032a43b8ccf8cc6bfb4557"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b7734b755032a43b8ccf8cc6bfb4557">&#9670;&#160;</a></span>Shared_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">using <a class="el" href="#a9b7734b755032a43b8ccf8cc6bfb4557">L4Re::Util::Shared_del_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared capability that implements automatic free and unmap+delete of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>This shared capability implements a counted reference to a capability selector. The capability shall be unmapped and freed when the reference count in the allocator goes to zero. The main difference to <a class="el" href="#a2eafa529c9c1144d7840f4e101ecf7aa" title="Shared capability that implements automatic free and unmap of the capability selector.">Shared_cap</a> is that the unmap is done with the deletion flag enabled and this leads to the deletion of the object if the current task holds appropriate deletion rights.</p>
<p>Usage: </p><pre class="fragment">L4Re::Util::Shared_del_cap&lt;L4Re::Dataspace&gt; global_ds_cap;
{
L4Re::Util::Shared_del_cap&lt;L4Re::Dataspace&gt;
ds_cap = make_shared_del_cap&lt;L4Re::Dataspace&gt;();
// reference count for the allocated cap selector is now 1
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(4096, ds_cap.get()));
global_ds_cap = ds_cap;
// reference count is now 2
...
}
// reference count dropped to 1 (ds_cap is no longer existing).
...
global_ds_cap = L4_INVALID_CAP;
// reference count dropped to 0 (data space shall be deleted).
</pre>
<p class="definition">Definition at line <a class="el" href="util_2shared__cap_source.html#l00098">98</a> of file <a class="el" href="util_2shared__cap_source.html">shared_cap</a>.</p>
</div>
</div>
<a id="af17f52920a3e956631ea6b3edf82e806" name="af17f52920a3e956631ea6b3edf82e806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17f52920a3e956631ea6b3edf82e806">&#9670;&#160;</a></span>shared_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">using <a class="el" href="#af17f52920a3e956631ea6b3edf82e806">L4Re::Util::shared_del_cap</a> = L4::Detail::Shared_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__count__cap.html">Smart_count_cap</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared capability that implements automatic free and unmap+delete of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>This shared capability implements a counted reference to a capability selector. The capability shall be unmapped and freed when the reference count in the allocator goes to zero. The main difference to <a class="el" href="#a2eafa529c9c1144d7840f4e101ecf7aa" title="Shared capability that implements automatic free and unmap of the capability selector.">Shared_cap</a> is that the unmap is done with the deletion flag enabled and this leads to the deletion of the object if the current task holds appropriate deletion rights.</p>
<p>Usage: </p><pre class="fragment">L4Re::Util::Shared_del_cap&lt;L4Re::Dataspace&gt; global_ds_cap;
{
L4Re::Util::Shared_del_cap&lt;L4Re::Dataspace&gt;
ds_cap = make_shared_del_cap&lt;L4Re::Dataspace&gt;();
// reference count for the allocated cap selector is now 1
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(4096, ds_cap.get()));
global_ds_cap = ds_cap;
// reference count is now 2
...
}
// reference count dropped to 1 (ds_cap is no longer existing).
...
global_ds_cap = L4_INVALID_CAP;
// reference count dropped to 0 (data space shall be deleted).
</pre>
<p class="definition">Definition at line <a class="el" href="util_2shared__cap_source.html#l00101">101</a> of file <a class="el" href="util_2shared__cap_source.html">shared_cap</a>.</p>
</div>
</div>
<a id="a0efccd325a19246334922e58dd973914" name="a0efccd325a19246334922e58dd973914"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0efccd325a19246334922e58dd973914">&#9670;&#160;</a></span>Unique_cap</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a0efccd325a19246334922e58dd973914">L4Re::Util::Unique_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique capability that implements automatic free and unmap of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>The ownership of the capability is managed in the same way as unique_ptr.</p>
<p>Usage: </p><pre class="fragment">{
L4Re::Util::Unique_cap&lt;L4Re::Dataspace&gt;
ds_cap = L4Re::Util::make_unique_cap&lt;L4Re::Dataspace&gt;();
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(L4_PAGESIZE, ds_cap.get()));
...
// At the end of the scope ds_cap is unmapped and the capability
// selector is freed.
}
</pre>
<p class="definition">Definition at line <a class="el" href="util_2unique__cap_source.html#l00043">43</a> of file <a class="el" href="util_2unique__cap_source.html">unique_cap</a>.</p>
</div>
</div>
<a id="a987984b0219186ceb761fb221e705557" name="a987984b0219186ceb761fb221e705557"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a987984b0219186ceb761fb221e705557">&#9670;&#160;</a></span>unique_cap</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a987984b0219186ceb761fb221e705557">L4Re::Util::unique_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique capability that implements automatic free and unmap of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>The ownership of the capability is managed in the same way as unique_ptr.</p>
<p>Usage: </p><pre class="fragment">{
L4Re::Util::Unique_cap&lt;L4Re::Dataspace&gt;
ds_cap = L4Re::Util::make_unique_cap&lt;L4Re::Dataspace&gt;();
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(L4_PAGESIZE, ds_cap.get()));
...
// At the end of the scope ds_cap is unmapped and the capability
// selector is freed.
}
</pre>
<p class="definition">Definition at line <a class="el" href="util_2unique__cap_source.html#l00046">46</a> of file <a class="el" href="util_2unique__cap_source.html">unique_cap</a>.</p>
</div>
</div>
<a id="a13a4df2df2fdffc06880b49fb10b0c74" name="a13a4df2df2fdffc06880b49fb10b0c74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13a4df2df2fdffc06880b49fb10b0c74">&#9670;&#160;</a></span>Unique_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">using <a class="el" href="#a13a4df2df2fdffc06880b49fb10b0c74">L4Re::Util::Unique_del_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique capability that implements automatic free and unmap+delete of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>The main difference to <a class="el" href="#a0efccd325a19246334922e58dd973914" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a> is that the unmap is done with the deletion flag enabled and this leads to the deletion of the object if the current task holds appropriate deletion rights.</p>
<p>Usage: </p><pre class="fragment">{
L4Re::Util::Unique_del_cap&lt;L4Re::Dataspace&gt;
ds_cap = make_unique_del_cap&lt;L4Re::Dataspace&gt;());
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(L4_PAGESIZE, ds_cap.get()));
...
// At the end of the scope ds_cap is unmapped and the capability
// selector is freed. Because the deletion flag is set the data space
// shall also be deleted (even if there are other references to this
// data space).
}
</pre>
<p class="definition">Definition at line <a class="el" href="util_2unique__cap_source.html#l00086">86</a> of file <a class="el" href="util_2unique__cap_source.html">unique_cap</a>.</p>
</div>
</div>
<a id="a9cdcf86bc007bba92b86b66fa92a00bf" name="a9cdcf86bc007bba92b86b66fa92a00bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cdcf86bc007bba92b86b66fa92a00bf">&#9670;&#160;</a></span>unique_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">using <a class="el" href="#a9cdcf86bc007bba92b86b66fa92a00bf">L4Re::Util::unique_del_cap</a> = L4::Detail::Unique_cap_impl&lt;T, <a class="el" href="classL4Re_1_1Util_1_1Smart__cap__auto.html">Smart_cap_auto</a>&lt;<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66a49114f3e6952b9448fe776f2ab18813f">L4_FP_DELETE_OBJ</a>&gt;&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique capability that implements automatic free and unmap+delete of the capability selector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to.</td></tr>
</table>
</dd>
</dl>
<p>The main difference to <a class="el" href="#a0efccd325a19246334922e58dd973914" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a> is that the unmap is done with the deletion flag enabled and this leads to the deletion of the object if the current task holds appropriate deletion rights.</p>
<p>Usage: </p><pre class="fragment">{
L4Re::Util::Unique_del_cap&lt;L4Re::Dataspace&gt;
ds_cap = make_unique_del_cap&lt;L4Re::Dataspace&gt;());
// use the dataspace cap
L4Re::chksys(mem_alloc-&gt;alloc(L4_PAGESIZE, ds_cap.get()));
...
// At the end of the scope ds_cap is unmapped and the capability
// selector is freed. Because the deletion flag is set the data space
// shall also be deleted (even if there are other references to this
// data space).
}
</pre>
<p class="definition">Definition at line <a class="el" href="util_2unique__cap_source.html#l00089">89</a> of file <a class="el" href="util_2unique__cap_source.html">unique_cap</a>.</p>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a08b3c68edc484947355ca2b60a97e30d" name="a08b3c68edc484947355ca2b60a97e30d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08b3c68edc484947355ca2b60a97e30d">&#9670;&#160;</a></span>make_shared_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="#a2eafa529c9c1144d7840f4e101ecf7aa">Shared_cap</a>&lt; T &gt; L4Re::Util::make_shared_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="#a2eafa529c9c1144d7840f4e101ecf7aa" title="Shared capability that implements automatic free and unmap of the capability selector.">Shared_cap</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="util_2shared__cap_source.html#l00060">60</a> of file <a class="el" href="util_2shared__cap_source.html">shared_cap</a>.</p>
<p class="reference">References <a class="el" href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.</p>
<p class="reference">Referenced by <a class="el" href="server_2l4virtio_source.html#l00112">L4virtio::Svr::Dev_config::Dev_config()</a>.</p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</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="namespaceL4Re_1_1Util_a08b3c68edc484947355ca2b60a97e30d_icgraph.svg" width="418" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a0812bce3621d886729f5510b4b7f9128" name="a0812bce3621d886729f5510b4b7f9128"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0812bce3621d886729f5510b4b7f9128">&#9670;&#160;</a></span>make_shared_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="#a9b7734b755032a43b8ccf8cc6bfb4557">Shared_del_cap</a>&lt; T &gt; L4Re::Util::make_shared_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="#a9b7734b755032a43b8ccf8cc6bfb4557" title="Shared capability that implements automatic free and unmap+delete of the capability selector.">Shared_del_cap</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="util_2shared__cap_source.html#l00110">110</a> of file <a class="el" href="util_2shared__cap_source.html">shared_cap</a>.</p>
<p class="reference">References <a class="el" href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.</p>
</div>
</div>
<a id="a0c4ee77222764600950f2ebe23a1e45a" name="a0c4ee77222764600950f2ebe23a1e45a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c4ee77222764600950f2ebe23a1e45a">&#9670;&#160;</a></span>make_unique_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="#a0efccd325a19246334922e58dd973914">Unique_cap</a>&lt; T &gt; L4Re::Util::make_unique_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 an <a class="el" href="#a0efccd325a19246334922e58dd973914" title="Unique capability that implements automatic free and unmap of the capability selector.">Unique_cap</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="util_2unique__cap_source.html#l00055">55</a> of file <a class="el" href="util_2unique__cap_source.html">unique_cap</a>.</p>
<p class="reference">References <a class="el" href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.</p>
<p class="reference">Referenced by <a class="el" href="client_2l4virtio_source.html#l00056">L4virtio::Driver::Device::driver_connect()</a>, <a class="el" href="client_2virtio-block_source.html#l00092">L4virtio::Driver::Block_device::setup_device()</a>, and <a class="el" href="virtio-net_source.html#l00066">L4virtio::Driver::Virtio_net_device::setup_device()</a>.</p>
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="namespaceL4Re_1_1Util_a0c4ee77222764600950f2ebe23a1e45a_icgraph.svg" width="684" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a4c9140864b109e2582d94d5def245fd1" name="a4c9140864b109e2582d94d5def245fd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c9140864b109e2582d94d5def245fd1">&#9670;&#160;</a></span>make_unique_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="#a13a4df2df2fdffc06880b49fb10b0c74">Unique_del_cap</a>&lt; T &gt; L4Re::Util::make_unique_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 an <a class="el" href="#a13a4df2df2fdffc06880b49fb10b0c74" title="Unique capability that implements automatic free and unmap+delete of the capability selector.">Unique_del_cap</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the object the capability refers to. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="util_2unique__cap_source.html#l00098">98</a> of file <a class="el" href="util_2unique__cap_source.html">unique_cap</a>.</p>
<p class="reference">References <a class="el" href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</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="navelem"><a href="namespaceL4Re.html">L4Re</a></li><li class="navelem"><a href="namespaceL4Re_1_1Util.html">Util</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>