mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
159 lines
14 KiB
HTML
159 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: chregistry.c Source File</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<h1>chregistry.c</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chregistry_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"></span>
|
|
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
|
|
<a name="l00005"></a>00005 <span class="comment"></span>
|
|
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
|
|
<a name="l00010"></a>00010 <span class="comment"></span>
|
|
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"></span>
|
|
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"></span>
|
|
<a name="l00019"></a>00019 <span class="comment"> ---</span>
|
|
<a name="l00020"></a>00020 <span class="comment"></span>
|
|
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
|
|
<a name="l00025"></a>00025 <span class="comment">*/</span>
|
|
<a name="l00026"></a>00026 <span class="comment"></span>
|
|
<a name="l00027"></a>00027 <span class="comment">/**</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @file chregistry.c</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Threads registry code.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup registry</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @details Threads Registry related APIs and services.</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> *</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> * <h2>Operation mode</h2></span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * The Threads Registry is a double linked list that holds all the</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * active threads in the system.<br></span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * Operations defined for the registry:</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * - <b>First</b>, returns the first, in creation order, active thread</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * in the system.</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * - <b>Next</b>, returns the next, in creation order, active thread</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * in the system.</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * .</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> * The registry is meant to be mainly a debug feature, as example,</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * using the registry a debugger can enumerate the active threads</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> * in any given moment or the shell can print the active threads</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> * and their state.<br></span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * Another possible use is for centralized threads memory management,</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> * terminating threads can pulse an event source and an event handler</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * can perform a scansion of the registry in order to recover the</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> * memory.<br></span>
|
|
<a name="l00051"></a>00051 <span class="comment"> * In order to use the threads registry the @p CH_USE_REGISTRY option</span>
|
|
<a name="l00052"></a>00052 <span class="comment"> * must be enabled in @p chconf.h.</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> * @{</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> */</span>
|
|
<a name="l00055"></a>00055 <span class="preprocessor">#include "<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>"</span>
|
|
<a name="l00056"></a>00056
|
|
<a name="l00057"></a>00057 <span class="preprocessor">#if CH_USE_REGISTRY</span>
|
|
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00059"></a>00059 <span class="comment">/**</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> * @brief Returns the first thread in the system.</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * @details Returns the most ancient thread in the system, usually this is</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> * the main thread unless it terminated.</span>
|
|
<a name="l00063"></a>00063 <span class="comment"> * @note A reference is added to the returned thread in order to make sure</span>
|
|
<a name="l00064"></a>00064 <span class="comment"> * it status is not lost.</span>
|
|
<a name="l00065"></a>00065 <span class="comment"> * @note This function cannot return @p NULL because there is always at</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> * least one thread in the system.</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> *</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * @return A reference to the first thread.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> */</span>
|
|
<a name="l00070"></a><a class="code" href="group__registry.html#ga55c0a485b40cf4acbfce0dd333f28513">00070</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__registry.html#ga55c0a485b40cf4acbfce0dd333f28513" title="Returns the first thread in the system.">chRegFirstThread</a>(<span class="keywordtype">void</span>) {
|
|
<a name="l00071"></a>00071 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp;
|
|
<a name="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00074"></a>00074 tp = <a class="code" href="group__scheduler.html#ga752cd9dbf0dc458b8b532182836ca38d" title="Ready list header.">rlist</a>.<a class="code" href="struct_ready_list.html#adaf2a3d936298fdee21396af9cf640c9" title="Newer registry element.">r_newer</a>;
|
|
<a name="l00075"></a>00075 <span class="preprocessor">#if CH_USE_DYNAMIC</span>
|
|
<a name="l00076"></a>00076 <span class="preprocessor"></span> tp-><a class="code" href="struct_thread.html#af86d1da435197d113bc42fe8139a21c5" title="References to this thread.">p_refs</a>++;
|
|
<a name="l00077"></a>00077 <span class="preprocessor">#endif</span>
|
|
<a name="l00078"></a>00078 <span class="preprocessor"></span> <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00079"></a>00079 <span class="keywordflow">return</span> tp;
|
|
<a name="l00080"></a>00080 }
|
|
<a name="l00081"></a>00081 <span class="comment"></span>
|
|
<a name="l00082"></a>00082 <span class="comment">/**</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> * @brief Returns the thread next to the specified one.</span>
|
|
<a name="l00084"></a>00084 <span class="comment"> * @details The reference counter of the specified thread is decremented and</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * the reference counter of the returned thread is incremented.</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> *</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * @param[in] tp pointer to the thread</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * @return A reference to the next thread.</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * @retval NULL if there is no next thread.</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> */</span>
|
|
<a name="l00091"></a><a class="code" href="group__registry.html#gaefff43a49fb7888a596319d67cf01dab">00091</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__registry.html#gaefff43a49fb7888a596319d67cf01dab" title="Returns the thread next to the specified one.">chRegNextThread</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp) {
|
|
<a name="l00092"></a>00092 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *ntp;
|
|
<a name="l00093"></a>00093
|
|
<a name="l00094"></a>00094 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00095"></a>00095 ntp = tp-><a class="code" href="struct_thread.html#a735bed4a4185b8fd502c01d7ad491710" title="Newer registry element.">p_newer</a>;
|
|
<a name="l00096"></a>00096 <span class="keywordflow">if</span> (ntp == (<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *)&<a class="code" href="group__scheduler.html#ga752cd9dbf0dc458b8b532182836ca38d" title="Ready list header.">rlist</a>)
|
|
<a name="l00097"></a>00097 ntp = NULL;
|
|
<a name="l00098"></a>00098 <span class="preprocessor">#if CH_USE_DYNAMIC</span>
|
|
<a name="l00099"></a>00099 <span class="preprocessor"></span> <span class="keywordflow">else</span> {
|
|
<a name="l00100"></a>00100 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>(ntp-><a class="code" href="struct_thread.html#af86d1da435197d113bc42fe8139a21c5" title="References to this thread.">p_refs</a> < 255, <span class="stringliteral">"chRegNextThread(), #1"</span>,
|
|
<a name="l00101"></a>00101 <span class="stringliteral">"too many references"</span>);
|
|
<a name="l00102"></a>00102 ntp-><a class="code" href="struct_thread.html#af86d1da435197d113bc42fe8139a21c5" title="References to this thread.">p_refs</a>++;
|
|
<a name="l00103"></a>00103 }
|
|
<a name="l00104"></a>00104 <span class="preprocessor">#endif</span>
|
|
<a name="l00105"></a>00105 <span class="preprocessor"></span> <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00106"></a>00106 <span class="preprocessor">#if CH_USE_DYNAMIC</span>
|
|
<a name="l00107"></a>00107 <span class="preprocessor"></span> <a class="code" href="group__threads.html#gaa22f80040cf192015be4607f31a0ac80" title="Releases a reference to a thread object.">chThdRelease</a>(tp);
|
|
<a name="l00108"></a>00108 <span class="preprocessor">#endif</span>
|
|
<a name="l00109"></a>00109 <span class="preprocessor"></span> <span class="keywordflow">return</span> ntp;
|
|
<a name="l00110"></a>00110 }
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a>00112 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_REGISTRY */</span>
|
|
<a name="l00113"></a>00113 <span class="comment"></span>
|
|
<a name="l00114"></a>00114 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|