Files
moslab-code/doc/source/html/sys_2assert_8h_source.html
2025-09-12 15:55:45 +02:00

179 lines
18 KiB
HTML

<!-- HTML header for doxygen 1.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: l4/sys/assert.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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</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',true);
$(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">
$(function(){initNavTree('sys_2assert_8h_source.html','',''); });
</script>
<div id="container">
<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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">assert.h</div></div>
</div><!--header-->
<div class="contents">
<a href="sys_2assert_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">/*</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * (c) 2015 Adam Lackorzynski &lt;adam@l4re.org&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> *</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> */</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#ifdef NDEBUG</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#define l4_assert(x) do { } while (0)</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define l4_check(x) do { (void)(x); } while (0)</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;<a class="code" href="compiler_8h.html">l4/sys/compiler.h</a>&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;<a class="code" href="l4_2sys_2thread_8h.html">l4/sys/thread.h</a>&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &lt;<a class="code" href="vcon_8h.html">l4/sys/vcon.h</a>&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
<div class="foldopen" id="foldopen00032" data-start="" data-end="">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="sys_2assert_8h.html#a01be6aeab808dab408e341a7a8bd17a6"> 32</a></span><span class="preprocessor">#define l4_assert(expr) \</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor"> l4_assert_fn(!!(expr), __FILE__ &quot;:&quot; L4_stringify(__LINE__) &quot;: Assertion \&quot;&quot; \</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor"> L4_stringify(expr) &quot;\&quot; failed.\n&quot;)</span></div>
</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#define l4_check(expr) l4_assert(expr)</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><a class="code hl_define" href="group__l4sys__defines.html#ga2480e75b7c2b4976ce05d124d6d4c984">L4_ALWAYS_INLINE</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keywordtype">void</span> l4_assert_fn(<span class="keywordtype">unsigned</span> expr, <span class="keyword">const</span> <span class="keywordtype">char</span> *text) <a class="code hl_define" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><a class="code hl_define" href="group__l4sys__defines.html#ga427377e23e3680dc178035d391b2ca45">L4_INLINE</a> <a class="code hl_define" href="group__l4sys__defines.html#gab2364b91355f435e015c5b85b7d93a73">L4_NORETURN</a></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keywordtype">void</span> l4_assert_abort(<span class="keyword">const</span> <span class="keywordtype">char</span> *text) <a class="code hl_define" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment">/* IMPLEMENTATION -----------------------------------------------------------*/</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><a class="code hl_define" href="group__l4sys__defines.html#ga427377e23e3680dc178035d391b2ca45">L4_INLINE</a> <a class="code hl_define" href="group__l4sys__defines.html#gab2364b91355f435e015c5b85b7d93a73">L4_NORETURN</a></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keywordtype">void</span> l4_assert_abort(<span class="keyword">const</span> <span class="keywordtype">char</span> *text) <a class="code hl_define" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>{</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_function" href="group__l4__vcon__api.html#ga9f083a69c2c51329da6778a3af0331bc">l4_vcon_write</a>(<a class="code hl_enumvalue" href="group__l4__cap__api.html#ggaa7801b63edba351bad9ea8026432b5c4af57a9dce7f2435bea0e7f7a2298a0022">L4_BASE_LOG_CAP</a>, text, __builtin_strlen(text));</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">for</span> (;;)</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_function" href="group__l4__thread__api.html#ga1ea29499c679caeae810516d16f4347c">l4_thread_ex_regs</a>(<a class="code hl_enumvalue" href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a>, ~0UL, ~0UL,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_enumvalue" href="group__l4__thread__api.html#gga288a4500e4be2587d2f16d754d1a2e16abed26b392ea6e1ee9f468246ae19bf35">L4_THREAD_EX_REGS_TRIGGER_EXCEPTION</a>);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>}</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><a class="code hl_define" href="group__l4sys__defines.html#ga2480e75b7c2b4976ce05d124d6d4c984">L4_ALWAYS_INLINE</a></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="keywordtype">void</span> l4_assert_fn(<span class="keywordtype">unsigned</span> expr, <span class="keyword">const</span> <span class="keywordtype">char</span> *text) <a class="code hl_define" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>{</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">if</span> (<a class="code hl_define" href="group__l4sys__defines.html#gac76599eba5afa89a12c44176cbfa90cb">L4_LIKELY</a>(expr))</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> l4_assert_abort(text);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>}</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="preprocessor">#endif </span><span class="comment">/* NDEBUG */</span><span class="preprocessor"></span></div>
<div class="ttc" id="acompiler_8h_html"><div class="ttname"><a href="compiler_8h.html">compiler.h</a></div><div class="ttdoc">L4 compiler related defines.</div></div>
<div class="ttc" id="agroup__l4__cap__api_html_ggaa7801b63edba351bad9ea8026432b5c4af57a9dce7f2435bea0e7f7a2298a0022"><div class="ttname"><a href="group__l4__cap__api.html#ggaa7801b63edba351bad9ea8026432b5c4af57a9dce7f2435bea0e7f7a2298a0022">L4_BASE_LOG_CAP</a></div><div class="ttdeci">@ L4_BASE_LOG_CAP</div><div class="ttdoc">Capability selector for the log object.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2consts_8h_source.html#l00347">consts.h:347</a></div></div>
<div class="ttc" id="agroup__l4__cap__api_html_ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102"><div class="ttname"><a href="group__l4__cap__api.html#ggafee0421c2fe0e5cfc59f17f16ea10879aff9320ed307e76cebfca6c2871136102">L4_INVALID_CAP</a></div><div class="ttdeci">@ L4_INVALID_CAP</div><div class="ttdoc">Invalid capability selector.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2consts_8h_source.html#l00153">consts.h:153</a></div></div>
<div class="ttc" id="agroup__l4__thread__api_html_ga1ea29499c679caeae810516d16f4347c"><div class="ttname"><a href="group__l4__thread__api.html#ga1ea29499c679caeae810516d16f4347c">l4_thread_ex_regs</a></div><div class="ttdeci">l4_msgtag_t l4_thread_ex_regs(l4_cap_idx_t thread, l4_addr_t ip, l4_addr_t sp, l4_umword_t flags) L4_NOTHROW</div><div class="ttdoc">Exchange basic thread registers.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2thread_8h_source.html#l00942">thread.h:942</a></div></div>
<div class="ttc" id="agroup__l4__thread__api_html_gga288a4500e4be2587d2f16d754d1a2e16abed26b392ea6e1ee9f468246ae19bf35"><div class="ttname"><a href="group__l4__thread__api.html#gga288a4500e4be2587d2f16d754d1a2e16abed26b392ea6e1ee9f468246ae19bf35">L4_THREAD_EX_REGS_TRIGGER_EXCEPTION</a></div><div class="ttdeci">@ L4_THREAD_EX_REGS_TRIGGER_EXCEPTION</div><div class="ttdoc">Trigger artificial exception in thread.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2thread_8h_source.html#l00800">thread.h:800</a></div></div>
<div class="ttc" id="agroup__l4__vcon__api_html_ga9f083a69c2c51329da6778a3af0331bc"><div class="ttname"><a href="group__l4__vcon__api.html#ga9f083a69c2c51329da6778a3af0331bc">l4_vcon_write</a></div><div class="ttdeci">long l4_vcon_write(l4_cap_idx_t vcon, char const *buf, unsigned size) L4_NOTHROW</div><div class="ttdoc">Write data to virtual console.</div><div class="ttdef"><b>Definition</b> <a href="vcon_8h_source.html#l00336">vcon.h:336</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga2480e75b7c2b4976ce05d124d6d4c984"><div class="ttname"><a href="group__l4sys__defines.html#ga2480e75b7c2b4976ce05d124d6d4c984">L4_ALWAYS_INLINE</a></div><div class="ttdeci">#define L4_ALWAYS_INLINE</div><div class="ttdoc">Always inline a function.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00058">compiler.h:58</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga362dfa378e662dd04f710a23fc7ea931"><div class="ttname"><a href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></div><div class="ttdeci">#define L4_NOTHROW</div><div class="ttdoc">Mark a function declaration and definition as never throwing an exception.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00161">compiler.h:161</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga427377e23e3680dc178035d391b2ca45"><div class="ttname"><a href="group__l4sys__defines.html#ga427377e23e3680dc178035d391b2ca45">L4_INLINE</a></div><div class="ttdeci">#define L4_INLINE</div><div class="ttdoc">L4 Inline function attribute.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00051">compiler.h:51</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_gab2364b91355f435e015c5b85b7d93a73"><div class="ttname"><a href="group__l4sys__defines.html#gab2364b91355f435e015c5b85b7d93a73">L4_NORETURN</a></div><div class="ttdeci">#define L4_NORETURN</div><div class="ttdoc">Noreturn function attribute.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00201">compiler.h:201</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_gac76599eba5afa89a12c44176cbfa90cb"><div class="ttname"><a href="group__l4sys__defines.html#gac76599eba5afa89a12c44176cbfa90cb">L4_LIKELY</a></div><div class="ttdeci">#define L4_LIKELY(x)</div><div class="ttdoc">Expression is likely to execute.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00283">compiler.h:283</a></div></div>
<div class="ttc" id="al4_2sys_2thread_8h_html"><div class="ttname"><a href="l4_2sys_2thread_8h.html">thread.h</a></div><div class="ttdoc">Common thread related definitions.</div></div>
<div class="ttc" id="avcon_8h_html"><div class="ttname"><a href="vcon_8h.html">vcon.h</a></div><div class="ttdoc">Virtual console interface.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>l4</b></li><li class="navelem"><b>sys</b></li><li class="navelem"><a href="sys_2assert_8h.html">assert.h</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>