237 lines
31 KiB
HTML
237 lines
31 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: l4/shmc/shmc.h File Reference</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('shmc_8h.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">shmc.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Shared memory library header file.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="compiler_8h_source.html">l4/sys/compiler.h</a>></code><br />
|
|
<code>#include <l4/sys/linkage.h></code><br />
|
|
<code>#include <<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>></code><br />
|
|
<code>#include <<a class="el" href="err_8h_source.html">l4/sys/err.h</a>></code><br />
|
|
<code>#include <l4/shmc/types.h></code><br />
|
|
<code>#include <l4/shmc/internal.h></code><br />
|
|
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Include dependency graph for shmc.h:</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="shmc_8h__incl.svg" width="1072" height="330"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
</div><div class="textblock"><div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>This graph shows which files directly or indirectly include this file:</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="shmc_8h__dep__incl.svg" width="146" height="110"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
</div>
|
|
<p><a href="shmc_8h_source.html">Go to the source code of this file.</a></p>
|
|
<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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#ga3b18cf7ff5492e60ba1b9aec99a4a195">l4shmc_create</a> (char const *shmc_name)</td></tr>
|
|
<tr class="memdesc:ga3b18cf7ff5492e60ba1b9aec99a4a195"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#gabce1c28a48bc887ebd2923681ab524b2">l4shmc_attach</a> (char const *shmc_name, l4shmc_area_t *shmarea)</td></tr>
|
|
<tr class="memdesc:gabce1c28a48bc887ebd2923681ab524b2"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#gaf078db90961d5f67ea2a84e43f322edd">l4shmc_get_client_nr</a> (l4shmc_area_t const *shmarea)</td></tr>
|
|
<tr class="memdesc:gaf078db90961d5f67ea2a84e43f322edd"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#ga9b8015fb4d9a78205d25eadf3da3ad6a">l4shmc_mark_client_initialized</a> (l4shmc_area_t *shmarea)</td></tr>
|
|
<tr class="memdesc:ga9b8015fb4d9a78205d25eadf3da3ad6a"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#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"> </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:gaacecac77ae23e653e1246f2b46934324" id="r_gaacecac77ae23e653e1246f2b46934324"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#gaacecac77ae23e653e1246f2b46934324">l4shmc_add_chunk</a> (l4shmc_area_t *shmarea, char const *chunk_name, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> chunk_capacity, l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gaacecac77ae23e653e1246f2b46934324"><td class="mdescLeft"> </td><td class="mdescRight">Add a chunk in the shared memory area. <br /></td></tr>
|
|
<tr class="memitem:gae05b27f98a6e59a2a8aa6856d3f9425d" id="r_gae05b27f98a6e59a2a8aa6856d3f9425d"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal.html#gae05b27f98a6e59a2a8aa6856d3f9425d">l4shmc_add_signal</a> (l4shmc_area_t *shmarea, char const *signal_name, l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:gae05b27f98a6e59a2a8aa6856d3f9425d"><td class="mdescLeft"> </td><td class="mdescRight">Add a signal for the shared memory area. <br /></td></tr>
|
|
<tr class="memitem:ga2762193edfb3693911b57343fd5e6b37" id="r_ga2762193edfb3693911b57343fd5e6b37"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__prod.html#ga2762193edfb3693911b57343fd5e6b37">l4shmc_trigger</a> (l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:ga2762193edfb3693911b57343fd5e6b37"><td class="mdescLeft"> </td><td class="mdescRight">Trigger a signal. <br /></td></tr>
|
|
<tr class="memitem:gad1e169157b30f4b02c9770a592b718e8" id="r_gad1e169157b30f4b02c9770a592b718e8"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html#gad1e169157b30f4b02c9770a592b718e8">l4shmc_chunk_try_to_take</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gad1e169157b30f4b02c9770a592b718e8"><td class="mdescLeft"> </td><td class="mdescRight">Try to mark chunk busy. <br /></td></tr>
|
|
<tr class="memitem:ga964fa7017b97a1b8c8941372a42a505a" id="r_ga964fa7017b97a1b8c8941372a42a505a"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html#ga964fa7017b97a1b8c8941372a42a505a">l4shmc_chunk_try_to_take_for_writing</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga964fa7017b97a1b8c8941372a42a505a"><td class="mdescLeft"> </td><td class="mdescRight">Try to mark chunk busy writing. <br /></td></tr>
|
|
<tr class="memitem:ga607118f1db9673e9a36ce302262ff023" id="r_ga607118f1db9673e9a36ce302262ff023"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html#ga607118f1db9673e9a36ce302262ff023">l4shmc_chunk_try_to_take_for_overwriting</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga607118f1db9673e9a36ce302262ff023"><td class="mdescLeft"> </td><td class="mdescRight">Try to mark the chunk busy writing after it was ready for reading. <br /></td></tr>
|
|
<tr class="memitem:gaf036796bc923ff50feffdf142cf04ace" id="r_gaf036796bc923ff50feffdf142cf04ace"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#gaf036796bc923ff50feffdf142cf04ace">l4shmc_chunk_try_to_take_for_reading</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gaf036796bc923ff50feffdf142cf04ace"><td class="mdescLeft"> </td><td class="mdescRight">Try to mark chunk busy reading. <br /></td></tr>
|
|
<tr class="memitem:gaa478271039c7a5e4aee854a4b0d74b5c" id="r_gaa478271039c7a5e4aee854a4b0d74b5c"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html#gaa478271039c7a5e4aee854a4b0d74b5c">l4shmc_chunk_ready</a> (l4shmc_chunk_t *chunk, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> size)</td></tr>
|
|
<tr class="memdesc:gaa478271039c7a5e4aee854a4b0d74b5c"><td class="mdescLeft"> </td><td class="mdescRight">Mark chunk as filled (ready). <br /></td></tr>
|
|
<tr class="memitem:ga281d0d34edf25fa2197f365bc4c4565c" id="r_ga281d0d34edf25fa2197f365bc4c4565c"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html#ga281d0d34edf25fa2197f365bc4c4565c">l4shmc_chunk_ready_sig</a> (l4shmc_chunk_t *chunk, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> size)</td></tr>
|
|
<tr class="memdesc:ga281d0d34edf25fa2197f365bc4c4565c"><td class="mdescLeft"> </td><td class="mdescRight">Mark chunk as filled (ready) and signal consumer. <br /></td></tr>
|
|
<tr class="memitem:ga3e2f5aadb44747d7c8310d38289a98fb" id="r_ga3e2f5aadb44747d7c8310d38289a98fb"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#ga3e2f5aadb44747d7c8310d38289a98fb">l4shmc_get_chunk</a> (l4shmc_area_t *shmarea, char const *chunk_name, l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga3e2f5aadb44747d7c8310d38289a98fb"><td class="mdescLeft"> </td><td class="mdescRight">Get chunk out of shared memory area. <br /></td></tr>
|
|
<tr class="memitem:gac72e7a7c8c7538f46465124fa50f38a4" id="r_gac72e7a7c8c7538f46465124fa50f38a4"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#gac72e7a7c8c7538f46465124fa50f38a4">l4shmc_get_chunk_to</a> (l4shmc_area_t *shmarea, char const *chunk_name, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> timeout_ms, l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gac72e7a7c8c7538f46465124fa50f38a4"><td class="mdescLeft"> </td><td class="mdescRight">Get chunk out of shared memory area, with timeout. <br /></td></tr>
|
|
<tr class="memitem:ga31d12658a159af46afa9f016343fb0c8" id="r_ga31d12658a159af46afa9f016343fb0c8"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#ga31d12658a159af46afa9f016343fb0c8">l4shmc_iterate_chunk</a> (l4shmc_area_t const *shmarea, char const **chunk_name, long offs)</td></tr>
|
|
<tr class="memdesc:ga31d12658a159af46afa9f016343fb0c8"><td class="mdescLeft"> </td><td class="mdescRight">Iterate over names of all existing chunks. <br /></td></tr>
|
|
<tr class="memitem:ga064c2b3e6a04900e35922d157b049232" id="r_ga064c2b3e6a04900e35922d157b049232"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal.html#ga064c2b3e6a04900e35922d157b049232">l4shmc_attach_signal</a> (l4shmc_area_t *shmarea, char const *signal_name, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> thread, l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:ga064c2b3e6a04900e35922d157b049232"><td class="mdescLeft"> </td><td class="mdescRight">Attach to signal. <br /></td></tr>
|
|
<tr class="memitem:ga4ebf2ff8f2041c71fe967582d6f9d622" id="r_ga4ebf2ff8f2041c71fe967582d6f9d622"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal.html#ga4ebf2ff8f2041c71fe967582d6f9d622">l4shmc_get_signal</a> (l4shmc_area_t *shmarea, char const *signal_name, l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:ga4ebf2ff8f2041c71fe967582d6f9d622"><td class="mdescLeft"> </td><td class="mdescRight">Get signal object from the shared memory area. <br /></td></tr>
|
|
<tr class="memitem:ga3161453b4ffd75416a55994c5b6142ff" id="r_ga3161453b4ffd75416a55994c5b6142ff"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#ga3161453b4ffd75416a55994c5b6142ff">l4shmc_enable_signal</a> (l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:ga3161453b4ffd75416a55994c5b6142ff"><td class="mdescLeft"> </td><td class="mdescRight">Enable a signal. <br /></td></tr>
|
|
<tr class="memitem:gad6b9490fb30e8069243fea04eb1e5920" id="r_gad6b9490fb30e8069243fea04eb1e5920"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#gad6b9490fb30e8069243fea04eb1e5920">l4shmc_enable_chunk</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gad6b9490fb30e8069243fea04eb1e5920"><td class="mdescLeft"> </td><td class="mdescRight">Enable a signal connected with a chunk. <br /></td></tr>
|
|
<tr class="memitem:gacd00f0806e35df2d9fe3adc0f96bc59b" id="r_gacd00f0806e35df2d9fe3adc0f96bc59b"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#gacd00f0806e35df2d9fe3adc0f96bc59b">l4shmc_wait_any</a> (l4shmc_signal_t **retsignal)</td></tr>
|
|
<tr class="memdesc:gacd00f0806e35df2d9fe3adc0f96bc59b"><td class="mdescLeft"> </td><td class="mdescRight">Wait on any signal. <br /></td></tr>
|
|
<tr class="memitem:gaefb2ffef370d4daee379109f47406e2b" id="r_gaefb2ffef370d4daee379109f47406e2b"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#gaefb2ffef370d4daee379109f47406e2b">l4shmc_wait_any_try</a> (l4shmc_signal_t **retsignal)</td></tr>
|
|
<tr class="memdesc:gaefb2ffef370d4daee379109f47406e2b"><td class="mdescLeft"> </td><td class="mdescRight">Check whether any waited signal has an event pending. <br /></td></tr>
|
|
<tr class="memitem:gaf7659f41e8eb97534e19b10f4d5e2251" id="r_gaf7659f41e8eb97534e19b10f4d5e2251"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#gaf7659f41e8eb97534e19b10f4d5e2251">l4shmc_wait_any_to</a> (<a class="el" href="unionl4__timeout__t.html">l4_timeout_t</a> timeout, l4shmc_signal_t **retsignal)</td></tr>
|
|
<tr class="memdesc:gaf7659f41e8eb97534e19b10f4d5e2251"><td class="mdescLeft"> </td><td class="mdescRight">Wait for any signal with timeout. <br /></td></tr>
|
|
<tr class="memitem:gad233b71970dba39afc29f8dd6eedcc1d" id="r_gad233b71970dba39afc29f8dd6eedcc1d"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#gad233b71970dba39afc29f8dd6eedcc1d">l4shmc_wait_signal</a> (l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:gad233b71970dba39afc29f8dd6eedcc1d"><td class="mdescLeft"> </td><td class="mdescRight">Wait on a specific signal. <br /></td></tr>
|
|
<tr class="memitem:gadcfe6466d4ecd586abc35e2f44cd5077" id="r_gadcfe6466d4ecd586abc35e2f44cd5077"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#gadcfe6466d4ecd586abc35e2f44cd5077">l4shmc_wait_signal_to</a> (l4shmc_signal_t *signal, <a class="el" href="unionl4__timeout__t.html">l4_timeout_t</a> timeout)</td></tr>
|
|
<tr class="memdesc:gadcfe6466d4ecd586abc35e2f44cd5077"><td class="mdescLeft"> </td><td class="mdescRight">Wait on a specific signal, with timeout. <br /></td></tr>
|
|
<tr class="memitem:ga5bfea2fd4482966236857773ae7e6748" id="r_ga5bfea2fd4482966236857773ae7e6748"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html#ga5bfea2fd4482966236857773ae7e6748">l4shmc_wait_signal_try</a> (l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:ga5bfea2fd4482966236857773ae7e6748"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a specific signal has an event pending. <br /></td></tr>
|
|
<tr class="memitem:ga54e47ebdb2dd47f06daef36d02a09904" id="r_ga54e47ebdb2dd47f06daef36d02a09904"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#ga54e47ebdb2dd47f06daef36d02a09904">l4shmc_wait_chunk</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga54e47ebdb2dd47f06daef36d02a09904"><td class="mdescLeft"> </td><td class="mdescRight">Wait on a specific chunk. <br /></td></tr>
|
|
<tr class="memitem:gad0abef2e0c7577aedeb4974e2161e5d2" id="r_gad0abef2e0c7577aedeb4974e2161e5d2"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#gad0abef2e0c7577aedeb4974e2161e5d2">l4shmc_wait_chunk_to</a> (l4shmc_chunk_t *chunk, <a class="el" href="unionl4__timeout__t.html">l4_timeout_t</a> timeout)</td></tr>
|
|
<tr class="memdesc:gad0abef2e0c7577aedeb4974e2161e5d2"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a specific chunk has an event pending, with timeout. <br /></td></tr>
|
|
<tr class="memitem:ga1126ff741cc2af2a36fd22eca1c4a05a" id="r_ga1126ff741cc2af2a36fd22eca1c4a05a"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#ga1126ff741cc2af2a36fd22eca1c4a05a">l4shmc_wait_chunk_try</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga1126ff741cc2af2a36fd22eca1c4a05a"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a specific chunk has an event pending. <br /></td></tr>
|
|
<tr class="memitem:ga3a2f46cf0f95b9d50af33a55c7a42d06" id="r_ga3a2f46cf0f95b9d50af33a55c7a42d06"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#ga3a2f46cf0f95b9d50af33a55c7a42d06">l4shmc_chunk_consumed</a> (l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga3a2f46cf0f95b9d50af33a55c7a42d06"><td class="mdescLeft"> </td><td class="mdescRight">Mark a chunk as free. <br /></td></tr>
|
|
<tr class="memitem:ga4d4ef679fdd3837893a10a18265aa5f7" id="r_ga4d4ef679fdd3837893a10a18265aa5f7"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#ga4d4ef679fdd3837893a10a18265aa5f7">l4shmc_connect_chunk_signal</a> (l4shmc_chunk_t *chunk, l4shmc_signal_t *signal)</td></tr>
|
|
<tr class="memdesc:ga4d4ef679fdd3837893a10a18265aa5f7"><td class="mdescLeft"> </td><td class="mdescRight">Connect a signal with a chunk. <br /></td></tr>
|
|
<tr class="memitem:ga3f40b9e52eb2cda60131a401a423cb2f" id="r_ga3f40b9e52eb2cda60131a401a423cb2f"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#ga3f40b9e52eb2cda60131a401a423cb2f">l4shmc_is_chunk_ready</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:ga3f40b9e52eb2cda60131a401a423cb2f"><td class="mdescLeft"> </td><td class="mdescRight">Check whether data is available. <br /></td></tr>
|
|
<tr class="memitem:ga5ea0625e227458ca2bc38b34bc414e5a" id="r_ga5ea0625e227458ca2bc38b34bc414e5a"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html#ga5ea0625e227458ca2bc38b34bc414e5a">l4shmc_is_chunk_clear</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:ga5ea0625e227458ca2bc38b34bc414e5a"><td class="mdescLeft"> </td><td class="mdescRight">Check whether chunk is free. <br /></td></tr>
|
|
<tr class="memitem:gae3d6557c03fec27dbb348ef52bcbc3a6" id="r_gae3d6557c03fec27dbb348ef52bcbc3a6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#gae3d6557c03fec27dbb348ef52bcbc3a6">l4shmc_chunk_ptr</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:gae3d6557c03fec27dbb348ef52bcbc3a6"><td class="mdescLeft"> </td><td class="mdescRight">Get data pointer to chunk. <br /></td></tr>
|
|
<tr class="memitem:gab6b454c50526819b7ce568716fe7aae0" id="r_gab6b454c50526819b7ce568716fe7aae0"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html#gab6b454c50526819b7ce568716fe7aae0">l4shmc_chunk_size</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:gab6b454c50526819b7ce568716fe7aae0"><td class="mdescLeft"> </td><td class="mdescRight">Get current size of a chunk. <br /></td></tr>
|
|
<tr class="memitem:gac6cbec9505bb9d7c7dfac881a602235b" id="r_gac6cbec9505bb9d7c7dfac881a602235b"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#gac6cbec9505bb9d7c7dfac881a602235b">l4shmc_chunk_capacity</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:gac6cbec9505bb9d7c7dfac881a602235b"><td class="mdescLeft"> </td><td class="mdescRight">Get capacity of a chunk. <br /></td></tr>
|
|
<tr class="memitem:ga55b848686a0629e8aa44308acc29f8a5" id="r_ga55b848686a0629e8aa44308acc29f8a5"><td class="memItemLeft" align="right" valign="top">l4shmc_signal_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk.html#ga55b848686a0629e8aa44308acc29f8a5">l4shmc_chunk_signal</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:ga55b848686a0629e8aa44308acc29f8a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the registered signal of a chunk. <br /></td></tr>
|
|
<tr class="memitem:gaa5df3aab1bb149f8225136be03ad7ec8" id="r_gaa5df3aab1bb149f8225136be03ad7ec8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal.html#gaa5df3aab1bb149f8225136be03ad7ec8">l4shmc_signal_cap</a> (l4shmc_signal_t const *signal)</td></tr>
|
|
<tr class="memdesc:gaa5df3aab1bb149f8225136be03ad7ec8"><td class="mdescLeft"> </td><td class="mdescRight">Get the signal capability of a signal. <br /></td></tr>
|
|
<tr class="memitem:gaca094c1631403a80b8202c1c03286410" id="r_gaca094c1631403a80b8202c1c03286410"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal.html#gaca094c1631403a80b8202c1c03286410">l4shmc_check_magic</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:gaca094c1631403a80b8202c1c03286410"><td class="mdescLeft"> </td><td class="mdescRight">Check magic value of a chunk. <br /></td></tr>
|
|
<tr class="memitem:gaa4ea9c620797c1aa775eed6d9bb4cd30" id="r_gaa4ea9c620797c1aa775eed6d9bb4cd30"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#gaa4ea9c620797c1aa775eed6d9bb4cd30">l4shmc_area_size</a> (l4shmc_area_t const *shmarea)</td></tr>
|
|
<tr class="memdesc:gaa4ea9c620797c1aa775eed6d9bb4cd30"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#gaf421fb8d6e9bd2085ac13fd93fb00fff">l4shmc_area_size_free</a> (l4shmc_area_t const *shmarea)</td></tr>
|
|
<tr class="memdesc:gaf421fb8d6e9bd2085ac13fd93fb00fff"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#ga1f1c979842bcaac02483af57a2f5d004">l4shmc_area_overhead</a> (void)</td></tr>
|
|
<tr class="memdesc:ga1f1c979842bcaac02483af57a2f5d004"><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm.html#ga1036b5366588c627f778fdcf6ea94a14">l4shmc_chunk_overhead</a> (void)</td></tr>
|
|
<tr class="memdesc:ga1036b5366588c627f778fdcf6ea94a14"><td class="mdescLeft"> </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>
|
|
<div class="textblock"><p>Shared memory library header file. </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="shmc_8h_source.html">shmc.h</a>.</p>
|
|
</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="navelem"><b>l4</b></li><li class="navelem"><b>shmc</b></li><li class="navelem"><a href="shmc_8h.html">shmc.h</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>
|