mirror of
https://github.com/Mbed-TLS/mbedtls.git
synced 2026-04-03 11:06:14 +02:00
cdf3b0a535
Always activate `__USE_MINGW_ANSI_STDIO` unless overridden on the command line. This is necessary with older versions of MingW and/or Windows, where snprintf does not always zero-terminate the buffer, and does not support formats such as `"%zu"` for size_t and `"%lld"` for long long. Simplify debug.h accordingly. The macros `MBEDTLS_PRINTF_SIZET`, `MBEDTLS_PRINTF_SIZET_HAX` and `MBEDTLS_PRINTF_LONGLONG` are no longer needed, but they are still used in our code base and must stay in debug.h for backward compatibility. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
121 lines
3.9 KiB
C
121 lines
3.9 KiB
C
/**
|
|
* \file debug.h
|
|
*
|
|
* \brief Functions for controlling and providing debug output from the library.
|
|
*/
|
|
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
|
|
*/
|
|
#ifndef MBEDTLS_DEBUG_H
|
|
#define MBEDTLS_DEBUG_H
|
|
|
|
#include "mbedtls/build_info.h"
|
|
|
|
#include "mbedtls/ssl.h"
|
|
|
|
#if defined(MBEDTLS_DEBUG_C)
|
|
|
|
#define MBEDTLS_DEBUG_STRIP_PARENS(...) __VA_ARGS__
|
|
|
|
#define MBEDTLS_SSL_DEBUG_MSG(level, args) \
|
|
mbedtls_debug_print_msg(ssl, level, __FILE__, __LINE__, \
|
|
MBEDTLS_DEBUG_STRIP_PARENS args)
|
|
|
|
#define MBEDTLS_SSL_DEBUG_RET(level, text, ret) \
|
|
mbedtls_debug_print_ret(ssl, level, __FILE__, __LINE__, text, ret)
|
|
|
|
#define MBEDTLS_SSL_DEBUG_BUF(level, text, buf, len) \
|
|
mbedtls_debug_print_buf(ssl, level, __FILE__, __LINE__, text, buf, len)
|
|
|
|
#if defined(MBEDTLS_X509_CRT_PARSE_C) && !defined(MBEDTLS_X509_REMOVE_INFO)
|
|
#define MBEDTLS_SSL_DEBUG_CRT(level, text, crt) \
|
|
mbedtls_debug_print_crt(ssl, level, __FILE__, __LINE__, text, crt)
|
|
#else
|
|
#define MBEDTLS_SSL_DEBUG_CRT(level, text, crt) do { } while (0)
|
|
#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_X509_REMOVE_INFO */
|
|
|
|
#else /* MBEDTLS_DEBUG_C */
|
|
|
|
#define MBEDTLS_SSL_DEBUG_MSG(level, args) do { } while (0)
|
|
#define MBEDTLS_SSL_DEBUG_RET(level, text, ret) do { } while (0)
|
|
#define MBEDTLS_SSL_DEBUG_BUF(level, text, buf, len) do { } while (0)
|
|
#define MBEDTLS_SSL_DEBUG_ECP(level, text, X) do { } while (0)
|
|
#define MBEDTLS_SSL_DEBUG_CRT(level, text, crt) do { } while (0)
|
|
|
|
#endif /* MBEDTLS_DEBUG_C */
|
|
|
|
/**
|
|
* \def MBEDTLS_PRINTF_ATTRIBUTE
|
|
*
|
|
* Mark a function as having printf attributes, and thus enable checking
|
|
* via -wFormat and other flags. This does nothing on builds with compilers
|
|
* that do not support the format attribute
|
|
*
|
|
* Module: library/debug.c
|
|
* Caller:
|
|
*
|
|
* This module provides debugging functions.
|
|
*/
|
|
#if defined(__has_attribute)
|
|
#if __has_attribute(format)
|
|
#if defined(__MINGW32__)
|
|
#define MBEDTLS_PRINTF_ATTRIBUTE(string_index, first_to_check) \
|
|
__attribute__((__format__(gnu_printf, string_index, first_to_check)))
|
|
#else /* defined(__MINGW32__) */
|
|
#define MBEDTLS_PRINTF_ATTRIBUTE(string_index, first_to_check) \
|
|
__attribute__((format(printf, string_index, first_to_check)))
|
|
#endif
|
|
#else /* __has_attribute(format) */
|
|
#define MBEDTLS_PRINTF_ATTRIBUTE(string_index, first_to_check)
|
|
#endif /* __has_attribute(format) */
|
|
#else /* defined(__has_attribute) */
|
|
#define MBEDTLS_PRINTF_ATTRIBUTE(string_index, first_to_check)
|
|
#endif
|
|
|
|
/* Legacy definitions, kept for backward compatibility.
|
|
* Since Mbed TLS 4.1, the standard specifiers are always valid.
|
|
* We still define the macros because they're part of the Mbed TLS 4.0 API.
|
|
* In the library and test code, keep using them for code that's backported
|
|
* to 3.6.
|
|
*/
|
|
#define MBEDTLS_PRINTF_SIZET "zu"
|
|
#define MBEDTLS_PRINTF_SIZET_HEX "zx"
|
|
#define MBEDTLS_PRINTF_LONGLONG "lld"
|
|
|
|
#if !defined(MBEDTLS_PRINTF_MS_TIME)
|
|
#include <inttypes.h>
|
|
#if !defined(PRId64)
|
|
#define MBEDTLS_PRINTF_MS_TIME MBEDTLS_PRINTF_LONGLONG
|
|
#else
|
|
#define MBEDTLS_PRINTF_MS_TIME PRId64
|
|
#endif
|
|
#endif /* MBEDTLS_PRINTF_MS_TIME */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \brief Set the threshold error level to handle globally all debug output.
|
|
* Debug messages that have a level over the threshold value are
|
|
* discarded.
|
|
* (Default value: 0 = No debug )
|
|
*
|
|
* \param threshold threshold level of messages to filter on. Messages at a
|
|
* higher level will be discarded.
|
|
* - Debug levels
|
|
* - 0 No debug
|
|
* - 1 Error
|
|
* - 2 State change
|
|
* - 3 Informational
|
|
* - 4 Verbose
|
|
*/
|
|
void mbedtls_debug_set_threshold(int threshold);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* MBEDTLS_DEBUG_H */
|