Files
moslab-code/doc/source/html/l4_2sys_2task_8h.html
2025-09-12 15:55:45 +02:00

176 lines
16 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/sys/task.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('l4_2sys_2task_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">task.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Common task related definitions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="l4_2sys_2utcb_8h_source.html">l4/sys/utcb.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="l4_2sys_2ipc_8h_source.html">l4/sys/ipc.h</a>&gt;</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 task.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="l4_2sys_2task_8h__incl.svg" width="727" height="476"><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="l4_2sys_2task_8h__dep__incl.svg" width="5650" height="726"><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="l4_2sys_2task_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-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga23a759356490c4b1feffc9f36440a82d" id="r_ga23a759356490c4b1feffc9f36440a82d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__protocol__ops.html#ga23a759356490c4b1feffc9f36440a82d">L4_task_ops</a> { <br />
&#160;&#160;<a class="el" href="group__l4__protocol__ops.html#gga23a759356490c4b1feffc9f36440a82daa704ed64f23f28237d3889170e835a8b">L4_TASK_MAP_OP</a> = 0UL
, <a class="el" href="group__l4__protocol__ops.html#gga23a759356490c4b1feffc9f36440a82dacf2f7d650b09524d1f2890c55ac42c04">L4_TASK_UNMAP_OP</a> = 1UL
, <a class="el" href="group__l4__protocol__ops.html#gga23a759356490c4b1feffc9f36440a82da6075e7dab8204f782790fc1279db0130">L4_TASK_CAP_INFO_OP</a> = 2UL
, <a class="el" href="group__l4__protocol__ops.html#gga23a759356490c4b1feffc9f36440a82da361352c492a08a7426a986219b2058b3">L4_TASK_ADD_KU_MEM_OP</a> = 3UL
, <br />
&#160;&#160;<a class="el" href="group__l4__protocol__ops.html#gga23a759356490c4b1feffc9f36440a82da1dc147565402a8c98f9a19a087f0062a">L4_TASK_LDT_SET_X86_OP</a> = 0x11UL
, <a class="el" href="group__l4__protocol__ops.html#gga23a759356490c4b1feffc9f36440a82da317f1418430c7753e2a6655caa8ca420">L4_TASK_MAP_VGICC_ARM_OP</a> = 0x12UL
<br />
}</td></tr>
<tr class="memdesc:ga23a759356490c4b1feffc9f36440a82d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operations on task objects. <a href="group__l4__protocol__ops.html#ga23a759356490c4b1feffc9f36440a82d">More...</a><br /></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:ga8ed2ff7ba204de7c01311c22412a2063" id="r_ga8ed2ff7ba204de7c01311c22412a2063"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#ga8ed2ff7ba204de7c01311c22412a2063">l4_task_map</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> dst_task, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> src_task, <a class="el" href="unionl4__fpage__t.html">l4_fpage_t</a> snd_fpage, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> snd_base) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga8ed2ff7ba204de7c01311c22412a2063"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map resources available in the source task to a destination task. <br /></td></tr>
<tr class="memitem:gaa5558855716b35c1790b61249cf2974b" id="r_gaa5558855716b35c1790b61249cf2974b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#gaa5558855716b35c1790b61249cf2974b">l4_task_unmap</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="unionl4__fpage__t.html">l4_fpage_t</a> fpage, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> map_mask) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaa5558855716b35c1790b61249cf2974b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Revoke rights from the task. <br /></td></tr>
<tr class="memitem:ga3632af3a1c0c1b0f011494dd60fabe41" id="r_ga3632af3a1c0c1b0f011494dd60fabe41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#ga3632af3a1c0c1b0f011494dd60fabe41">l4_task_unmap_batch</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="unionl4__fpage__t.html">l4_fpage_t</a> const *fpages, unsigned num_fpages, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> map_mask) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga3632af3a1c0c1b0f011494dd60fabe41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Revoke rights from a task. <br /></td></tr>
<tr class="memitem:gaf0ce40ee0426a016cb344370d20d2fcd" id="r_gaf0ce40ee0426a016cb344370d20d2fcd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#gaf0ce40ee0426a016cb344370d20d2fcd">l4_task_delete_obj</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> obj) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaf0ce40ee0426a016cb344370d20d2fcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release capability and delete object. <br /></td></tr>
<tr class="memitem:gafdf0c8d5d6cd5e9489bf9d205bd3b5dc" id="r_gafdf0c8d5d6cd5e9489bf9d205bd3b5dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#gafdf0c8d5d6cd5e9489bf9d205bd3b5dc">l4_task_release_cap</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gafdf0c8d5d6cd5e9489bf9d205bd3b5dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release object capability. <br /></td></tr>
<tr class="memitem:ga829a1b5cb4d5dba33ffee57534a505af" id="r_ga829a1b5cb4d5dba33ffee57534a505af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#ga829a1b5cb4d5dba33ffee57534a505af">l4_task_cap_valid</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga829a1b5cb4d5dba33ffee57534a505af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a capability is present (refers to an object). <br /></td></tr>
<tr class="memitem:ga0cadc0abbf54ac249bae17239c9cfb81" id="r_ga0cadc0abbf54ac249bae17239c9cfb81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#ga0cadc0abbf54ac249bae17239c9cfb81">l4_task_cap_equal</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap_a, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap_b) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga0cadc0abbf54ac249bae17239c9cfb81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test whether two capabilities point to the same object with the same permissions (only considering selected permissions). <br /></td></tr>
<tr class="memitem:ga433356d17f678aa259c6b616aeb476ef" id="r_ga433356d17f678aa259c6b616aeb476ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__task__api.html#ga433356d17f678aa259c6b616aeb476ef">l4_task_add_ku_mem</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="unionl4__fpage__t.html">l4_fpage_t</a> *ku_mem) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga433356d17f678aa259c6b616aeb476ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add kernel-user memory. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common task related definitions. </p>
<p class="definition">Definition in file <a class="el" href="l4_2sys_2task_8h_source.html">task.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>sys</b></li><li class="navelem"><a href="l4_2sys_2task_8h.html">task.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>