Files
moslab-code/doc/source/html/mac__table_8h_source.html
2025-09-12 15:55:45 +02:00

236 lines
23 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/mac_table.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('mac__table_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">mac_table.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 &lt;jean.wolter@kernkonzept.com&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;mac_addr.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;port.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;array&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;tuple&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">template</span>&lt;std::<span class="keywordtype">size_t</span> Size = 1024U&gt;</div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="};">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classMac__table.html"> 40</a></span><span class="keyword">class </span>Mac_table</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> Mac_table()</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> : _mac_table(),</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> _entries(),</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> _rr_index(0U)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {}</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span></div>
<div class="foldopen" id="foldopen00058" data-start="{" data-end="}">
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classMac__table.html#a6481a7ce121e437f7ccb5ccff51f649e"> 58</a></span> Port_iface *<a class="code hl_function" href="classMac__table.html#a6481a7ce121e437f7ccb5ccff51f649e">lookup</a>(<a class="code hl_class" href="classMac__addr.html">Mac_addr</a> dst, <a class="code hl_typedef" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a> vlan_id)<span class="keyword"> const</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">auto</span> entry = _mac_table.find(std::tuple(dst, vlan_id));</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> (entry != _mac_table.end()) ? entry-&gt;second-&gt;port : <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classMac__table.html#a7a4255cfce83ba656004fd3a34aaaab3"> 78</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMac__table.html#a7a4255cfce83ba656004fd3a34aaaab3">learn</a>(<a class="code hl_class" href="classMac__addr.html">Mac_addr</a> src, Port_iface *port, <a class="code hl_typedef" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a> vlan_id)</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> Dbg info(Dbg::Port, Dbg::Info);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">if</span> (<a class="code hl_define" href="group__l4sys__defines.html#ga3df4200910f2664b97397c23693beeb0">L4_UNLIKELY</a>(info.is_active()))</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// check whether we already know about src mac and vlan_id</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">auto</span> *p = <a class="code hl_function" href="classMac__table.html#a6481a7ce121e437f7ccb5ccff51f649e">lookup</a>(src, vlan_id);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">if</span> (!p || p != port)</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> {</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> info.printf(<span class="stringliteral">&quot;%s %-20s -&gt; &quot;</span>, !p ? <span class="stringliteral">&quot;learned &quot;</span> : <span class="stringliteral">&quot;replaced&quot;</span>,</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> port-&gt;get_name());</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> src.print(info);</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> info.cprintf(<span class="stringliteral">&quot;\n&quot;</span>);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> }</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> }</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">auto</span> status = _mac_table.emplace(std::tuple(src, vlan_id),</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> &amp;_entries[_rr_index]);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">if</span> (<a class="code hl_define" href="group__l4sys__defines.html#ga3df4200910f2664b97397c23693beeb0">L4_UNLIKELY</a>(status.second))</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> {</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">if</span> (_entries[_rr_index].port)</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> {</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// remove old entry</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> _mac_table.erase(std::tuple(_entries[_rr_index].addr,</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> _entries[_rr_index].vlan_id));</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// Set/Replace port and mac address</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> _entries[_rr_index].port = port;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> _entries[_rr_index].addr = src;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> _entries[_rr_index].vlan_id = vlan_id;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> _rr_index = (_rr_index + 1U) % Size;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> }</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> {</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// Update port to allow for movement of client between ports</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> status.first-&gt;second-&gt;port = port;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> }</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div>
</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span></div>
<div class="foldopen" id="foldopen00129" data-start="{" data-end="}">
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classMac__table.html#aa81a8de47548581771d85d3f2601c2de"> 129</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMac__table.html#aa81a8de47548581771d85d3f2601c2de">flush</a>(Port_iface *port)</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> {</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">typedef</span> std::pair&lt;std::tuple&lt;const Mac_addr, l4_uint16_t&gt;, Entry*&gt; TableEntry;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">auto</span> iter = _mac_table.begin();</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordflow">while</span> ((iter = std::find_if(iter, _mac_table.end(),</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> [port](TableEntry <span class="keyword">const</span> &amp;p)</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> { return p.second-&gt;port == port; }))</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> != _mac_table.end())</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> {</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> iter-&gt;second-&gt;port = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> iter-&gt;second-&gt;addr = Mac_addr::Addr_unknown;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> iter-&gt;second-&gt;vlan_id = 0;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> iter = _mac_table.erase(iter);</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> }</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> assert(std::find_if(_mac_table.begin(), _mac_table.end(),</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> [port](TableEntry <span class="keyword">const</span> &amp;p)</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> { return p.second-&gt;port == port; }) == _mac_table.end());</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> }</div>
</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="keyword">private</span>:</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="keyword">struct </span>Entry {</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> Port_iface *port;</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <a class="code hl_class" href="classMac__addr.html">Mac_addr</a> addr;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <a class="code hl_typedef" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a> vlan_id;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> Entry()</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> : port(nullptr),</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> addr(<a class="code hl_class" href="classMac__addr.html">Mac_addr</a>::Addr_unknown),</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> vlan_id(0)</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> {}</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> };</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> std::map&lt;std::tuple&lt;Mac_addr, l4_uint16_t&gt;, Entry*&gt; _mac_table;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> std::array&lt;Entry, Size&gt; _entries;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> <span class="keywordtype">size_t</span> _rr_index;</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span>};</div>
</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span></div>
<div class="ttc" id="aclassMac__addr_html"><div class="ttname"><a href="classMac__addr.html">Mac_addr</a></div><div class="ttdoc">A wrapper class around the value of a MAC address.</div><div class="ttdef"><b>Definition</b> <a href="mac__addr_8h_source.html#l00019">mac_addr.h:20</a></div></div>
<div class="ttc" id="aclassMac__table_html_a6481a7ce121e437f7ccb5ccff51f649e"><div class="ttname"><a href="classMac__table.html#a6481a7ce121e437f7ccb5ccff51f649e">Mac_table::lookup</a></div><div class="ttdeci">Port_iface * lookup(Mac_addr dst, l4_uint16_t vlan_id) const</div><div class="ttdoc">Find the destination port for a MAC address and VLAN id.</div><div class="ttdef"><b>Definition</b> <a href="#l00058">mac_table.h:58</a></div></div>
<div class="ttc" id="aclassMac__table_html_a7a4255cfce83ba656004fd3a34aaaab3"><div class="ttname"><a href="classMac__table.html#a7a4255cfce83ba656004fd3a34aaaab3">Mac_table::learn</a></div><div class="ttdeci">void learn(Mac_addr src, Port_iface *port, l4_uint16_t vlan_id)</div><div class="ttdoc">Learn a MAC address (add it to the MAC table).</div><div class="ttdef"><b>Definition</b> <a href="#l00078">mac_table.h:78</a></div></div>
<div class="ttc" id="aclassMac__table_html_aa81a8de47548581771d85d3f2601c2de"><div class="ttname"><a href="classMac__table.html#aa81a8de47548581771d85d3f2601c2de">Mac_table::flush</a></div><div class="ttdeci">void flush(Port_iface *port)</div><div class="ttdoc">Flush all associations with a given port.</div><div class="ttdef"><b>Definition</b> <a href="#l00129">mac_table.h:129</a></div></div>
<div class="ttc" id="agroup__l4__basic__types_html_gae8d67914f723bf843df6f311ad2619a2"><div class="ttname"><a href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a></div><div class="ttdeci">unsigned short int l4_uint16_t</div><div class="ttdoc">Unsigned 16bit value.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2l4int_8h_source.html#l00027">l4int.h:27</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga3df4200910f2664b97397c23693beeb0"><div class="ttname"><a href="group__l4sys__defines.html#ga3df4200910f2664b97397c23693beeb0">L4_UNLIKELY</a></div><div class="ttdeci">#define L4_UNLIKELY(x)</div><div class="ttdoc">Expression is unlikely to execute.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00284">compiler.h:284</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>mac_table.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>