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

171
doc/source/html/rcv__endpoint_source.html Normal file
View File

@@ -0,0 +1,171 @@
<!-- 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: l4/sys/rcv_endpoint Source File</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('rcv__endpoint_source.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">rcv_endpoint</div></div>
</div><!--header-->
<div class="contents">
<a href="rcv__endpoint.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// vi:set ft=cpp: -*- Mode: C++ -*-</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">/*</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * (c) 2017 Alexander Warg &lt;alexander.warg@kernkonzept.com&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> */</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;<a class="code" href="rcv__endpoint_8h.html">l4/sys/rcv_endpoint.h</a>&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;<a class="code" href="snd__destination.html">l4/sys/snd_destination</a>&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;<a class="code" href="l4_2sys_2types_8h.html">l4/sys/types.h</a>&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;<a class="code" href="capability.html">l4/sys/capability</a>&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;<a class="code" href="ipc__iface.html">l4/sys/cxx/ipc_iface</a>&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4.html">L4</a> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">class </span><a class="code hl_class" href="classL4_1_1Thread.html">Thread</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classL4_1_1Rcv__endpoint.html"> 30</a></span><span class="keyword">class </span><a class="code hl_define" href="group__l4sys__defines.html#ga63e7f1ab50a1b3049bdd0a34e97423c2">L4_EXPORT</a> <a class="code hl_class" href="classL4_1_1Rcv__endpoint.html">Rcv_endpoint</a> :</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span> <a class="code hl_class" href="classL4_1_1Kobject__t.html">Kobject_t</a>&lt;Rcv_endpoint, Kobject, L4_PROTO_KOBJECT,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> Type_info::Demand_t&lt;1&gt; &gt;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_define" href="ipc__iface.html#afd77fe126e97c4d046e3842d948ec91d">L4_INLINE_RPC_OP</a>(<a class="code hl_enumvalue" href="rcv__endpoint_8h.html#abcba8cb4c48ea1dcd4c8a952570066c6a823a2ea579aa6e0838c0b71a79a66b0e">L4_RCV_EP_BIND_OP</a>,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classL4_1_1Rcv__endpoint.html#a44d288dd670226f6845b5bd8c973b15e"> 67</a></span> <a class="code hl_struct" href="structl4__msgtag__t.html">l4_msgtag_t</a>, <a class="code hl_function" href="classL4_1_1Rcv__endpoint.html#a44d288dd670226f6845b5bd8c973b15e">bind_thread</a>, (<a class="code hl_class" href="classL4_1_1Ipc_1_1Cap.html">Ipc::Cap&lt;Thread&gt;</a> t, <a class="code hl_typedef" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> label));</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span></div>
<div class="foldopen" id="foldopen00101" data-start="{" data-end="}">
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classL4_1_1Rcv__endpoint.html#a704d82925cec6c9827a9bfcfb062859a"> 101</a></span> <a class="code hl_struct" href="structl4__msgtag__t.html">l4_msgtag_t</a> <a class="code hl_function" href="classL4_1_1Rcv__endpoint.html#a704d82925cec6c9827a9bfcfb062859a">bind_snd_destination</a>(<a class="code hl_class" href="classL4_1_1Cap.html">Cap&lt;Snd_destination&gt;</a> snd_dst, <a class="code hl_typedef" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> label)</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> {</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> <a class="code hl_function" href="group__l4__kernel__object__gate__api.html#gadb03d49fcf42b9fc167338fa1cd72fb4">l4_rcv_ep_bind_snd_destination</a>(<a class="code hl_function" href="classL4_1_1Kobject.html#a4f2117ae76762f4084e6a1adb915863c">cap</a>(), snd_dst.<a class="code hl_function" href="classL4_1_1Cap__base.html#a90ff089ca2442b128c2b2b0e1c22c6d7">cap</a>(), label);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">typedef</span> <a class="code hl_struct" href="structL4_1_1Typeid_1_1Rpcs__sys.html">L4::Typeid::Rpcs_sys&lt;bind_thread_t&gt;</a> Rpcs;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>};</div>
</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>}</div>
<div class="ttc" id="acapability_html"><div class="ttname"><a href="capability.html">capability</a></div><div class="ttdoc">L4::Cap related definitions.</div></div>
<div class="ttc" id="aclassL4_1_1Cap__base_html_a90ff089ca2442b128c2b2b0e1c22c6d7"><div class="ttname"><a href="classL4_1_1Cap__base.html#a90ff089ca2442b128c2b2b0e1c22c6d7">L4::Cap_base::cap</a></div><div class="ttdeci">l4_cap_idx_t cap() const noexcept</div><div class="ttdoc">Return capability selector.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00049">capability.h:49</a></div></div>
<div class="ttc" id="aclassL4_1_1Cap_html"><div class="ttname"><a href="classL4_1_1Cap.html">L4::Cap</a></div><div class="ttdoc">C++ interface for capabilities.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00223">capability.h:224</a></div></div>
<div class="ttc" id="aclassL4_1_1Ipc_1_1Cap_html"><div class="ttname"><a href="classL4_1_1Ipc_1_1Cap.html">L4::Ipc::Cap</a></div><div class="ttdoc">Capability type for RPC interfaces (see L4::Cap&lt;T&gt;).</div><div class="ttdef"><b>Definition</b> <a href="ipc__types_source.html#l00698">ipc_types:699</a></div></div>
<div class="ttc" id="aclassL4_1_1Kobject__t_html"><div class="ttname"><a href="classL4_1_1Kobject__t.html">L4::Kobject_t</a></div><div class="ttdoc">Helper class to create an L4Re interface class that is derived from a single base class.</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00749">__typeinfo.h:750</a></div></div>
<div class="ttc" id="aclassL4_1_1Kobject_html_a4f2117ae76762f4084e6a1adb915863c"><div class="ttname"><a href="classL4_1_1Kobject.html#a4f2117ae76762f4084e6a1adb915863c">L4::Kobject::cap</a></div><div class="ttdeci">l4_cap_idx_t cap() const noexcept</div><div class="ttdoc">Return capability selector.</div><div class="ttdef"><b>Definition</b> <a href="kobject_source.html#l00069">kobject:69</a></div></div>
<div class="ttc" id="aclassL4_1_1Rcv__endpoint_html"><div class="ttname"><a href="classL4_1_1Rcv__endpoint.html">L4::Rcv_endpoint</a></div><div class="ttdoc">Interface for kernel objects that allow to receive IPC from them.</div><div class="ttdef"><b>Definition</b> <a href="#l00030">rcv_endpoint:33</a></div></div>
<div class="ttc" id="aclassL4_1_1Rcv__endpoint_html_a44d288dd670226f6845b5bd8c973b15e"><div class="ttname"><a href="classL4_1_1Rcv__endpoint.html#a44d288dd670226f6845b5bd8c973b15e">L4::Rcv_endpoint::bind_thread</a></div><div class="ttdeci">l4_msgtag_t bind_thread(Ipc::Cap&lt; Thread &gt; t, l4_umword_t label)</div><div class="ttdoc">Bind the IPC receive endpoint to a thread.</div></div>
<div class="ttc" id="aclassL4_1_1Rcv__endpoint_html_a704d82925cec6c9827a9bfcfb062859a"><div class="ttname"><a href="classL4_1_1Rcv__endpoint.html#a704d82925cec6c9827a9bfcfb062859a">L4::Rcv_endpoint::bind_snd_destination</a></div><div class="ttdeci">l4_msgtag_t bind_snd_destination(Cap&lt; Snd_destination &gt; snd_dst, l4_umword_t label)</div><div class="ttdoc">Bind a send destination (a thread or thread group) to an IPC receive endpoint.</div><div class="ttdef"><b>Definition</b> <a href="#l00101">rcv_endpoint:101</a></div></div>
<div class="ttc" id="aclassL4_1_1Thread_html"><div class="ttname"><a href="classL4_1_1Thread.html">L4::Thread</a></div><div class="ttdoc">C++ L4 kernel thread interface, see Thread for the C interface.</div><div class="ttdef"><b>Definition</b> <a href="sys_2thread_source.html#l00052">thread:55</a></div></div>
<div class="ttc" id="agroup__l4__basic__types_html_ga1c2c4b333f75b1d05b59855910f2b9cb"><div class="ttname"><a href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a></div><div class="ttdeci">unsigned long l4_umword_t</div><div class="ttdoc">Unsigned machine word.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2l4int_8h_source.html#l00040">l4int.h:40</a></div></div>
<div class="ttc" id="agroup__l4__kernel__object__gate__api_html_gadb03d49fcf42b9fc167338fa1cd72fb4"><div class="ttname"><a href="group__l4__kernel__object__gate__api.html#gadb03d49fcf42b9fc167338fa1cd72fb4">l4_rcv_ep_bind_snd_destination</a></div><div class="ttdeci">l4_msgtag_t l4_rcv_ep_bind_snd_destination(l4_cap_idx_t ep, l4_cap_idx_t snd_dst, l4_umword_t label)</div><div class="ttdoc">Bind the IPC receive endpoint to a send destination (a thread).</div><div class="ttdef"><b>Definition</b> <a href="rcv__endpoint_8h_source.html#l00138">rcv_endpoint.h:138</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga63e7f1ab50a1b3049bdd0a34e97423c2"><div class="ttname"><a href="group__l4sys__defines.html#ga63e7f1ab50a1b3049bdd0a34e97423c2">L4_EXPORT</a></div><div class="ttdeci">#define L4_EXPORT</div><div class="ttdoc">Attribute to mark functions, variables, and data types as being exported from a library.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00214">compiler.h:214</a></div></div>
<div class="ttc" id="aipc__iface_html"><div class="ttname"><a href="ipc__iface.html">ipc_iface</a></div><div class="ttdoc">Interface Definition Language.</div></div>
<div class="ttc" id="aipc__iface_html_afd77fe126e97c4d046e3842d948ec91d"><div class="ttname"><a href="ipc__iface.html#afd77fe126e97c4d046e3842d948ec91d">L4_INLINE_RPC_OP</a></div><div class="ttdeci">#define L4_INLINE_RPC_OP(op, res, name, args, attr...)</div><div class="ttdoc">Define an inline RPC call with specific opcode (type and callable).</div><div class="ttdef"><b>Definition</b> <a href="ipc__iface_source.html#l00497">ipc_iface:497</a></div></div>
<div class="ttc" id="al4_2sys_2types_8h_html"><div class="ttname"><a href="l4_2sys_2types_8h.html">types.h</a></div><div class="ttdoc">Common L4 ABI Data Types.</div></div>
<div class="ttc" id="anamespaceL4_html"><div class="ttname"><a href="namespaceL4.html">L4</a></div><div class="ttdoc">L4 low-level kernel interface.</div><div class="ttdef"><b>Definition</b> <a href="l4sys-l4f-groups_8dox_source.html#l00050">l4sys-l4f-groups.dox:50</a></div></div>
<div class="ttc" id="arcv__endpoint_8h_html"><div class="ttname"><a href="rcv__endpoint_8h.html">rcv_endpoint.h</a></div><div class="ttdoc">Receive endpoint C interface.</div></div>
<div class="ttc" id="arcv__endpoint_8h_html_abcba8cb4c48ea1dcd4c8a952570066c6a823a2ea579aa6e0838c0b71a79a66b0e"><div class="ttname"><a href="rcv__endpoint_8h.html#abcba8cb4c48ea1dcd4c8a952570066c6a823a2ea579aa6e0838c0b71a79a66b0e">L4_RCV_EP_BIND_OP</a></div><div class="ttdeci">@ L4_RCV_EP_BIND_OP</div><div class="ttdoc">Bind to thread or thread group.</div><div class="ttdef"><b>Definition</b> <a href="rcv__endpoint_8h_source.html#l00095">rcv_endpoint.h:95</a></div></div>
<div class="ttc" id="asnd__destination_html"><div class="ttname"><a href="snd__destination.html">snd_destination</a></div><div class="ttdoc">The C++ Sender destination interface.</div></div>
<div class="ttc" id="astructL4_1_1Typeid_1_1Rpcs__sys_html"><div class="ttname"><a href="structL4_1_1Typeid_1_1Rpcs__sys.html">L4::Typeid::Rpcs_sys</a></div><div class="ttdoc">List of RPCs typically used for kernel interfaces.</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00465">__typeinfo.h:465</a></div></div>
<div class="ttc" id="astructl4__msgtag__t_html"><div class="ttname"><a href="structl4__msgtag__t.html">l4_msgtag_t</a></div><div class="ttdoc">Message tag data structure.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2types_8h_source.html#l00153">types.h:154</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</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"><b>l4</b></li><li class="navelem"><b>sys</b></li><li class="navelem"><a href="rcv__endpoint.html">rcv_endpoint</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>