teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

l4re-base-25.08.0

Browse Source
This commit is contained in:
Viktor Reusch
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

199
doc/source/html/group__l4__api.html Normal file
View File

@@ -0,0 +1,199 @@
<!-- 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: Base API</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__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">Base API </div></div>
</div><!--header-->
<div class="contents">
<p>Interfaces for all kinds of base 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 Base API:</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__api.svg" width="348" height="628"><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:l4sys_5Fdefines" id="r_l4sys_5Fdefines"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4sys__defines.html">Basic Macros </a></td></tr>
<tr class="memdesc:group__l4sys__defines"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> standard macros for header files, function definitions, and public APIs etc. <br /></td></tr>
<tr class="memitem:api_5Fcalls_5Ffiasco" id="r_api_5Fcalls_5Ffiasco"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__calls__fiasco.html">Fiasco extensions </a></td></tr>
<tr class="memdesc:group__api__calls__fiasco"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extensions of the Fiasco <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> implementation. <br /></td></tr>
<tr class="memitem:l4_5Ffpage_5Fapi" id="r_l4_5Ffpage_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__fpage__api.html">Flexpages </a></td></tr>
<tr class="memdesc:group__l4__fpage__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flexpage-related API. <br /></td></tr>
<tr class="memitem:l4_5Fcxx_5Fipc_5Fifaces" id="r_l4_5Fcxx_5Fipc_5Fifaces"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__cxx__ipc__ifaces.html">C++ IPC Interface Definition. </a></td></tr>
<tr class="memdesc:group__l4__cxx__ipc__ifaces"><td class="mdescLeft">&#160;</td><td class="mdescRight">APIs for defining IPC interfaces using C++ as language. <br /></td></tr>
<tr class="memitem:l4_5Fcache_5Fapi" id="r_l4_5Fcache_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__cache__api.html">Cache Consistency </a></td></tr>
<tr class="memdesc:group__l4__cache__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">Various functions for cache consistency. <br /></td></tr>
<tr class="memitem:l4_5Fmemory_5Fapi" id="r_l4_5Fmemory_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__memory__api.html">Memory related </a></td></tr>
<tr class="memdesc:group__l4__memory__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory related constants, data types and functions. <br /></td></tr>
<tr class="memitem:l4_5Ferror_5Fapi" id="r_l4_5Ferror_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__error__api.html">Error codes </a></td></tr>
<tr class="memdesc:group__l4__error__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common error codes. <br /></td></tr>
<tr class="memitem:l4_5Fipc_5Fapi" id="r_l4_5Fipc_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__ipc__api.html">Object Invocation </a></td></tr>
<tr class="memdesc:group__l4__ipc__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">API for <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> object invocation. <br /></td></tr>
<tr class="memitem:l4_5Fkernel_5Fobject_5Fapi" id="r_l4_5Fkernel_5Fobject_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kernel__object__api.html">Kernel Objects </a></td></tr>
<tr class="memdesc:group__l4__kernel__object__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">API of kernel objects. <br /></td></tr>
<tr class="memitem:l4_5Fkip_5Fapi" id="r_l4_5Fkip_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__api.html">Kernel Interface Page </a></td></tr>
<tr class="memdesc:group__l4__kip__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">Kernel Interface Page. <br /></td></tr>
<tr class="memitem:l4_5Fcap_5Fapi" id="r_l4_5Fcap_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__cap__api.html">Capabilities </a></td></tr>
<tr class="memdesc:group__l4__cap__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">C interface for capabilities. <br /></td></tr>
<tr class="memitem:l4_5Fmem_5Fop_5Fapi" id="r_l4_5Fmem_5Fop_5Fapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__mem__op__api.html">Memory operations. </a></td></tr>
<tr class="memdesc:group__l4__mem__op__api"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operations for memory access. <br /></td></tr>
<tr class="memitem:l4_5Fbasic_5Ftypes" id="r_l4_5Fbasic_5Ftypes"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__basic__types.html">Integer Types </a></td></tr>
<tr class="memdesc:group__l4__basic__types"><td class="mdescLeft">&#160;</td><td class="mdescRight"><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-files" class="groupheader"><a id="files" name="files"></a>
Files</h2></td></tr>
<tr class="memitem:cache_2Eh" id="r_cache_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="l4_2sys_2cache_8h.html">cache.h</a></td></tr>
<tr class="memdesc:l4_2sys_2cache_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache-consistency functions. <br /></td></tr>
<tr class="memitem:compiler_2Eh" id="r_compiler_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compiler_8h.html">compiler.h</a></td></tr>
<tr class="memdesc:compiler_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> compiler related defines. <br /></td></tr>
<tr class="memitem:consts_2Eh" id="r_consts_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="l4_2sys_2consts_8h.html">consts.h</a></td></tr>
<tr class="memdesc:l4_2sys_2consts_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common constants. <br /></td></tr>
<tr class="memitem:debugger_2Eh" id="r_debugger_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugger_8h.html">debugger.h</a></td></tr>
<tr class="memdesc:debugger_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debugger related definitions. <br /></td></tr>
<tr class="memitem:factory_2Eh" id="r_factory_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="factory_8h.html">factory.h</a></td></tr>
<tr class="memdesc:factory_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common factory related definitions. <br /></td></tr>
<tr class="memitem:icu" id="r_icu"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icu.html">icu</a></td></tr>
<tr class="memdesc:icu"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt controller. <br /></td></tr>
<tr class="memitem:icu_2Eh" id="r_icu_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icu_8h.html">icu.h</a></td></tr>
<tr class="memdesc:icu_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt controller. <br /></td></tr>
<tr class="memitem:ipc_2Eh" id="r_ipc_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="l4_2sys_2ipc_8h.html">ipc.h</a></td></tr>
<tr class="memdesc:l4_2sys_2ipc_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common IPC interface. <br /></td></tr>
<tr class="memitem:irq_2Eh" id="r_irq_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="l4_2sys_2irq_8h.html">irq.h</a></td></tr>
<tr class="memdesc:l4_2sys_2irq_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">C Irq interface. <br /></td></tr>
<tr class="memitem:kip" id="r_kip"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="kip.html">kip</a></td></tr>
<tr class="memitem:kip_2Eh" id="r_kip_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sys_2kip_8h.html">kip.h</a></td></tr>
<tr class="memdesc:sys_2kip_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Kernel Info Page access functions. <br /></td></tr>
<tr class="memitem:memdesc_2Eh" id="r_memdesc_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memdesc_8h.html">memdesc.h</a></td></tr>
<tr class="memdesc:memdesc_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory description functions. <br /></td></tr>
<tr class="memitem:semaphore_2Eh" id="r_semaphore_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="semaphore_8h.html">semaphore.h</a></td></tr>
<tr class="memdesc:semaphore_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">C semaphore interface. <br /></td></tr>
<tr class="memitem:types_2Eh" id="r_types_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="l4_2sys_2types_8h.html">types.h</a></td></tr>
<tr class="memdesc:l4_2sys_2types_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> ABI Data Types. <br /></td></tr>
<tr class="memitem:consts_2Eh" id="r_consts_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm_2l4_2sys_2consts_8h.html">consts.h</a></td></tr>
<tr class="memdesc:arm_2l4_2sys_2consts_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> constants, arm version. <br /></td></tr>
<tr class="memitem:consts_2Eh" id="r_consts_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm64_2l4_2sys_2consts_8h.html">consts.h</a></td></tr>
<tr class="memdesc:arm64_2l4_2sys_2consts_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> constants, arm version. <br /></td></tr>
<tr class="memitem:consts_2Eh" id="r_consts_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amd64_2l4_2sys_2consts_8h.html">consts.h</a></td></tr>
<tr class="memdesc:amd64_2l4_2sys_2consts_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> constants, AMD64 version. <br /></td></tr>
<tr class="memitem:ipc_2Eh" id="r_ipc_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x86_2l4f_2l4_2sys_2ipc_8h.html">ipc.h</a></td></tr>
<tr class="memdesc:x86_2l4f_2l4_2sys_2ipc_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> IPC System Calls, x86. <br /></td></tr>
<tr class="memitem:consts_2Eh" id="r_consts_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x86_2l4_2sys_2consts_8h.html">consts.h</a></td></tr>
<tr class="memdesc:x86_2l4_2sys_2consts_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> constants, x86 version. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<p>Interfaces for all kinds of base functionality. </p>
<p>Some notes on Inter Process Communication (IPC)</p>
<p>IPC in <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> is always synchronous and unbuffered: a message is transferred from the sender to the recipient if and only if the recipient has invoked a corresponding IPC operation. The sender blocks until this happens or a timeout specified by the sender elapsed without the destination becoming ready to receive. </p>
</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>