universalisos/docs/html/posix-personality/group__instrumon__tsd.html
Fábio Coutada 7855eab092 feat(import): Complete PikeOS 5.0 ecosystem import from devvm-arch
MAJOR MILESTONE: Successfully imported complete PikeOS 5.0 ecosystem
from Virtual Machine 100 (devvm-arch) on gigabyte Proxmox server.

Import Summary:
- Source Code: 4.3GB, 63,441 files, 14,829 C/C++/H files
- Documentation: 78MB, 37+ PDF manuals covering all PikeOS aspects
- XSD Schemas: 1.8MB, 158 schema files for configuration/code generation
- Test Framework: Complete TFW infrastructure in src/tfw/

Key Components:
 Multi-architecture kernels (ARM v7/v8, PowerPC e500/e500mc/e5500, x86_64)
 Core source libraries (libstand, ssw, p4ext)
 Complete test framework with executables, includes, libraries
 37+ comprehensive PDF documentation (installation, development, platform manuals)
 158 XSD schemas for Eclipse-based code generation and configuration
 AUTOSAR/MISRA safety-critical compliance foundation
 Hardware virtualization support
 Eclipse IDE project configuration (.project, .cproject)

Documentation Categories:
- Installation & User Guides (pikeos-installation-guide.pdf, user manuals)
- Development References (kernel, driver, test framework manuals)
- API & Programming (C/C++ environments, native API extensions)
- Platform Manuals (ARM, PowerPC, x86 specific guides)
- CDK Documentation (gcc, binutils, ld, cpp internals)
- Release Notes (all components for 5.0.3)
- Specialized Topics (hardware virtualization, POSIX compliance)

Technical Achievements:
 Complete PikeOS 5.0 codebase across multiple processor architectures
 Safety-critical foundation with AUTOSAR/MISRA compliance
 Eclipse IDE integration with XSD-driven code generation pipeline
 Comprehensive test framework for validation and verification
 Complete documentation covering development, deployment, and optimization

Extraction Method:
- Source: VM 100 (devvm-arch) on gigabyte server (192.168.0.104)
- Method: Direct LVM disk mount via losetup, rsync transfer
- Size: Total 4.4GB extracted and organized

Next Phases:
- Phase 3: XSD Workflow Analysis (Day 8-10)
- Phase 4: Safety Standards Compliance Documentation (Day 11-12)
- Phase 5: Component Categorization (Day 13-14)
- Phase 6: Aurelio Brain Test (Day 15)

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-06 21:01:41 +01:00

252 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Instrumon_tsd</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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</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');
$(document).ready(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">
$(document).ready(function(){initNavTree('group__instrumon__tsd.html','');});
</script>
<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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Instrumon_tsd</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>End of group instrumon_sig</p>
<p>End of group instrumon_thr </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structinstr__tsd__s.html">instr_tsd_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread specific data key description. <a href="structinstr__tsd__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gac628d08894979234978ce35f1465cb9e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structinstr__tsd__s.html">instr_tsd_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__instrumon__tsd.html#gac628d08894979234978ce35f1465cb9e">instr_tsd_t</a></td></tr>
<tr class="memdesc:gac628d08894979234978ce35f1465cb9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread specific data key description. <a href="#gac628d08894979234978ce35f1465cb9e">More...</a><br /></td></tr>
<tr class="separator:gac628d08894979234978ce35f1465cb9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa88b770a102316faf7131c508fade1eb"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__instrumon__tsd.html#gac628d08894979234978ce35f1465cb9e">instr_tsd_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__instrumon__tsd.html#gaa88b770a102316faf7131c508fade1eb">instr_tsd_set_t</a>[<a class="el" href="instrumon__api_8h.html#a73fef1f026af8cf8318b5f00a367fa3c">INSTR_KEYS_MAX</a>]</td></tr>
<tr class="memdesc:gaa88b770a102316faf7131c508fade1eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set of all thread specific data key description. <a href="#gaa88b770a102316faf7131c508fade1eb">More...</a><br /></td></tr>
<tr class="separator:gaa88b770a102316faf7131c508fade1eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga45122e61ef492218dacb1d10a1aaf45d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="instrumon__api_8h.html#adc67de54a02c9e862daac18598cf54a8">instr_e_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__instrumon__tsd.html#ga45122e61ef492218dacb1d10a1aaf45d">instr_one_tsd_key</a> (<a class="el" href="instrumon__api_8h.html#a0396bf2339512322562c92b6ca58350f">instr_t</a> handle, unsigned int ndx, <a class="el" href="group__instrumon__tsd.html#gac628d08894979234978ce35f1465cb9e">instr_tsd_t</a> *key)</td></tr>
<tr class="memdesc:ga45122e61ef492218dacb1d10a1aaf45d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve description of one thread specific data key. <a href="#ga45122e61ef492218dacb1d10a1aaf45d">More...</a><br /></td></tr>
<tr class="separator:ga45122e61ef492218dacb1d10a1aaf45d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga412b3108c1dc0a21831b845e877e1488"><td class="memItemLeft" align="right" valign="top"><a class="el" href="instrumon__api_8h.html#adc67de54a02c9e862daac18598cf54a8">instr_e_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__instrumon__tsd.html#ga412b3108c1dc0a21831b845e877e1488">instr_all_tsd_keys</a> (<a class="el" href="instrumon__api_8h.html#a0396bf2339512322562c92b6ca58350f">instr_t</a> handle, <a class="el" href="group__instrumon__tsd.html#gaa88b770a102316faf7131c508fade1eb">instr_tsd_set_t</a> keys)</td></tr>
<tr class="memdesc:ga412b3108c1dc0a21831b845e877e1488"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve descriptions of all thread specific data keys. <a href="#ga412b3108c1dc0a21831b845e877e1488">More...</a><br /></td></tr>
<tr class="separator:ga412b3108c1dc0a21831b845e877e1488"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gac628d08894979234978ce35f1465cb9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac628d08894979234978ce35f1465cb9e">&#9670;&nbsp;</a></span>instr_tsd_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structinstr__tsd__s.html">instr_tsd_s</a> <a class="el" href="group__instrumon__tsd.html#gac628d08894979234978ce35f1465cb9e">instr_tsd_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Thread specific data key description. </p>
<p>Information on a thread specific data key, can be retrieved using <a class="el" href="group__instrumon__tsd.html#ga45122e61ef492218dacb1d10a1aaf45d" title="Retrieve description of one thread specific data key. ">instr_one_tsd_key()</a> and is the base type for <a class="el" href="group__instrumon__tsd.html#gaa88b770a102316faf7131c508fade1eb" title="Set of all thread specific data key description. ">instr_tsd_set_t</a>. Thread specific data of a thread is contained in <em><a class="el" href="structinstr__thr__s.html" title="Thread state description. ">instr_thr_s</a></em> (see {API_instr_thr_s}). </p>
</div>
</div>
<a id="gaa88b770a102316faf7131c508fade1eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa88b770a102316faf7131c508fade1eb">&#9670;&nbsp;</a></span>instr_tsd_set_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__instrumon__tsd.html#gac628d08894979234978ce35f1465cb9e">instr_tsd_t</a> instr_tsd_set_t[<a class="el" href="instrumon__api_8h.html#a73fef1f026af8cf8318b5f00a367fa3c">INSTR_KEYS_MAX</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set of all thread specific data key description. </p>
<p>Array type containing information on all thread specific data keys, can be retrieved using <a class="el" href="group__instrumon__tsd.html#ga412b3108c1dc0a21831b845e877e1488" title="Retrieve descriptions of all thread specific data keys. ">instr_all_tsd_keys()</a>. The actual number of valid entries is stored in structure member <em>key_num</em> of <a class="el" href="structinstr__app__config__s.html" title="Application configuration of monitored application. ">instr_app_config_s</a>. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga45122e61ef492218dacb1d10a1aaf45d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45122e61ef492218dacb1d10a1aaf45d">&#9670;&nbsp;</a></span>instr_one_tsd_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="instrumon__api_8h.html#adc67de54a02c9e862daac18598cf54a8">instr_e_t</a> instr_one_tsd_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="instrumon__api_8h.html#a0396bf2339512322562c92b6ca58350f">instr_t</a>&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>ndx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__instrumon__tsd.html#gac628d08894979234978ce35f1465cb9e">instr_tsd_t</a> *&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve description of one thread specific data key. </p>
<p><br />
Returns the description of the thread specific data key specified by its index <em>ndx</em> in the monitored application referred to by <em>handle</em> and stores it in <em>key</em>. </p><dl class="section return"><dt>Returns</dt><dd></dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">INSTR_E_OK</td><td>Upon successful completion. </td></tr>
<tr><td class="paramname">INSTR_E_INVAL</td><td>Invalid Instrumon handle. </td></tr>
<tr><td class="paramname">INSTR_E_INVAL</td><td>Invalid key index. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Instrumon handle. </td></tr>
<tr><td class="paramname">ndx</td><td>Thread specific data key index. <br />
The PikeOS/POSIX implementation uses integer types for <em>pthread_key_t</em>, so key values in the implementation correspond to the key index in the Instrumon API. </td></tr>
<tr><td class="paramname">key</td><td>Storage for thread specific data key description. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga412b3108c1dc0a21831b845e877e1488"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga412b3108c1dc0a21831b845e877e1488">&#9670;&nbsp;</a></span>instr_all_tsd_keys()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="instrumon__api_8h.html#adc67de54a02c9e862daac18598cf54a8">instr_e_t</a> instr_all_tsd_keys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="instrumon__api_8h.html#a0396bf2339512322562c92b6ca58350f">instr_t</a>&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__instrumon__tsd.html#gaa88b770a102316faf7131c508fade1eb">instr_tsd_set_t</a>&#160;</td>
<td class="paramname"><em>keys</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve descriptions of all thread specific data keys. </p>
<p><br />
Returns the description of all thread specific data keys in the monitored application referred to by <em>handle</em> and stores them in <em>keys</em>. </p><dl class="section return"><dt>Returns</dt><dd></dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">INSTR_E_OK</td><td>Upon successful completion. </td></tr>
<tr><td class="paramname">INSTR_E_INVAL</td><td>Invalid Instrumon handle. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Instrumon handle. </td></tr>
<tr><td class="paramname">keys</td><td>Storage for thread specific data key description set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">(C) Copyright SYSGO AG</li>
</ul>
</div>
</body>
</html>