teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
49bd21a8e5e36f1a6d87ccd2c6d8168f23e2f91a
moslab-code/doc/source/html/classVirtio__vlan__mangle.html
vreusch d959eaab98 l4re-base-25.08.0
2025-09-12 15:55:45 +02:00

363 lines
20 KiB
HTML
Raw Blame History

<!-- 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: Virtio_vlan_mangle 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('classVirtio__vlan__mangle.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">Virtio_vlan_mangle 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>Class for VLAN packet rewriting.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vlan_8h_source.html">vlan.h</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>Collaboration diagram for Virtio_vlan_mangle:</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="classVirtio__vlan__mangle__coll__graph.svg" width="176" height="156"><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:ae7061fe4d675ff57857cf32016bdb903" id="r_ae7061fe4d675ff57857cf32016bdb903"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7061fe4d675ff57857cf32016bdb903">Virtio_vlan_mangle</a> ()</td></tr>
<tr class="memdesc:ae7061fe4d675ff57857cf32016bdb903"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="memitem:affcb6c9ab833a401b1b6d914c44ad81f" id="r_affcb6c9ab833a401b1b6d914c44ad81f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#affcb6c9ab833a401b1b6d914c44ad81f">copy_pkt</a> (<a class="el" href="structBuffer.html">Buffer</a> &amp;dst, <a class="el" href="structBuffer.html">Buffer</a> &amp;src)</td></tr>
<tr class="memdesc:affcb6c9ab833a401b1b6d914c44ad81f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy packet from <em class="arg">src</em> to <em class="arg">dst</em>. <br /></td></tr>
<tr class="memitem:acf035d85b15dbfb5ada843ea9393d145" id="r_acf035d85b15dbfb5ada843ea9393d145"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acf035d85b15dbfb5ada843ea9393d145">rewrite_hdr</a> (Virtio_net::Hdr *hdr)</td></tr>
<tr class="memdesc:acf035d85b15dbfb5ada843ea9393d145"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rewrite the virtio network header. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-methods" class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae73a7ef2980e765af8bcbb596a9540e0" id="r_ae73a7ef2980e765af8bcbb596a9540e0"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="classVirtio__vlan__mangle.html">Virtio_vlan_mangle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae73a7ef2980e765af8bcbb596a9540e0">add</a> (<a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a> tci)</td></tr>
<tr class="memdesc:ae73a7ef2980e765af8bcbb596a9540e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an object that adds a VLAN tag. <br /></td></tr>
<tr class="memitem:aba874bc1e4df446ef48274e2331b017b" id="r_aba874bc1e4df446ef48274e2331b017b"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="classVirtio__vlan__mangle.html">Virtio_vlan_mangle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba874bc1e4df446ef48274e2331b017b">remove</a> ()</td></tr>
<tr class="memdesc:aba874bc1e4df446ef48274e2331b017b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an object that removes the VLAN tag. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for VLAN packet rewriting. </p>
<p class="definition">Definition at line <a class="el" href="vlan_8h_source.html#l00036">36</a> of file <a class="el" href="vlan_8h_source.html">vlan.h</a>.</p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae7061fe4d675ff57857cf32016bdb903" name="ae7061fe4d675ff57857cf32016bdb903"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7061fe4d675ff57857cf32016bdb903">&#9670;&#160;</a></span>Virtio_vlan_mangle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Virtio_vlan_mangle::Virtio_vlan_mangle </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></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>Default constructor. </p>
<p>The packet is not touched in any way. </p>
<p class="definition">Definition at line <a class="el" href="vlan_8h_source.html#l00052">52</a> of file <a class="el" href="vlan_8h_source.html">vlan.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="vlan_8h_source.html#l00064">add()</a>, and <a class="el" href="vlan_8h_source.html#l00075">remove()</a>.</p>
<div id="dynsection-1" 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-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="classVirtio__vlan__mangle_ae7061fe4d675ff57857cf32016bdb903_icgraph.svg" width="395" height="102"><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 name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="ae73a7ef2980e765af8bcbb596a9540e0" name="ae73a7ef2980e765af8bcbb596a9540e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae73a7ef2980e765af8bcbb596a9540e0">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classVirtio__vlan__mangle.html">Virtio_vlan_mangle</a> Virtio_vlan_mangle::add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a></td> <td class="paramname"><span class="paramname"><em>tci</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an object that adds a VLAN tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tci</td><td>The TCI field of the VLAN tag to add.</td></tr>
</table>
</dd>
</dl>
<p>It is the callers responsibility to ensure that the packet is not already tagged. </p>
<p class="definition">Definition at line <a class="el" href="vlan_8h_source.html#l00064">64</a> of file <a class="el" href="vlan_8h_source.html">vlan.h</a>.</p>
<p class="reference">References <a class="el" href="vlan_8h_source.html#l00052">Virtio_vlan_mangle()</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 call 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="classVirtio__vlan__mangle_ae73a7ef2980e765af8bcbb596a9540e0_cgraph.svg" width="395" height="51"><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="affcb6c9ab833a401b1b6d914c44ad81f" name="affcb6c9ab833a401b1b6d914c44ad81f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affcb6c9ab833a401b1b6d914c44ad81f">&#9670;&#160;</a></span>copy_pkt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a> Virtio_vlan_mangle::copy_pkt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structBuffer.html">Buffer</a> &amp;</td> <td class="paramname"><span class="paramname"><em>dst</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structBuffer.html">Buffer</a> &amp;</td> <td class="paramname"><span class="paramname"><em>src</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>Copy packet from <em class="arg">src</em> to <em class="arg">dst</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Source packet buffer </td></tr>
<tr><td class="paramname">dst</td><td>Destination packet buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes copied</dd></dl>
<p>Copy the data from <em class="arg">src</em> to <em class="arg">dst</em>, possibly rewriting parts of the packet. The method is expected to be called repeatedly until the source packet is finished. Partial copies are allowed (including reading nothing from the source buffer) as long as progress is made, i.e. repeatedly calling this function eventually consumes the source buffer. </p>
<p class="definition">Definition at line <a class="el" href="vlan_8h_source.html#l00093">93</a> of file <a class="el" href="vlan_8h_source.html">vlan.h</a>.</p>
<p class="reference">References <a class="el" href="virtio_source.html#l00354">L4virtio::Svr::Data_buffer::copy_to()</a>, <a class="el" href="compiler_8h_source.html#l00283">L4_LIKELY</a>, <a class="el" href="virtio_source.html#l00309">L4virtio::Svr::Data_buffer::left</a>, <a class="el" href="virtio_source.html#l00308">L4virtio::Svr::Data_buffer::pos</a>, and <a class="el" href="virtio_source.html#l00375">L4virtio::Svr::Data_buffer::skip()</a>.</p>
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classVirtio__vlan__mangle_affcb6c9ab833a401b1b6d914c44ad81f_cgraph.svg" width="346" height="115"><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="aba874bc1e4df446ef48274e2331b017b" name="aba874bc1e4df446ef48274e2331b017b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba874bc1e4df446ef48274e2331b017b">&#9670;&#160;</a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classVirtio__vlan__mangle.html">Virtio_vlan_mangle</a> Virtio_vlan_mangle::remove </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an object that removes the VLAN tag. </p>
<p>This object assumes that the Ethernet packet has a VLAN tag and will slavishly remove the necessary bytes from the packet. </p>
<p class="definition">Definition at line <a class="el" href="vlan_8h_source.html#l00075">75</a> of file <a class="el" href="vlan_8h_source.html">vlan.h</a>.</p>
<p class="reference">References <a class="el" href="vlan_8h_source.html#l00052">Virtio_vlan_mangle()</a>.</p>
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classVirtio__vlan__mangle_aba874bc1e4df446ef48274e2331b017b_cgraph.svg" width="363" height="51"><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="acf035d85b15dbfb5ada843ea9393d145" name="acf035d85b15dbfb5ada843ea9393d145"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf035d85b15dbfb5ada843ea9393d145">&#9670;&#160;</a></span>rewrite_hdr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Virtio_vlan_mangle::rewrite_hdr </td>
<td>(</td>
<td class="paramtype">Virtio_net::Hdr *</td> <td class="paramname"><span class="paramname"><em>hdr</em></span></td><td>)</td>
<td></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>Rewrite the virtio network header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hdr</td><td>The virtio header of the packet</td></tr>
</table>
</dd>
</dl>
<p>This method is called exactly once for every virtio network packet. Any necessary changes to the header are done in-place. </p>
<p class="definition">Definition at line <a class="el" href="vlan_8h_source.html#l00142">142</a> of file <a class="el" href="vlan_8h_source.html">vlan.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00284">L4_UNLIKELY</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="vlan_8h_source.html">vlan.h</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="classVirtio__vlan__mangle.html">Virtio_vlan_mangle</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>
Reference in New Issue View Git Blame Copy Permalink