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

255
doc/source/html/classL4virtio_1_1Ptr.html Normal file
View File

@@ -0,0 +1,255 @@
<!-- 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: L4virtio::Ptr&lt; T &gt; Class Template 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('classL4virtio_1_1Ptr.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">L4virtio::Ptr&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Pointer used in virtio descriptors.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="virtqueue_source.html">virtqueue</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 L4virtio::Ptr&lt; T &gt;:</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="classL4virtio_1_1Ptr__inherit__graph.svg" width="158" height="292"><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 L4virtio::Ptr&lt; T &gt;:</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="classL4virtio_1_1Ptr__coll__graph.svg" width="138" 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-types" class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa67c3dbb485b777efcd874b9a78e9899" id="r_aa67c3dbb485b777efcd874b9a78e9899"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa67c3dbb485b777efcd874b9a78e9899">Invalid_type</a> { <a class="el" href="#aa67c3dbb485b777efcd874b9a78e9899ab5abd55e2190163bd25dbc488ef0ea9f">Invalid</a>
}</td></tr>
<tr class="memdesc:aa67c3dbb485b777efcd874b9a78e9899"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for making an invalid (NULL) <a class="el" href="classL4virtio_1_1Ptr.html" title="Pointer used in virtio descriptors.">Ptr</a>. <a href="#aa67c3dbb485b777efcd874b9a78e9899">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:acc111cad3e7f248a9a8cc8b50e3cffb2" id="r_acc111cad3e7f248a9a8cc8b50e3cffb2"><td class="memItemLeft" align="right" valign="top"><a id="acc111cad3e7f248a9a8cc8b50e3cffb2" name="acc111cad3e7f248a9a8cc8b50e3cffb2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Ptr</b> (<a class="el" href="#aa67c3dbb485b777efcd874b9a78e9899">Invalid_type</a>)</td></tr>
<tr class="memdesc:acc111cad3e7f248a9a8cc8b50e3cffb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make and invalid <a class="el" href="classL4virtio_1_1Ptr.html" title="Pointer used in virtio descriptors.">Ptr</a>. <br /></td></tr>
<tr class="memitem:a66b787e51f106d307562f29e7a7da2f8" id="r_a66b787e51f106d307562f29e7a7da2f8"><td class="memItemLeft" align="right" valign="top"><a id="a66b787e51f106d307562f29e7a7da2f8" name="a66b787e51f106d307562f29e7a7da2f8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Ptr</b> (<a class="el" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a> vm_addr)</td></tr>
<tr class="memdesc:a66b787e51f106d307562f29e7a7da2f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a <a class="el" href="classL4virtio_1_1Ptr.html" title="Pointer used in virtio descriptors.">Ptr</a> from a raw 64bit address. <br /></td></tr>
<tr class="memitem:a8e39f7c9cd370812ebb4610b096c44b6" id="r_a8e39f7c9cd370812ebb4610b096c44b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e39f7c9cd370812ebb4610b096c44b6">get</a> () const</td></tr>
<tr class="memitem:aa919b52f31fda0491610eed4b40f3095" id="r_aa919b52f31fda0491610eed4b40f3095"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa919b52f31fda0491610eed4b40f3095">is_valid</a> () const</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T&gt;<br />
class L4virtio::Ptr&lt; T &gt;</div><p>Pointer used in virtio descriptors. </p>
<p>As the descriptor contain guest addresses these pointers cannot be dereferenced directly. </p>
<p class="definition">Definition at line <a class="el" href="virtqueue_source.html#l00047">47</a> of file <a class="el" href="virtqueue_source.html">virtqueue</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="aa67c3dbb485b777efcd874b9a78e9899" name="aa67c3dbb485b777efcd874b9a78e9899"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa67c3dbb485b777efcd874b9a78e9899">&#9670;&#160;</a></span>Invalid_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#aa67c3dbb485b777efcd874b9a78e9899">L4virtio::Ptr::Invalid_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for making an invalid (NULL) <a class="el" href="classL4virtio_1_1Ptr.html" title="Pointer used in virtio descriptors.">Ptr</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa67c3dbb485b777efcd874b9a78e9899ab5abd55e2190163bd25dbc488ef0ea9f" name="aa67c3dbb485b777efcd874b9a78e9899ab5abd55e2190163bd25dbc488ef0ea9f"></a>Invalid&#160;</td><td class="fielddoc"><p>Use to set a <a class="el" href="classL4virtio_1_1Ptr.html" title="Pointer used in virtio descriptors.">Ptr</a> to invalid (NULL). </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="virtqueue_source.html#l00051">51</a> of file <a class="el" href="virtqueue_source.html">virtqueue</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="a8e39f7c9cd370812ebb4610b096c44b6" name="a8e39f7c9cd370812ebb4610b096c44b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e39f7c9cd370812ebb4610b096c44b6">&#9670;&#160;</a></span>get()</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="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a> <a class="el" href="classL4virtio_1_1Ptr.html">L4virtio::Ptr</a>&lt; T &gt;::get </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The raw 64bit address of the stored pointer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="virtqueue_source.html#l00062">62</a> of file <a class="el" href="virtqueue_source.html">virtqueue</a>.</p>
<p class="reference">Referenced by <a class="el" href="server_2l4virtio_source.html#l00764">L4virtio::Svr::Driver_mem_list_t&lt; No_custom_data &gt;::load_desc()</a>, <a class="el" href="server_2l4virtio_source.html#l00737">L4virtio::Svr::Driver_mem_list_t&lt; No_custom_data &gt;::load_desc()</a>, <a class="el" href="server_2l4virtio_source.html#l00717">L4virtio::Svr::Driver_mem_list_t&lt; No_custom_data &gt;::load_desc()</a>, and <a class="el" href="server_2l4virtio_source.html#l00616">L4virtio::Svr::Driver_mem_region_t&lt; No_custom_data &gt;::local()</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 caller 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="classL4virtio_1_1Ptr_a8e39f7c9cd370812ebb4610b096c44b6_icgraph.svg" width="396" height="302"><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="aa919b52f31fda0491610eed4b40f3095" name="aa919b52f31fda0491610eed4b40f3095"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa919b52f31fda0491610eed4b40f3095">&#9670;&#160;</a></span>is_valid()</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">bool <a class="el" href="classL4virtio_1_1Ptr.html">L4virtio::Ptr</a>&lt; T &gt;::is_valid </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if the stored pointer is valid (not NULL). </dd></dl>
<p class="definition">Definition at line <a class="el" href="virtqueue_source.html#l00065">65</a> of file <a class="el" href="virtqueue_source.html">virtqueue</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>l4/l4virtio/<a class="el" href="virtqueue_source.html">virtqueue</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="namespaceL4virtio.html">L4virtio</a></li><li class="navelem"><a href="classL4virtio_1_1Ptr.html">Ptr</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>