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

230
doc/source/html/classSwitch__factory.html Normal file
View File

@@ -0,0 +1,230 @@
<!-- 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: Switch_factory 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('classSwitch__factory.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">Switch_factory Class Reference<div class="ingroups"><a class="el" href="group__virtio__net__switch.html">Virtio Net Switch</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>The IPC interface for creating ports.
<a href="#details">More...</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>Inheritance diagram for Switch_factory:</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="classSwitch__factory__inherit__graph.svg" width="426" height="971"><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 Switch_factory:</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="classSwitch__factory__coll__graph.svg" width="426" height="971"><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:a15ef952a526c1ce7633b241d674f9e00" id="r_a15ef952a526c1ce7633b241d674f9e00"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a15ef952a526c1ce7633b241d674f9e00">op_create</a> (L4::Factory::Rights, <a class="el" href="classL4_1_1Ipc_1_1Cap.html">L4::Ipc::Cap</a>&lt; void &gt; &amp;res, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> type, <a class="el" href="classL4_1_1Ipc_1_1Varg__list__ref.html">L4::Ipc::Varg_list_ref</a> va)</td></tr>
<tr class="memdesc:a15ef952a526c1ce7633b241d674f9e00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle factory protocol. <br /></td></tr>
<tr class="inherit_header pub_methods_structL4_1_1Epiface__t0"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_structL4_1_1Epiface__t0')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="structL4_1_1Epiface__t0.html">L4::Epiface_t0&lt; L4::Factory, L4::Epiface &gt;</a></td></tr>
<tr class="memitem:a180eb2c1be5e27d44d27b5e260a81245 inherit pub_methods_structL4_1_1Epiface__t0" id="r_a180eb2c1be5e27d44d27b5e260a81245"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classL4_1_1Type__info_1_1Demand.html">Type_info::Demand</a>&#160;</td><td class="memItemRight" valign="bottom"><b>get_buffer_demand</b> () const</td></tr>
<tr class="memdesc:a180eb2c1be5e27d44d27b5e260a81245 inherit pub_methods_structL4_1_1Epiface__t0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the server-side buffer demand based in <em class="arg">IFACE</em>. <br /></td></tr>
<tr class="memitem:a3557bb44ec6dd6d378083748e94f27f5 inherit pub_methods_structL4_1_1Epiface__t0" id="r_a3557bb44ec6dd6d378083748e94f27f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; <a class="el" href="classL4_1_1Factory.html">L4::Factory</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4_1_1Epiface__t0.html#a3557bb44ec6dd6d378083748e94f27f5">obj_cap</a> () const</td></tr>
<tr class="memdesc:a3557bb44ec6dd6d378083748e94f27f5 inherit pub_methods_structL4_1_1Epiface__t0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the (typed) capability to this object. <br /></td></tr>
<tr class="inherit_header pub_methods_structL4_1_1Epiface"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_structL4_1_1Epiface')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="structL4_1_1Epiface.html">L4::Epiface</a></td></tr>
<tr class="memitem:afadfe87d66e639d554b6a4e5af29454d inherit pub_methods_structL4_1_1Epiface" id="r_afadfe87d66e639d554b6a4e5af29454d"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>Epiface</b> ()</td></tr>
<tr class="memdesc:afadfe87d66e639d554b6a4e5af29454d inherit pub_methods_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a server object. <br /></td></tr>
<tr class="memitem:a92a03ecd44d4e1571697b58701046522 inherit pub_methods_structL4_1_1Epiface" id="r_a92a03ecd44d4e1571697b58701046522"><td class="memItemLeft" align="right" valign="top">
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~Epiface</b> ()=0</td></tr>
<tr class="memdesc:a92a03ecd44d4e1571697b58701046522 inherit pub_methods_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the object. <br /></td></tr>
<tr class="memitem:a0d454b9446bdf9e317b09574a5155fe0 inherit pub_methods_structL4_1_1Epiface" id="r_a0d454b9446bdf9e317b09574a5155fe0"><td class="memItemLeft" align="right" valign="top">Stored_cap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4_1_1Epiface.html#a0d454b9446bdf9e317b09574a5155fe0">obj_cap</a> () const</td></tr>
<tr class="memdesc:a0d454b9446bdf9e317b09574a5155fe0 inherit pub_methods_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the capability to the kernel object belonging to this object. <br /></td></tr>
<tr class="memitem:a9605834c855375364504bd0f7ae78273 inherit pub_methods_structL4_1_1Epiface" id="r_a9605834c855375364504bd0f7ae78273"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structL4_1_1Epiface.html#aeec53d54ab6eb8e660679cdda1102fd7">Server_iface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4_1_1Epiface.html#a9605834c855375364504bd0f7ae78273">server_iface</a> () const</td></tr>
<tr class="memdesc:a9605834c855375364504bd0f7ae78273 inherit pub_methods_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get pointer to server interface at which the object is currently registered. <br /></td></tr>
<tr class="memitem:af47d6b2877fa4a09e04140a6644631aa inherit pub_methods_structL4_1_1Epiface" id="r_af47d6b2877fa4a09e04140a6644631aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structL4_1_1Epiface.html#af47d6b2877fa4a09e04140a6644631aa">set_server</a> (<a class="el" href="structL4_1_1Epiface.html#aeec53d54ab6eb8e660679cdda1102fd7">Server_iface</a> *srv, <a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt; cap, bool managed=false)</td></tr>
<tr class="memdesc:af47d6b2877fa4a09e04140a6644631aa inherit pub_methods_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set server registration info for the object. <br /></td></tr>
<tr class="memitem:ab7308b8ad45d0a6341c351797c3d6dbd inherit pub_methods_structL4_1_1Epiface" id="r_ab7308b8ad45d0a6341c351797c3d6dbd"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_obj_cap</b> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt; const &amp;cap)</td></tr>
<tr class="memdesc:ab7308b8ad45d0a6341c351797c3d6dbd inherit pub_methods_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated server registration function. <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 pub_types_structL4_1_1Epiface__t0"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_structL4_1_1Epiface__t0')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Types inherited from <a class="el" href="structL4_1_1Epiface__t0.html">L4::Epiface_t0&lt; L4::Factory, L4::Epiface &gt;</a></td></tr>
<tr class="memitem:aaef79f5617a61cf2601c8020a1751628 inherit pub_types_structL4_1_1Epiface__t0" id="r_aaef79f5617a61cf2601c8020a1751628"><td class="memItemLeft" align="right" valign="top">
typedef <a class="el" href="classL4_1_1Factory.html">L4::Factory</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Interface</b></td></tr>
<tr class="memdesc:aaef79f5617a61cf2601c8020a1751628 inherit pub_types_structL4_1_1Epiface__t0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data type of the IPC interface definition. <br /></td></tr>
<tr class="inherit_header pub_types_structL4_1_1Epiface"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_structL4_1_1Epiface')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Types inherited from <a class="el" href="structL4_1_1Epiface.html">L4::Epiface</a></td></tr>
<tr class="memitem:aeec53d54ab6eb8e660679cdda1102fd7 inherit pub_types_structL4_1_1Epiface" id="r_aeec53d54ab6eb8e660679cdda1102fd7"><td class="memItemLeft" align="right" valign="top">
typedef <a class="el" href="classL4_1_1Ipc__svr_1_1Server__iface.html">Ipc_svr::Server_iface</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Server_iface</b></td></tr>
<tr class="memdesc:aeec53d54ab6eb8e660679cdda1102fd7 inherit pub_types_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for abstract server interface. <br /></td></tr>
<tr class="memitem:a3b6915f6a99478aa323219cb5441cd24 inherit pub_types_structL4_1_1Epiface" id="r_a3b6915f6a99478aa323219cb5441cd24"><td class="memItemLeft" align="right" valign="top">
typedef <a class="el" href="classL4_1_1Ipc__svr_1_1Server__iface.html#a06e47dba2ba71662337758f0cbf37053">Ipc_svr::Server_iface::Demand</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Demand</b></td></tr>
<tr class="memdesc:a3b6915f6a99478aa323219cb5441cd24 inherit pub_types_structL4_1_1Epiface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for server-side receive buffer demand. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The IPC interface for creating ports. </p>
<p>The Switch factory provides an IPC interface to create ports. Ports are the only option for a client to communicate with the switch and, thus, with other network devices.</p>
<p>The <span class="tt"><a class="el" href="classSwitch__factory.html" title="The IPC interface for creating ports.">Switch_factory</a></span> gets constructed when the net switch application gets started. It thereafter gets registered on the switch's server to serve IPC <span class="tt">create</span> calls. </p>
<p class="definition">Definition at line <a class="el" href="main_8cc_source.html#l00114">114</a> of file <a class="el" href="main_8cc_source.html">main.cc</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="a15ef952a526c1ce7633b241d674f9e00" name="a15ef952a526c1ce7633b241d674f9e00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15ef952a526c1ce7633b241d674f9e00">&#9670;&#160;</a></span>op_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long Switch_factory::op_create </td>
<td>(</td>
<td class="paramtype">L4::Factory::Rights</td> <td class="paramname"><span class="paramname"><em></em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classL4_1_1Ipc_1_1Cap.html">L4::Ipc::Cap</a>&lt; void &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>res</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classL4_1_1Ipc_1_1Varg__list__ref.html">L4::Ipc::Varg_list_ref</a></td> <td class="paramname"><span class="paramname"><em>va</em></span>&#160;)</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">
<p>Handle factory protocol. </p>
<p>This function is invoked after an incoming factory::create request and creates a new port or statistics interface if possible. </p>
<p class="definition">Definition at line <a class="el" href="main_8cc_source.html#l00528">528</a> of file <a class="el" href="main_8cc_source.html">main.cc</a>.</p>
<p class="reference">References <a class="el" href="err_8h_source.html#l00046">L4_EINVAL</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pkg/virtio-net-switch/server/switch/<a class="el" href="main_8cc_source.html">main.cc</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="classSwitch__factory.html">Switch_factory</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>