git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/mbedtls/include/mbedtls/threading.h

   1 /**\r
   2  * \file threading.h\r
   3  *\r
   4  * \brief Threading abstraction layer\r
   5  */\r
   6 /*\r
   7  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved\r
   8  *  SPDX-License-Identifier: Apache-2.0\r
   9  *\r
  10  *  Licensed under the Apache License, Version 2.0 (the "License"); you may\r
  11  *  not use this file except in compliance with the License.\r
  12  *  You may obtain a copy of the License at\r
  13  *\r
  14  *  http://www.apache.org/licenses/LICENSE-2.0\r
  15  *\r
  16  *  Unless required by applicable law or agreed to in writing, software\r
  17  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
  18  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  19  *  See the License for the specific language governing permissions and\r
  20  *  limitations under the License.\r
  21  *\r
  22  *  This file is part of mbed TLS (https://tls.mbed.org)\r
  23  */\r
  24 #ifndef MBEDTLS_THREADING_H\r
  25 #define MBEDTLS_THREADING_H\r
  26 \r
  27 #if !defined(MBEDTLS_CONFIG_FILE)\r
  28 #include "config.h"\r
  29 #else\r
  30 #include MBEDTLS_CONFIG_FILE\r
  31 #endif\r
  32 \r
  33 #include <stdlib.h>\r
  34 \r
  35 #ifdef __cplusplus\r
  36 extern "C" {\r
  37 #endif\r
  38 \r
  39 /* MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE is deprecated and should not be\r
  40  * used. */\r
  41 #define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE         -0x001A  /**< The selected feature is not available. */\r
  42 \r
  43 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA              -0x001C  /**< Bad input parameters to function. */\r
  44 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR                 -0x001E  /**< Locking / unlocking / free failed with error code. */\r
  45 \r
  46 #if defined(MBEDTLS_THREADING_PTHREAD)\r
  47 #include <pthread.h>\r
  48 typedef struct mbedtls_threading_mutex_t\r
  49 {\r
  50     pthread_mutex_t mutex;\r
  51     char is_valid;\r
  52 } mbedtls_threading_mutex_t;\r
  53 #endif\r
  54 \r
  55 #if defined(MBEDTLS_THREADING_ALT)\r
  56 /* You should define the mbedtls_threading_mutex_t type in your header */\r
  57 #include "threading_alt.h"\r
  58 \r
  59 /**\r
  60  * \brief           Set your alternate threading implementation function\r
  61  *                  pointers and initialize global mutexes. If used, this\r
  62  *                  function must be called once in the main thread before any\r
  63  *                  other mbed TLS function is called, and\r
  64  *                  mbedtls_threading_free_alt() must be called once in the main\r
  65  *                  thread after all other mbed TLS functions.\r
  66  *\r
  67  * \note            mutex_init() and mutex_free() don't return a status code.\r
  68  *                  If mutex_init() fails, it should leave its argument (the\r
  69  *                  mutex) in a state such that mutex_lock() will fail when\r
  70  *                  called with this argument.\r
  71  *\r
  72  * \param mutex_init    the init function implementation\r
  73  * \param mutex_free    the free function implementation\r
  74  * \param mutex_lock    the lock function implementation\r
  75  * \param mutex_unlock  the unlock function implementation\r
  76  */\r
  77 void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ),\r
  78                        void (*mutex_free)( mbedtls_threading_mutex_t * ),\r
  79                        int (*mutex_lock)( mbedtls_threading_mutex_t * ),\r
  80                        int (*mutex_unlock)( mbedtls_threading_mutex_t * ) );\r
  81 \r
  82 /**\r
  83  * \brief               Free global mutexes.\r
  84  */\r
  85 void mbedtls_threading_free_alt( void );\r
  86 #endif /* MBEDTLS_THREADING_ALT */\r
  87 \r
  88 #if defined(MBEDTLS_THREADING_C)\r
  89 /*\r
  90  * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock\r
  91  *\r
  92  * All these functions are expected to work or the result will be undefined.\r
  93  */\r
  94 extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex );\r
  95 extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex );\r
  96 extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex );\r
  97 extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex );\r
  98 \r
  99 /*\r
 100  * Global mutexes\r
 101  */\r
 102 #if defined(MBEDTLS_FS_IO)\r
 103 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex;\r
 104 #endif\r
 105 \r
 106 #if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT)\r
 107 /* This mutex may or may not be used in the default definition of\r
 108  * mbedtls_platform_gmtime_r(), but in order to determine that,\r
 109  * we need to check POSIX features, hence modify _POSIX_C_SOURCE.\r
 110  * With the current approach, this declaration is orphaned, lacking\r
 111  * an accompanying definition, in case mbedtls_platform_gmtime_r()\r
 112  * doesn't need it, but that's not a problem. */\r
 113 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex;\r
 114 #endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */\r
 115 \r
 116 #endif /* MBEDTLS_THREADING_C */\r
 117 \r
 118 #ifdef __cplusplus\r
 119 }\r
 120 #endif\r
 121 \r
 122 #endif /* threading.h */\r