universalisos/docs/html/pssw-reference-manual/vm__se_8h.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

139 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>vm_se.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="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('vm__se_8h.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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">vm_se.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>PSSW API: Services available to system extensions.
<a href="#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>PSSW API: Services available to system extensions. </p>
<p><a class="el" href="vm__se_8h.html" title="PSSW API: Services available to system extensions. ">vm_se.h</a> </p>
</div>
<p><a href="vm__se_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gabeea7ea3d0bdbc1ba38a907aa425498c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#gabeea7ea3d0bdbc1ba38a907aa425498c">VM_DECLARE_SE</a>(desc)</td></tr>
<tr class="memdesc:gabeea7ea3d0bdbc1ba38a907aa425498c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declare a system extension. <a href="group__system__extensions.html#gabeea7ea3d0bdbc1ba38a907aa425498c">More...</a><br /></td></tr>
<tr class="separator:gabeea7ea3d0bdbc1ba38a907aa425498c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f55da7ded043e418afc58a99082f20e"><td class="memItemLeft" align="right" valign="top">
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga3f55da7ded043e418afc58a99082f20e">VM_SE_HOOK_PART_TABLE</a></td></tr>
<tr class="memdesc:ga3f55da7ded043e418afc58a99082f20e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of hooks to PSSW internals. <br /></td></tr>
<tr class="separator:ga3f55da7ded043e418afc58a99082f20e"><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:ga1615e4b8c836e4d17537fa60cac6cfe3"><td class="memItemLeft" align="right" valign="top">P4_e_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga1615e4b8c836e4d17537fa60cac6cfe3">vm_thread_create</a> (P4_thr_t *tid, const char *name, <a class="el" href="group__system__extensions.html#ga8ae73ff36885a36fa8186dd97c08d7a8">vm_se_prio_t</a> prio_level, void(*entry)(void *), P4_size_t stacksize, void *user)</td></tr>
<tr class="memdesc:ga1615e4b8c836e4d17537fa60cac6cfe3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new system extension thread. <a href="group__system__extensions.html#ga1615e4b8c836e4d17537fa60cac6cfe3">More...</a><br /></td></tr>
<tr class="separator:ga1615e4b8c836e4d17537fa60cac6cfe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7d465679eceb72f07b3c2678b23ad301"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga7d465679eceb72f07b3c2678b23ad301">vm_crit_enter</a> (P4_prio_t *prio)</td></tr>
<tr class="memdesc:ga7d465679eceb72f07b3c2678b23ad301"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enter a critical section. <a href="group__system__extensions.html#ga7d465679eceb72f07b3c2678b23ad301">More...</a><br /></td></tr>
<tr class="separator:ga7d465679eceb72f07b3c2678b23ad301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga496c325d1c6459ff4fa4587a61470c0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga496c325d1c6459ff4fa4587a61470c0b">vm_crit_leave</a> (P4_prio_t *prio)</td></tr>
<tr class="memdesc:ga496c325d1c6459ff4fa4587a61470c0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave a critical section. <a href="group__system__extensions.html#ga496c325d1c6459ff4fa4587a61470c0b">More...</a><br /></td></tr>
<tr class="separator:ga496c325d1c6459ff4fa4587a61470c0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93db370372cba6fb586554a3ac650dd2"><td class="memItemLeft" align="right" valign="top">P4_e_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga93db370372cba6fb586554a3ac650dd2">vm_add_romimage</a> (const void *start, const char *sub_prefix)</td></tr>
<tr class="memdesc:ga93db370372cba6fb586554a3ac650dd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deploy a mapped ROM image to add the contents of its file system to the extensible ROM file system (xrfs). The files are addressed via the directory specified with the call. For instance, if a ROM image containing a file f is registered with the directory p, a call to <a class="el" href="group__file__system.html#ga1b98f4cf8f9a10e92eeef9657634ff1c" title="Open a file managed by a PikeOS file provider. ">vm_open()</a> may address the file via xrfs:p/f. <a href="group__system__extensions.html#ga93db370372cba6fb586554a3ac650dd2">More...</a><br /></td></tr>
<tr class="separator:ga93db370372cba6fb586554a3ac650dd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa9153d0a4e463758deb1f8199a1e949d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#gaa9153d0a4e463758deb1f8199a1e949d">vm_monitor_hook</a> (unsigned int type)</td></tr>
<tr class="memdesc:gaa9153d0a4e463758deb1f8199a1e949d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Monitoring Hook into the PSSW for System Extensions. This service returns pointers to various internal data structures. The caller has to include private headers of the PSSW component in order to be able to parse those data structures. <a href="group__system__extensions.html#gaa9153d0a4e463758deb1f8199a1e949d">More...</a><br /></td></tr>
<tr class="separator:gaa9153d0a4e463758deb1f8199a1e949d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1884c4336bfcde1da92d56fe7272befe"><td class="memItemLeft" align="right" valign="top">P4_e_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga1884c4336bfcde1da92d56fe7272befe">vm_register_part_change_cb</a> (<a class="el" href="group__system__extensions.html#gaefddd525daac19b27a6a2ea0292cb64e">vm_se_part_change_cb_t</a> *cb)</td></tr>
<tr class="memdesc:ga1884c4336bfcde1da92d56fe7272befe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a callback handler for partition startup and shutdown. The PSSW registers the handler <em>cb</em> as callback for partition mode change. The PSSW will call this handler at partition startup, shutdown, and transition to mode VM_PART_MODE_NORMAL from the partition daemon's context. <a href="group__system__extensions.html#ga1884c4336bfcde1da92d56fe7272befe">More...</a><br /></td></tr>
<tr class="separator:ga1884c4336bfcde1da92d56fe7272befe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5d3885b6cc4f74664f98e5cacfc0449"><td class="memItemLeft" align="right" valign="top">P4_e_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#gaa5d3885b6cc4f74664f98e5cacfc0449">vm_get_acl</a> (unsigned int part_id, unsigned int idx, char *name, P4_size_t name_sz, vm_file_access_mode_t *access_mode)</td></tr>
<tr class="memdesc:gaa5d3885b6cc4f74664f98e5cacfc0449"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate all file access configuration entries of a partition. <a href="group__system__extensions.html#gaa5d3885b6cc4f74664f98e5cacfc0449">More...</a><br /></td></tr>
<tr class="separator:gaa5d3885b6cc4f74664f98e5cacfc0449"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga282335c6ebad242fa386ee0f536e4692"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga282335c6ebad242fa386ee0f536e4692">vm_shm_iter_init</a> (<a class="el" href="structvm__se__shm__iterate__t.html">vm_se_shm_iterate_t</a> *it)</td></tr>
<tr class="memdesc:ga282335c6ebad242fa386ee0f536e4692"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate shared memory requirements. <a href="group__system__extensions.html#ga282335c6ebad242fa386ee0f536e4692">More...</a><br /></td></tr>
<tr class="separator:ga282335c6ebad242fa386ee0f536e4692"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga49ea9e3375dba997b45a8ca64e0402f7"><td class="memItemLeft" align="right" valign="top">P4_bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga49ea9e3375dba997b45a8ca64e0402f7">vm_shm_iter_take</a> (<a class="el" href="structvm__se__shm__iterate__t.html">vm_se_shm_iterate_t</a> *it)</td></tr>
<tr class="memdesc:ga49ea9e3375dba997b45a8ca64e0402f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate shared memory requirements. <a href="group__system__extensions.html#ga49ea9e3375dba997b45a8ca64e0402f7">More...</a><br /></td></tr>
<tr class="separator:ga49ea9e3375dba997b45a8ca64e0402f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7887ad749406e38fa5673eb9cf8643cc"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__system__extensions.html#ga7887ad749406e38fa5673eb9cf8643cc">vm_thread_get_priv</a> (P4_size_t size)</td></tr>
<tr class="memdesc:ga7887ad749406e38fa5673eb9cf8643cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the pointer to the TLS area reserved for SE drivers. <a href="group__system__extensions.html#ga7887ad749406e38fa5673eb9cf8643cc">More...</a><br /></td></tr>
<tr class="separator:ga7887ad749406e38fa5673eb9cf8643cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a5c23e4d4d2f2652fc21caa9afd4c5c7.html">opt</a></li><li class="navelem"><a class="el" href="dir_435533676c28ab3bbada0316da160146.html">pikeos-D5.0</a></li><li class="navelem"><a class="el" href="dir_48b8b87fe66c38ce4d22fbc9231439a9.html">build</a></li><li class="navelem"><a class="el" href="dir_4090a5462cff037c2a1aae8e8de3b5f7.html">doc</a></li><li class="navelem"><a class="el" href="dir_21fee110a3203400e106c1d61080c374.html">pssw</a></li><li class="navelem"><a class="el" href="dir_ad3ed7cbc164e66cfdb901458538ebf3.html">pssw</a></li><li class="navelem"><a class="el" href="dir_3e1dd917a3fc9d13cb50b4a11c97102b.html">include</a></li><li class="navelem"><a class="el" href="vm__se_8h.html">vm_se.h</a></li>
<li class="footer">(C) Copyright SYSGO AG</li>
</ul>
</div>
</body>
</html>