Fábio Coutada
7855eab092
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>
364 lines
23 KiB
HTML
364 lines
23 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>AnisInstr</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__anisInstr.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> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">AnisInstr</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structanis__instr__intf__stat__s.html">anis_instr_intf_stat_s</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ANIS interface specific instrumentation API structure. <a href="structanis__instr__intf__stat__s.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structanis__instr__stat__s.html">anis_instr_stat_s</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ANIS instrumentation API data structure. <a href="structanis__instr__stat__s.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga87cde7850762475b4062da44466de232"><td class="memItemLeft" align="right" valign="top"><a id="ga87cde7850762475b4062da44466de232"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga87cde7850762475b4062da44466de232">ANIS_ALL_INTF</a></td></tr>
|
|
<tr class="memdesc:ga87cde7850762475b4062da44466de232"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of Ethernet interfaces including localhost loopback. <br /></td></tr>
|
|
<tr class="separator:ga87cde7850762475b4062da44466de232"><td class="memSeparator" colspan="2"> </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:ga88f7c4283e8696eda2be7e13be18f694"><td class="memItemLeft" align="right" valign="top"><a id="ga88f7c4283e8696eda2be7e13be18f694"></a>
|
|
typedef enum <a class="el" href="group__anisInstr.html#gaf91532290d03684b42e95516fb9c2fd3">anis_instr_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a></td></tr>
|
|
<tr class="memdesc:ga88f7c4283e8696eda2be7e13be18f694"><td class="mdescLeft"> </td><td class="mdescRight">ANIS instrumentation API service return codes. <br /></td></tr>
|
|
<tr class="separator:ga88f7c4283e8696eda2be7e13be18f694"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga36751e86aa47705c743d6e8e47fe2cdd"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structanis__instr__intf__stat__s.html">anis_instr_intf_stat_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga36751e86aa47705c743d6e8e47fe2cdd">anis_instr_intf_stat_t</a></td></tr>
|
|
<tr class="memdesc:ga36751e86aa47705c743d6e8e47fe2cdd"><td class="mdescLeft"> </td><td class="mdescRight">ANIS interface specific instrumentation API structure. <a href="#ga36751e86aa47705c743d6e8e47fe2cdd">More...</a><br /></td></tr>
|
|
<tr class="separator:ga36751e86aa47705c743d6e8e47fe2cdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1a0f529b5d2b57dc8cbc92fa0dee7797"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structanis__instr__stat__s.html">anis_instr_stat_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga1a0f529b5d2b57dc8cbc92fa0dee7797">anis_instr_stat_t</a></td></tr>
|
|
<tr class="memdesc:ga1a0f529b5d2b57dc8cbc92fa0dee7797"><td class="mdescLeft"> </td><td class="mdescRight">ANIS instrumentation API data structure. <a href="#ga1a0f529b5d2b57dc8cbc92fa0dee7797">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1a0f529b5d2b57dc8cbc92fa0dee7797"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga25f6c7eeec9068160a84f221b9b8f70a"><td class="memItemLeft" align="right" valign="top">typedef vm_file_desc_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a></td></tr>
|
|
<tr class="memdesc:ga25f6c7eeec9068160a84f221b9b8f70a"><td class="mdescLeft"> </td><td class="mdescRight">ANIS instrumentation API handle. <a href="#ga25f6c7eeec9068160a84f221b9b8f70a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga25f6c7eeec9068160a84f221b9b8f70a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gaf91532290d03684b42e95516fb9c2fd3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#gaf91532290d03684b42e95516fb9c2fd3">anis_instr_e</a> { <br />
|
|
  <a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3add96326bbb08c09c72847848f69d79cc">ANIS_INSTR_E_OK</a>,
|
|
<a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3ade3483867d1f6511ee1fc15a91453bef">ANIS_INSTR_E_INVAL</a>,
|
|
<a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3a22c8fcb7b1c12d6035ce0583f506feee">ANIS_INSTR_E_PERM</a>,
|
|
<a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3abf0621224b1cba4a4126043d245e998d">ANIS_INSTR_E_NO_MEM</a>,
|
|
<br />
|
|
  <a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3afc3751b5a17789530924062ecc6723d1">ANIS_INSTR_E_NO_ENT</a>,
|
|
<a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3aaac477d830c436a491d3bf643d804c9e">ANIS_INSTR_E_SYS</a>,
|
|
<a class="el" href="group__anisInstr.html#ggaf91532290d03684b42e95516fb9c2fd3a9f4e2b2e4c165ef6859cab7bb1d577c0">ANIS_INSTR_E_BUSY</a>
|
|
<br />
|
|
}<tr class="memdesc:gaf91532290d03684b42e95516fb9c2fd3"><td class="mdescLeft"> </td><td class="mdescRight">ANIS instrumentation API service return codes. <a href="group__anisInstr.html#gaf91532290d03684b42e95516fb9c2fd3">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gaf91532290d03684b42e95516fb9c2fd3"><td class="memSeparator" colspan="2"> </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:ga139f5b04d531111a0f01404fe164b218"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga139f5b04d531111a0f01404fe164b218">anis_instr_open</a> (const char *name, <a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a> *handle)</td></tr>
|
|
<tr class="separator:ga139f5b04d531111a0f01404fe164b218"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa611edd7b9305541675203dafb2975ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#gaa611edd7b9305541675203dafb2975ea">anis_instr_close</a> (<a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a> *handle)</td></tr>
|
|
<tr class="separator:gaa611edd7b9305541675203dafb2975ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga983328e3daaf32f769fe96b997f9c467"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__anisInstr.html#ga983328e3daaf32f769fe96b997f9c467">anis_instr_read</a> (<a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a> *handle, <a class="el" href="group__anisInstr.html#ga1a0f529b5d2b57dc8cbc92fa0dee7797">anis_instr_stat_t</a> *stats)</td></tr>
|
|
<tr class="separator:ga983328e3daaf32f769fe96b997f9c467"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="ga36751e86aa47705c743d6e8e47fe2cdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga36751e86aa47705c743d6e8e47fe2cdd">◆ </a></span>anis_instr_intf_stat_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structanis__instr__intf__stat__s.html">anis_instr_intf_stat_s</a> <a class="el" href="group__anisInstr.html#ga36751e86aa47705c743d6e8e47fe2cdd">anis_instr_intf_stat_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ANIS interface specific instrumentation API structure. </p>
|
|
<p>This data structure is used to communicate network interface statistics to an application. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1a0f529b5d2b57dc8cbc92fa0dee7797"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1a0f529b5d2b57dc8cbc92fa0dee7797">◆ </a></span>anis_instr_stat_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structanis__instr__stat__s.html">anis_instr_stat_s</a> <a class="el" href="group__anisInstr.html#ga1a0f529b5d2b57dc8cbc92fa0dee7797">anis_instr_stat_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ANIS instrumentation API data structure. </p>
|
|
<p>This data structure is used to communicate network interface statistics to an application. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga25f6c7eeec9068160a84f221b9b8f70a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga25f6c7eeec9068160a84f221b9b8f70a">◆ </a></span>anis_instr_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef vm_file_desc_t <a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ANIS instrumentation API handle. </p>
|
|
<p>This data type is used in the ANIS instrumentation API for handles that identify the open instance of the instrumentation channel. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="gaf91532290d03684b42e95516fb9c2fd3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf91532290d03684b42e95516fb9c2fd3">◆ </a></span>anis_instr_e</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__anisInstr.html#gaf91532290d03684b42e95516fb9c2fd3">anis_instr_e</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ANIS instrumentation API service return codes. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3add96326bbb08c09c72847848f69d79cc"></a>ANIS_INSTR_E_OK </td><td class="fielddoc"><p>The instrumentation API call was successful. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3ade3483867d1f6511ee1fc15a91453bef"></a>ANIS_INSTR_E_INVAL </td><td class="fielddoc"><p>The instrumentation API call failed due to invalid arguments. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3a22c8fcb7b1c12d6035ce0583f506feee"></a>ANIS_INSTR_E_PERM </td><td class="fielddoc"><p>The instrumentation API call failed due to insufficient access rights. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3abf0621224b1cba4a4126043d245e998d"></a>ANIS_INSTR_E_NO_MEM </td><td class="fielddoc"><p>The instrumentation API call failed due to missing resources. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3afc3751b5a17789530924062ecc6723d1"></a>ANIS_INSTR_E_NO_ENT </td><td class="fielddoc"><p>The instrumentation API call failed as the given ANIS instance does not exist. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3aaac477d830c436a491d3bf643d804c9e"></a>ANIS_INSTR_E_SYS </td><td class="fielddoc"><p>The instrumentation API call failed due to an internal error. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaf91532290d03684b42e95516fb9c2fd3a9f4e2b2e4c165ef6859cab7bb1d577c0"></a>ANIS_INSTR_E_BUSY </td><td class="fielddoc"><p>The instrumentation read channel is already open. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga139f5b04d531111a0f01404fe164b218"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga139f5b04d531111a0f01404fe164b218">◆ </a></span>anis_instr_open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a> anis_instr_open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section user"><dt>Purpose</dt><dd>Open an instrumentation connection.</dd></dl>
|
|
<p>This function opens an instrumentation connection on an ANIS instance, specified by parameter <em>name</em>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of ANIS instance. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">handle</td><td>Handle to ANIS instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>On success, the function returns ANIS_INSTR_E_OK and a valid handle in parameter <em>handle</em>.</dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">ANIS_INSTR_E_NO_ENT</td><td>No ANIS instance with the specified name exists.</td></tr>
|
|
<tr><td class="paramname">ANIS_INSTR_E_NO_PERM</td><td>The caller does not have sufficient rights to access the instrumentation statistics.</td></tr>
|
|
<tr><td class="paramname">ANIS_INSTR_E_NO_MEM</td><td>The caller does not have sufficient resources to establish a connection with the ANIS instance.</td></tr>
|
|
<tr><td class="paramname">ANIS_INSTR_E_INVAL</td><td>The length of <em>name</em> exceeds VM_MAX_PATHNAME_LEN.</td></tr>
|
|
<tr><td class="paramname">ANIS_INSTR_E_SYS</td><td>The connection with the ANIS instance failed do to internal reasons. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa611edd7b9305541675203dafb2975ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa611edd7b9305541675203dafb2975ea">◆ </a></span>anis_instr_close()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a> anis_instr_close </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a> * </td>
|
|
<td class="paramname"><em>handle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section user"><dt>Purpose</dt><dd>Close the instrumentation connection.</dd></dl>
|
|
<p>This function closes the instrumentation connection with the ANIS instance referenced by parameter <em>handle</em>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle to ANIS instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>On success, the function returns ANIS_INSTR_E_OK.</dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">ANIS_INSTR_E_INVAL</td><td><em>handle</em> is not a valid ANIS instrumentation handle.</td></tr>
|
|
<tr><td class="paramname">ANIS_INSTR_E_SYS</td><td>The connection with the ANIS instance fails. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga983328e3daaf32f769fe96b997f9c467"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga983328e3daaf32f769fe96b997f9c467">◆ </a></span>anis_instr_read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__anisInstr.html#ga88f7c4283e8696eda2be7e13be18f694">anis_instr_e_t</a> anis_instr_read </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__anisInstr.html#ga25f6c7eeec9068160a84f221b9b8f70a">anis_instr_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__anisInstr.html#ga1a0f529b5d2b57dc8cbc92fa0dee7797">anis_instr_stat_t</a> * </td>
|
|
<td class="paramname"><em>stats</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section user"><dt>Purpose</dt><dd>Read instrumentation data.</dd></dl>
|
|
<p>This function retrieves instrumentation statistics from the ANIS instance referenced by parameter <em>handle</em>. It returns statistics for all the interfaces including localhost loopback. Valid records are indicated by the value '1' in the intf_enabled member. The order of the counters is the same as order of configured interfaces in the system. Localhost loopback is all the time the last one from the group of enabled interfaces. Example of "intf_enabled" values based on the configured interfaces: <br />
|
|
Enabled interfaces (1)+ localhost loopback: 1 1 0 0 0 0 0 0<br />
|
|
Enabled interfaces (3)+ localhost loopback: 1 1 1 1 0 0 0 0<br />
|
|
Enabled interfaces (7)+ localhost loopback: 1 1 1 1 1 1 1 1</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle to ANIS instance. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">stats</td><td>Pointer to structure to receive the statistics.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>On success, the function returns ANIS_INSTR_E_OK.</dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">ANIS_INSTR_E_INVAL</td><td><em>handle</em> is not a valid ANIS instrumentation handle.</td></tr>
|
|
<tr><td class="paramname">ANIS_INSTR_E_SYS</td><td>The connection with the ANIS instance fails. </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>
|