269 lines
17 KiB
HTML
269 lines
17 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: Virtio_net_request 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__net__request.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_net_request Class Reference<span class="mlabels"><span class="mlabel final">final</span></span><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>Abstraction for a network request.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="request__l4virtio_8h_source.html">request_l4virtio.h</a>></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_net_request:</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__net__request__coll__graph.svg" width="144" height="136"><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:a9d25c994539f6f7d20f0cf273026a06d" id="r_a9d25c994539f6f7d20f0cf273026a06d"><td class="memItemLeft" align="right" valign="top"><a id="a9d25c994539f6f7d20f0cf273026a06d" name="a9d25c994539f6f7d20f0cf273026a06d"></a>
|
|
<a class="el" href="classMac__addr.html">Mac_addr</a> </td><td class="memItemRight" valign="bottom"><b>dst_mac</b> () const</td></tr>
|
|
<tr class="memdesc:a9d25c994539f6f7d20f0cf273026a06d"><td class="mdescLeft"> </td><td class="mdescRight">Get the Mac address of the destination port. <br /></td></tr>
|
|
<tr class="memitem:a929bf78b8f546e47f962d848b0df4c8f" id="r_a929bf78b8f546e47f962d848b0df4c8f"><td class="memItemLeft" align="right" valign="top"><a id="a929bf78b8f546e47f962d848b0df4c8f" name="a929bf78b8f546e47f962d848b0df4c8f"></a>
|
|
<a class="el" href="classMac__addr.html">Mac_addr</a> </td><td class="memItemRight" valign="bottom"><b>src_mac</b> () const</td></tr>
|
|
<tr class="memdesc:a929bf78b8f546e47f962d848b0df4c8f"><td class="mdescLeft"> </td><td class="mdescRight">Get the Mac address of the source port. <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:a7b7f4879d5a6d2081e4dac7266c50fbc" id="r_a7b7f4879d5a6d2081e4dac7266c50fbc"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b7f4879d5a6d2081e4dac7266c50fbc">drop_requests</a> (<a class="el" href="classVirtio__net.html">Virtio_net</a> *dev, <a class="el" href="classL4virtio_1_1Svr_1_1Virtqueue.html">L4virtio::Svr::Virtqueue</a> *queue)</td></tr>
|
|
<tr class="memdesc:a7b7f4879d5a6d2081e4dac7266c50fbc"><td class="mdescLeft"> </td><td class="mdescRight">Drop all requests of a specific queue. <br /></td></tr>
|
|
<tr class="memitem:a54bc204105bfec0d318affa5d87185d8" id="r_a54bc204105bfec0d318affa5d87185d8"><td class="memItemLeft" align="right" valign="top">static std::optional< <a class="el" href="classVirtio__net__request.html">Virtio_net_request</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a54bc204105bfec0d318affa5d87185d8">get_request</a> (<a class="el" href="classVirtio__net.html">Virtio_net</a> *dev, <a class="el" href="classL4virtio_1_1Svr_1_1Virtqueue.html">L4virtio::Svr::Virtqueue</a> *queue)</td></tr>
|
|
<tr class="memdesc:a54bc204105bfec0d318affa5d87185d8"><td class="mdescLeft"> </td><td class="mdescRight">Construct a request from the next entry of a provided queue. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Abstraction for a network request. </p>
|
|
<p>A <span class="tt"><a class="el" href="classVirtio__net__request.html" title="Abstraction for a network request.">Virtio_net_request</a></span> is constructed by the source port, using the static function <span class="tt"><a class="el" href="#a54bc204105bfec0d318affa5d87185d8" title="Construct a request from the next entry of a provided queue.">get_request()</a></span> as part of <span class="tt">Port_iface::get_tx_request()</span>.</p>
|
|
<p>On destruction, <span class="tt">finish()</span> will be called, which, will trigger the client IRQ of the source client. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="request__l4virtio_8h_source.html#l00035">35</a> of file <a class="el" href="request__l4virtio_8h_source.html">request_l4virtio.h</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="a7b7f4879d5a6d2081e4dac7266c50fbc" name="a7b7f4879d5a6d2081e4dac7266c50fbc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b7f4879d5a6d2081e4dac7266c50fbc">◆ </a></span>drop_requests()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Virtio_net_request::drop_requests </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classVirtio__net.html">Virtio_net</a> *</td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classL4virtio_1_1Svr_1_1Virtqueue.html">L4virtio::Svr::Virtqueue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Drop all requests of a specific queue. </p>
|
|
<p>This function is used for example to drop all requests in the transmission queue of a monitor port, since monitor ports are not allowed to transmit data.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dev</td><td>Port of the provided virtqueue. </td></tr>
|
|
<tr><td class="paramname">queue</td><td>Virtqueue to drop all requests of. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="request__l4virtio_8h_source.html#l00172">172</a> of file <a class="el" href="request__l4virtio_8h_source.html">request_l4virtio.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="virtio_source.html#l00175">L4virtio::Svr::Virtqueue::desc_avail()</a>, <a class="el" href="virtio_source.html#l00240">L4virtio::Svr::Virtqueue::finish()</a>, <a class="el" href="compiler_8h_source.html#l00284">L4_UNLIKELY</a>, <a class="el" href="virtio_source.html#l00136">L4virtio::Svr::Virtqueue::next_avail()</a>, <a class="el" href="virtqueue_source.html#l00400">L4virtio::Virtqueue::ready()</a>, and <a class="el" href="virtio_source.html#l00501">L4virtio::Svr::Request_processor::start()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="port__l4virtio_8h_source.html#l00103">L4virtio_port::drop_requests()</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 call 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__net__request_a7b7f4879d5a6d2081e4dac7266c50fbc_cgraph.svg" width="598" height="390"><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-2" 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-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__net__request_a7b7f4879d5a6d2081e4dac7266c50fbc_icgraph.svg" width="342" 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="a54bc204105bfec0d318affa5d87185d8" name="a54bc204105bfec0d318affa5d87185d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54bc204105bfec0d318affa5d87185d8">◆ </a></span>get_request()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< <a class="el" href="classVirtio__net__request.html">Virtio_net_request</a> > Virtio_net_request::get_request </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classVirtio__net.html">Virtio_net</a> *</td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classL4virtio_1_1Svr_1_1Virtqueue.html">L4virtio::Svr::Virtqueue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a request from the next entry of a provided queue. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dev</td><td>Port of the provided virtqueue. </td></tr>
|
|
<tr><td class="paramname">queue</td><td>Virtqueue to extract next entry from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="request__l4virtio_8h_source.html#l00199">199</a> of file <a class="el" href="request__l4virtio_8h_source.html">request_l4virtio.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00284">L4_UNLIKELY</a>, <a class="el" href="virtio_source.html#l00136">L4virtio::Svr::Virtqueue::next_avail()</a>, and <a class="el" href="virtqueue_source.html#l00400">L4virtio::Virtqueue::ready()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="port__l4virtio_8h_source.html#l00093">L4virtio_port::get_tx_request()</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__net__request_a54bc204105bfec0d318affa5d87185d8_cgraph.svg" width="371" 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 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 caller 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__net__request_a54bc204105bfec0d318affa5d87185d8_icgraph.svg" width="334" 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>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>pkg/virtio-net-switch/server/switch/<a class="el" href="request__l4virtio_8h_source.html">request_l4virtio.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__net__request.html">Virtio_net_request</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>
|