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

402 lines
20 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: Cache Consistency</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__l4__cache__api.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">Cache Consistency <div class="ingroups"><a class="el" href="group__l4__api.html">Base API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Various functions for cache consistency.
<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 Cache Consistency:</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__l4__cache__api.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>
<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:gae5aedc9d4cc667bd0c199bc0d5c4580a" id="r_gae5aedc9d4cc667bd0c199bc0d5c4580a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae5aedc9d4cc667bd0c199bc0d5c4580a">l4_cache_clean_data</a> (unsigned long start, unsigned long end) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gae5aedc9d4cc667bd0c199bc0d5c4580a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache clean a range in D-cache; writes back to PoC. <br /></td></tr>
<tr class="memitem:gab516ac01f6335e6e21e4e804974e0891" id="r_gab516ac01f6335e6e21e4e804974e0891"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab516ac01f6335e6e21e4e804974e0891">l4_cache_flush_data</a> (unsigned long start, unsigned long end) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gab516ac01f6335e6e21e4e804974e0891"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache flush a range; writes back to PoC. <br /></td></tr>
<tr class="memitem:gaf9f4aebefdf0c6db4a4b42a5470f19be" id="r_gaf9f4aebefdf0c6db4a4b42a5470f19be"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf9f4aebefdf0c6db4a4b42a5470f19be">l4_cache_inv_data</a> (unsigned long start, unsigned long end) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaf9f4aebefdf0c6db4a4b42a5470f19be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache invalidate a range; might write back to PoC. <br /></td></tr>
<tr class="memitem:gac8838da96084e6be24c5dd5566bb970e" id="r_gac8838da96084e6be24c5dd5566bb970e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac8838da96084e6be24c5dd5566bb970e">l4_cache_coherent</a> (unsigned long start, unsigned long end) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gac8838da96084e6be24c5dd5566bb970e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make memory coherent between I-cache and D-cache; writes back to PoU. <br /></td></tr>
<tr class="memitem:ga1889aec508935bdb4896ef81abeac9eb" id="r_ga1889aec508935bdb4896ef81abeac9eb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1889aec508935bdb4896ef81abeac9eb">l4_cache_dma_coherent</a> (unsigned long start, unsigned long end) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga1889aec508935bdb4896ef81abeac9eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make memory coherent for use with external memory; writes back to PoC. <br /></td></tr>
<tr class="memitem:ga23b6517d08db422ad9f5dba795f30039" id="r_ga23b6517d08db422ad9f5dba795f30039"><td class="memItemLeft" align="right" valign="top"><a id="ga23b6517d08db422ad9f5dba795f30039" name="ga23b6517d08db422ad9f5dba795f30039"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>l4_cache_dma_coherent_full</b> (void) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga23b6517d08db422ad9f5dba795f30039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make memory coherent for use with external memory; writes back to PoC. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<p>Various functions for cache consistency. </p>
<p>These functions shall be used to ensure that</p><ul>
<li>all blocks (e.g. CPU cores, devices, DMA engines) are guaranteed to see the same copy of a memory location (Point of Coherency &ndash; PoC),</li>
<li>instruction and data caches of a core are guaranteed to see the same copy of a memory location (Point of Unification &ndash; PoU).</li>
</ul>
<p>Certain functions are NOPs on certain architectures, for example on Intel it's not necessary to explicitly make caches coherent to PoU. </p>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="gae5aedc9d4cc667bd0c199bc0d5c4580a" name="gae5aedc9d4cc667bd0c199bc0d5c4580a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae5aedc9d4cc667bd0c199bc0d5c4580a">&#9670;&#160;</a></span>l4_cache_clean_data()</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__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int l4_cache_clean_data </td>
<td>(</td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>start</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>end</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>Cache clean a range in D-cache; writes back to PoC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>Start of range (inclusive) </td></tr>
<tr><td class="paramname">end</td><td>End of range (exclusive)</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">-EFAULT</td><td>in the case of an unresolved page fault in the given area</td></tr>
</table>
</dd>
</dl>
<p>Writes back any dirty cache lines in the range but leaves them in the cache and marks the cached copies clean. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2l4re_2c_09_09_2shared_ds_2ds_clnt_8cc-example.html#a11">examples/libs/l4re/c++/shared_ds/ds_clnt.cc</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="arm_2l4_2sys_2cache_8h_source.html#l00070">70</a> of file <a class="el" href="arm_2l4_2sys_2cache_8h_source.html">cache.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
</div>
</div>
<a id="gac8838da96084e6be24c5dd5566bb970e" name="gac8838da96084e6be24c5dd5566bb970e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8838da96084e6be24c5dd5566bb970e">&#9670;&#160;</a></span>l4_cache_coherent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4_cache_coherent </td>
<td>(</td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>start</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>end</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>Make memory coherent between I-cache and D-cache; writes back to PoU. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>Start of range (inclusive) </td></tr>
<tr><td class="paramname">end</td><td>End of range (exclusive)</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">-EFAULT</td><td>in the case of an unresolved page fault in the given area </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="arm_2l4_2sys_2cache_8h_source.html#l00094">94</a> of file <a class="el" href="arm_2l4_2sys_2cache_8h_source.html">cache.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
</div>
</div>
<a id="ga1889aec508935bdb4896ef81abeac9eb" name="ga1889aec508935bdb4896ef81abeac9eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1889aec508935bdb4896ef81abeac9eb">&#9670;&#160;</a></span>l4_cache_dma_coherent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4_cache_dma_coherent </td>
<td>(</td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>start</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>end</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>Make memory coherent for use with external memory; writes back to PoC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>Start of range (inclusive) </td></tr>
<tr><td class="paramname">end</td><td>End of range (exclusive)</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">-EFAULT</td><td>in the case of an unresolved page fault in the given area </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="arm_2l4_2sys_2cache_8h_source.html#l00102">102</a> of file <a class="el" href="arm_2l4_2sys_2cache_8h_source.html">cache.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
</div>
</div>
<a id="gab516ac01f6335e6e21e4e804974e0891" name="gab516ac01f6335e6e21e4e804974e0891"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab516ac01f6335e6e21e4e804974e0891">&#9670;&#160;</a></span>l4_cache_flush_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4_cache_flush_data </td>
<td>(</td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>start</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>end</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>Cache flush a range; writes back to PoC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>Start of range (inclusive) </td></tr>
<tr><td class="paramname">end</td><td>End of range (exclusive)</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">-EFAULT</td><td>in the case of an unresolved page fault in the given area</td></tr>
</table>
</dd>
</dl>
<p>Writes back any dirty cache lines and invalidates all cache entries in the range. </p>
<p class="definition">Definition at line <a class="el" href="arm_2l4_2sys_2cache_8h_source.html#l00078">78</a> of file <a class="el" href="arm_2l4_2sys_2cache_8h_source.html">cache.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
</div>
</div>
<a id="gaf9f4aebefdf0c6db4a4b42a5470f19be" name="gaf9f4aebefdf0c6db4a4b42a5470f19be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9f4aebefdf0c6db4a4b42a5470f19be">&#9670;&#160;</a></span>l4_cache_inv_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4_cache_inv_data </td>
<td>(</td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>start</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>end</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>Cache invalidate a range; might write back to PoC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>Start of range (inclusive) </td></tr>
<tr><td class="paramname">end</td><td>End of range (exclusive)</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">-EFAULT</td><td>in the case of an unresolved page fault in the given area</td></tr>
</table>
</dd>
</dl>
<p>Invalidates all cache entries in the range but does not necessarily write back dirty cache lines.</p>
<dl class="section note"><dt>Note</dt><dd>Implementations may choose to write back dirty lines nonetheless if this is more efficient. </dd></dl>
<p class="definition">Definition at line <a class="el" href="arm_2l4_2sys_2cache_8h_source.html#l00086">86</a> of file <a class="el" href="arm_2l4_2sys_2cache_8h_source.html">cache.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>.</p>
</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>