universalisos/docs/html/posix-personality/sched__hook_8h_source.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

92 lines
33 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>sched_hook.h Source File</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('sched__hook_8h_source.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="headertitle">
<div class="title">sched_hook.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="sched__hook_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* -------------------------- FILE PROLOGUE -------------------------------- */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">/**</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * @copyright</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (C) Copyright SYSGO AG.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Ulm, Germany</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * @endif</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * @file</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * sys/sched_hook.h</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * @purpose</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * Scheduler Hook API</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * @cfg_management</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * $Id: p4/sys/sys/sched_hook.h 2016-07-27 10:39:55 +0000 f9789adfaea6e3af123674591af77f38cac110ad $</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * $Author$</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * $Date$</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * $Revision$</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * $State$</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * @endif</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#ifndef _SYS_SCHED_HOOK_H_</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define _SYS_SCHED_HOOK_H_</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">/* ------------------------- FILE INCLUSION -------------------------------- */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">/* __BEGIN_DECLS, __END_DECLS. */</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &lt;sys/cdefs.h&gt;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">/* pthread_t. */</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &lt;sys/types.h&gt;</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment">/**</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> * @addtogroup OS_SCHED</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> * @{</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">/* ------------------------ TYPE DECLARATIONS ------------------------------ */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">/**</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> * @brief</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> * Scheduler hook identifier.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__OS__SCHED.html#ga6f51d72f12e7a46be1d0d4088ef4dfa4"> 49</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="group__OS__SCHED.html#ga6f51d72f12e7a46be1d0d4088ef4dfa4">__sched_hook_id_e</a> {<span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> /** Thread switch hook, called for all thread switches. */</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="group__OS__SCHED.html#gga6f51d72f12e7a46be1d0d4088ef4dfa4af95565aa08a783e0e7e14ed66708094c"> 51</a></span>&#160; <a class="code" href="group__OS__SCHED.html#gga6f51d72f12e7a46be1d0d4088ef4dfa4af95565aa08a783e0e7e14ed66708094c">SCHED_SWITCH_HOOK</a>,<span class="comment"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> /** Thread switch hook, called for thread preemption. */</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__OS__SCHED.html#gga6f51d72f12e7a46be1d0d4088ef4dfa4a38af816fceb9942873eb80404f0d68ad"> 53</a></span>&#160; <a class="code" href="group__OS__SCHED.html#gga6f51d72f12e7a46be1d0d4088ef4dfa4a38af816fceb9942873eb80404f0d68ad">SCHED_PREEMPT_HOOK</a></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;} <a class="code" href="group__OS__SCHED.html#gadd13a243a372831a92ef362c16a92fda">__sched_hook_id_t</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">/**</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> * @brief</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> * Data type for a scheduler hook function.</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> * Scheduler hook functions are called when the scheduler passes</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"> * execution from one application thread to another. Depending on the</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"> * hook function type, the hook may not be called for all thread</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> * switches. A hook function is called with three arguments, a logical</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> * CPU number \a cpu and two pthread_t type function arguments, the first</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> * thread identifier argument \a t_old is the previously executing</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> * (current) thread, the second argument \a t_new is the next thread to</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> * be scheduled. \n</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"> * @returns</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> * The return of SCHED_PREEMPT_HOOK hook functions is interpreted as a</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"> * truth value influencing the scheduler decision. For other hook</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> * function types, the return value is ignored.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> * @retval !=0 The scheduler will switch from thread \a t_old to thread</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> * \a t_new.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"> * @retval 0 The scheduler will leave thread \a t_old as current</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"> * thread, the thread&#39;s priority and scheduling quantum (if</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment"> * applicable) is boosted so that no further preemptions</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"> * occur based on scheduling policy. The scheduling</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"> * parameter boosting must be explicitly reverted by the</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> * application using __revert_sched_boost().</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> * @note</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> * A scheduler hook is called in &quot;interrupt context&quot;. It should</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> * only be used as debug or profiling instrument. The use of almost</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment"> * any POSIX API function is considered to be an error and leads to</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"> * undefined system behavior. \n</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> * Scheduler hook functions must be reentrant.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="group__OS__SCHED.html#ga386130560912629a1a317c182a426be7"> 91</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__OS__SCHED.html#ga386130560912629a1a317c182a426be7">__sched_hook_t</a>(<span class="comment"></span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> /** Logical CPU number. */</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">unsigned</span> cpu,<span class="comment"></span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"> /** Previously executing application thread. */</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; pthread_t t_old,<span class="comment"></span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"> /** Next application thread to be scheduled. */</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; pthread_t t_new);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment">/* ----------------------- FUNCTION DECLARATIONS --------------------------- */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;__BEGIN_DECLS</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment">/** </span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"> * @brief</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"> * Install a scheduler hook.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> * Installs function \a hook as new scheduler hook for scheduler hook</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> * function type \a id.</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"> * @returns</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"> * If the system supports scheduler hooks, the function returns the</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"> * previously installed scheduler hook, or the NULL-pointer if no</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> * hook was installed prior to the call. \n</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment"> * If the system does not support scheduler hooks, or \a id is an invalid</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> * hook function identifier, the function returns (__sched_hook_t *)-1.</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="keyword">extern</span> <a class="code" href="group__OS__SCHED.html#ga386130560912629a1a317c182a426be7">__sched_hook_t</a> *<a class="code" href="group__OS__SCHED.html#ga5bb224a7e3484b75d66b21fbf409a487">__set_sched_hook</a>(<span class="comment"></span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment"> /** Scheduler hook to modify. */</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="group__OS__SCHED.html#gadd13a243a372831a92ef362c16a92fda">__sched_hook_id_t</a> <span class="keywordtype">id</span>,<span class="comment"></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> /** Pointer to scheduler hook function, or NULL. */</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <a class="code" href="group__OS__SCHED.html#ga386130560912629a1a317c182a426be7">__sched_hook_t</a> *hook);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="comment">/**</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment"> * @brief</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="comment"> * Revert scheduling parameter boost.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"> * Reverts scheduling parameter boosting initiated by a scheduler hook</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="comment"> * function of type SCHED_PREEMPT_HOOK for thread \a thr. The scheduling</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment"> * parameters of thread \a thr are restored according to the parameters</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> * most recently set by pthread_setschedparam() or</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"> * pthread_setschedprio(), the thread is put at the tail of the thread</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment"> * list for its priority and a rescheduling request is issued.</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="comment"> * @note</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment"> * No error checking is performed, calling the function with an invalid</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment"> * thread identifier, or a thread that has not been subject to scheduling</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment"> * parameter boost results in undefined behavior.</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__OS__SCHED.html#ga03a212dbde24b0436e4a7fee378a8745">__revert_sched_boost</a>(<span class="comment"></span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="comment"> /** Thread identifier. */</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; pthread_t thr);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="comment">/**</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="comment"> * @brief</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="comment"> * Retrieve scheduling parameters of a thread.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment"> * @detailed \n</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="comment"> * Retrieves &#39;snapshot&#39; values of scheduling parameters for thread \a thr</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="comment"> * and stores data in non-NULL input arguments.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="comment"> * The function can (and should only) be called from within a scheduler</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="comment"> * hook function.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<span class="comment"> * @note</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="comment"> * No error checking is performed, calling the function with an invalid</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="comment"> * thread identifier results in undefined behavior.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__OS__SCHED.html#gacae597ece8eee883e97feba4be3580a4">__get_thread_schedparam</a>(<span class="comment"></span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> /** Thread identifier. */</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; pthread_t thr,<span class="comment"></span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment"> /** Storage for base scheduling priority. */</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordtype">int</span> *prio,<span class="comment"></span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="comment"> /** Effective Scheduling priority based on priority protocols and</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="comment"> * scheduling parameter boost.</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keywordtype">int</span> *eff_prio,<span class="comment"></span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="comment"> /** CPU number. */</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordtype">unsigned</span> *cpu,<span class="comment"></span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment"> /** Scheduling state, ready (1) or suspended (0). */</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordtype">int</span> *state);</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;__END_DECLS</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="comment">/** @} */</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !_SYS_SCHED_HOOK_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="group__OS__SCHED_html_gadd13a243a372831a92ef362c16a92fda"><div class="ttname"><a href="group__OS__SCHED.html#gadd13a243a372831a92ef362c16a92fda">__sched_hook_id_t</a></div><div class="ttdeci">enum __sched_hook_id_e __sched_hook_id_t</div><div class="ttdoc">Scheduler hook identifier. </div></div>
<div class="ttc" id="group__OS__SCHED_html_ga6f51d72f12e7a46be1d0d4088ef4dfa4"><div class="ttname"><a href="group__OS__SCHED.html#ga6f51d72f12e7a46be1d0d4088ef4dfa4">__sched_hook_id_e</a></div><div class="ttdeci">__sched_hook_id_e</div><div class="ttdoc">Scheduler hook identifier. </div><div class="ttdef"><b>Definition:</b> sched_hook.h:49</div></div>
<div class="ttc" id="group__OS__SCHED_html_gacae597ece8eee883e97feba4be3580a4"><div class="ttname"><a href="group__OS__SCHED.html#gacae597ece8eee883e97feba4be3580a4">__get_thread_schedparam</a></div><div class="ttdeci">void __get_thread_schedparam(pthread_t thr, int *prio, int *eff_prio, unsigned *cpu, int *state)</div><div class="ttdoc">Retrieve scheduling parameters of a thread. </div></div>
<div class="ttc" id="group__OS__SCHED_html_gga6f51d72f12e7a46be1d0d4088ef4dfa4af95565aa08a783e0e7e14ed66708094c"><div class="ttname"><a href="group__OS__SCHED.html#gga6f51d72f12e7a46be1d0d4088ef4dfa4af95565aa08a783e0e7e14ed66708094c">SCHED_SWITCH_HOOK</a></div><div class="ttdef"><b>Definition:</b> sched_hook.h:51</div></div>
<div class="ttc" id="group__OS__SCHED_html_ga03a212dbde24b0436e4a7fee378a8745"><div class="ttname"><a href="group__OS__SCHED.html#ga03a212dbde24b0436e4a7fee378a8745">__revert_sched_boost</a></div><div class="ttdeci">void __revert_sched_boost(pthread_t thr)</div><div class="ttdoc">Revert scheduling parameter boost. </div></div>
<div class="ttc" id="group__OS__SCHED_html_gga6f51d72f12e7a46be1d0d4088ef4dfa4a38af816fceb9942873eb80404f0d68ad"><div class="ttname"><a href="group__OS__SCHED.html#gga6f51d72f12e7a46be1d0d4088ef4dfa4a38af816fceb9942873eb80404f0d68ad">SCHED_PREEMPT_HOOK</a></div><div class="ttdef"><b>Definition:</b> sched_hook.h:53</div></div>
<div class="ttc" id="group__OS__SCHED_html_ga5bb224a7e3484b75d66b21fbf409a487"><div class="ttname"><a href="group__OS__SCHED.html#ga5bb224a7e3484b75d66b21fbf409a487">__set_sched_hook</a></div><div class="ttdeci">__sched_hook_t * __set_sched_hook(__sched_hook_id_t id, __sched_hook_t *hook)</div><div class="ttdoc">Install a scheduler hook. </div></div>
<div class="ttc" id="group__OS__SCHED_html_ga386130560912629a1a317c182a426be7"><div class="ttname"><a href="group__OS__SCHED.html#ga386130560912629a1a317c182a426be7">__sched_hook_t</a></div><div class="ttdeci">int __sched_hook_t(unsigned cpu, pthread_t t_old, pthread_t t_new)</div><div class="ttdoc">Data type for a scheduler hook function. </div><div class="ttdef"><b>Definition:</b> sched_hook.h:91</div></div>
</div><!-- fragment --></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_a8adc0807d5a5926ebf6cd2ff2d915eb.html">localsrc</a></li><li class="navelem"><a class="el" href="dir_e5ab56458b395d3914abb489957af44a.html">pse51</a></li><li class="navelem"><a class="el" href="dir_382df6351c2622d26be84382bbf63b9d.html">p4</a></li><li class="navelem"><a class="el" href="dir_c995972fd5f46ddeb8a200664e7f57ef.html">sys</a></li><li class="navelem"><a class="el" href="dir_e545b109f33496355964ac58581c0ffd.html">sys</a></li><li class="navelem"><a class="el" href="sched__hook_8h.html">sched_hook.h</a></li>
<li class="footer">(C) Copyright SYSGO AG</li>
</ul>
</div>
</body>
</html>