gnuk/ChibiOS_2.0.6/docs/html/chdebug_8h_source.html

215 lines
21 KiB
HTML
Raw Normal View History

2010-08-10 03:11:02 +00:00
<!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: chdebug.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">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<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>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="headertitle">
<h1>chdebug.h</h1> </div>
</div>
<div class="contents">
<a href="chdebug_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>
2010-08-10 03:11:02 +00:00
<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 chdebug.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Debug macros and structures.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup debug</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 _CHDEBUG_H_</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHDEBUG_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 Trace buffer entries.</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef TRACE_BUFFER_SIZE</span>
2010-11-22 05:53:37 +00:00
<a name="l00042"></a><a class="code" href="group__debug.html#ga85f9a678e5f44d97a8a21adab8c065b7">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define TRACE_BUFFER_SIZE 64</span>
2010-08-10 03:11:02 +00:00
<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 Fill value for thread stack area in debug mode.</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a>00048 <span class="preprocessor">#ifndef STACK_FILL_VALUE</span>
<a name="l00049"></a><a class="code" href="group__debug.html#ga1379fe3590594def45a6a6c7a4faa41b">00049</a> <span class="preprocessor"></span><span class="preprocessor">#define STACK_FILL_VALUE 0x55</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment">/**</span>
<a name="l00053"></a>00053 <span class="comment"> * @brief Fill value for thread area in debug mode.</span>
<a name="l00054"></a>00054 <span class="comment"> * @note The chosen default value is 0xFF in order to make evident which</span>
<a name="l00055"></a>00055 <span class="comment"> * thread fields were not initialized when inspecting the memory with</span>
<a name="l00056"></a>00056 <span class="comment"> * a debugger. A uninitialized field is not an error in itself but it</span>
<a name="l00057"></a>00057 <span class="comment"> * better to know it.</span>
<a name="l00058"></a>00058 <span class="comment"> */</span>
<a name="l00059"></a>00059 <span class="preprocessor">#ifndef THREAD_FILL_VALUE</span>
<a name="l00060"></a><a class="code" href="group__debug.html#gad8d58eb160d991692ecc3bd4e04e0cbd">00060</a> <span class="preprocessor"></span><span class="preprocessor">#define THREAD_FILL_VALUE 0xFF</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span>
<a name="l00063"></a>00063 <span class="preprocessor">#if CH_DBG_ENABLE_TRACE || defined(__DOXYGEN__)</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00065"></a>00065 <span class="comment"> * @brief Trace buffer record.</span>
<a name="l00066"></a>00066 <span class="comment"> */</span>
<a name="l00067"></a><a class="code" href="struct_ctx_swc_event.html">00067</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00068"></a><a class="code" href="struct_ctx_swc_event.html#ac28fce73613158bf501382c110c4a0fa">00068</a> <span class="keywordtype">void</span> *cse_wtobjp; <span class="comment">/**&lt; @brief Object where going to</span>
<a name="l00069"></a>00069 <span class="comment"> sleep. */</span>
<a name="l00070"></a><a class="code" href="struct_ctx_swc_event.html#a463c08b6776d7337d18b1965243abfc9">00070</a> <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> cse_time; <span class="comment">/**&lt; @brief Time of the switch</span>
<a name="l00071"></a>00071 <span class="comment"> event. */</span>
<a name="l00072"></a><a class="code" href="struct_ctx_swc_event.html#a83d48714c7e96b1bb4f8756ea5cbaf56">00072</a> <a class="code" href="group___s_t_m8___c_o_r_e.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> cse_state: 4; <span class="comment">/**&lt; @brief Switched out thread</span>
<a name="l00073"></a>00073 <span class="comment"> state. */</span>
<a name="l00074"></a><a class="code" href="struct_ctx_swc_event.html#ad982bde0268f45b772c07d993de65a41">00074</a> <a class="code" href="group___s_t_m8___c_o_r_e.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> cse_tid: 12; <span class="comment">/**&lt; @brief Switched in thread id. */</span>
<a name="l00075"></a>00075 } <a class="code" href="struct_ctx_swc_event.html" title="Trace buffer record.">CtxSwcEvent</a>;
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">/**</span>
<a name="l00078"></a>00078 <span class="comment"> * @brief Trace buffer header.</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a><a class="code" href="struct_trace_buffer.html">00080</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00081"></a><a class="code" href="struct_trace_buffer.html#aca809b9d6e80fb01c98e67f25f53aa37">00081</a> <span class="keywordtype">unsigned</span> tb_size; <span class="comment">/**&lt; @brief Trace buffer size</span>
<a name="l00082"></a>00082 <span class="comment"> (entries). */</span>
<a name="l00083"></a><a class="code" href="struct_trace_buffer.html#a647a0c08bf641558f87ca690fd933097">00083</a> <a class="code" href="struct_ctx_swc_event.html" title="Trace buffer record.">CtxSwcEvent</a> *tb_ptr; <span class="comment">/**&lt; @brief Pointer to the ring buffer</span>
<a name="l00084"></a>00084 <span class="comment"> front. */</span><span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment"> /** @brief Ring buffer.*/</span>
<a name="l00086"></a><a class="code" href="struct_trace_buffer.html#a3e5f6e61398a217126933b092afd1cea">00086</a> <a class="code" href="struct_ctx_swc_event.html" title="Trace buffer record.">CtxSwcEvent</a> tb_buffer[TRACE_BUFFER_SIZE];
<a name="l00087"></a>00087 } <a class="code" href="struct_trace_buffer.html" title="Trace buffer header.">TraceBuffer</a>;
<a name="l00088"></a>00088 <span class="preprocessor">#endif </span><span class="comment">/* CH_DBG_ENABLE_TRACE */</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="preprocessor">#define __QUOTE_THIS(p) #p</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
<a name="l00092"></a>00092 <span class="preprocessor">#if CH_DBG_ENABLE_CHECKS</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00094"></a>00094 <span class="comment"> * @brief Function parameter check.</span>
<a name="l00095"></a>00095 <span class="comment"> * @details If the condition check fails then the kernel panics and halts.</span>
<a name="l00096"></a>00096 <span class="comment"> * @note The condition is tested only if the @p CH_DBG_ENABLE_CHECKS switch</span>
<a name="l00097"></a>00097 <span class="comment"> * is specified in @p chconf.h else the macro does nothing.</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * @param[in] c the condition to be verified to be true</span>
<a name="l00100"></a>00100 <span class="comment"> * @param[in] func the undecorated function name</span>
<a name="l00101"></a>00101 <span class="comment"> */</span>
<a name="l00102"></a><a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844">00102</a> <span class="preprocessor">#define chDbgCheck(c, func) { \</span>
<a name="l00103"></a>00103 <span class="preprocessor"> if (!(c)) \</span>
<a name="l00104"></a>00104 <span class="preprocessor"> chDbgPanic(__QUOTE_THIS(func)&quot;(), line &quot;__QUOTE_THIS(__LINE__)); \</span>
<a name="l00105"></a>00105 <span class="preprocessor">}</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* !CH_DBG_ENABLE_CHECKS */</span>
<a name="l00107"></a>00107 <span class="preprocessor">#define chDbgCheck(c, func) { \</span>
<a name="l00108"></a>00108 <span class="preprocessor"> (void)(c), (void)__QUOTE_THIS(func)&quot;(), line &quot;__QUOTE_THIS(__LINE__); \</span>
<a name="l00109"></a>00109 <span class="preprocessor">}</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !CH_DBG_ENABLE_CHECKS */</span>
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="preprocessor">#if CH_DBG_ENABLE_ASSERTS</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00114"></a>00114 <span class="comment"> * @brief Condition assertion.</span>
<a name="l00115"></a>00115 <span class="comment"> * @details If the condition check fails then the kernel panics with the</span>
<a name="l00116"></a>00116 <span class="comment"> * specified message and halts.</span>
<a name="l00117"></a>00117 <span class="comment"> * @note The condition is tested only if the @p CH_DBG_ENABLE_ASSERTS switch</span>
<a name="l00118"></a>00118 <span class="comment"> * is specified in @p chconf.h else the macro does nothing.</span>
<a name="l00119"></a>00119 <span class="comment"> * @note The convention for the message is the following:&lt;br&gt;</span>
<a name="l00120"></a>00120 <span class="comment"> * @&lt;function_name@&gt;(), #@&lt;assert_number@&gt;</span>
<a name="l00121"></a>00121 <span class="comment"> * @note The remark string is not currently used except for putting a</span>
<a name="l00122"></a>00122 <span class="comment"> * comment in the code about the assertion.</span>
<a name="l00123"></a>00123 <span class="comment"> *</span>
<a name="l00124"></a>00124 <span class="comment"> * @param[in] c the condition to be verified to be true</span>
<a name="l00125"></a>00125 <span class="comment"> * @param[in] m the text message</span>
<a name="l00126"></a>00126 <span class="comment"> * @param[in] r a remark string</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a><a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9">00128</a> <span class="preprocessor">#define chDbgAssert(c, m, r) { \</span>
<a name="l00129"></a>00129 <span class="preprocessor"> if (!(c)) \</span>
<a name="l00130"></a>00130 <span class="preprocessor"> chDbgPanic(m); \</span>
<a name="l00131"></a>00131 <span class="preprocessor">}</span>
<a name="l00132"></a>00132 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* !CH_DBG_ENABLE_ASSERTS */</span>
<a name="l00133"></a>00133 <span class="preprocessor">#define chDbgAssert(c, m, r) {(void)(c);}</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !CH_DBG_ENABLE_ASSERTS */</span>
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="preprocessor">#if !(CH_DBG_ENABLE_ASSERTS || \</span>
<a name="l00137"></a>00137 <span class="preprocessor"> CH_DBG_ENABLE_CHECKS || \</span>
<a name="l00138"></a>00138 <span class="preprocessor"> CH_DBG_ENABLE_STACK_CHECK)</span>
<a name="l00139"></a>00139 <span class="preprocessor"></span><span class="comment">/* When the debug features are disabled this function is replaced by an empty</span>
<a name="l00140"></a>00140 <span class="comment"> macro.*/</span>
<a name="l00141"></a>00141 <span class="preprocessor">#define chDbgPanic(msg) {}</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00143"></a>00143 <span class="preprocessor"></span>
<a name="l00144"></a>00144 <span class="preprocessor">#if !CH_DBG_ENABLE_TRACE</span>
<a name="l00145"></a>00145 <span class="preprocessor"></span><span class="comment">/* When the trace feature is disabled this function is replaced by an empty</span>
<a name="l00146"></a>00146 <span class="comment"> macro.*/</span>
<a name="l00147"></a>00147 <span class="preprocessor">#define chDbgTrace(otp) {}</span>
<a name="l00148"></a>00148 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00149"></a>00149 <span class="preprocessor"></span>
<a name="l00150"></a>00150 <span class="preprocessor">#if !defined(__DOXYGEN__)</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span><span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00152"></a>00152 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00153"></a>00153 <span class="preprocessor">#endif</span>
<a name="l00154"></a>00154 <span class="preprocessor"></span><span class="preprocessor">#if CH_DBG_ENABLE_TRACE</span>
<a name="l00155"></a>00155 <span class="preprocessor"></span> <span class="keyword">extern</span> <a class="code" href="struct_trace_buffer.html" title="Trace buffer header.">TraceBuffer</a> <a class="code" href="group__debug.html#ga8293a8dffdb533372e469fafd5a12f21" title="Public trace buffer.">trace_buffer</a>;
<a name="l00156"></a>00156 <span class="keywordtype">void</span> <a class="code" href="group__debug.html#ga5ef5d43e7c59f0ee9c490ea4e423c008" title="Trace circular buffer subsystem initialization.">trace_init</a>(<span class="keywordtype">void</span>);
<a name="l00157"></a>00157 <span class="keywordtype">void</span> <a class="code" href="group__debug.html#gac7f8f0653faf2e3a93108ff5333821b7" title="Inserts in the circular debug trace buffer a context switch record.">chDbgTrace</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *otp);
<a name="l00158"></a>00158 <span class="preprocessor">#endif</span>
<a name="l00159"></a>00159 <span class="preprocessor"></span><span class="preprocessor">#if CH_DBG_ENABLE_ASSERTS || CH_DBG_ENABLE_CHECKS || CH_DBG_ENABLE_STACK_CHECK</span>
<a name="l00160"></a>00160 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="keywordtype">char</span> *<a class="code" href="group__debug.html#ga218d35701e90bead41b249f80f58aac4" title="Pointer to the panic message.">panic_msg</a>;
<a name="l00161"></a>00161 <span class="keywordtype">void</span> <a class="code" href="group__debug.html#ga3cfb02183cd13f939b9b666810511157" title="Prints a panic message on the console and then halts the system.">chDbgPanic</a>(<span class="keywordtype">char</span> *msg);
<a name="l00162"></a>00162 <span class="preprocessor">#endif</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span><span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00164"></a>00164 <span class="preprocessor"></span>}
<a name="l00165"></a>00165 <span class="preprocessor">#endif</span>
<a name="l00166"></a>00166 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !defined(__DOXYGEN__) */</span>
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="preprocessor">#endif </span><span class="comment">/* _CHDEBUG_H_ */</span>
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment">/** @} */</span>
</pre></div></div>
2010-11-22 05:53:37 +00:00
</div>
2010-08-10 03:11:02 +00:00
<hr size="1"><address style="text-align: right;"><small>
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:37 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>
2010-08-10 03:11:02 +00:00
</body>
</html>