gnuk/ChibiOS_2.0.8/docs/html/chlists_8c_source.html
2010-11-30 13:54:43 +09:00

200 lines
21 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: chlists.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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>chlists.c</h1> </div>
</div>
<div class="contents">
<a href="chlists_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 &lt;http://www.gnu.org/licenses/&gt;.</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 chlists.c</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Thread queues/lists code.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup internals</span>
<a name="l00032"></a>00032 <span class="comment"> * @details All the functions present in this module, while public, are not</span>
<a name="l00033"></a>00033 <span class="comment"> * an OS API and should not be directly used in the user applications</span>
<a name="l00034"></a>00034 <span class="comment"> * code.</span>
<a name="l00035"></a>00035 <span class="comment"> * @{</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include &quot;<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>&quot;</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#if !CH_OPTIMIZE_SPEED || defined(__DOXYGEN__)</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00041"></a>00041 <span class="comment"> * @brief Inserts a thread into a priority ordered queue.</span>
<a name="l00042"></a>00042 <span class="comment"> * @note The insertion is done by scanning the list from the highest priority</span>
<a name="l00043"></a>00043 <span class="comment"> * toward the lowest.</span>
<a name="l00044"></a>00044 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00045"></a>00045 <span class="comment"> *</span>
<a name="l00046"></a>00046 <span class="comment"> * @param[in] tp the pointer to the thread to be inserted in the list</span>
<a name="l00047"></a>00047 <span class="comment"> * @param[in] tqp the pointer to the threads list header</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a><a class="code" href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2">00049</a> <span class="keywordtype">void</span> <a class="code" href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2" title="Inserts a thread into a priority ordered queue.">prio_insert</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp, <a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp) {
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">/* cp iterates over the queue.*/</span>
<a name="l00052"></a>00052 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *cp = (<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *)tqp;
<a name="l00053"></a>00053 <span class="keywordflow">do</span> {
<a name="l00054"></a>00054 <span class="comment">/* Iterate to next thread in queue.*/</span>
<a name="l00055"></a>00055 cp = cp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a>;
<a name="l00056"></a>00056 <span class="comment">/* Not end of queue? and cp has equal or higher priority than tp?.*/</span>
<a name="l00057"></a>00057 } <span class="keywordflow">while</span> ((cp != (<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *)tqp) &amp;&amp; (cp-&gt;<a class="code" href="struct_thread.html#ae60cc22956f4c19965cb94045333aa9c" title="Thread priority.">p_prio</a> &gt;= tp-&gt;<a class="code" href="struct_thread.html#ae60cc22956f4c19965cb94045333aa9c" title="Thread priority.">p_prio</a>));
<a name="l00058"></a>00058 <span class="comment">/* Insertion on p_prev.*/</span>
<a name="l00059"></a>00059 tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a> = cp;
<a name="l00060"></a>00060 tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a> = cp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>;
<a name="l00061"></a>00061 tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a> = cp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a> = tp;
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment">/**</span>
<a name="l00065"></a>00065 <span class="comment"> * @brief Inserts a Thread into a queue.</span>
<a name="l00066"></a>00066 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * @param[in] tp the pointer to the thread to be inserted in the list</span>
<a name="l00069"></a>00069 <span class="comment"> * @param[in] tqp the pointer to the threads list header</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a><a class="code" href="group__internals.html#gaf7072f75fdab9dcc5f7b8dcad212965c">00071</a> <span class="keywordtype">void</span> <a class="code" href="group__internals.html#gaf7072f75fdab9dcc5f7b8dcad212965c" title="Inserts a Thread into a queue.">queue_insert</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp, <a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp) {
<a name="l00072"></a>00072
<a name="l00073"></a>00073 tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a> = (<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *)tqp;
<a name="l00074"></a>00074 tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a> = tqp-&gt;<a class="code" href="struct_threads_queue.html#aefc0a5e3ba3ed03da122337bc13be8fa">p_prev</a>;
<a name="l00075"></a>00075 tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a> = tqp-&gt;<a class="code" href="struct_threads_queue.html#aefc0a5e3ba3ed03da122337bc13be8fa">p_prev</a> = tp;
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">/**</span>
<a name="l00079"></a>00079 <span class="comment"> * @brief Removes the first-out Thread from a queue and returns it.</span>
<a name="l00080"></a>00080 <span class="comment"> * @note If the queue is priority ordered then this function returns the</span>
<a name="l00081"></a>00081 <span class="comment"> * thread with the highest priority.</span>
<a name="l00082"></a>00082 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00083"></a>00083 <span class="comment"> *</span>
<a name="l00084"></a>00084 <span class="comment"> * @param[in] tqp the pointer to the threads list header</span>
<a name="l00085"></a>00085 <span class="comment"> * @return The removed thread pointer.</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a><a class="code" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a">00087</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a" title="Removes the first-out Thread from a queue and returns it.">fifo_remove</a>(<a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp) {
<a name="l00088"></a>00088 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp = tqp-&gt;<a class="code" href="struct_threads_queue.html#af4a099c245d7ceecdf2f9755d05d0ed0">p_next</a>;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 (tqp-&gt;<a class="code" href="struct_threads_queue.html#af4a099c245d7ceecdf2f9755d05d0ed0">p_next</a> = tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a>)-&gt;p_prev = (<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *)tqp;
<a name="l00091"></a>00091 <span class="keywordflow">return</span> tp;
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 <span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">/**</span>
<a name="l00095"></a>00095 <span class="comment"> * @brief Removes the last-out Thread from a queue and returns it.</span>
<a name="l00096"></a>00096 <span class="comment"> * @note If the queue is priority ordered then this function returns the</span>
<a name="l00097"></a>00097 <span class="comment"> * thread with the lowest priority.</span>
<a name="l00098"></a>00098 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00099"></a>00099 <span class="comment"> *</span>
<a name="l00100"></a>00100 <span class="comment"> * @param[in] tqp the pointer to the threads list header</span>
<a name="l00101"></a>00101 <span class="comment"> * @return The removed thread pointer.</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a><a class="code" href="group__internals.html#gacacfe77140cab62948e63d898bf4dfba">00103</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#gacacfe77140cab62948e63d898bf4dfba" title="Removes the last-out Thread from a queue and returns it.">lifo_remove</a>(<a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp) {
<a name="l00104"></a>00104 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp = tqp-&gt;<a class="code" href="struct_threads_queue.html#aefc0a5e3ba3ed03da122337bc13be8fa">p_prev</a>;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 (tqp-&gt;<a class="code" href="struct_threads_queue.html#aefc0a5e3ba3ed03da122337bc13be8fa">p_prev</a> = tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>)-&gt;p_next = (<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *)tqp;
<a name="l00107"></a>00107 <span class="keywordflow">return</span> tp;
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109 <span class="comment"></span>
<a name="l00110"></a>00110 <span class="comment">/**</span>
<a name="l00111"></a>00111 <span class="comment"> * @brief Removes a Thread from a queue and returns it.</span>
<a name="l00112"></a>00112 <span class="comment"> * @details The thread is removed from the queue regardless of its relative</span>
<a name="l00113"></a>00113 <span class="comment"> * position and regardless the used insertion method.</span>
<a name="l00114"></a>00114 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00115"></a>00115 <span class="comment"> *</span>
<a name="l00116"></a>00116 <span class="comment"> * @param[in] tp the pointer to the thread to be removed from the queue</span>
<a name="l00117"></a>00117 <span class="comment"> * @return The removed thread pointer.</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a><a class="code" href="group__internals.html#gafff11bcd31d7dc3d1a0a6c66f3fc6ec9">00119</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#gafff11bcd31d7dc3d1a0a6c66f3fc6ec9" title="Removes a Thread from a queue and returns it.">dequeue</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp) {
<a name="l00120"></a>00120
<a name="l00121"></a>00121 tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a> = tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a>;
<a name="l00122"></a>00122 tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a>-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a> = tp-&gt;<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>;
<a name="l00123"></a>00123 <span class="keywordflow">return</span> tp;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment">/**</span>
<a name="l00127"></a>00127 <span class="comment"> * @brief Pushes a Thread on top of a stack list.</span>
<a name="l00128"></a>00128 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00129"></a>00129 <span class="comment"> *</span>
<a name="l00130"></a>00130 <span class="comment"> * @param[in] tp the pointer to the thread to be inserted in the list</span>
<a name="l00131"></a>00131 <span class="comment"> * @param[in] tlp the pointer to the threads list header</span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a><a class="code" href="group__internals.html#ga5818ce2d363d36402baece614b06e41b">00133</a> <span class="keywordtype">void</span> <a class="code" href="group__internals.html#ga5818ce2d363d36402baece614b06e41b" title="Pushes a Thread on top of a stack list.">list_insert</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp, <a class="code" href="struct_threads_list.html" title="Generic threads single link list, it works like a stack.">ThreadsList</a> *tlp) {
<a name="l00134"></a>00134
<a name="l00135"></a>00135 tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a> = tlp-&gt;<a class="code" href="struct_threads_list.html#a9076f9b8ac5d59067adc11faa8998371">p_next</a>;
<a name="l00136"></a>00136 tlp-&gt;<a class="code" href="struct_threads_list.html#a9076f9b8ac5d59067adc11faa8998371">p_next</a> = tp;
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment">/**</span>
<a name="l00140"></a>00140 <span class="comment"> * @brief Pops a Thread from the top of a stack list and returns it.</span>
<a name="l00141"></a>00141 <span class="comment"> * @note The list must be non-empty before calling this function.</span>
<a name="l00142"></a>00142 <span class="comment"> * @note This function is @b not an API.</span>
<a name="l00143"></a>00143 <span class="comment"> *</span>
<a name="l00144"></a>00144 <span class="comment"> * @param[in] tlp the pointer to the threads list header</span>
<a name="l00145"></a>00145 <span class="comment"> * @return The removed thread pointer.</span>
<a name="l00146"></a>00146 <span class="comment"> */</span>
<a name="l00147"></a><a class="code" href="group__internals.html#gad9aa523aebdaeefa3cc4a311bc210e8a">00147</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#gad9aa523aebdaeefa3cc4a311bc210e8a" title="Pops a Thread from the top of a stack list and returns it.">list_remove</a>(<a class="code" href="struct_threads_list.html" title="Generic threads single link list, it works like a stack.">ThreadsList</a> *tlp) {
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp = tlp-&gt;<a class="code" href="struct_threads_list.html#a9076f9b8ac5d59067adc11faa8998371">p_next</a>;
<a name="l00150"></a>00150 tlp-&gt;<a class="code" href="struct_threads_list.html#a9076f9b8ac5d59067adc11faa8998371">p_next</a> = tp-&gt;<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a>;
<a name="l00151"></a>00151 <span class="keywordflow">return</span> tp;
<a name="l00152"></a>00152 }
<a name="l00153"></a>00153 <span class="preprocessor">#endif </span><span class="comment">/* CH_OPTIMIZE_SPEED */</span>
<a name="l00154"></a>00154 <span class="comment"></span>
<a name="l00155"></a>00155 <span class="comment">/** @} */</span>
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Nov 28 2010 14:09:48 for ChibiOS/RT by&nbsp;<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>