Mbed TLS v2.28.5
Loading...
Searching...
No Matches
threading.h
Go to the documentation of this file.
1
6/*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 */
22#ifndef MBEDTLS_THREADING_H
23#define MBEDTLS_THREADING_H
24
25#if !defined(MBEDTLS_CONFIG_FILE)
26#include "mbedtls/config.h"
27#else
28#include MBEDTLS_CONFIG_FILE
29#endif
30
31#include <stdlib.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/* MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE is deprecated and should not be
38 * used. */
40#define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A
41
43#define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C
45#define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E
46
47#if defined(MBEDTLS_THREADING_PTHREAD)
48#include <pthread.h>
50 pthread_mutex_t mutex;
51 /* is_valid is 0 after a failed init or a free, and nonzero after a
52 * successful init. This field is not considered part of the public
53 * API of Mbed TLS and may change without notice. */
56#endif
57
58#if defined(MBEDTLS_THREADING_ALT)
59/* You should define the mbedtls_threading_mutex_t type in your header */
60#include "threading_alt.h"
61
80void mbedtls_threading_set_alt(void (*mutex_init)(mbedtls_threading_mutex_t *),
81 void (*mutex_free)(mbedtls_threading_mutex_t *),
82 int (*mutex_lock)(mbedtls_threading_mutex_t *),
83 int (*mutex_unlock)(mbedtls_threading_mutex_t *));
84
88void mbedtls_threading_free_alt(void);
89#endif /* MBEDTLS_THREADING_ALT */
90
91#if defined(MBEDTLS_THREADING_C)
92/*
93 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock
94 *
95 * All these functions are expected to work or the result will be undefined.
96 */
101
102/*
103 * Global mutexes
104 */
105#if defined(MBEDTLS_FS_IO)
107#endif
108
109#if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT)
110/* This mutex may or may not be used in the default definition of
111 * mbedtls_platform_gmtime_r(), but in order to determine that,
112 * we need to check POSIX features, hence modify _POSIX_C_SOURCE.
113 * With the current approach, this declaration is orphaned, lacking
114 * an accompanying definition, in case mbedtls_platform_gmtime_r()
115 * doesn't need it, but that's not a problem. */
117#endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */
118
119#endif /* MBEDTLS_THREADING_C */
120
121#ifdef __cplusplus
122}
123#endif
124
125#endif /* threading.h */
Configuration options (set of defines)
pthread_mutex_t mutex
Definition: threading.h:50
void(* mbedtls_mutex_init)(mbedtls_threading_mutex_t *mutex)
void(* mbedtls_mutex_free)(mbedtls_threading_mutex_t *mutex)
mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex
mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex
int(* mbedtls_mutex_unlock)(mbedtls_threading_mutex_t *mutex)
int(* mbedtls_mutex_lock)(mbedtls_threading_mutex_t *mutex)