gnuk/ChibiOS_2.0.2/docs/html/test_8h_source.html
2010-08-10 12:11:02 +09:00

206 lines
22 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: test.h 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.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>test.h</h1><a href="test_8h.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 test.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Tests support header.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup test</span>
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
<a name="l00033"></a>00033 <span class="comment"> */</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _TEST_H_</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _TEST_H_</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * @brief Delay inserted between test cases.</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041 <span class="preprocessor">#if !defined(DELAY_BETWEEN_TESTS) || defined(__DOXYGEN__)</span>
<a name="l00042"></a><a class="code" href="group__test.html#ga7417eac27c938fcd3e7bbbf36ea29d17">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define DELAY_BETWEEN_TESTS 200</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/**</span>
<a name="l00046"></a>00046 <span class="comment"> * @brief If @p TRUE then benchmarks are not included.</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a>00048 <span class="preprocessor">#if !defined(TEST_NO_BENCHMARKS) || defined(__DOXYGEN__)</span>
<a name="l00049"></a><a class="code" href="group__test.html#gac35bb55c5e46bf6f19a62606dec25c04">00049</a> <span class="preprocessor"></span><span class="preprocessor">#define TEST_NO_BENCHMARKS FALSE</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a>00052 <span class="preprocessor">#define MAX_THREADS 5</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TOKENS 16</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00055"></a>00055 <span class="preprocessor">#if defined(CH_ARCHITECTURE_AVR) || \</span>
<a name="l00056"></a>00056 <span class="preprocessor"> defined(CH_ARCHITECTURE_MSP430) || \</span>
<a name="l00057"></a>00057 <span class="preprocessor"> defined(CH_ARCHITECTURE_STM8)</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define THREADS_STACK_SIZE 48</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor">#elif defined(CH_ARCHITECTURE_SIMIA32)</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#define THREADS_STACK_SIZE 512</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define THREADS_STACK_SIZE 128</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#define WA_SIZE THD_WA_SIZE(THREADS_STACK_SIZE)</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">/**</span>
<a name="l00067"></a>00067 <span class="comment"> * @brief Structure representing a test case.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a><a class="code" href="structtestcase.html">00069</a> <span class="keyword">struct </span><a class="code" href="structtestcase.html" title="Structure representing a test case.">testcase</a> {
<a name="l00070"></a><a class="code" href="structtestcase.html#ac2174dd3b54bc450ef1234b1327ad56e">00070</a> <span class="keywordtype">char</span> *(*gettest)(void); <span class="comment">/**&lt; @brief Test case name get function. */</span>
<a name="l00071"></a><a class="code" href="structtestcase.html#a6834d2a8e6c4ba9047f548162f582b04">00071</a> void (*<a class="code" href="structtestcase.html#a6834d2a8e6c4ba9047f548162f582b04" title="Test case preparation function.">setup</a>)(void); <span class="comment">/**&lt; @brief Test case preparation function. */</span>
<a name="l00072"></a><a class="code" href="structtestcase.html#af49c801184c28dfd578bfe4a69a7f211">00072</a> void (*<a class="code" href="structtestcase.html#af49c801184c28dfd578bfe4a69a7f211" title="Test case clean up function.">teardown</a>)(void); <span class="comment">/**&lt; @brief Test case clean up function. */</span>
<a name="l00073"></a><a class="code" href="structtestcase.html#af216996149ef003c44a83a57c57db2f0">00073</a> void (*<a class="code" href="structtestcase.html#af216996149ef003c44a83a57c57db2f0" title="Test case execution function.">execute</a>)(void); <span class="comment">/**&lt; @brief Test case execution function. */</span>
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="preprocessor">#ifndef __DOXYGEN__</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="keyword">union </span>test_buffers {
<a name="l00078"></a>00078 <span class="keyword">struct </span>{
<a name="l00079"></a>00079 <a class="code" href="group__core.html#gac8b681d521d3b6c25e7a0304674732c9" title="Static working area allocation.">WORKING_AREA</a>(T0, THREADS_STACK_SIZE);
<a name="l00080"></a>00080 <a class="code" href="group__core.html#gac8b681d521d3b6c25e7a0304674732c9" title="Static working area allocation.">WORKING_AREA</a>(T1, THREADS_STACK_SIZE);
<a name="l00081"></a>00081 <a class="code" href="group__core.html#gac8b681d521d3b6c25e7a0304674732c9" title="Static working area allocation.">WORKING_AREA</a>(T2, THREADS_STACK_SIZE);
<a name="l00082"></a>00082 <a class="code" href="group__core.html#gac8b681d521d3b6c25e7a0304674732c9" title="Static working area allocation.">WORKING_AREA</a>(T3, THREADS_STACK_SIZE);
<a name="l00083"></a>00083 <a class="code" href="group__core.html#gac8b681d521d3b6c25e7a0304674732c9" title="Static working area allocation.">WORKING_AREA</a>(T4, THREADS_STACK_SIZE);
<a name="l00084"></a>00084 } wa;
<a name="l00085"></a>00085 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> buffer[WA_SIZE * 5];
<a name="l00086"></a>00086 };
<a name="l00087"></a>00087 <span class="preprocessor">#endif</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span>
<a name="l00089"></a>00089 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00091"></a>00091 <span class="preprocessor">#endif</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__test.html#ga6b0a5b39f57674777d7b044e1a15603a" title="Test execution thread function.">TestThread</a>(<span class="keywordtype">void</span> *p);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group__test.html#ga5551ca9506fe131cae2e4036c512cc98" title="Prints a decimal unsigned number.">test_printn</a>(<a class="code" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> n);
<a name="l00094"></a>00094 <span class="keywordtype">void</span> <a class="code" href="group__test.html#ga65f8ec6aa3d624a48d498f04efa2dce8" title="Prints a line without final end-of-line.">test_print</a>(<span class="keywordtype">char</span> *msgp);
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="group__test.html#gaf5e5d95b5ea7bd33f91ca52ee8088f4e" title="Prints a line.">test_println</a>(<span class="keywordtype">char</span> *msgp);
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="group__test.html#gab3d9527d7616b3f9f8cba60cda0211a8" title="Emits a token into the tokens buffer.">test_emit_token</a>(<span class="keywordtype">char</span> token);
<a name="l00097"></a>00097 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> _test_fail(<span class="keywordtype">unsigned</span> point);
<a name="l00098"></a>00098 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> _test_assert(<span class="keywordtype">unsigned</span> point, <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> condition);
<a name="l00099"></a>00099 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> _test_assert_sequence(<span class="keywordtype">unsigned</span> point, <span class="keywordtype">char</span> *expected);
<a name="l00100"></a>00100 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> _test_assert_time_window(<span class="keywordtype">unsigned</span> point, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> start, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> end);
<a name="l00101"></a>00101 <span class="keywordtype">void</span> <a class="code" href="group__test.html#ga9415896a22ab615391028ec0852bc678" title="Pends a termination request in all the test-spawned threads.">test_terminate_threads</a>(<span class="keywordtype">void</span>);
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="group__test.html#ga361d9d2685d79754206ae8af370a303c" title="Waits for the completion of all the test-spawned threads.">test_wait_threads</a>(<span class="keywordtype">void</span>);
<a name="l00103"></a>00103 <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> <a class="code" href="group__test.html#gac067dd7ee03b2c56d4d26ce9815ed3f7" title="Delays execution until next system time tick.">test_wait_tick</a>(<span class="keywordtype">void</span>);
<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="group__test.html#gad4ce516117b9a9c8cd884c192c8f9bb1" title="Starts the test timer.">test_start_timer</a>(<span class="keywordtype">unsigned</span> ms);
<a name="l00105"></a>00105 <span class="preprocessor">#if CH_DBG_THREADS_PROFILING</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__test.html#ga92f3d7b7f63683ca0e873dd19eb450b0" title="CPU pulse.">test_cpu_pulse</a>(<span class="keywordtype">unsigned</span> duration);
<a name="l00107"></a>00107 <span class="preprocessor">#endif</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="preprocessor">#if defined(WIN32)</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span> <span class="keywordtype">void</span> ChkIntSources(<span class="keywordtype">void</span>);
<a name="l00110"></a>00110 <span class="preprocessor">#endif</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span>}
<a name="l00113"></a>00113 <span class="preprocessor">#endif</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/**</span>
<a name="l00116"></a>00116 <span class="comment"> * @brief Test failure enforcement.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a><a class="code" href="group__test.html#ga7839549262e1e0d8fedb90ef2bd4009e">00118</a> <span class="preprocessor">#define test_fail(point) { \</span>
<a name="l00119"></a>00119 <span class="preprocessor"> _test_fail(point); \</span>
<a name="l00120"></a>00120 <span class="preprocessor"> return; \</span>
<a name="l00121"></a>00121 <span class="preprocessor">}</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">/**</span>
<a name="l00124"></a>00124 <span class="comment"> * @brief Test assertion.</span>
<a name="l00125"></a>00125 <span class="comment"> *</span>
<a name="l00126"></a>00126 <span class="comment"> * @param[in] point numeric assertion identifier</span>
<a name="l00127"></a>00127 <span class="comment"> * @param[in] condition a boolean expression that must be verified to be true</span>
<a name="l00128"></a>00128 <span class="comment"> * @param[in] msg failure message</span>
<a name="l00129"></a>00129 <span class="comment"> */</span>
<a name="l00130"></a><a class="code" href="group__test.html#ga835cb17ca3869922b49435d95324a68b">00130</a> <span class="preprocessor">#define test_assert(point, condition, msg) { \</span>
<a name="l00131"></a>00131 <span class="preprocessor"> if (_test_assert(point, condition)) \</span>
<a name="l00132"></a>00132 <span class="preprocessor"> return; \</span>
<a name="l00133"></a>00133 <span class="preprocessor">}</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00135"></a>00135 <span class="comment">/**</span>
<a name="l00136"></a>00136 <span class="comment"> * @brief Test sequence assertion.</span>
<a name="l00137"></a>00137 <span class="comment"> *</span>
<a name="l00138"></a>00138 <span class="comment"> * @param[in] point numeric assertion identifier</span>
<a name="l00139"></a>00139 <span class="comment"> * @param[in] expected string to be matched with the tokens buffer</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a><a class="code" href="group__test.html#ga876d47c016ac2d69d6611274252bdaf9">00141</a> <span class="preprocessor">#define test_assert_sequence(point, expected) { \</span>
<a name="l00142"></a>00142 <span class="preprocessor"> if (_test_assert_sequence(point, expected)) \</span>
<a name="l00143"></a>00143 <span class="preprocessor"> return; \</span>
<a name="l00144"></a>00144 <span class="preprocessor">}</span>
<a name="l00145"></a>00145 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> * @brief Test time window assertion.</span>
<a name="l00148"></a>00148 <span class="comment"> *</span>
<a name="l00149"></a>00149 <span class="comment"> * @param[in] point numeric assertion identifier</span>
<a name="l00150"></a>00150 <span class="comment"> * @param[in] start initial time in the window (included)</span>
<a name="l00151"></a>00151 <span class="comment"> * @param[in] end final time in the window (not included)</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a><a class="code" href="group__test.html#gabb18a77859d6fc0972a35d88f11a90e1">00153</a> <span class="preprocessor">#define test_assert_time_window(point, start, end) { \</span>
<a name="l00154"></a>00154 <span class="preprocessor"> if (_test_assert_time_window(point, start, end)) \</span>
<a name="l00155"></a>00155 <span class="preprocessor"> return; \</span>
<a name="l00156"></a>00156 <span class="preprocessor">}</span>
<a name="l00157"></a>00157 <span class="preprocessor"></span>
<a name="l00158"></a>00158 <span class="preprocessor">#if !defined(__DOXYGEN__)</span>
<a name="l00159"></a>00159 <span class="preprocessor"></span><span class="keyword">extern</span> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *threads[MAX_THREADS];
<a name="l00160"></a>00160 <span class="keyword">extern</span> <span class="keyword">union </span>test_buffers test;
<a name="l00161"></a>00161 <span class="keyword">extern</span> <span class="keywordtype">void</span> * <span class="keyword">const</span> wa[];
<a name="l00162"></a>00162 <span class="keyword">extern</span> <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> <a class="code" href="group__test.html#gad74c89f8a5049c1055b6a0f0596424b0" title="Set to TRUE when the test timer reaches its deadline.">test_timer_done</a>;
<a name="l00163"></a>00163 <span class="preprocessor">#endif</span>
<a name="l00164"></a>00164 <span class="preprocessor"></span>
<a name="l00165"></a>00165 <span class="preprocessor">#endif </span><span class="comment">/* _TEST_H_ */</span>
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment">/** @} */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Jul 11 13:13:01 2010 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.6.3</small></address>
</body>
</html>