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

230 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_addr.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__addr_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_addr.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 &lt;cstring&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;inttypes.h&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span></div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classMac__addr.html"> 19</a></span><span class="keyword">class </span>Mac_addr</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>{</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">enum</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> Addr_length = 6,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> Addr_unknown = 0ULL</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> };</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">explicit</span> Mac_addr(<span class="keywordtype">char</span> <span class="keyword">const</span> *_src)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/* A mac address is 6 bytes long, it is transmitted in big endian</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> order over the network. For our internal representation we</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> focus on easy testability of broadcast/multicast and reorder</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> the bytes that the most significant byte becomes the least</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> significant one. */</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *src = <span class="keyword">reinterpret_cast&lt;</span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const </span>*<span class="keyword">&gt;</span>(_src);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> _mac = ((uint64_t)src[0]) | (((uint64_t)src[1]) &lt;&lt; 8)</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> | (((uint64_t)src[2]) &lt;&lt; 16) | (((uint64_t)src[3]) &lt;&lt; 24)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> | (((uint64_t)src[4]) &lt;&lt; 32) | (((uint64_t)src[5]) &lt;&lt; 40);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> Mac_addr from_uncached(<span class="keywordtype">char</span> <span class="keyword">volatile</span> <span class="keyword">const</span> *src)</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> { <span class="keywordflow">return</span> Mac_addr(src); }</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">explicit</span> Mac_addr(uint64_t mac) : _mac{mac} {}</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> Mac_addr(Mac_addr <span class="keyword">const</span> &amp;other) : _mac{other._mac} {}</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
<div class="foldopen" id="foldopen00049" data-start="{" data-end="}">
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classMac__addr.html#ab88238acfb1cf55edeb79eb39a4e5805"> 49</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classMac__addr.html#ab88238acfb1cf55edeb79eb39a4e5805">is_broadcast</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/* There are broadcast and multicast addresses, both are supposed</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> to be delivered to all station and the local network (layer 2).</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"></span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> Broadcast address is FF:FF:FF:FF:FF:FF, multicast addresses have</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> the LSB of the first octet set. Since this holds for both</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> broadcast and multicast we test for the multicast bit here.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"></span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> In our internal representation we store the bytes in reverse</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> order, so we test the least significant bit of the least</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> significant byte.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> */</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">return</span> _mac &amp; 1;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span></div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classMac__addr.html#a34fa435b622acaf605593ca2b27965d4"> 66</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classMac__addr.html#a34fa435b622acaf605593ca2b27965d4">is_unknown</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keyword"> </span>{ <span class="keywordflow">return</span> _mac == Addr_unknown; }</div>
</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">bool</span> operator == (<a class="code hl_class" href="classMac__addr.html">Mac_addr</a> <span class="keyword">const</span> &amp;other)<span class="keyword"> const</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="keyword"> </span>{ <span class="keywordflow">return</span> _mac == other._mac; }</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">bool</span> operator != (Mac_addr <span class="keyword">const</span> &amp;other)<span class="keyword"> const</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="keyword"> </span>{ <span class="keywordflow">return</span> _mac != other._mac; }</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">bool</span> operator &lt; (Mac_addr <span class="keyword">const</span> &amp;other)<span class="keyword"> const</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="keyword"> </span>{ <span class="keywordflow">return</span> _mac &lt; other._mac; }</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> Mac_addr&amp; operator = (Mac_addr <span class="keyword">const</span> &amp;other)</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> { _mac = other._mac; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> Mac_addr&amp; operator = (uint64_t mac)</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> { _mac = mac; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</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="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">void</span> print(T &amp;stream)<span class="keyword"> const</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> stream.cprintf(<span class="stringliteral">&quot;%02x:%02x:%02x:%02x:%02x:%02x&quot;</span>,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> (<span class="keywordtype">int</span>)(_mac &amp; 0xff) , (<span class="keywordtype">int</span>)((_mac &gt;&gt; 8) &amp; 0xff),</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> (<span class="keywordtype">int</span>)((_mac &gt;&gt; 16) &amp; 0xff), (<span class="keywordtype">int</span>)((_mac &gt;&gt; 24) &amp; 0xff),</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> (<span class="keywordtype">int</span>)((_mac &gt;&gt; 32) &amp; 0xff), (<span class="keywordtype">int</span>)((_mac &gt;&gt; 40) &amp; 0xff));</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</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> <span class="keywordtype">void</span> to_array(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> mac[6])<span class="keyword"> const</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> mac[0] = _mac &amp; 0xffU;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> mac[1] = (_mac &gt;&gt; 8) &amp; 0xffU;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> mac[2] = (_mac &gt;&gt; 16) &amp; 0xffU;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> mac[3] = (_mac &gt;&gt; 24) &amp; 0xffU;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> mac[4] = (_mac &gt;&gt; 32) &amp; 0xffU;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> mac[5] = (_mac &gt;&gt; 40) &amp; 0xffU;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> }</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">explicit</span> Mac_addr(<span class="keywordtype">char</span> <span class="keyword">volatile</span> <span class="keyword">const</span> *_src)</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> {</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/* A mac address is 6 bytes long, it is transmitted in big endian</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"> order over the network. For our internal representation we</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"> focus on easy testability of broadcast/multicast and reorder</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"> the bytes that the most significant byte becomes the least</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment"> significant one. */</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *src = <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">volatile </span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const </span>*<span class="keyword">&gt;</span>(_src);</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> _mac = ((uint64_t)src[0]) | (((uint64_t)src[1]) &lt;&lt; 8)</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> | (((uint64_t)src[2]) &lt;&lt; 16) | (((uint64_t)src[3]) &lt;&lt; 24)</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> | (((uint64_t)src[4]) &lt;&lt; 32) | (((uint64_t)src[5]) &lt;&lt; 40);</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 class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> uint64_t _mac;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>};</div>
</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</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="#l00019">mac_addr.h:20</a></div></div>
<div class="ttc" id="aclassMac__addr_html_a34fa435b622acaf605593ca2b27965d4"><div class="ttname"><a href="classMac__addr.html#a34fa435b622acaf605593ca2b27965d4">Mac_addr::is_unknown</a></div><div class="ttdeci">bool is_unknown() const</div><div class="ttdoc">Check if the MAC address is not yet known.</div><div class="ttdef"><b>Definition</b> <a href="#l00066">mac_addr.h:66</a></div></div>
<div class="ttc" id="aclassMac__addr_html_ab88238acfb1cf55edeb79eb39a4e5805"><div class="ttname"><a href="classMac__addr.html#ab88238acfb1cf55edeb79eb39a4e5805">Mac_addr::is_broadcast</a></div><div class="ttdeci">bool is_broadcast() const</div><div class="ttdoc">Check if MAC address is a broadcast or multicast address.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">mac_addr.h:49</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_addr.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>