teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d959eaab9861a3e2784a8f4b2ebb099c14c0c5eb
moslab-code/doc/source/html/classL4Re_1_1Cap__alloc.html
vreusch d959eaab98 l4re-base-25.08.0
2025-09-12 15:55:45 +02:00

283 lines
16 KiB
HTML
Raw Blame History

<!-- 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::Cap_alloc Class 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('classL4Re_1_1Cap__alloc.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::Cap_alloc Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span><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> &raquo; <a class="el" href="group__l4re__cap__api.html">L4Re Capability API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Capability allocator interface.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="cap__alloc_source.html">cap_alloc</a>&gt;</code></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>Inheritance diagram for L4Re::Cap_alloc:</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="classL4Re_1_1Cap__alloc__inherit__graph.svg" width="166" height="290"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4Re::Cap_alloc:</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="classL4Re_1_1Cap__alloc__coll__graph.svg" width="128" height="136"><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-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8ec47fe158e8a2acae49ceff505be193" id="r_a8ec47fe158e8a2acae49ceff505be193"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ec47fe158e8a2acae49ceff505be193">alloc</a> () noexcept=0</td></tr>
<tr class="memdesc:a8ec47fe158e8a2acae49ceff505be193"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability. <br /></td></tr>
<tr class="memitem:a88fcbfda3d06aa82bb0c36d6a0b60ab2" id="r_a88fcbfda3d06aa82bb0c36d6a0b60ab2"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a88fcbfda3d06aa82bb0c36d6a0b60ab2 template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88fcbfda3d06aa82bb0c36d6a0b60ab2">alloc</a> () noexcept</td></tr>
<tr class="memdesc:a88fcbfda3d06aa82bb0c36d6a0b60ab2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a capability. <br /></td></tr>
<tr class="memitem:ad8e36ca35881e1bc7ec3ff12e3956f10" id="r_ad8e36ca35881e1bc7ec3ff12e3956f10"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad8e36ca35881e1bc7ec3ff12e3956f10">free</a> (<a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; void &gt; cap, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task=<a class="el" href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a>, unsigned unmap_flags=<a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a>) noexcept=0</td></tr>
<tr class="memdesc:ad8e36ca35881e1bc7ec3ff12e3956f10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a capability. <br /></td></tr>
<tr class="memitem:gadb65db1681bc65100caf66924331b85b" id="r_gadb65db1681bc65100caf66924331b85b"><td class="memItemLeft" align="right" valign="top">
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~Cap_alloc</b> ()=0</td></tr>
<tr class="memdesc:gadb65db1681bc65100caf66924331b85b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Capability allocator interface. </p>
<p class="definition">Definition at line <a class="el" href="cap__alloc_source.html#l00030">30</a> of file <a class="el" href="cap__alloc_source.html">cap_alloc</a>.</p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a88fcbfda3d06aa82bb0c36d6a0b60ab2" name="a88fcbfda3d06aa82bb0c36d6a0b60ab2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88fcbfda3d06aa82bb0c36d6a0b60ab2">&#9670;&#160;</a></span>alloc() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; T &gt; L4Re::Cap_alloc::alloc </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a capability. </p>
<dl class="section return"><dt>Returns</dt><dd>Capability of type T </dd></dl>
<p class="definition">Definition at line <a class="el" href="cap__alloc_source.html#l00053">53</a> of file <a class="el" href="cap__alloc_source.html">cap_alloc</a>.</p>
<p class="reference">References <a class="el" href="#a8ec47fe158e8a2acae49ceff505be193">alloc()</a>, and <a class="el" href="capability_8h_source.html#l00416">L4::cap_cast()</a>.</p>
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4Re_1_1Cap__alloc_a88fcbfda3d06aa82bb0c36d6a0b60ab2_cgraph.svg" width="387" height="86"><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="a8ec47fe158e8a2acae49ceff505be193" name="a8ec47fe158e8a2acae49ceff505be193"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ec47fe158e8a2acae49ceff505be193">&#9670;&#160;</a></span>alloc() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; void &gt; L4Re::Cap_alloc::alloc </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a capability. </p>
<dl class="section return"><dt>Returns</dt><dd>Capability of type void </dd></dl>
<p>Implemented in <a class="el" href="classL4Re_1_1Util_1_1__Cap__alloc.html#ae84bade0c0ac25a658a66f6f3129c50b">L4Re::Util::_Cap_alloc</a>, and <a class="el" href="classL4Re_1_1Util_1_1__Cap__alloc.html#a0102af80b0c799eb9343ac1768a64692">L4Re::Util::_Cap_alloc</a>.</p>
<p class="reference">Referenced by <a class="el" href="cap__alloc_source.html#l00053">alloc()</a>, <a class="el" href="shared__cap_source.html#l00049">L4Re::make_shared_cap()</a>, <a class="el" href="shared__cap_source.html#l00085">L4Re::make_shared_del_cap()</a>, <a class="el" href="unique__cap_source.html#l00047">L4Re::make_unique_cap()</a>, and <a class="el" href="unique__cap_source.html#l00080">L4Re::make_unique_del_cap()</a>.</p>
<div id="dynsection-3" 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-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4Re_1_1Cap__alloc_a8ec47fe158e8a2acae49ceff505be193_icgraph.svg" width="430" height="234"><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="ad8e36ca35881e1bc7ec3ff12e3956f10" name="ad8e36ca35881e1bc7ec3ff12e3956f10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8e36ca35881e1bc7ec3ff12e3956f10">&#9670;&#160;</a></span>free()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void L4Re::Cap_alloc::free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; void &gt;</td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>task</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>unmap_flags</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="group__l4__task__api.html#gga3c24e67b976870a3e911c43c83382f66aa85d4766b182308e5847d543e7d59055">L4_FP_ALL_SPACES</a></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a capability. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Capability to free. </td></tr>
<tr><td class="paramname">task</td><td>If set, task to unmap the capability from. </td></tr>
<tr><td class="paramname">unmap_flags</td><td>Flags for unmap, see <a class="el" href="group__l4__task__api.html#ga3c24e67b976870a3e911c43c83382f66" title="Flags for the unmap operation.">l4_unmap_flags_t</a>. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classL4Re_1_1Util_1_1__Cap__alloc.html#a048ebd34dddce10a155faefc8aa73ec7">L4Re::Util::_Cap_alloc</a>.</p>
<p class="reference">References <a class="el" href="l4_2sys_2consts_8h_source.html#l00183">L4_FP_ALL_SPACES</a>, and <a class="el" href="l4_2sys_2consts_8h_source.html#l00153">L4_INVALID_CAP</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>l4/re/<a class="el" href="cap__alloc_source.html">cap_alloc</a></li>
</ul>
</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="classL4Re_1_1Cap__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>
Reference in New Issue View Git Blame Copy Permalink