<!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>mbed TLS v2.7.6: threading.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="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">mbed TLS v2.7.6 </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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">threading.h</div> </div> </div><!--header--> <div class="contents"> <a href="threading_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/*</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * not use this file except in compliance with the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * This file is part of mbed TLS (https://tls.mbed.org)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef MBEDTLS_THREADING_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define MBEDTLS_THREADING_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#if !defined(MBEDTLS_CONFIG_FILE)</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="config_8h.html">config.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include MBEDTLS_CONFIG_FILE</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <stdlib.h></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="threading_8h.html#ad3cbda6bbb5ce837b33ada893d7d5613"> 39</a></span> <span class="preprocessor">#define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A </span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="threading_8h.html#a76cd79a1ed3fd583ed3a4428d6a1e967"> 40</a></span> <span class="preprocessor">#define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C </span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="threading_8h.html#a51005c51b928706511d3c2ea3390c07f"> 41</a></span> <span class="preprocessor">#define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E </span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#if defined(MBEDTLS_THREADING_PTHREAD)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include <pthread.h></span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structmbedtls__threading__mutex__t.html"> 45</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structmbedtls__threading__mutex__t.html#a55664deb2a4c37da07f59afdeed1e0f8"> 47</a></span>  pthread_mutex_t <a class="code" href="structmbedtls__threading__mutex__t.html#a55664deb2a4c37da07f59afdeed1e0f8">mutex</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structmbedtls__threading__mutex__t.html#abcb41b414dc71a45e5150ddeb3452b86"> 48</a></span>  <span class="keywordtype">char</span> <a class="code" href="structmbedtls__threading__mutex__t.html#abcb41b414dc71a45e5150ddeb3452b86">is_valid</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> } <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#if defined(MBEDTLS_THREADING_ALT)</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/* You should define the mbedtls_threading_mutex_t type in your header */</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#include "threading_alt.h"</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">void</span> mbedtls_threading_set_alt( <span class="keywordtype">void</span> (*mutex_init)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> * ),</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> (*mutex_free)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> * ),</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> (*mutex_lock)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> * ),</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">int</span> (*mutex_unlock)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> * ) );</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> mbedtls_threading_free_alt( <span class="keywordtype">void</span> );</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_THREADING_ALT */</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">#if defined(MBEDTLS_THREADING_C)</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/*</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> *</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * All these functions are expected to work or the result will be undefined.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">extern</span> void (*<a class="code" href="threading_8h.html#a197b6c71b89a7db14e6540c1280d4b1f">mbedtls_mutex_init</a>)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> *mutex );</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">extern</span> void (*<a class="code" href="threading_8h.html#a623f4688707b88f2ee3313b64f505c0e">mbedtls_mutex_free</a>)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> *mutex );</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">extern</span> int (*<a class="code" href="threading_8h.html#af42238b3b7d16726a7b87edf7e7a68fe">mbedtls_mutex_lock</a>)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> *mutex );</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">extern</span> int (*<a class="code" href="threading_8h.html#a98737d8d49dfb29a36efc3d9ef7cf13c">mbedtls_mutex_unlock</a>)( <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> *mutex );</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/*</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * Global mutexes</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#if defined(MBEDTLS_FS_IO)</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">extern</span> <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> <a class="code" href="threading_8h.html#a87bbccdf40874b80a9f7313627734c38">mbedtls_threading_readdir_mutex</a>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#if defined(MBEDTLS_HAVE_TIME_DATE)</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">extern</span> <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> <a class="code" href="threading_8h.html#a81df682884dc24198fb7fc86c6100f34">mbedtls_threading_gmtime_mutex</a>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_THREADING_C */</span><span class="preprocessor"></span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#endif</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">#endif </span><span class="comment">/* threading.h */</span><span class="preprocessor"></span></div><div class="ttc" id="threading_8h_html_a87bbccdf40874b80a9f7313627734c38"><div class="ttname"><a href="threading_8h.html#a87bbccdf40874b80a9f7313627734c38">mbedtls_threading_readdir_mutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex</div></div> <div class="ttc" id="threading_8h_html_a98737d8d49dfb29a36efc3d9ef7cf13c"><div class="ttname"><a href="threading_8h.html#a98737d8d49dfb29a36efc3d9ef7cf13c">mbedtls_mutex_unlock</a></div><div class="ttdeci">int(* mbedtls_mutex_unlock)(mbedtls_threading_mutex_t *mutex)</div></div> <div class="ttc" id="config_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Configuration options (set of defines) </div></div> <div class="ttc" id="threading_8h_html_a81df682884dc24198fb7fc86c6100f34"><div class="ttname"><a href="threading_8h.html#a81df682884dc24198fb7fc86c6100f34">mbedtls_threading_gmtime_mutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex</div></div> <div class="ttc" id="threading_8h_html_a197b6c71b89a7db14e6540c1280d4b1f"><div class="ttname"><a href="threading_8h.html#a197b6c71b89a7db14e6540c1280d4b1f">mbedtls_mutex_init</a></div><div class="ttdeci">void(* mbedtls_mutex_init)(mbedtls_threading_mutex_t *mutex)</div></div> <div class="ttc" id="structmbedtls__threading__mutex__t_html"><div class="ttname"><a href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a></div><div class="ttdef"><b>Definition:</b> <a href="threading_8h_source.html#l00045">threading.h:45</a></div></div> <div class="ttc" id="structmbedtls__threading__mutex__t_html_a55664deb2a4c37da07f59afdeed1e0f8"><div class="ttname"><a href="structmbedtls__threading__mutex__t.html#a55664deb2a4c37da07f59afdeed1e0f8">mbedtls_threading_mutex_t::mutex</a></div><div class="ttdeci">pthread_mutex_t mutex</div><div class="ttdef"><b>Definition:</b> <a href="threading_8h_source.html#l00047">threading.h:47</a></div></div> <div class="ttc" id="threading_8h_html_a623f4688707b88f2ee3313b64f505c0e"><div class="ttname"><a href="threading_8h.html#a623f4688707b88f2ee3313b64f505c0e">mbedtls_mutex_free</a></div><div class="ttdeci">void(* mbedtls_mutex_free)(mbedtls_threading_mutex_t *mutex)</div></div> <div class="ttc" id="threading_8h_html_af42238b3b7d16726a7b87edf7e7a68fe"><div class="ttname"><a href="threading_8h.html#af42238b3b7d16726a7b87edf7e7a68fe">mbedtls_mutex_lock</a></div><div class="ttdeci">int(* mbedtls_mutex_lock)(mbedtls_threading_mutex_t *mutex)</div></div> <div class="ttc" id="structmbedtls__threading__mutex__t_html_abcb41b414dc71a45e5150ddeb3452b86"><div class="ttname"><a href="structmbedtls__threading__mutex__t.html#abcb41b414dc71a45e5150ddeb3452b86">mbedtls_threading_mutex_t::is_valid</a></div><div class="ttdeci">char is_valid</div><div class="ttdef"><b>Definition:</b> <a href="threading_8h_source.html#l00048">threading.h:48</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 12 2018 20:26:59 for mbed TLS v2.7.6 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>