<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tpm2-tss: src/tss2-fapi/ifapi_macros.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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tpm2-tss
 <span id="projectnumber">3.2.0</span>
</div>
<div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','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">
$(document).ready(function(){initNavTree('ifapi__macros_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">ifapi_macros.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-License-Identifier: BSD-2-Clause */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2018-2019, Fraunhofer SIT sponsored by Infineon Technologies AG</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *******************************************************************************/</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef IFAPI_MACROS_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define IFAPI_MACROS_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define strdup_check(dest, str, r, label) \</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"> if (str) { \</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"> dest = strdup(str); \</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"> if (!dest) { \</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"> r = TSS2_FAPI_RC_MEMORY; \</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"> LOG_ERROR("Out of memory."); \</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"> } \</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"> } else { \</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"> dest = NULL; \</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define calloc_check(dest, size, r, label) \</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"> { \</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"> dest = callock(size,1); \</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"> if (!dest) { \</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"> r = TSS2_FAPI_RC_MEMORY; \</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"> LOG_ERROR("Out of memory."); \</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"> } \</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define goto_if_null2(p,msg, r, ec, label, ...) \</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> if ((p) == NULL) { \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(ec), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"> r = (ec); \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define goto_if_error2(r,msg,label, ...) \</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"> if (r != TSS2_RC_SUCCESS) { \</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define return_if_error2(r,msg, ...) \</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> if (r != TSS2_RC_SUCCESS) { \</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"> return r; \</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define try_again_or_error(r,msg, ...) \</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"> if (base_rc(r) == TSS2_BASE_RC_TRY_AGAIN) \</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"> return TSS2_FAPI_RC_TRY_AGAIN; \</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"> if (r != TSS2_RC_SUCCESS) { \</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"> return r; \</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define try_again_or_error_goto(r,msg, label, ...) \</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"> if (base_rc(r) == TSS2_BASE_RC_TRY_AGAIN) \</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> return TSS2_FAPI_RC_TRY_AGAIN; \</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"> if (r != TSS2_RC_SUCCESS) { \</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#define return_error2(r,msg, ...) { \</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> return (r); }</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#define return_if_error_reset_state(r,msg, ...) \</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> if (r != TSS2_RC_SUCCESS) { \</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> context->state = _FAPI_STATE_INIT; \</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> return r; \</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#define goto_if_error_reset_state(r,msg,label, ...) \</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"> if (r != TSS2_RC_SUCCESS) { \</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"> LOG_ERROR(TPM2_ERROR_FORMAT " " msg, TPM2_ERROR_TEXT(r), ## __VA_ARGS__); \</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> context->state = _FAPI_STATE_INIT; \</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#define goto_error_reset_state(r,v,msg,label) { \</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"> r = v; \</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"> LOG_ERROR("%s " TPM2_ERROR_FORMAT, msg, TPM2_ERROR_TEXT(r)); \</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"> context->state = _FAPI_STATE_INIT; \</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"> goto label; }</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#define goto_if_null_reset_state(p,msg,r,ec,label) \</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> if ((p) == NULL) { \</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> LOG_ERROR("%s ", (msg)); \</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> context->state = _FAPI_STATE_INIT; \</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor"> (r) = (ec); \</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"> goto label; \</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#define return_try_again(r) \</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor"> if (base_rc(r) == TSS2_BASE_RC_TRY_AGAIN) { \</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"> LOG_TRACE("Received TRY_AGAIN; returning TRY_AGAIN"); \</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor"> return TSS2_FAPI_RC_TRY_AGAIN; \</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#define check_not_null(X) \</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"> if (X == NULL) { \</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> LOG_ERROR(str(X) " is NULL: BAD_REFERENCE"); \</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> return TSS2_FAPI_RC_BAD_REFERENCE; \</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#define check_oom(X) \</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"> if (X == NULL) { \</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"> LOG_ERROR("Out of memory"); \</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"> return TSS2_FAPI_RC_MEMORY; \</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#if defined __GNUC__ && __GNUC__ < 7</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#define fallthrough { }</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#define fallthrough __attribute__((fallthrough))</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#define statecase(VAR, STATE) \</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor"> case STATE: \</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor"> LOG_TRACE("State " str(VAR) " reached " str(STATE)); \</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor"> VAR=STATE;</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#define general_failure(VAR) \</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor"> default: \</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor"> LOG_ERROR("Bad state for " str(VAR)); \</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor"> return TSS2_FAPI_RC_GENERAL_FAILURE;</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#define statecasedefault(VAR) \</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor"> default: \</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor"> LOG_ERROR("Bad state for " str(VAR)); \</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor"> return TSS2_FAPI_RC_BAD_SEQUENCE;</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#define statecasedefault_error(VAR, r, label) \</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor"> default: \</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor"> LOG_ERROR("Bad state for " str(VAR)); \</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor"> r = TSS2_FAPI_RC_BAD_SEQUENCE; \</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor"> goto label;</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif </span><span class="comment">/* IFAPI_MACROS_H */</span><span class="preprocessor"></span></div></div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_acac3fc32f1470bed36645d881a616c0.html">tss2-fapi</a></li><li class="navelem"><b>ifapi_macros.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>