mbed TLS v2.7.16
threading.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  *
49  * This file is part of mbed TLS (https://tls.mbed.org)
50  */
51 #ifndef MBEDTLS_THREADING_H
52 #define MBEDTLS_THREADING_H
53 
54 #if !defined(MBEDTLS_CONFIG_FILE)
55 #include "config.h"
56 #else
57 #include MBEDTLS_CONFIG_FILE
58 #endif
59 
60 #include <stdlib.h>
61 
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65 
66 #define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A
67 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C
68 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E
70 #if defined(MBEDTLS_THREADING_PTHREAD)
71 #include <pthread.h>
72 typedef struct
73 {
74  pthread_mutex_t mutex;
75  char is_valid;
76 } mbedtls_threading_mutex_t;
77 #endif
78 
79 #if defined(MBEDTLS_THREADING_ALT)
80 /* You should define the mbedtls_threading_mutex_t type in your header */
81 #include "threading_alt.h"
82 
101 void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ),
102  void (*mutex_free)( mbedtls_threading_mutex_t * ),
103  int (*mutex_lock)( mbedtls_threading_mutex_t * ),
104  int (*mutex_unlock)( mbedtls_threading_mutex_t * ) );
105 
109 void mbedtls_threading_free_alt( void );
110 #endif /* MBEDTLS_THREADING_ALT */
111 
112 #if defined(MBEDTLS_THREADING_C)
113 /*
114  * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock
115  *
116  * All these functions are expected to work or the result will be undefined.
117  */
118 extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex );
119 extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex );
120 extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex );
121 extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex );
122 
123 /*
124  * Global mutexes
125  */
126 #if defined(MBEDTLS_FS_IO)
127 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex;
128 #endif
129 #if defined(MBEDTLS_HAVE_TIME_DATE)
130 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex;
131 #endif
132 #endif /* MBEDTLS_THREADING_C */
133 
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #endif /* threading.h */
Configuration options (set of defines)