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

624 lines
37 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: Kernel Debugger</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__l4__debugger__api.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">Kernel Debugger <div class="ingroups"><a class="el" href="group__l4__api.html">Base API</a> &raquo; <a class="el" href="group__api__calls__fiasco.html">Fiasco extensions</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Kernel debugger related functionality.
<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 Kernel Debugger:</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__l4__debugger__api.svg" width="328" height="36"><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-files" class="groupheader"><a id="files" name="files"></a>
Files</h2></td></tr>
<tr class="memitem:kdebug_2Eh" id="r_kdebug_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="kdebug_8h.html">kdebug.h</a></td></tr>
<tr class="memdesc:kdebug_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functionality for invoking the kernel debugger. <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:ga531493fd992a2eb5ad5f24e7e180ccab" id="r_ga531493fd992a2eb5ad5f24e7e180ccab"><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="#ga531493fd992a2eb5ad5f24e7e180ccab">l4_debugger_set_object_name</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, const char *name) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga531493fd992a2eb5ad5f24e7e180ccab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the name of a kernel object. <br /></td></tr>
<tr class="memitem:ga0cf4ccc8d042b0a0a5a4e19aca37fed3" id="r_ga0cf4ccc8d042b0a0a5a4e19aca37fed3"><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="#ga0cf4ccc8d042b0a0a5a4e19aca37fed3">l4_debugger_get_object_name</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, unsigned id, char *name, unsigned size) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga0cf4ccc8d042b0a0a5a4e19aca37fed3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get name of the kernel object with Id <span class="tt">id</span>. <br /></td></tr>
<tr class="memitem:gadfa30ada361d59a07b0187fbc006f56d" id="r_gadfa30ada361d59a07b0187fbc006f56d"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gadfa30ada361d59a07b0187fbc006f56d">l4_debugger_global_id</a> (<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:gadfa30ada361d59a07b0187fbc006f56d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the globally unique ID of the object behind a capability. <br /></td></tr>
<tr class="memitem:ga3caffa3020eed1d69c3c73fd8a332a5d" id="r_ga3caffa3020eed1d69c3c73fd8a332a5d"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3caffa3020eed1d69c3c73fd8a332a5d">l4_debugger_kobj_to_id</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> kobjp) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga3caffa3020eed1d69c3c73fd8a332a5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the globally unique ID of the object behind the kobject pointer. <br /></td></tr>
<tr class="memitem:ga3be4f2a1dbb3252d62217dfa2e3bac5f" id="r_ga3be4f2a1dbb3252d62217dfa2e3bac5f"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3be4f2a1dbb3252d62217dfa2e3bac5f">l4_debugger_query_log_typeid</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, const char *name, unsigned idx) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga3be4f2a1dbb3252d62217dfa2e3bac5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query the log-id for a log type. <br /></td></tr>
<tr class="memitem:ga4e91ec4087d3941028ecb1693d0d451a" id="r_ga4e91ec4087d3941028ecb1693d0d451a"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4e91ec4087d3941028ecb1693d0d451a">l4_debugger_query_log_name</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, unsigned idx, char *name, unsigned namelen, char *shortname, unsigned shortnamelen) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga4e91ec4087d3941028ecb1693d0d451a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query the name of a log type given the ID. <br /></td></tr>
<tr class="memitem:gaeab27982e1db8d0795ee9bc3f8786bdb" id="r_gaeab27982e1db8d0795ee9bc3f8786bdb"><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="#gaeab27982e1db8d0795ee9bc3f8786bdb">l4_debugger_switch_log</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, const char *name, int on_off) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaeab27982e1db8d0795ee9bc3f8786bdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set or unset log. <br /></td></tr>
<tr class="memitem:ga26d3c64b1f5641a742e031c8293e914d" id="r_ga26d3c64b1f5641a742e031c8293e914d"><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="#ga26d3c64b1f5641a742e031c8293e914d">l4_debugger_add_image_info</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> base, const char *name) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:ga26d3c64b1f5641a742e031c8293e914d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add loaded image information for a task. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<p>Kernel debugger related functionality. </p>
<dl class="section attention"><dt>Attention</dt><dd>This API is subject to change!</dd></dl>
<p>This is a debugging facility, any call to any function might be invalid. Do not rely on it in any real code.</p>
<dl class="section user"><dt>Include File</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="debugger_8h.html">l4/sys/debugger.h</a>&gt;</span> </div>
<div class="ttc" id="adebugger_8h_html"><div class="ttname"><a href="debugger_8h.html">debugger.h</a></div><div class="ttdoc">Debugger related definitions.</div></div>
</div><!-- fragment --> </dd></dl>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ga26d3c64b1f5641a742e031c8293e914d" name="ga26d3c64b1f5641a742e031c8293e914d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26d3c64b1f5641a742e031c8293e914d">&#9670;&#160;</a></span>l4_debugger_add_image_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a> l4_debugger_add_image_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a></td> <td class="paramname"><span class="paramname"><em>base</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add loaded image information for a task. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Capability which refers to the task object. </td></tr>
<tr><td class="paramname">base</td><td>Load base address of image. </td></tr>
<tr><td class="paramname">name</td><td>Image base name.</td></tr>
</table>
</dd>
</dl>
<p>This is a debugging facility, the call might be invalid. </p>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00417">417</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</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="group__l4__debugger__api_ga26d3c64b1f5641a742e031c8293e914d_cgraph.svg" width="342" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ga0cf4ccc8d042b0a0a5a4e19aca37fed3" name="ga0cf4ccc8d042b0a0a5a4e19aca37fed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0cf4ccc8d042b0a0a5a4e19aca37fed3">&#9670;&#160;</a></span>l4_debugger_get_object_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a> l4_debugger_get_object_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of the kernel object with Id <span class="tt">id</span>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">cap</td><td>Capability of the debugger object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">id</td><td>Global id of the object whose name is asked. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> to copy the name into. The buffer must be allocated by the caller. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">size</td><td>Length of the <span class="tt">name</span> buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Syscall return tag </dd></dl>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00410">410</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_ga0cf4ccc8d042b0a0a5a4e19aca37fed3_cgraph.svg" width="350" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="gadfa30ada361d59a07b0187fbc006f56d" name="gadfa30ada361d59a07b0187fbc006f56d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadfa30ada361d59a07b0187fbc006f56d">&#9670;&#160;</a></span>l4_debugger_global_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned long l4_debugger_global_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the globally unique ID of the object behind a capability. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Capability</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">~0UL</td><td>Capability is not valid. </td></tr>
<tr><td class="paramname">otherwise</td><td>Global debugger id.</td></tr>
</table>
</dd>
</dl>
<p>This is a debugging facility, the call might be invalid. </p>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00375">375</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_gadfa30ada361d59a07b0187fbc006f56d_cgraph.svg" width="296" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ga3caffa3020eed1d69c3c73fd8a332a5d" name="ga3caffa3020eed1d69c3c73fd8a332a5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3caffa3020eed1d69c3c73fd8a332a5d">&#9670;&#160;</a></span>l4_debugger_kobj_to_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned long l4_debugger_kobj_to_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a></td> <td class="paramname"><span class="paramname"><em>kobjp</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the globally unique ID of the object behind the kobject pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Capability </td></tr>
<tr><td class="paramname">kobjp</td><td>Kobject pointer</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">~0UL</td><td>The capability or the kobject pointer are invalid. </td></tr>
<tr><td class="paramname">otherwise</td><td>The globally unique id.</td></tr>
</table>
</dd>
</dl>
<p>This is a debugging facility, the call might be invalid. </p>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00381">381</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_ga3caffa3020eed1d69c3c73fd8a332a5d_cgraph.svg" width="303" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ga4e91ec4087d3941028ecb1693d0d451a" name="ga4e91ec4087d3941028ecb1693d0d451a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e91ec4087d3941028ecb1693d0d451a">&#9670;&#160;</a></span>l4_debugger_query_log_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long l4_debugger_query_log_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>namelen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>shortname</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>shortnamelen</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Query the name of a log type given the ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Debugger capability. </td></tr>
<tr><td class="paramname">idx</td><td>ID to query. </td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> to copy name to. </td></tr>
<tr><td class="paramname">namelen</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> length of name. </td></tr>
<tr><td class="paramname">shortname</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> to copy <span class="tt">shortname</span> to. </td></tr>
<tr><td class="paramname">shortnamelen</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> length of <span class="tt">shortname</span>.</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>
<p>This is a debugging facility, the call might be invalid. </p>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00394">394</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-5" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_ga4e91ec4087d3941028ecb1693d0d451a_cgraph.svg" width="346" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ga3be4f2a1dbb3252d62217dfa2e3bac5f" name="ga3be4f2a1dbb3252d62217dfa2e3bac5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3be4f2a1dbb3252d62217dfa2e3bac5f">&#9670;&#160;</a></span>l4_debugger_query_log_typeid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long l4_debugger_query_log_typeid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Query the log-id for a log type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Debugger capability </td></tr>
<tr><td class="paramname">name</td><td>Name to query for. </td></tr>
<tr><td class="paramname">idx</td><td>Idx to start searching, start with 0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>positive ID, or negative error code</dd></dl>
<p>This is a debugging facility, the call might be invalid. </p>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00387">387</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-6" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_ga3be4f2a1dbb3252d62217dfa2e3bac5f_cgraph.svg" width="302" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ga531493fd992a2eb5ad5f24e7e180ccab" name="ga531493fd992a2eb5ad5f24e7e180ccab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga531493fd992a2eb5ad5f24e7e180ccab">&#9670;&#160;</a></span>l4_debugger_set_object_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a> l4_debugger_set_object_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the name of a kernel object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Capability which refers to the kernel object. </td></tr>
<tr><td class="paramname">name</td><td>Name of the kernel object that is e.g. displayed in the kernel debugger.</td></tr>
</table>
</dd>
</dl>
<p>This is a debugging facility, the call might be invalid. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a2">examples/libs/shmc/prodcons.c</a>, and <a class="el" href="examples_2sys_2aliens_2main_8c-example.html#a23">examples/sys/aliens/main.c</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00368">368</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-7" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-7-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_ga531493fd992a2eb5ad5f24e7e180ccab_cgraph.svg" width="348" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="gaeab27982e1db8d0795ee9bc3f8786bdb" name="gaeab27982e1db8d0795ee9bc3f8786bdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeab27982e1db8d0795ee9bc3f8786bdb">&#9670;&#160;</a></span>l4_debugger_switch_log()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a> l4_debugger_switch_log </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>on_off</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set or unset log. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cap</td><td>Debugger object. </td></tr>
<tr><td class="paramname">name</td><td>Name of the log type. </td></tr>
<tr><td class="paramname">on_off</td><td>1: turn log on, 0: turn log off</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Syscall return tag </dd></dl>
<p class="definition">Definition at line <a class="el" href="debugger_8h_source.html#l00403">403</a> of file <a class="el" href="debugger_8h_source.html">debugger.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00161">L4_NOTHROW</a>, and <a class="el" href="l4_2sys_2utcb_8h_source.html#l00346">l4_utcb()</a>.</p>
<div id="dynsection-8" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-8-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4__debugger__api_gaeab27982e1db8d0795ee9bc3f8786bdb_cgraph.svg" width="307" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</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>