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

506 lines
27 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: Shared Memory 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__l4shm.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">Shared Memory Library </div></div>
</div><!--header-->
<div class="contents">
<p>L4SHM provides a shared memory infrastructure that establishes a shared memory area between multiple parties and uses a fast notification mechanism.
<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 Shared Memory 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__l4shm.svg" width="304" height="86"><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_5Fl4shmc_5Fchunk" id="r_api_5Fl4shmc_5Fchunk"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html">Chunks </a></td></tr>
<tr class="memitem:api_5Fl4shmc_5Fsignal" id="r_api_5Fl4shmc_5Fsignal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal.html">Signals </a></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:ga3b18cf7ff5492e60ba1b9aec99a4a195" id="r_ga3b18cf7ff5492e60ba1b9aec99a4a195"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3b18cf7ff5492e60ba1b9aec99a4a195">l4shmc_create</a> (char const *shmc_name)</td></tr>
<tr class="memdesc:ga3b18cf7ff5492e60ba1b9aec99a4a195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a shared memory area. <br /></td></tr>
<tr class="memitem:gabce1c28a48bc887ebd2923681ab524b2" id="r_gabce1c28a48bc887ebd2923681ab524b2"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gabce1c28a48bc887ebd2923681ab524b2">l4shmc_attach</a> (char const *shmc_name, l4shmc_area_t *shmarea)</td></tr>
<tr class="memdesc:gabce1c28a48bc887ebd2923681ab524b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach to a shared memory area. <br /></td></tr>
<tr class="memitem:gaf078db90961d5f67ea2a84e43f322edd" id="r_gaf078db90961d5f67ea2a84e43f322edd"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf078db90961d5f67ea2a84e43f322edd">l4shmc_get_client_nr</a> (l4shmc_area_t const *shmarea)</td></tr>
<tr class="memdesc:gaf078db90961d5f67ea2a84e43f322edd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine the client number of the shared memory region. <br /></td></tr>
<tr class="memitem:ga9b8015fb4d9a78205d25eadf3da3ad6a" id="r_ga9b8015fb4d9a78205d25eadf3da3ad6a"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9b8015fb4d9a78205d25eadf3da3ad6a">l4shmc_mark_client_initialized</a> (l4shmc_area_t *shmarea)</td></tr>
<tr class="memdesc:ga9b8015fb4d9a78205d25eadf3da3ad6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark this shared memory client as 'initialized'. <br /></td></tr>
<tr class="memitem:gaafac792578e3274613015ed1144aeabc" id="r_gaafac792578e3274613015ed1144aeabc"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaafac792578e3274613015ed1144aeabc">l4shmc_get_initialized_clients</a> (l4shmc_area_t *shmarea, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *bitmask)</td></tr>
<tr class="memdesc:gaafac792578e3274613015ed1144aeabc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetch the <span class="tt">_clients_init_done</span> bitmask of the shared memory area. <br /></td></tr>
<tr class="memitem:ga4d4ef679fdd3837893a10a18265aa5f7" id="r_ga4d4ef679fdd3837893a10a18265aa5f7"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4d4ef679fdd3837893a10a18265aa5f7">l4shmc_connect_chunk_signal</a> (l4shmc_chunk_t *chunk, l4shmc_signal_t *signal)</td></tr>
<tr class="memdesc:ga4d4ef679fdd3837893a10a18265aa5f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect a signal with a chunk. <br /></td></tr>
<tr class="memitem:gaa4ea9c620797c1aa775eed6d9bb4cd30" id="r_gaa4ea9c620797c1aa775eed6d9bb4cd30"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa4ea9c620797c1aa775eed6d9bb4cd30">l4shmc_area_size</a> (l4shmc_area_t const *shmarea)</td></tr>
<tr class="memdesc:gaa4ea9c620797c1aa775eed6d9bb4cd30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get size of shared memory area. <br /></td></tr>
<tr class="memitem:gaf421fb8d6e9bd2085ac13fd93fb00fff" id="r_gaf421fb8d6e9bd2085ac13fd93fb00fff"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf421fb8d6e9bd2085ac13fd93fb00fff">l4shmc_area_size_free</a> (l4shmc_area_t const *shmarea)</td></tr>
<tr class="memdesc:gaf421fb8d6e9bd2085ac13fd93fb00fff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get free size of shared memory area. <br /></td></tr>
<tr class="memitem:ga1f1c979842bcaac02483af57a2f5d004" id="r_ga1f1c979842bcaac02483af57a2f5d004"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1f1c979842bcaac02483af57a2f5d004">l4shmc_area_overhead</a> (void)</td></tr>
<tr class="memdesc:ga1f1c979842bcaac02483af57a2f5d004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get memory overhead per area that is not available for chunks. <br /></td></tr>
<tr class="memitem:ga1036b5366588c627f778fdcf6ea94a14" id="r_ga1036b5366588c627f778fdcf6ea94a14"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1036b5366588c627f778fdcf6ea94a14">l4shmc_chunk_overhead</a> (void)</td></tr>
<tr class="memdesc:ga1036b5366588c627f778fdcf6ea94a14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get memory overhead required in addition to the chunk capacity for adding one chunk. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<p>L4SHM provides a shared memory infrastructure that establishes a shared memory area between multiple parties and uses a fast notification mechanism. </p>
<p>A shared memory area consists of chunks and signals. A chunk is a defined chunk of memory within the memory area with a maximum size. A chunk is filled (written) by a producer and read by a consumer. When a producer has finished writing to the chunk it signals a data ready notification to the consumer.</p>
<p>A consumer attaches to a chunk and waits for the producer to fill the chunk. After reading out the chunk it marks the chunk free again.</p>
<p>A shared memory area can have multiple chunks.</p>
<p>The interface is divided in three roles.</p><ul>
<li>The master role, responsible for setting up a shared memory area.</li>
<li>A producer, generating data into a chunk</li>
<li>A consumer, receiving data.</li>
</ul>
<p>A signal can be connected with a chunk or can be used independently (e.g. for multiple chunks). </p>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ga1f1c979842bcaac02483af57a2f5d004" name="ga1f1c979842bcaac02483af57a2f5d004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1f1c979842bcaac02483af57a2f5d004">&#9670;&#160;</a></span>l4shmc_area_overhead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_area_overhead </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get memory overhead per area that is not available for chunks. </p>
<dl class="section return"><dt>Returns</dt><dd>Size of the overhead in bytes. </dd></dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="gaa4ea9c620797c1aa775eed6d9bb4cd30" name="gaa4ea9c620797c1aa775eed6d9bb4cd30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4ea9c620797c1aa775eed6d9bb4cd30">&#9670;&#160;</a></span>l4shmc_area_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_area_size </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t const *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get size of shared memory area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shmarea</td><td>Shared memory area.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">&gt;0</td><td>Size of the shared memory area. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="gaf421fb8d6e9bd2085ac13fd93fb00fff" name="gaf421fb8d6e9bd2085ac13fd93fb00fff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf421fb8d6e9bd2085ac13fd93fb00fff">&#9670;&#160;</a></span>l4shmc_area_size_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_area_size_free </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t const *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get free size of shared memory area. </p>
<p>To get the max size to pass to l4shmc_add_chunk, subtract <a class="el" href="#ga1036b5366588c627f778fdcf6ea94a14" title="Get memory overhead required in addition to the chunk capacity for adding one chunk.">l4shmc_chunk_overhead()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shmarea</td><td>Shared memory area.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Size of the shared memory area. </dd></dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="gabce1c28a48bc887ebd2923681ab524b2" name="gabce1c28a48bc887ebd2923681ab524b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabce1c28a48bc887ebd2923681ab524b2">&#9670;&#160;</a></span>l4shmc_attach()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_attach </td>
<td>(</td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>shmc_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach to a shared memory area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">shmc_name</td><td>Name of the shared memory area. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">shmarea</td><td>Pointer to shared memory area descriptor to be filled with information for the shared memory area.</td></tr>
</table>
</dd>
</dl>
<p>On success, the data in 'shmarea' contains a client number which can be used to mutual agree about client initialization:</p><ul>
<li><a class="el" href="#gaf078db90961d5f67ea2a84e43f322edd" title="Determine the client number of the shared memory region.">l4shmc_get_client_nr()</a> returns the client number stored in 'shmarea'. The first attached client will get 0 and this number is increased for each attached client.</li>
<li><a class="el" href="#ga9b8015fb4d9a78205d25eadf3da3ad6a" title="Mark this shared memory client as &#39;initialized&#39;.">l4shmc_mark_client_initialized()</a> tells other clients that this client has finished its initialization.</li>
<li><a class="el" href="#gaafac792578e3274613015ed1144aeabc" title="Fetch the _clients_init_done bitmask of the shared memory area.">l4shmc_get_initialized_clients()</a> returns the bitmap of initialized clients attached to this shared memory.</li>
</ul>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a3">examples/libs/shmc/prodcons.c</a>.</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="ga1036b5366588c627f778fdcf6ea94a14" name="ga1036b5366588c627f778fdcf6ea94a14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1036b5366588c627f778fdcf6ea94a14">&#9670;&#160;</a></span>l4shmc_chunk_overhead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_chunk_overhead </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get memory overhead required in addition to the chunk capacity for adding one chunk. </p>
<dl class="section return"><dt>Returns</dt><dd>Size of the overhead in bytes. </dd></dl>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00166">L4_END_DECLS</a>.</p>
</div>
</div>
<a id="ga4d4ef679fdd3837893a10a18265aa5f7" name="ga4d4ef679fdd3837893a10a18265aa5f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d4ef679fdd3837893a10a18265aa5f7">&#9670;&#160;</a></span>l4shmc_connect_chunk_signal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_connect_chunk_signal </td>
<td>(</td>
<td class="paramtype">l4shmc_chunk_t *</td> <td class="paramname"><span class="paramname"><em>chunk</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_signal_t *</td> <td class="paramname"><span class="paramname"><em>signal</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect a signal with a chunk. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chunk</td><td>Chunk to attach the signal to. </td></tr>
<tr><td class="paramname">signal</td><td>Signal to attach.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a7">examples/libs/shmc/prodcons.c</a>.</dd>
</dl>
<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#l00051">L4_INLINE</a>.</p>
</div>
</div>
<a id="ga3b18cf7ff5492e60ba1b9aec99a4a195" name="ga3b18cf7ff5492e60ba1b9aec99a4a195"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b18cf7ff5492e60ba1b9aec99a4a195">&#9670;&#160;</a></span>l4shmc_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> long l4shmc_create </td>
<td>(</td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>shmc_name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a shared memory area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shmc_name</td><td>Name of the shared memory area.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">-L4_ENOMEM</td><td>The requested size is too big. </td></tr>
<tr><td class="paramname">-L4_ENOENT</td><td>No valid capability with the name of the shared memory area found. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Errors from l4re_rm_attach or l4re_ns_register_obj_srv. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a23">examples/libs/shmc/prodcons.c</a>.</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="gaf078db90961d5f67ea2a84e43f322edd" name="gaf078db90961d5f67ea2a84e43f322edd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf078db90961d5f67ea2a84e43f322edd">&#9670;&#160;</a></span>l4shmc_get_client_nr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_get_client_nr </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t const *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine the client number of the shared memory region. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shmarea</td><td>The shared memory area.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>client number. </dd></dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="gaafac792578e3274613015ed1144aeabc" name="gaafac792578e3274613015ed1144aeabc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaafac792578e3274613015ed1144aeabc">&#9670;&#160;</a></span>l4shmc_get_initialized_clients()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_get_initialized_clients </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> *</td> <td class="paramname"><span class="paramname"><em>bitmask</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch the <span class="tt">_clients_init_done</span> bitmask of the shared memory area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>The shared memory area. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">bitmask</td><td>The bitmask describing which clients are initialized.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga9b8015fb4d9a78205d25eadf3da3ad6a" title="Mark this shared memory client as &#39;initialized&#39;.">l4shmc_mark_client_initialized()</a>, <a class="el" href="#gaf078db90961d5f67ea2a84e43f322edd" title="Determine the client number of the shared memory region.">l4shmc_get_client_nr()</a> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a12">examples/libs/shmc/prodcons.c</a>.</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="ga9b8015fb4d9a78205d25eadf3da3ad6a" name="ga9b8015fb4d9a78205d25eadf3da3ad6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9b8015fb4d9a78205d25eadf3da3ad6a">&#9670;&#160;</a></span>l4shmc_mark_client_initialized()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_mark_client_initialized </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mark this shared memory client as 'initialized'. </p>
<p>The corresponding bit is set in the <span class="tt">_clients_init_done</span> bitmask. The bitmask can be fetched with <a class="el" href="#gaafac792578e3274613015ed1144aeabc" title="Fetch the _clients_init_done bitmask of the shared memory area.">l4shmc_get_initialized_clients()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shmarea</td><td>The shared memory area.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a8">examples/libs/shmc/prodcons.c</a>.</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</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>
Reference in New Issue View Git Blame Copy Permalink