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

598 lines
38 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: vCPU Support Library</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('group__api__libvcpu.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">vCPU Support Library </div></div>
</div><!--header-->
<div class="contents">
<p>vCPU handling functionality.
<a href="#details">More...</a></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 vCPU Support Library:</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="group__api__libvcpu.svg" width="394" height="36"><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-groups" class="groupheader"><a id="groups" name="groups"></a>
Topics</h2></td></tr>
<tr class="memitem:api_5Flibvcpu_5Fext" id="r_api_5Flibvcpu_5Fext"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu__ext.html">Extended vCPU support </a></td></tr>
<tr class="memdesc:group__api__libvcpu__ext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extended vCPU handling functionality. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:L4vcpu_3A_3AState" id="r_L4vcpu_3A_3AState"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vcpu_1_1State.html">L4vcpu::State</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">C++ implementation of state word in the vCPU area. <a href="classL4vcpu_1_1State.html#details">More...</a><br /></td></tr>
<tr class="memitem:L4vcpu_3A_3AVcpu" id="r_L4vcpu_3A_3AVcpu"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vcpu_1_1Vcpu.html">L4vcpu::Vcpu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">C++ implementation of the vCPU save state area. <a href="classL4vcpu_1_1Vcpu.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac8dd177f5382328e3922754cc9d36b28" id="r_gac8dd177f5382328e3922754cc9d36b28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac8dd177f5382328e3922754cc9d36b28">l4vcpu_irq_disable</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gac8dd177f5382328e3922754cc9d36b28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable a vCPU for event delivery. <br /></td></tr>
<tr class="memitem:gaa1e7797e4ed8b7dabd40c9849f5c362c" id="r_gaa1e7797e4ed8b7dabd40c9849f5c362c"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa1e7797e4ed8b7dabd40c9849f5c362c">l4vcpu_irq_disable_save</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaa1e7797e4ed8b7dabd40c9849f5c362c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable a vCPU for event delivery and return previous state. <br /></td></tr>
<tr class="memitem:ga58a61ec0b02bed0a03f708e1594cf8a5" id="r_ga58a61ec0b02bed0a03f708e1594cf8a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga58a61ec0b02bed0a03f708e1594cf8a5">l4vcpu_irq_enable</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb, l4vcpu_event_hndl_t do_event_work_cb, l4vcpu_setup_ipc_t setup_ipc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga58a61ec0b02bed0a03f708e1594cf8a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable a vCPU for event delivery. <br /></td></tr>
<tr class="memitem:ga68cccc12b6542f9413afb281d8bdffcc" id="r_ga68cccc12b6542f9413afb281d8bdffcc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga68cccc12b6542f9413afb281d8bdffcc">l4vcpu_irq_restore</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, unsigned s, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb, l4vcpu_event_hndl_t do_event_work_cb, l4vcpu_setup_ipc_t setup_ipc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga68cccc12b6542f9413afb281d8bdffcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore a previously saved IRQ/event state. <br /></td></tr>
<tr class="memitem:gaf305894f807867f8a5b1a99b22c05587" id="r_gaf305894f807867f8a5b1a99b22c05587"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf305894f807867f8a5b1a99b22c05587">l4vcpu_wait_for_event</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb, l4vcpu_event_hndl_t do_event_work_cb, l4vcpu_setup_ipc_t setup_ipc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaf305894f807867f8a5b1a99b22c05587"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for event. <br /></td></tr>
<tr class="memitem:gaed55cde10e914bfc8be9760a0fd90b0e" id="r_gaed55cde10e914bfc8be9760a0fd90b0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaed55cde10e914bfc8be9760a0fd90b0e">l4vcpu_print_state</a> (const <a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, const char *prefix) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaed55cde10e914bfc8be9760a0fd90b0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the state of a vCPU. <br /></td></tr>
<tr class="memitem:ga55f7fc7f6496002375240e2354ecb807" id="r_ga55f7fc7f6496002375240e2354ecb807"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga55f7fc7f6496002375240e2354ecb807">l4vcpu_is_irq_entry</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> const *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga55f7fc7f6496002375240e2354ecb807"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the entry reason was an IRQ/IPC message. <br /></td></tr>
<tr class="memitem:gab5156a117efc0b4760e81e99938a2dc1" id="r_gab5156a117efc0b4760e81e99938a2dc1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab5156a117efc0b4760e81e99938a2dc1">l4vcpu_is_page_fault_entry</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> const *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gab5156a117efc0b4760e81e99938a2dc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the entry reason was a page fault. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<p>vCPU handling functionality. </p>
<p>This library provides convenience functionality on top of the l4sys vCPU interface to ease programming. It wraps commonly used code and abstracts architecture depends parts as far as reasonable. </p>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="gac8dd177f5382328e3922754cc9d36b28" name="gac8dd177f5382328e3922754cc9d36b28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8dd177f5382328e3922754cc9d36b28">&#9670;&#160;</a></span>l4vcpu_irq_disable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void l4vcpu_irq_disable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *</td> <td class="paramname"><span class="paramname"><em>vcpu</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>Disable a vCPU for event delivery. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_2vcpu_8h_source.html#l00201">201</a> of file <a class="el" href="vcpu_2vcpu_8h_source.html">vcpu.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00332">l4_barrier()</a>, <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="sys_2vcpu_8h_source.html#l00114">L4_VCPU_F_IRQ</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00071">L4vcpu::Vcpu::irq_disable()</a>, <a class="el" href="vcpu_2vcpu_8h_source.html#l00209">l4vcpu_irq_disable_save()</a>, and <a class="el" href="vcpu_2vcpu_8h_source.html#l00257">l4vcpu_irq_restore()</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="group__api__libvcpu_gac8dd177f5382328e3922754cc9d36b28_cgraph.svg" width="286" height="36"><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="group__api__libvcpu_gac8dd177f5382328e3922754cc9d36b28_icgraph.svg" width="662" height="135"><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="gaa1e7797e4ed8b7dabd40c9849f5c362c" name="gaa1e7797e4ed8b7dabd40c9849f5c362c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1e7797e4ed8b7dabd40c9849f5c362c">&#9670;&#160;</a></span>l4vcpu_irq_disable_save()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned l4vcpu_irq_disable_save </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *</td> <td class="paramname"><span class="paramname"><em>vcpu</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>Disable a vCPU for event delivery and return previous state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>IRQ state before disabling IRQs. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vcpu_2vcpu_8h_source.html#l00209">209</a> of file <a class="el" href="vcpu_2vcpu_8h_source.html">vcpu.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="vcpu_2vcpu_8h_source.html#l00201">l4vcpu_irq_disable()</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00078">L4vcpu::Vcpu::irq_disable_save()</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="group__api__libvcpu_gaa1e7797e4ed8b7dabd40c9849f5c362c_cgraph.svg" width="515" height="36"><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="group__api__libvcpu_gaa1e7797e4ed8b7dabd40c9849f5c362c_icgraph.svg" width="466" height="36"><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="ga58a61ec0b02bed0a03f708e1594cf8a5" name="ga58a61ec0b02bed0a03f708e1594cf8a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58a61ec0b02bed0a03f708e1594cf8a5">&#9670;&#160;</a></span>l4vcpu_irq_enable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void l4vcpu_irq_enable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *</td> <td class="paramname"><span class="paramname"><em>vcpu</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *</td> <td class="paramname"><span class="paramname"><em>utcb</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4vcpu_event_hndl_t</td> <td class="paramname"><span class="paramname"><em>do_event_work_cb</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4vcpu_setup_ipc_t</td> <td class="paramname"><span class="paramname"><em>setup_ipc</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>Enable a vCPU for event delivery. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area. </td></tr>
<tr><td class="paramname">utcb</td><td>Utcb pointer of the calling vCPU. </td></tr>
<tr><td class="paramname">do_event_work_cb</td><td>Call-back function that is called in case an event (such as an interrupt) is pending. </td></tr>
<tr><td class="paramname">setup_ipc</td><td>Function call-back that is called right before any IPC operation, and before event delivery is enabled. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_2vcpu_8h_source.html#l00232">232</a> of file <a class="el" href="vcpu_2vcpu_8h_source.html">vcpu.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00332">l4_barrier()</a>, <a class="el" href="____timeout_8h_source.html#l00079">L4_IPC_BOTH_TIMEOUT_0</a>, <a class="el" href="compiler_8h_source.html#l00283">L4_LIKELY</a>, <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, <a class="el" href="sys_2vcpu_8h_source.html#l00114">L4_VCPU_F_IRQ</a>, and <a class="el" href="sys_2vcpu_8h_source.html#l00171">L4_VCPU_SF_IRQ_PENDING</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00135">L4vcpu::Vcpu::irq_enable()</a>, and <a class="el" href="vcpu_2vcpu_8h_source.html#l00257">l4vcpu_irq_restore()</a>.</p>
<div id="dynsection-5" 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-5-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_ga58a61ec0b02bed0a03f708e1594cf8a5_cgraph.svg" width="283" height="36"><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-6" 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-6-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_ga58a61ec0b02bed0a03f708e1594cf8a5_icgraph.svg" width="618" height="86"><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="ga68cccc12b6542f9413afb281d8bdffcc" name="ga68cccc12b6542f9413afb281d8bdffcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68cccc12b6542f9413afb281d8bdffcc">&#9670;&#160;</a></span>l4vcpu_irq_restore()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void l4vcpu_irq_restore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *</td> <td class="paramname"><span class="paramname"><em>vcpu</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>s</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *</td> <td class="paramname"><span class="paramname"><em>utcb</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4vcpu_event_hndl_t</td> <td class="paramname"><span class="paramname"><em>do_event_work_cb</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4vcpu_setup_ipc_t</td> <td class="paramname"><span class="paramname"><em>setup_ipc</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>Restore a previously saved IRQ/event state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area. </td></tr>
<tr><td class="paramname">s</td><td>IRQ state to be restored. </td></tr>
<tr><td class="paramname">utcb</td><td>Utcb pointer of the calling vCPU. </td></tr>
<tr><td class="paramname">do_event_work_cb</td><td>Call-back function that is called in case an event (such as an interrupt) is pending after enabling. </td></tr>
<tr><td class="paramname">setup_ipc</td><td>Function call-back that is called right before any IPC operation, and before event delivery is enabled. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="vcpu_2vcpu_8h_source.html#l00257">257</a> of file <a class="el" href="vcpu_2vcpu_8h_source.html">vcpu.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, <a class="el" href="sys_2vcpu_8h_source.html#l00114">L4_VCPU_F_IRQ</a>, <a class="el" href="vcpu_2vcpu_8h_source.html#l00201">l4vcpu_irq_disable()</a>, and <a class="el" href="vcpu_2vcpu_8h_source.html#l00232">l4vcpu_irq_enable()</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00150">L4vcpu::Vcpu::irq_restore()</a>.</p>
<div id="dynsection-7" 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-7-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_ga68cccc12b6542f9413afb281d8bdffcc_cgraph.svg" width="476" height="86"><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-8" 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-8-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_ga68cccc12b6542f9413afb281d8bdffcc_icgraph.svg" width="388" height="36"><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="ga55f7fc7f6496002375240e2354ecb807" name="ga55f7fc7f6496002375240e2354ecb807"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga55f7fc7f6496002375240e2354ecb807">&#9670;&#160;</a></span>l4vcpu_is_irq_entry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4vcpu_is_irq_entry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> const *</td> <td class="paramname"><span class="paramname"><em>vcpu</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>Return whether the entry reason was an IRQ/IPC message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area.</td></tr>
</table>
</dd>
</dl>
<p>return 0 if not, !=0 otherwise. </p>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, <a class="el" href="compiler_8h_source.html#l00051">L4_INLINE</a>, and <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00188">L4vcpu::Vcpu::is_irq_entry()</a>.</p>
<div id="dynsection-9" 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-9-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-9-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_ga55f7fc7f6496002375240e2354ecb807_icgraph.svg" width="358" 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="gab5156a117efc0b4760e81e99938a2dc1" name="gab5156a117efc0b4760e81e99938a2dc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab5156a117efc0b4760e81e99938a2dc1">&#9670;&#160;</a></span>l4vcpu_is_page_fault_entry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4vcpu_is_page_fault_entry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> const *</td> <td class="paramname"><span class="paramname"><em>vcpu</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>Return whether the entry reason was a page fault. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area.</td></tr>
</table>
</dd>
</dl>
<p>return 0 if not, !=0 otherwise. </p>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00181">L4vcpu::Vcpu::is_page_fault_entry()</a>.</p>
<div id="dynsection-10" 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-10-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-10-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_gab5156a117efc0b4760e81e99938a2dc1_icgraph.svg" width="384" 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="gaed55cde10e914bfc8be9760a0fd90b0e" name="gaed55cde10e914bfc8be9760a0fd90b0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed55cde10e914bfc8be9760a0fd90b0e">&#9670;&#160;</a></span>l4vcpu_print_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4vcpu_print_state </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *</td> <td class="paramname"><span class="paramname"><em>vcpu</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>prefix</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Print the state of a vCPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area. </td></tr>
<tr><td class="paramname">prefix</td><td>A prefix for each line printed. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, <a class="el" href="compiler_8h_source.html#l00051">L4_INLINE</a>, and <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00275">L4vcpu::Vcpu::print_state()</a>.</p>
<div id="dynsection-11" 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-11-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-11-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_gaed55cde10e914bfc8be9760a0fd90b0e_icgraph.svg" width="348" 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="gaf305894f807867f8a5b1a99b22c05587" name="gaf305894f807867f8a5b1a99b22c05587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf305894f807867f8a5b1a99b22c05587">&#9670;&#160;</a></span>l4vcpu_wait_for_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void l4vcpu_wait_for_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *</td> <td class="paramname"><span class="paramname"><em>vcpu</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *</td> <td class="paramname"><span class="paramname"><em>utcb</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4vcpu_event_hndl_t</td> <td class="paramname"><span class="paramname"><em>do_event_work_cb</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4vcpu_setup_ipc_t</td> <td class="paramname"><span class="paramname"><em>setup_ipc</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>Wait for event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vcpu</td><td>Pointer to vCPU area. </td></tr>
<tr><td class="paramname">utcb</td><td>Utcb pointer of the calling vCPU. </td></tr>
<tr><td class="paramname">do_event_work_cb</td><td>Call-back function that is called when the vCPU awakes and needs to handle an event/IRQ. </td></tr>
<tr><td class="paramname">setup_ipc</td><td>Function call-back that is called right before any IPC operation.</td></tr>
</table>
</dd>
</dl>
<p>Note that event delivery remains disabled after this function returns. </p>
<p class="definition">Definition at line <a class="el" href="vcpu_2vcpu_8h_source.html#l00270">270</a> of file <a class="el" href="vcpu_2vcpu_8h_source.html">vcpu.h</a>.</p>
<p class="reference">References <a class="el" href="____timeout_8h_source.html#l00076">L4_IPC_NEVER</a>, and <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
<p class="reference">Referenced by <a class="el" href="vcpu_source.html#l00166">L4vcpu::Vcpu::wait_for_event()</a>.</p>
<div id="dynsection-12" 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-12-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-12-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__api__libvcpu_gaf305894f807867f8a5b1a99b22c05587_icgraph.svg" width="372" 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>
</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="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