debug.h File Reference

Functions for controlling and providing debug output from the library. More...

#include "mbedtls/build_info.h"
#include "mbedtls/ssl.h"
#include "mbedtls/ecp.h"
#include <inttypes.h>

Include dependency graph for debug.h:

Go to the source code of this file.

Macros
#define	MBEDTLS_DEBUG_STRIP_PARENS(...)
#define	MBEDTLS_SSL_DEBUG_MSG(level, args)
#define	MBEDTLS_SSL_DEBUG_RET(level, text, ret)
#define	MBEDTLS_SSL_DEBUG_BUF(level, text, buf, len)
#define	MBEDTLS_SSL_DEBUG_MPI(level, text, X)
#define	MBEDTLS_SSL_DEBUG_ECP(level, text, X)
#define	MBEDTLS_SSL_DEBUG_CRT(level, text, crt)
#define	MBEDTLS_SSL_DEBUG_ECDH(level, ecdh, attr)
#define	MBEDTLS_PRINTF_ATTRIBUTE(string_index, first_to_check)
#define	MBEDTLS_PRINTF_SIZET   "zu"
#define	MBEDTLS_PRINTF_LONGLONG   "lld"
#define	MBEDTLS_PRINTF_MS_TIME   MBEDTLS_PRINTF_LONGLONG

Functions
void	mbedtls_debug_set_threshold (int threshold)
	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 ).

Detailed Description

Functions for controlling and providing debug output from the library.

Definition in file debug.h.

Macro Definition Documentation

MBEDTLS_DEBUG_STRIP_PARENS

#define MBEDTLS_DEBUG_STRIP_PARENS

(

...

)

Value:

__VA_ARGS__

Definition at line 23 of file debug.h.

MBEDTLS_PRINTF_ATTRIBUTE

#define MBEDTLS_PRINTF_ATTRIBUTE	(		string_index,
			first_to_check )

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.

Definition at line 96 of file debug.h.

MBEDTLS_PRINTF_LONGLONG

#define MBEDTLS_PRINTF_LONGLONG   "lld"

Definition at line 118 of file debug.h.

MBEDTLS_PRINTF_MS_TIME

#define MBEDTLS_PRINTF_MS_TIME   MBEDTLS_PRINTF_LONGLONG

Definition at line 125 of file debug.h.

MBEDTLS_PRINTF_SIZET

#define MBEDTLS_PRINTF_SIZET   "zu"

MBEDTLS_PRINTF_xxx: Due to issues with older window compilers and MinGW we need to define the printf specifier for size_t and long long per platform.

Module: library/debug.c Caller:

This module provides debugging functions.

Definition at line 117 of file debug.h.

MBEDTLS_SSL_DEBUG_BUF

#define MBEDTLS_SSL_DEBUG_BUF	(		level,
			text,
			buf,
			len )

Value:

mbedtls_debug_print_buf(ssl, level, __FILE__, __LINE__, text, buf, len)

Definition at line 32 of file debug.h.

MBEDTLS_SSL_DEBUG_CRT

#define MBEDTLS_SSL_DEBUG_CRT	(		level,
			text,
			crt )

Value:

mbedtls_debug_print_crt(ssl, level, __FILE__, __LINE__, text, crt)

Definition at line 47 of file debug.h.

MBEDTLS_SSL_DEBUG_ECDH

#define MBEDTLS_SSL_DEBUG_ECDH	(		level,
			ecdh,
			attr )

Value:

mbedtls_debug_printf_ecdh(ssl, level, __FILE__, __LINE__, ecdh, attr)

Definition at line 55 of file debug.h.

MBEDTLS_SSL_DEBUG_ECP

#define MBEDTLS_SSL_DEBUG_ECP	(		level,
			text,
			X )

Value:

mbedtls_debug_print_ecp(ssl, level, __FILE__, __LINE__, text, X)

Definition at line 41 of file debug.h.

MBEDTLS_SSL_DEBUG_MPI

#define MBEDTLS_SSL_DEBUG_MPI	(		level,
			text,
			X )

Value:

mbedtls_debug_print_mpi(ssl, level, __FILE__, __LINE__, text, X)

Definition at line 36 of file debug.h.

MBEDTLS_SSL_DEBUG_MSG

#define MBEDTLS_SSL_DEBUG_MSG	(		level,
			args )

Value:

mbedtls_debug_print_msg(ssl, level, __FILE__, __LINE__,    \
                        MBEDTLS_DEBUG_STRIP_PARENS args)

Definition at line 25 of file debug.h.

MBEDTLS_SSL_DEBUG_RET

#define MBEDTLS_SSL_DEBUG_RET	(		level,
			text,
			ret )

Value:

mbedtls_debug_print_ret(ssl, level, __FILE__, __LINE__, text, ret)

Definition at line 29 of file debug.h.

Function Documentation

mbedtls_debug_set_threshold()

void mbedtls_debug_set_threshold

(

int

threshold

)

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 ).

Parameters

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

References mbedtls_debug_set_threshold().

Referenced by mbedtls_debug_set_threshold().