l4re-base-25.08.0

This commit is contained in:
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions

View File

@@ -0,0 +1,380 @@
<!-- 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::Mem_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_1Mem__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::Mem_alloc Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Memory allocation interface.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="mem__alloc_source.html">mem_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::Mem_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_1Mem__alloc__inherit__graph.svg" width="496" height="856"><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::Mem_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_1Mem__alloc__coll__graph.svg" width="496" height="856"><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:Stats" id="r_Stats"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4Re_1_1Mem__alloc_1_1Stats.html">Stats</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Statistics about memory-allocator. <a href="structL4Re_1_1Mem__alloc_1_1Stats.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-types" class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a47f3e054def977c17dbf60bfbb4ee05e" id="r_a47f3e054def977c17dbf60bfbb4ee05e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05e">Mem_alloc_flags</a> { <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05ea24aed4d1617b5d1247f03ff81f828b1c">Continuous</a> = 0x01
, <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05ea7875dadd56bd617a0921da23f43da7ca">Pinned</a> = 0x02
, <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05ea0d3bad158560fa9101c2ed2fd234f407">Super_pages</a> = 0x04
, <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05ea23b07ecdd311dbeea23ff77965ccdb9a">Fixed_paddr</a> = 0x08
}</td></tr>
<tr class="memdesc:a47f3e054def977c17dbf60bfbb4ee05e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags for the allocator. <a href="#a47f3e054def977c17dbf60bfbb4ee05e">More...</a><br /></td></tr>
</table><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:a3e61dd10005ccbabb7052050704d6520" id="r_a3e61dd10005ccbabb7052050704d6520"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e61dd10005ccbabb7052050704d6520">alloc</a> (long size, <a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; <a class="el" href="classL4Re_1_1Dataspace.html">Dataspace</a> &gt; mem, unsigned long flags=0, unsigned long align=0, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> paddr=0) const noexcept</td></tr>
<tr class="memdesc:a3e61dd10005ccbabb7052050704d6520"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate anonymous memory. <br /></td></tr>
<tr class="memitem:a691e583da7fbfd8d0aaa13db3b2919c3" id="r_a691e583da7fbfd8d0aaa13db3b2919c3"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a691e583da7fbfd8d0aaa13db3b2919c3">info</a> (<a class="el" href="structL4Re_1_1Mem__alloc_1_1Stats.html">Stats</a> &amp;stats)</td></tr>
<tr class="memdesc:a691e583da7fbfd8d0aaa13db3b2919c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get allocator information. <br /></td></tr>
<tr class="inherit_header pub_methods_classL4_1_1Factory"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classL4_1_1Factory')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classL4_1_1Factory.html">L4::Factory</a></td></tr>
<tr class="memitem:ab52604d4abed4d6009ce51a59492edd7 inherit pub_methods_classL4_1_1Factory" id="r_ab52604d4abed4d6009ce51a59492edd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4_1_1Factory_1_1S.html">S</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Factory.html#ab52604d4abed4d6009ce51a59492edd7">create</a> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt; target, long obj, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>()) noexcept</td></tr>
<tr class="memdesc:ab52604d4abed4d6009ce51a59492edd7 inherit pub_methods_classL4_1_1Factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic create call to the factory. <br /></td></tr>
<tr class="memitem:add39d432a64a16aec33abeefcb3ba1cd inherit pub_methods_classL4_1_1Factory" id="r_add39d432a64a16aec33abeefcb3ba1cd"><td class="memTemplParams" colspan="2">template&lt;typename OBJ&gt; </td></tr>
<tr class="memitem:add39d432a64a16aec33abeefcb3ba1cd inherit pub_methods_classL4_1_1Factory template"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4_1_1Factory_1_1S.html">S</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Factory.html#add39d432a64a16aec33abeefcb3ba1cd">create</a> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; OBJ &gt; target, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>()) noexcept</td></tr>
<tr class="memdesc:add39d432a64a16aec33abeefcb3ba1cd inherit pub_methods_classL4_1_1Factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create call for typed capabilities. <br /></td></tr>
<tr class="memitem:a491c8f5113bb68cd402db1eb59ac76ea inherit pub_methods_classL4_1_1Factory" id="r_a491c8f5113bb68cd402db1eb59ac76ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Factory.html#a491c8f5113bb68cd402db1eb59ac76ea">create_task</a> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; <a class="el" href="classL4_1_1Task.html">Task</a> &gt; const &amp;target_cap, <a class="el" href="unionl4__fpage__t.html">l4_fpage_t</a> *utcb_area, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>()) noexcept</td></tr>
<tr class="memdesc:a491c8f5113bb68cd402db1eb59ac76ea inherit pub_methods_classL4_1_1Factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new task. <br /></td></tr>
<tr class="memitem:a014721aec27ad4877555d5f4b7204896 inherit pub_methods_classL4_1_1Factory" id="r_a014721aec27ad4877555d5f4b7204896"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Factory.html#a014721aec27ad4877555d5f4b7204896">create_factory</a> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; <a class="el" href="classL4_1_1Factory.html">Factory</a> &gt; const &amp;target_cap, unsigned long limit, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>()) noexcept</td></tr>
<tr class="memdesc:a014721aec27ad4877555d5f4b7204896 inherit pub_methods_classL4_1_1Factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new factory. <br /></td></tr>
<tr class="memitem:a79b67bcf639db7fd92b399d44ab272a8 inherit pub_methods_classL4_1_1Factory" id="r_a79b67bcf639db7fd92b399d44ab272a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Factory.html#a79b67bcf639db7fd92b399d44ab272a8">create_gate</a> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt; const &amp;target_cap, <a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; Snd_destination &gt; const &amp;snd_dst_cap, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> label, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>()) noexcept</td></tr>
<tr class="memdesc:a79b67bcf639db7fd92b399d44ab272a8 inherit pub_methods_classL4_1_1Factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new IPC gate, optionally bound to a send destination (a thread or thread group). <br /></td></tr>
<tr class="memitem:a6b0504bc01000ccbeaf137b20e7284c5 inherit pub_methods_classL4_1_1Factory" id="r_a6b0504bc01000ccbeaf137b20e7284c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Factory.html#a6b0504bc01000ccbeaf137b20e7284c5">create_thread_group</a> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; <a class="el" href="classL4_1_1Thread__group.html">Thread_group</a> &gt; const &amp;target_cap, unsigned policy, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>()) noexcept</td></tr>
<tr class="memdesc:a6b0504bc01000ccbeaf137b20e7284c5 inherit pub_methods_classL4_1_1Factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new thread group. <br /></td></tr>
<tr class="inherit_header pub_methods_classL4_1_1Kobject"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classL4_1_1Kobject')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classL4_1_1Kobject.html">L4::Kobject</a></td></tr>
<tr class="memitem:a9fe009599de49f1af438ff49998faec0 inherit pub_methods_classL4_1_1Kobject" id="r_a9fe009599de49f1af438ff49998faec0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Kobject.html#a9fe009599de49f1af438ff49998faec0">dec_refcnt</a> (<a class="el" href="group__l4__basic__types.html#ga51d9492e7700d70ed35838154ca9b279">l4_mword_t</a> diff, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb=<a class="el" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>())</td></tr>
<tr class="memdesc:a9fe009599de49f1af438ff49998faec0 inherit pub_methods_classL4_1_1Kobject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrement the in kernel reference counter for the object. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-inherited" class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_classL4_1_1Kobject__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_types_classL4_1_1Kobject__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Types inherited from <a class="el" href="classL4_1_1Kobject__t.html">L4::Kobject_t&lt; Mem_alloc, L4::Factory, L4RE_PROTO_MEM_ALLOC &gt;</a></td></tr>
<tr class="memitem:af7df35ba5bf68ef5993e605a6b62328a inherit pro_types_classL4_1_1Kobject__t" id="r_af7df35ba5bf68ef5993e605a6b62328a"><td class="memItemLeft" align="right" valign="top">
typedef Mem_alloc&#160;</td><td class="memItemRight" valign="bottom"><b>Class</b></td></tr>
<tr class="memdesc:af7df35ba5bf68ef5993e605a6b62328a inherit pro_types_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">The target interface type (inheriting from <a class="el" href="classL4_1_1Kobject__t.html" title="Helper class to create an L4Re interface class that is derived from a single base class.">Kobject_t</a>). <br /></td></tr>
<tr class="memitem:a0d83157994565e9c01f10006bdda2efa inherit pro_types_classL4_1_1Kobject__t" id="r_a0d83157994565e9c01f10006bdda2efa"><td class="memItemLeft" align="right" valign="top">
typedef Typeid::Iface&lt; PROTO, Mem_alloc &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>__Iface</b></td></tr>
<tr class="memdesc:a0d83157994565e9c01f10006bdda2efa inherit pro_types_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">The interface description for the derived class. <br /></td></tr>
<tr class="memitem:afc2feec2f4a15e85286aabfa15c53e06 inherit pro_types_classL4_1_1Kobject__t" id="r_afc2feec2f4a15e85286aabfa15c53e06"><td class="memItemLeft" align="right" valign="top">
typedef Typeid::Merge_list&lt; Typeid::Iface_list&lt; <a class="el" href="classL4_1_1Kobject__t.html#a0d83157994565e9c01f10006bdda2efa">__Iface</a> &gt;, typename L4::Factory::__Iface_list &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>__Iface_list</b></td></tr>
<tr class="memdesc:afc2feec2f4a15e85286aabfa15c53e06 inherit pro_types_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of all RPC interfaces provided directly or through inheritance. <br /></td></tr>
<tr class="inherit_header pro_types_classL4_1_1Kobject__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_types_classL4_1_1Kobject__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Types inherited from <a class="el" href="classL4_1_1Kobject__t.html">L4::Kobject_t&lt; Factory, Kobject, L4_PROTO_FACTORY &gt;</a></td></tr>
<tr class="memitem:af7df35ba5bf68ef5993e605a6b62328a inherit pro_types_classL4_1_1Kobject__t" id="r_af7df35ba5bf68ef5993e605a6b62328a"><td class="memItemLeft" align="right" valign="top">
typedef <a class="el" href="classL4_1_1Factory.html">Factory</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Class</b></td></tr>
<tr class="memdesc:af7df35ba5bf68ef5993e605a6b62328a inherit pro_types_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">The target interface type (inheriting from <a class="el" href="classL4_1_1Kobject__t.html" title="Helper class to create an L4Re interface class that is derived from a single base class.">Kobject_t</a>). <br /></td></tr>
<tr class="memitem:a0d83157994565e9c01f10006bdda2efa inherit pro_types_classL4_1_1Kobject__t" id="r_a0d83157994565e9c01f10006bdda2efa"><td class="memItemLeft" align="right" valign="top">
typedef Typeid::Iface&lt; PROTO, <a class="el" href="classL4_1_1Factory.html">Factory</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>__Iface</b></td></tr>
<tr class="memdesc:a0d83157994565e9c01f10006bdda2efa inherit pro_types_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">The interface description for the derived class. <br /></td></tr>
<tr class="memitem:afc2feec2f4a15e85286aabfa15c53e06 inherit pro_types_classL4_1_1Kobject__t" id="r_afc2feec2f4a15e85286aabfa15c53e06"><td class="memItemLeft" align="right" valign="top">
typedef Typeid::Merge_list&lt; Typeid::Iface_list&lt; <a class="el" href="classL4_1_1Kobject__t.html#a0d83157994565e9c01f10006bdda2efa">__Iface</a> &gt;, typename Kobject::__Iface_list &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>__Iface_list</b></td></tr>
<tr class="memdesc:afc2feec2f4a15e85286aabfa15c53e06 inherit pro_types_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of all RPC interfaces provided directly or through inheritance. <br /></td></tr>
<tr class="inherit_header pro_methods_classL4_1_1Kobject__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classL4_1_1Kobject__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Member Functions inherited from <a class="el" href="classL4_1_1Kobject__t.html">L4::Kobject_t&lt; Mem_alloc, L4::Factory, L4RE_PROTO_MEM_ALLOC &gt;</a></td></tr>
<tr class="memitem:a3d80fec7e057d575ec4b393437f05f8a inherit pro_methods_classL4_1_1Kobject__t" id="r_a3d80fec7e057d575ec4b393437f05f8a"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; <a class="el" href="classL4_1_1Kobject__t.html#af7df35ba5bf68ef5993e605a6b62328a">Class</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>c</b> () const noexcept</td></tr>
<tr class="memdesc:a3d80fec7e057d575ec4b393437f05f8a inherit pro_methods_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the capability to ourselves. <br /></td></tr>
<tr class="inherit_header pro_methods_classL4_1_1Kobject__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classL4_1_1Kobject__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Member Functions inherited from <a class="el" href="classL4_1_1Kobject__t.html">L4::Kobject_t&lt; Factory, Kobject, L4_PROTO_FACTORY &gt;</a></td></tr>
<tr class="memitem:a3d80fec7e057d575ec4b393437f05f8a inherit pro_methods_classL4_1_1Kobject__t" id="r_a3d80fec7e057d575ec4b393437f05f8a"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; <a class="el" href="classL4_1_1Kobject__t.html#af7df35ba5bf68ef5993e605a6b62328a">Class</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>c</b> () const noexcept</td></tr>
<tr class="memdesc:a3d80fec7e057d575ec4b393437f05f8a inherit pro_methods_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the capability to ourselves. <br /></td></tr>
<tr class="inherit_header pro_methods_classL4_1_1Kobject"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classL4_1_1Kobject')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Member Functions inherited from <a class="el" href="classL4_1_1Kobject.html">L4::Kobject</a></td></tr>
<tr class="memitem:a4f2117ae76762f4084e6a1adb915863c inherit pro_methods_classL4_1_1Kobject" id="r_a4f2117ae76762f4084e6a1adb915863c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4_1_1Kobject.html#a4f2117ae76762f4084e6a1adb915863c">cap</a> () const noexcept</td></tr>
<tr class="memdesc:a4f2117ae76762f4084e6a1adb915863c inherit pro_methods_classL4_1_1Kobject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return capability selector. <br /></td></tr>
<tr class="inherit_header pro_static_methods_classL4_1_1Kobject__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_methods_classL4_1_1Kobject__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Static Protected Member Functions inherited from <a class="el" href="classL4_1_1Kobject__t.html">L4::Kobject_t&lt; Mem_alloc, L4::Factory, L4RE_PROTO_MEM_ALLOC &gt;</a></td></tr>
<tr class="memitem:a7433b8eed587278821dd496864f75363 inherit pro_static_methods_classL4_1_1Kobject__t" id="r_a7433b8eed587278821dd496864f75363"><td class="memItemLeft" align="right" valign="top">
static void&#160;</td><td class="memItemRight" valign="bottom"><b>__check_protocols__</b> () noexcept</td></tr>
<tr class="memdesc:a7433b8eed587278821dd496864f75363 inherit pro_static_methods_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper to check for protocol conflicts. <br /></td></tr>
<tr class="inherit_header pro_static_methods_classL4_1_1Kobject__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_methods_classL4_1_1Kobject__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Static Protected Member Functions inherited from <a class="el" href="classL4_1_1Kobject__t.html">L4::Kobject_t&lt; Factory, Kobject, L4_PROTO_FACTORY &gt;</a></td></tr>
<tr class="memitem:a7433b8eed587278821dd496864f75363 inherit pro_static_methods_classL4_1_1Kobject__t" id="r_a7433b8eed587278821dd496864f75363"><td class="memItemLeft" align="right" valign="top">
static void&#160;</td><td class="memItemRight" valign="bottom"><b>__check_protocols__</b> () noexcept</td></tr>
<tr class="memdesc:a7433b8eed587278821dd496864f75363 inherit pro_static_methods_classL4_1_1Kobject__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper to check for protocol conflicts. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Memory allocation interface. </p>
<p>The memory-allocator API is the basic API to allocate memory from the <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a> subsystem. The memory is allocated in terms of dataspaces (see <a class="el" href="classL4Re_1_1Dataspace.html" title="Interface for memory-like objects.">L4Re::Dataspace</a>). The provided dataspaces have at least the property that data written to such a dataspace is available as long as the dataspace is not freed or the data is not overwritten. In particular, the memory backing a dataspace from an allocator need not be allocated instantly, but may be allocated lazily on demand.</p>
<p>A memory allocator can provide dataspaces with additional properties, such as physically contiguous memory, pre-allocated memory, or pinned memory. To request memory with an additional property the <a class="el" href="#a3e61dd10005ccbabb7052050704d6520" title="Allocate anonymous memory.">L4Re::Mem_alloc::alloc()</a> method provides a flags parameter. If the concrete implementation of a memory allocator does not support or allow allocation of memory with a certain property, the allocation may be refused. </p>
<p class="definition">Definition at line <a class="el" href="mem__alloc_source.html#l00052">52</a> of file <a class="el" href="mem__alloc_source.html">mem_alloc</a>.</p>
</div><a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Member Enumeration Documentation</h2>
<a id="a47f3e054def977c17dbf60bfbb4ee05e" name="a47f3e054def977c17dbf60bfbb4ee05e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47f3e054def977c17dbf60bfbb4ee05e">&#9670;&#160;</a></span>Mem_alloc_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05e">L4Re::Mem_alloc::Mem_alloc_flags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags for the allocator. </p>
<p>They describe requested properties of the allocated memory. Support of these properties by the dataspace provider is optional. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a47f3e054def977c17dbf60bfbb4ee05ea24aed4d1617b5d1247f03ff81f828b1c" name="a47f3e054def977c17dbf60bfbb4ee05ea24aed4d1617b5d1247f03ff81f828b1c"></a>Continuous&#160;</td><td class="fielddoc"><p>Allocate physically contiguous memory. </p>
</td></tr>
<tr><td class="fieldname"><a id="a47f3e054def977c17dbf60bfbb4ee05ea7875dadd56bd617a0921da23f43da7ca" name="a47f3e054def977c17dbf60bfbb4ee05ea7875dadd56bd617a0921da23f43da7ca"></a>Pinned&#160;</td><td class="fielddoc"><p>Deprecated, use <a class="el" href="classL4Re_1_1Dma__space.html" title="Managed DMA Address Space.">L4Re::Dma_space</a> instead. </p>
</td></tr>
<tr><td class="fieldname"><a id="a47f3e054def977c17dbf60bfbb4ee05ea0d3bad158560fa9101c2ed2fd234f407" name="a47f3e054def977c17dbf60bfbb4ee05ea0d3bad158560fa9101c2ed2fd234f407"></a>Super_pages&#160;</td><td class="fielddoc"><p>Allocate super pages. </p>
</td></tr>
<tr><td class="fieldname"><a id="a47f3e054def977c17dbf60bfbb4ee05ea23b07ecdd311dbeea23ff77965ccdb9a" name="a47f3e054def977c17dbf60bfbb4ee05ea23b07ecdd311dbeea23ff77965ccdb9a"></a>Fixed_paddr&#160;</td><td class="fielddoc"><p>Allocate at fixed physical address. </p>
<p>Only honored on no-MMU systems. Will fail on MMU systems. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="mem__alloc_source.html#l00062">62</a> of file <a class="el" href="mem__alloc_source.html">mem_alloc</a>.</p>
</div>
</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="a3e61dd10005ccbabb7052050704d6520" name="a3e61dd10005ccbabb7052050704d6520"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e61dd10005ccbabb7052050704d6520">&#9670;&#160;</a></span>alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long L4Re::Mem_alloc::alloc </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classL4_1_1Cap.html">L4::Cap</a>&lt; <a class="el" href="classL4Re_1_1Dataspace.html">Dataspace</a> &gt;</td> <td class="paramname"><span class="paramname"><em>mem</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>flags</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>align</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a></td> <td class="paramname"><span class="paramname"><em>paddr</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate anonymous memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">size</td><td>Size in bytes to be requested. Allocation granularity is (super)pages, however, the allocator will store the byte-granular given size as the size of the dataspace and consecutively will use this byte-granular size for servicing the dataspace. Allocators may optionally also implement a maximum allocation strategy: if <span class="tt">size</span> is a negative value and <span class="tt">flags</span> set the <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05ea24aed4d1617b5d1247f03ff81f828b1c" title="Allocate physically contiguous memory.">Mem_alloc_flags::Continuous</a> bit, the allocator tries to allocate as much memory as possible leaving an amount of at least <span class="tt">-size</span> bytes within the associated quota. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">mem</td><td>Capability slot where the capability to the dataspace is received. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">flags</td><td>Special dataspace properties, see <a class="el" href="#a47f3e054def977c17dbf60bfbb4ee05e" title="Flags for the allocator.">Mem_alloc_flags</a> </td></tr>
<tr><td class="paramdir"></td><td class="paramname">align</td><td>Log2 alignment of dataspace if supported by allocator, will be at least L4_PAGESHIFT, with Super_pages flag set at least L4_SUPERPAGESHIFT </td></tr>
<tr><td class="paramdir"></td><td class="paramname">paddr</td><td>The physical address where the dataspace should be allocated if Mem_alloc_flags::Fixed flag is set.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success </td></tr>
<tr><td class="paramname">-L4_ERANGE</td><td>Given size not supported. </td></tr>
<tr><td class="paramname">-L4_ENOMEM</td><td>Not enough memory available. </td></tr>
<tr><td class="paramname">&lt;0</td><td>IPC error </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="mem__alloc__impl_8h_source.html#l00024">24</a> of file <a class="el" href="mem__alloc__impl_8h_source.html">mem_alloc_impl.h</a>.</p>
<p class="reference">References <a class="el" href="kobject_source.html#l00069">L4::Kobject::cap()</a>, <a class="el" href="mem__alloc_source.html#l00067">Fixed_paddr</a>, and <a class="el" href="l4_2sys_2ipc_8h_source.html#l00646">l4_error()</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_1Mem__alloc_a3e61dd10005ccbabb7052050704d6520_cgraph.svg" width="472" 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="a691e583da7fbfd8d0aaa13db3b2919c3" name="a691e583da7fbfd8d0aaa13db3b2919c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a691e583da7fbfd8d0aaa13db3b2919c3">&#9670;&#160;</a></span>info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long L4Re::Mem_alloc::info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structL4Re_1_1Mem__alloc_1_1Stats.html">Stats</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stats</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get allocator information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">stats</td><td>Allocator information</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success </td></tr>
<tr><td class="paramname">&lt;0</td><td>IPC error </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="#a691e583da7fbfd8d0aaa13db3b2919c3">info()</a>, and <a class="el" href="ipc__iface_source.html#l00482">L4_INLINE_RPC</a>.</p>
<p class="reference">Referenced by <a class="el" href="#a691e583da7fbfd8d0aaa13db3b2919c3">info()</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 call 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_1Mem__alloc_a691e583da7fbfd8d0aaa13db3b2919c3_cgraph.svg" width="178" height="60"><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-4" 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-4-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4Re_1_1Mem__alloc_a691e583da7fbfd8d0aaa13db3b2919c3_icgraph.svg" width="178" height="60"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>l4/re/<a class="el" href="mem__alloc_source.html">mem_alloc</a></li>
<li>l4/re/impl/<a class="el" href="mem__alloc__impl_8h_source.html">mem_alloc_impl.h</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_1Mem__alloc.html">Mem_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>