180 lines
19 KiB
HTML
180 lines
19 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/re/inhibitor 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('inhibitor_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">inhibitor</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// vim:set ft=cpp: -*- Mode: C++ -*-</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * (c) 2014 Steffen Liebergeld <steffen.liebergeld@kernkonzept.com></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</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="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="code" href="capability.html">l4/sys/capability</a>></span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <<a class="code" href="ipc__iface.html">l4/sys/cxx/ipc_iface</a>></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <l4/sys/cxx/ipc_string></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <<a class="code" href="protocols_8h.html">l4/re/protocols.h</a>></span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4Re.html">L4Re</a> {</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span></div>
|
|
<div class="foldopen" id="foldopen00038" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classL4Re_1_1Inhibitor.html"> 38</a></span><span class="keyword">class </span><a class="code hl_class" href="classL4Re_1_1Inhibitor.html">Inhibitor</a> :</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span> <a class="code hl_class" href="classL4_1_1Kobject__t.html">L4::Kobject_t</a><Inhibitor, L4::Kobject, L4RE_PROTO_INHIBITOR></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>{</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classL4Re_1_1Inhibitor.html#a854ddc23caaf4f72157f7878e4a17fffad10674dcf6cde6eb7acb89dd77bb2bc3"> 44</a></span> <a class="code hl_enumvalue" href="classL4Re_1_1Inhibitor.html#a854ddc23caaf4f72157f7878e4a17fffad10674dcf6cde6eb7acb89dd77bb2bc3">Name_max</a> = 20 </div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> };</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classL4Re_1_1Inhibitor.html#ab220aac3d51cc9c422c04e8b18409179"> 57</a></span> <a class="code hl_define" href="ipc__iface.html#a5772eb61b611f8f17bbc89e02e534ca1">L4_INLINE_RPC</a>(<span class="keywordtype">long</span>, <a class="code hl_function" href="classL4Re_1_1Inhibitor.html#ab220aac3d51cc9c422c04e8b18409179">acquire</a>, (<a class="code hl_typedef" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> <span class="keywordtype">id</span>, L4::Ipc::String<> reason));</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classL4Re_1_1Inhibitor.html#ac228e6e7ba816c85eec1826c65e149d6"> 67</a></span> <a class="code hl_define" href="ipc__iface.html#a5772eb61b611f8f17bbc89e02e534ca1">L4_INLINE_RPC</a>(<span class="keywordtype">long</span>, <a class="code hl_function" href="classL4Re_1_1Inhibitor.html#ac228e6e7ba816c85eec1826c65e149d6">release</a>, (<a class="code hl_typedef" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> <span class="keywordtype">id</span>));</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span></div>
|
|
<div class="foldopen" id="foldopen00084" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classL4Re_1_1Inhibitor.html#aa524589a81a491df8cad60939373d0da"> 84</a></span> <span class="keywordtype">long</span> <a class="code hl_function" href="classL4Re_1_1Inhibitor.html#aa524589a81a491df8cad60939373d0da">next_lock_info</a>(<span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> len, <a class="code hl_typedef" href="group__l4__basic__types.html#ga51d9492e7700d70ed35838154ca9b279">l4_mword_t</a> current_id = -1,</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_typedef" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb = <a class="code hl_function" href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a>())</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> {</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> L4::Ipc::String<char> name_buf(len , name);</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">long</span> r = next_lock_info_t::call(<a class="code hl_function" href="classL4_1_1Kobject__t.html#a3d80fec7e057d575ec4b393437f05f8a">c</a>(), &current_id, name_buf, utcb);</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">if</span> (r < 0)</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">return</span> r;</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordflow">return</span> current_id;</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_define" href="ipc__iface.html#a7bc5bdbe269ef0598c166ed1dd923549">L4_INLINE_RPC_NF</a>(<span class="keywordtype">long</span>, <a class="code hl_function" href="classL4Re_1_1Inhibitor.html#aa524589a81a491df8cad60939373d0da">next_lock_info</a>, (<a class="code hl_struct" href="structL4_1_1Ipc_1_1In__out.html">L4::Ipc::In_out<l4_mword_t *></a> current_id,</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> L4::Ipc::String<char> &name));</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">typedef</span> <a class="code hl_struct" href="structL4_1_1Typeid_1_1Rpcs.html">L4::Typeid::Rpcs<acquire_t, release_t, next_lock_info_t></a> Rpcs;</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</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="aclassL4Re_1_1Inhibitor_html"><div class="ttname"><a href="classL4Re_1_1Inhibitor.html">L4Re::Inhibitor</a></div><div class="ttdoc">Set of inhibitor locks, which inhibit specific actions when held.</div><div class="ttdef"><b>Definition</b> <a href="#l00038">inhibitor:40</a></div></div>
|
|
<div class="ttc" id="aclassL4Re_1_1Inhibitor_html_a854ddc23caaf4f72157f7878e4a17fffad10674dcf6cde6eb7acb89dd77bb2bc3"><div class="ttname"><a href="classL4Re_1_1Inhibitor.html#a854ddc23caaf4f72157f7878e4a17fffad10674dcf6cde6eb7acb89dd77bb2bc3">L4Re::Inhibitor::Name_max</a></div><div class="ttdeci">@ Name_max</div><div class="ttdoc">The maximum length of a lock's name.</div><div class="ttdef"><b>Definition</b> <a href="#l00044">inhibitor:44</a></div></div>
|
|
<div class="ttc" id="aclassL4Re_1_1Inhibitor_html_aa524589a81a491df8cad60939373d0da"><div class="ttname"><a href="classL4Re_1_1Inhibitor.html#aa524589a81a491df8cad60939373d0da">L4Re::Inhibitor::next_lock_info</a></div><div class="ttdeci">long next_lock_info(char *name, unsigned len, l4_mword_t current_id=-1, l4_utcb_t *utcb=l4_utcb())</div><div class="ttdoc">Get information for the next available inhibitor lock.</div><div class="ttdef"><b>Definition</b> <a href="#l00084">inhibitor:84</a></div></div>
|
|
<div class="ttc" id="aclassL4Re_1_1Inhibitor_html_ab220aac3d51cc9c422c04e8b18409179"><div class="ttname"><a href="classL4Re_1_1Inhibitor.html#ab220aac3d51cc9c422c04e8b18409179">L4Re::Inhibitor::acquire</a></div><div class="ttdeci">long acquire(l4_umword_t id, L4::Ipc::String<> reason)</div><div class="ttdoc">Acquire a specific inhibitor lock.</div></div>
|
|
<div class="ttc" id="aclassL4Re_1_1Inhibitor_html_ac228e6e7ba816c85eec1826c65e149d6"><div class="ttname"><a href="classL4Re_1_1Inhibitor.html#ac228e6e7ba816c85eec1826c65e149d6">L4Re::Inhibitor::release</a></div><div class="ttdeci">long release(l4_umword_t id)</div><div class="ttdoc">Release a specific inhibitor lock.</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__t_html_a3d80fec7e057d575ec4b393437f05f8a"><div class="ttname"><a href="classL4_1_1Kobject__t.html#a3d80fec7e057d575ec4b393437f05f8a">L4::Kobject_t< Inhibitor, L4::Kobject, L4RE_PROTO_INHIBITOR >::c</a></div><div class="ttdeci">L4::Cap< Class > c() const noexcept</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00769">__typeinfo.h:769</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__basic__types_html_ga51d9492e7700d70ed35838154ca9b279"><div class="ttname"><a href="group__l4__basic__types.html#ga51d9492e7700d70ed35838154ca9b279">l4_mword_t</a></div><div class="ttdeci">signed long l4_mword_t</div><div class="ttdoc">Signed machine word.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2l4int_8h_source.html#l00037">l4int.h:37</a></div></div>
|
|
<div class="ttc" id="agroup__l4__utcb__api_html_ga89be8a86d11c1d532b636cc2df1330fb"><div class="ttname"><a href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a></div><div class="ttdeci">struct l4_utcb_t l4_utcb_t</div><div class="ttdoc">Opaque type for the UTCB.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2utcb_8h_source.html#l00056">utcb.h:56</a></div></div>
|
|
<div class="ttc" id="agroup__l4__utcb__api_html_gadc099b4a59e1d99638c72c11a8c8b644"><div class="ttname"><a href="group__l4__utcb__api.html#gadc099b4a59e1d99638c72c11a8c8b644">l4_utcb</a></div><div class="ttdeci">l4_utcb_t * l4_utcb(void) L4_NOTHROW L4_PURE</div><div class="ttdoc">Get the UTCB address.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2utcb_8h_source.html#l00346">utcb.h:346</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_a5772eb61b611f8f17bbc89e02e534ca1"><div class="ttname"><a href="ipc__iface.html#a5772eb61b611f8f17bbc89e02e534ca1">L4_INLINE_RPC</a></div><div class="ttdeci">#define L4_INLINE_RPC(res, name, args, attr...)</div><div class="ttdoc">Define an inline RPC call (type and callable).</div><div class="ttdef"><b>Definition</b> <a href="ipc__iface_source.html#l00482">ipc_iface:482</a></div></div>
|
|
<div class="ttc" id="aipc__iface_html_a7bc5bdbe269ef0598c166ed1dd923549"><div class="ttname"><a href="ipc__iface.html#a7bc5bdbe269ef0598c166ed1dd923549">L4_INLINE_RPC_NF</a></div><div class="ttdeci">#define L4_INLINE_RPC_NF(res, name, args...)</div><div class="ttdoc">Define an inline RPC call type (the type only, no callable).</div><div class="ttdef"><b>Definition</b> <a href="ipc__iface_source.html#l00453">ipc_iface:453</a></div></div>
|
|
<div class="ttc" id="anamespaceL4Re_html"><div class="ttname"><a href="namespaceL4Re.html">L4Re</a></div><div class="ttdoc">L4Re C++ Interfaces.</div><div class="ttdef"><b>Definition</b> <a href="cmd__control_source.html#l00014">cmd_control:14</a></div></div>
|
|
<div class="ttc" id="aprotocols_8h_html"><div class="ttname"><a href="protocols_8h.html">protocols.h</a></div><div class="ttdoc">L4Re Protocol Constants (C version).</div></div>
|
|
<div class="ttc" id="astructL4_1_1Ipc_1_1In__out_html"><div class="ttname"><a href="structL4_1_1Ipc_1_1In__out.html">L4::Ipc::In_out</a></div><div class="ttdoc">Mark an argument as in-out argument.</div><div class="ttdef"><b>Definition</b> <a href="ipc__types_source.html#l00041">ipc_types:42</a></div></div>
|
|
<div class="ttc" id="astructL4_1_1Typeid_1_1Rpcs_html"><div class="ttname"><a href="structL4_1_1Typeid_1_1Rpcs.html">L4::Typeid::Rpcs</a></div><div class="ttdoc">Standard list of RPCs of an interface.</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00428">__typeinfo.h:428</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>re</b></li><li class="navelem"><b>inhibitor</b></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>
|