201 lines
19 KiB
HTML
201 lines
19 KiB
HTML
<!-- 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: pkg/virtio-net-switch/server/switch/switch.h Source File</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('switch_8h_source.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.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (C) 2016-2017, 2020, 2022-2024 Kernkonzept GmbH.</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Author(s): Jean Wolter <jean.wolter@kernkonzept.com></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Alexander Warg <warg@os.inf.tu-dresden.de></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "port.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "port_l4virtio.h"</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "mac_table.h"</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#if CONFIG_VNS_IXL</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include "port_ixl.h"</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span></div>
|
|
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classVirtio__switch.html"> 33</a></span><span class="keyword">class </span><a class="code hl_function" href="classVirtio__switch.html#a9a34b2af89435edc6f96163cfc90b324">Virtio_switch</a></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> Port_iface **_ports; </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> Port_iface *_monitor = <span class="keyword">nullptr</span>; </div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">unsigned</span> _max_ports;</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">unsigned</span> _max_used = 0;</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="classMac__table.html">Mac_table<></a> _mac_table;</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Limits the number of consecutive TX requests a port can process before</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// being interrupted to ensure fairness to other ports.</span></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">unsigned</span> Tx_burst = 128;</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">int</span> lookup_free_slot();</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">template</span><<span class="keyword">typename</span> REQ></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">void</span> handle_tx_request(Port_iface *port, REQ <span class="keyword">const</span> &request);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">template</span><<span class="keyword">typename</span> PORT></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span> handle_tx_requests(PORT *port, <span class="keywordtype">unsigned</span> &num_reqs_handled);</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span> all_rx_notify_emit_and_enable()</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> idx = 0; idx < _max_ports; ++idx)</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordflow">if</span> (_ports[idx])</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> _ports[idx]->rx_notify_emit_and_enable();</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> all_rx_notify_disable_and_remember()</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> {</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> idx = 0; idx < _max_ports; ++idx)</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">if</span> (_ports[idx])</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> _ports[idx]->rx_notify_disable_and_remember();</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> }</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classVirtio__switch.html#a9a34b2af89435edc6f96163cfc90b324">Virtio_switch</a>(<span class="keywordtype">unsigned</span> max_ports);</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classVirtio__switch.html#af2f67c7f5ab25aceaf08eac5acbdc204">add_port</a>(Port_iface *port);</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span></div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classVirtio__switch.html#aa10627d88a15a711629bfa100813b0e1">add_monitor_port</a>(Port_iface *port);</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classVirtio__switch.html#a5b5b4ab52f242c7f829234b9165ab14c">check_ports</a>();</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classVirtio__switch.html#ac5cfe25b7791bdb18d48985631913447">handle_l4virtio_port_tx</a>(<a class="code hl_class" href="classL4virtio__port.html">L4virtio_port</a> *port);</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#if CONFIG_VNS_IXL</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">bool</span> handle_ixl_port_tx(Ixl_port *port);</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span></div>
|
|
<div class="foldopen" id="foldopen00148" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"><a class="line" href="classVirtio__switch.html#ad1209814056da7ca22b592c176f0773f"> 148</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classVirtio__switch.html#ad1209814056da7ca22b592c176f0773f">port_available</a>(<span class="keywordtype">bool</span> monitor)</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> {</div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <span class="keywordflow">if</span> (monitor)</div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keywordflow">return</span> !_monitor ? 0 : -1;</div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keywordflow">return</span> lookup_free_slot();</div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span></div>
|
|
<div class="ttc" id="aclassL4virtio__port_html"><div class="ttname"><a href="classL4virtio__port.html">L4virtio_port</a></div><div class="ttdoc">A Port on the Virtio Net Switch.</div><div class="ttdef"><b>Definition</b> <a href="port__l4virtio_8h_source.html#l00036">port_l4virtio.h:37</a></div></div>
|
|
<div class="ttc" id="aclassMac__table_html"><div class="ttname"><a href="classMac__table.html">Mac_table</a></div><div class="ttdoc">Mac_table manages a 1:n association between ports and MAC addresses.</div><div class="ttdef"><b>Definition</b> <a href="mac__table_8h_source.html#l00040">mac_table.h:41</a></div></div>
|
|
<div class="ttc" id="aclassVirtio__switch_html_a5b5b4ab52f242c7f829234b9165ab14c"><div class="ttname"><a href="classVirtio__switch.html#a5b5b4ab52f242c7f829234b9165ab14c">Virtio_switch::check_ports</a></div><div class="ttdeci">void check_ports()</div><div class="ttdoc">Check validity of ports.</div><div class="ttdef"><b>Definition</b> <a href="switch_8cc_source.html#l00069">switch.cc:69</a></div></div>
|
|
<div class="ttc" id="aclassVirtio__switch_html_a9a34b2af89435edc6f96163cfc90b324"><div class="ttname"><a href="classVirtio__switch.html#a9a34b2af89435edc6f96163cfc90b324">Virtio_switch::Virtio_switch</a></div><div class="ttdeci">Virtio_switch(unsigned max_ports)</div><div class="ttdoc">Create a switch with n ports.</div><div class="ttdef"><b>Definition</b> <a href="switch_8cc_source.html#l00012">switch.cc:12</a></div></div>
|
|
<div class="ttc" id="aclassVirtio__switch_html_aa10627d88a15a711629bfa100813b0e1"><div class="ttname"><a href="classVirtio__switch.html#aa10627d88a15a711629bfa100813b0e1">Virtio_switch::add_monitor_port</a></div><div class="ttdeci">bool add_monitor_port(Port_iface *port)</div><div class="ttdoc">Add a monitor port to the switch.</div><div class="ttdef"><b>Definition</b> <a href="switch_8cc_source.html#l00054">switch.cc:54</a></div></div>
|
|
<div class="ttc" id="aclassVirtio__switch_html_ac5cfe25b7791bdb18d48985631913447"><div class="ttname"><a href="classVirtio__switch.html#ac5cfe25b7791bdb18d48985631913447">Virtio_switch::handle_l4virtio_port_tx</a></div><div class="ttdeci">bool handle_l4virtio_port_tx(L4virtio_port *port)</div><div class="ttdoc">Handle TX queue of the given port.</div><div class="ttdef"><b>Definition</b> <a href="switch_8cc_source.html#l00194">switch.cc:194</a></div></div>
|
|
<div class="ttc" id="aclassVirtio__switch_html_ad1209814056da7ca22b592c176f0773f"><div class="ttname"><a href="classVirtio__switch.html#ad1209814056da7ca22b592c176f0773f">Virtio_switch::port_available</a></div><div class="ttdeci">int port_available(bool monitor)</div><div class="ttdoc">Is there still a free port on this switch available?</div><div class="ttdef"><b>Definition</b> <a href="#l00148">switch.h:148</a></div></div>
|
|
<div class="ttc" id="aclassVirtio__switch_html_af2f67c7f5ab25aceaf08eac5acbdc204"><div class="ttname"><a href="classVirtio__switch.html#af2f67c7f5ab25aceaf08eac5acbdc204">Virtio_switch::add_port</a></div><div class="ttdeci">bool add_port(Port_iface *port)</div><div class="ttdoc">Add a port to the switch.</div><div class="ttdef"><b>Definition</b> <a href="switch_8cc_source.html#l00029">switch.cc:29</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</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"><b>pkg</b></li><li class="navelem"><b>virtio-net-switch</b></li><li class="navelem"><b>server</b></li><li class="navelem"><b>switch</b></li><li class="navelem"><b>switch.h</b></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>
|