blob: b416d478a56a0c4ee975aeaa50444b337ce864ee [file] [log] [blame]
Paul Bakker2466d932013-09-28 14:40:38 +02001/**
2 * \file threading.h
3 *
4 * \brief Threading abstraction layer
5 *
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02006 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02007 * SPDX-License-Identifier: Apache-2.0
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
Paul Bakker2466d932013-09-28 14:40:38 +020020 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000021 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker2466d932013-09-28 14:40:38 +020022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020023#ifndef MBEDTLS_THREADING_H
24#define MBEDTLS_THREADING_H
Paul Bakker2466d932013-09-28 14:40:38 +020025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakker2466d932013-09-28 14:40:38 +020027#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020028#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020030#endif
Paul Bakker2466d932013-09-28 14:40:38 +020031
32#include <stdlib.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A /**< The selected feature is not available. */
39#define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C /**< Bad input parameters to function. */
40#define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E /**< Locking / unlocking / free failed with error code. */
Paul Bakker2466d932013-09-28 14:40:38 +020041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#if defined(MBEDTLS_THREADING_PTHREAD)
Paul Bakker2466d932013-09-28 14:40:38 +020043#include <pthread.h>
Manuel Pégourié-Gonnard1e2eae02015-04-29 01:26:03 +020044typedef struct
45{
46 pthread_mutex_t mutex;
47 char is_valid;
48} mbedtls_threading_mutex_t;
Paul Bakker2466d932013-09-28 14:40:38 +020049#endif
50
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_THREADING_ALT)
52/* You should define the mbedtls_threading_mutex_t type in your header */
Paul Bakker2466d932013-09-28 14:40:38 +020053#include "threading_alt.h"
54
55/**
56 * \brief Set your alternate threading implementation function
Manuel Pégourié-Gonnard944cfe82015-05-27 20:07:18 +020057 * pointers and initialize global mutexes. If used, this
58 * function must be called once in the main thread before any
59 * other mbed TLS function is called, and
60 * mbedtls_threading_free_alt() must be called once in the main
61 * thread after all other mbed TLS functions.
Paul Bakker2466d932013-09-28 14:40:38 +020062 *
Manuel Pégourié-Gonnard8f5fd312015-04-24 14:42:34 +020063 * \note mutex_init() and mutex_free() don't return a status code.
64 * If mutex_init() fails, it should leave its argument (the
65 * mutex) in a state such that mutex_lock() will fail when
66 * called with this argument.
67 *
Paul Bakker6838bd12013-09-30 13:56:38 +020068 * \param mutex_init the init function implementation
Paul Bakker2466d932013-09-28 14:40:38 +020069 * \param mutex_free the free function implementation
70 * \param mutex_lock the lock function implementation
71 * \param mutex_unlock the unlock function implementation
Paul Bakker2466d932013-09-28 14:40:38 +020072 */
Manuel Pégourié-Gonnard944cfe82015-05-27 20:07:18 +020073void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ),
Manuel Pégourié-Gonnard8f5fd312015-04-24 14:42:34 +020074 void (*mutex_free)( mbedtls_threading_mutex_t * ),
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075 int (*mutex_lock)( mbedtls_threading_mutex_t * ),
76 int (*mutex_unlock)( mbedtls_threading_mutex_t * ) );
Manuel Pégourié-Gonnard944cfe82015-05-27 20:07:18 +020077
78/**
79 * \brief Free global mutexes.
80 */
81void mbedtls_threading_free_alt( void );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020082#endif /* MBEDTLS_THREADING_ALT */
Paul Bakker2466d932013-09-28 14:40:38 +020083
Embedthis Software17ddff52015-09-10 11:45:13 -070084#if defined(MBEDTLS_THREADING_C)
Paul Bakker2466d932013-09-28 14:40:38 +020085/*
86 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock
Paul Bakker6838bd12013-09-30 13:56:38 +020087 *
88 * All these functions are expected to work or the result will be undefined.
Paul Bakker2466d932013-09-28 14:40:38 +020089 */
Manuel Pégourié-Gonnard8f5fd312015-04-24 14:42:34 +020090extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex );
91extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex );
93extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex );
Paul Bakker2466d932013-09-28 14:40:38 +020094
Manuel Pégourié-Gonnard944cfe82015-05-27 20:07:18 +020095/*
96 * Global mutexes
97 */
98extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex;
Manuel Pégourié-Gonnard864108d2015-05-29 10:11:03 +020099extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex;
Embedthis Software17ddff52015-09-10 11:45:13 -0700100#endif
Manuel Pégourié-Gonnard944cfe82015-05-27 20:07:18 +0200101
Paul Bakker2466d932013-09-28 14:40:38 +0200102#ifdef __cplusplus
103}
104#endif
105
106#endif /* threading.h */