blob: b71a09cf9314636b508654c189aec9f6d297624a [file] [log] [blame]
Paul Bakker747a83a2014-02-01 22:50:07 +01001/**
2 * \file platform.h
3 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00004 * \brief mbed TLS Platform abstraction layer
Paul Bakker747a83a2014-02-01 22:50:07 +01005 *
Manuel Pégourié-Gonnarda658a402015-01-23 09:45:19 +00006 * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
Paul Bakker747a83a2014-02-01 22:50:07 +01007 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +00008 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker747a83a2014-02-01 22:50:07 +01009 *
Paul Bakker747a83a2014-02-01 22:50:07 +010010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_PLATFORM_H
25#define MBEDTLS_PLATFORM_H
Paul Bakker747a83a2014-02-01 22:50:07 +010026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakker747a83a2014-02-01 22:50:07 +010028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Paul Bakker747a83a2014-02-01 22:50:07 +010032
Paul Bakker747a83a2014-02-01 22:50:07 +010033#ifdef __cplusplus
34extern "C" {
35#endif
36
Paul Bakker088c5c52014-04-25 11:11:10 +020037/**
38 * \name SECTION: Module settings
39 *
40 * The configuration options you can set for this module are in this section.
41 * Either change them in config.h or define them on the compiler command line.
42 * \{
43 */
44
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020045#if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS)
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <stdio.h>
Paul Bakkera9066cf2014-02-05 15:13:04 +010047#include <stdlib.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020048#if !defined(MBEDTLS_PLATFORM_STD_SNPRINTF)
49#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use */
Rich Evans46b0a8d2015-01-30 10:47:32 +000050#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if !defined(MBEDTLS_PLATFORM_STD_PRINTF)
52#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020053#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054#if !defined(MBEDTLS_PLATFORM_STD_FPRINTF)
55#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020056#endif
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020057#if !defined(MBEDTLS_PLATFORM_STD_CALLOC)
58#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020059#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#if !defined(MBEDTLS_PLATFORM_STD_FREE)
61#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020062#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020063#if !defined(MBEDTLS_PLATFORM_STD_EXIT)
64#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default free to use */
Rich Evansc39cb492015-01-30 12:01:34 +000065#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020066#else /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
67#if defined(MBEDTLS_PLATFORM_STD_MEM_HDR)
68#include MBEDTLS_PLATFORM_STD_MEM_HDR
Manuel Pégourié-Gonnardeb82a742014-04-02 13:43:48 +020069#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
Paul Bakker088c5c52014-04-25 11:11:10 +020071
72/* \} name SECTION: Module settings */
Paul Bakker747a83a2014-02-01 22:50:07 +010073
74/*
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020075 * The function pointers for calloc and free
Paul Bakker747a83a2014-02-01 22:50:07 +010076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077#if defined(MBEDTLS_PLATFORM_MEMORY)
78#if defined(MBEDTLS_PLATFORM_FREE_MACRO) && \
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020079 defined(MBEDTLS_PLATFORM_CALLOC_MACRO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020080#define mbedtls_free MBEDTLS_PLATFORM_FREE_MACRO
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020081#define mbedtls_calloc MBEDTLS_PLATFORM_CALLOC_MACRO
Rich Evans401bb902015-02-10 12:28:15 +000082#else
Manuel Pégourié-Gonnard7ee5ddd2015-06-03 10:33:55 +010083/* For size_t */
84#include <stddef.h>
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020085extern void * (*mbedtls_calloc)( size_t n, size_t size );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020086extern void (*mbedtls_free)( void *ptr );
Paul Bakkerdefc0ca2014-02-04 17:30:24 +010087
88/**
89 * \brief Set your own memory implementation function pointers
90 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020091 * \param calloc_func the calloc function implementation
Paul Bakkerdefc0ca2014-02-04 17:30:24 +010092 * \param free_func the free function implementation
93 *
94 * \return 0 if successful
95 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020096int mbedtls_platform_set_calloc_free( void * (*calloc_func)( size_t, size_t ),
Paul Bakkerdefc0ca2014-02-04 17:30:24 +010097 void (*free_func)( void * ) );
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +020098#endif /* MBEDTLS_PLATFORM_FREE_MACRO && MBEDTLS_PLATFORM_CALLOC_MACRO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099#else /* !MBEDTLS_PLATFORM_MEMORY */
100#define mbedtls_free free
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200101#define mbedtls_calloc calloc
102#endif /* MBEDTLS_PLATFORM_MEMORY && !MBEDTLS_PLATFORM_{FREE,CALLOC}_MACRO */
Paul Bakker747a83a2014-02-01 22:50:07 +0100103
104/*
105 * The function pointers for fprintf
106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107#if defined(MBEDTLS_PLATFORM_FPRINTF_ALT)
Manuel Pégourié-Gonnard7ee5ddd2015-06-03 10:33:55 +0100108/* We need FILE * */
109#include <stdio.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200110extern int (*mbedtls_fprintf)( FILE *stream, const char *format, ... );
Paul Bakker747a83a2014-02-01 22:50:07 +0100111
Rich Evansc39cb492015-01-30 12:01:34 +0000112/**
113 * \brief Set your own fprintf function pointer
114 *
115 * \param fprintf_func the fprintf function implementation
116 *
117 * \return 0
118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119int mbedtls_platform_set_fprintf( int (*fprintf_func)( FILE *stream, const char *,
Paul Bakker747a83a2014-02-01 22:50:07 +0100120 ... ) );
121#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122#if defined(MBEDTLS_PLATFORM_FPRINTF_MACRO)
123#define mbedtls_fprintf MBEDTLS_PLATFORM_FPRINTF_MACRO
Rich Evans16f8cd82015-02-06 16:14:34 +0000124#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200125#define mbedtls_fprintf fprintf
126#endif /* MBEDTLS_PLATFORM_FPRINTF_MACRO */
127#endif /* MBEDTLS_PLATFORM_FPRINTF_ALT */
Rich Evansc39cb492015-01-30 12:01:34 +0000128
129/*
Rich Evans16f8cd82015-02-06 16:14:34 +0000130 * The function pointers for printf
131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132#if defined(MBEDTLS_PLATFORM_PRINTF_ALT)
133extern int (*mbedtls_printf)( const char *format, ... );
Rich Evans16f8cd82015-02-06 16:14:34 +0000134
135/**
136 * \brief Set your own printf function pointer
137 *
138 * \param printf_func the printf function implementation
139 *
140 * \return 0
141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142int mbedtls_platform_set_printf( int (*printf_func)( const char *, ... ) );
143#else /* !MBEDTLS_PLATFORM_PRINTF_ALT */
144#if defined(MBEDTLS_PLATFORM_PRINTF_MACRO)
145#define mbedtls_printf MBEDTLS_PLATFORM_PRINTF_MACRO
Rich Evans16f8cd82015-02-06 16:14:34 +0000146#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147#define mbedtls_printf printf
148#endif /* MBEDTLS_PLATFORM_PRINTF_MACRO */
149#endif /* MBEDTLS_PLATFORM_PRINTF_ALT */
Rich Evans16f8cd82015-02-06 16:14:34 +0000150
151/*
152 * The function pointers for snprintf
153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154#if defined(MBEDTLS_PLATFORM_SNPRINTF_ALT)
155extern int (*mbedtls_snprintf)( char * s, size_t n, const char * format, ... );
Rich Evans16f8cd82015-02-06 16:14:34 +0000156
157/**
158 * \brief Set your own snprintf function pointer
159 *
160 * \param snprintf_func the snprintf function implementation
161 *
162 * \return 0
163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164int mbedtls_platform_set_snprintf( int (*snprintf_func)( char * s, size_t n,
Rich Evans16f8cd82015-02-06 16:14:34 +0000165 const char * format, ... ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166#else /* MBEDTLS_PLATFORM_SNPRINTF_ALT */
167#if defined(MBEDTLS_PLATFORM_SNPRINTF_MACRO)
168#define mbedtls_snprintf MBEDTLS_PLATFORM_SNPRINTF_MACRO
Rich Evans16f8cd82015-02-06 16:14:34 +0000169#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170#define mbedtls_snprintf snprintf
171#endif /* MBEDTLS_PLATFORM_SNPRINTF_MACRO */
172#endif /* MBEDTLS_PLATFORM_SNPRINTF_ALT */
Rich Evans16f8cd82015-02-06 16:14:34 +0000173
174/*
Rich Evansc39cb492015-01-30 12:01:34 +0000175 * The function pointers for exit
176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#if defined(MBEDTLS_PLATFORM_EXIT_ALT)
178extern void (*mbedtls_exit)( int status );
Rich Evansc39cb492015-01-30 12:01:34 +0000179
180/**
181 * \brief Set your own exit function pointer
182 *
183 * \param exit_func the exit function implementation
184 *
185 * \return 0
186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187int mbedtls_platform_set_exit( void (*exit_func)( int status ) );
Rich Evansc39cb492015-01-30 12:01:34 +0000188#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#if defined(MBEDTLS_PLATFORM_EXIT_MACRO)
190#define mbedtls_exit MBEDTLS_PLATFORM_EXIT_MACRO
Rich Evans16f8cd82015-02-06 16:14:34 +0000191#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192#define mbedtls_exit exit
193#endif /* MBEDTLS_PLATFORM_EXIT_MACRO */
194#endif /* MBEDTLS_PLATFORM_EXIT_ALT */
Paul Bakker747a83a2014-02-01 22:50:07 +0100195
196#ifdef __cplusplus
197}
198#endif
199
200#endif /* platform.h */