Skip to content

Commit

Permalink
add --debug-code-points and WOLFSSL_DEBUG_CODEPOINTS,
Browse files Browse the repository at this point in the history 
add file_name and line_number args to wolfssl_log(),

and inside WOLFSSL_DEBUG_CODEPOINTS gates,

add WOLFSSL_MSG_EX2(), WOLFSSL_MSG2(), WOLFSSL_ENTER2(), and WOLFSSL_LEAVE2(), each with file and line args,

and add wrapper macros for WOLFSSL_MSG, WOLFSSL_MSG_EX, WOLFSSL_ENTER, and WOLFSSL_LEAVE, that pass in file and line.
  • Loading branch information
@douzzer
douzzer committed Jun 15, 2024
1 parent 5df5720 commit 2c69e4a
Show file tree
Hide file tree
Showing 3 changed files with 183 additions and 29 deletions.
11 changes: 11 additions & 0 deletions configure.ac
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,17 @@ AS_IF([test "$ax_enable_debug" = "yes"],
[AM_CCASFLAGS="$DEBUG_CFLAGS $AM_CCASFLAGS"],
[AM_CCASFLAGS="$AM_CCASFLAGS -DNDEBUG"])

AC_ARG_ENABLE([debug-code-points],
[ AS_HELP_STRING([--enable-debug-code-points],[Include source file and line number in --enable-verbose messages.]) ],
[ ENABLED_DEBUG_CODEPOINTS=$enableval ],
[ ENABLED_DEBUG_CODEPOINTS=no ]
)

if test "$ENABLED_DEBUG_CODEPOINTS" = "yes"
then
AM_CFLAGS="$AM_CFLAGS -DWOLFSSL_DEBUG_CODEPOINTS"
fi

AC_ARG_ENABLE([debug-trace-errcodes],
[ AS_HELP_STRING([--enable-debug-trace-errcodes],[Print trace messages when library errors are thrown.]) ],
[ ENABLED_DEBUG_TRACE_ERRCODES=$enableval ],
Expand Down
182 changes: 153 additions & 29 deletions wolfcrypt/src/logging.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,14 @@ void WOLFSSL_TIME(int count)
#include <wolfssl/wolfcrypt/mem_track.h>
#endif

static void wolfssl_log(const int logLevel, const char *const logMessage)
{
static void wolfssl_log(
const int logLevel,
const char *file_name,
int line_number,
const char *const logMessage)
{
(void)file_name;
(void)line_number;
if (log_function)
log_function(logLevel, logMessage);
else {
Expand All @@ -289,46 +295,103 @@ static void wolfssl_log(const int logLevel, const char *const logMessage)
#elif defined(ARDUINO)
wolfSSL_Arduino_Serial_Print(logMessage);
#elif defined(WOLFSSL_LOG_PRINTF)
printf("%s\n", logMessage);
if (file_name != NULL)
printf("[%s L %d] %s\n", file_name, line_number, logMessage);
else
printf("%s\n", logMessage);
#elif defined(THREADX) && !defined(THREADX_NO_DC_PRINTF)
dc_log_printf("%s\n", logMessage);
if (file_name != NULL)
dc_log_printf("[%s L %d] %s\n", file_name, line_number, logMessage);
else
dc_log_printf("%s\n", logMessage);
#elif defined(WOLFSSL_DEOS)
printf("%s\r\n", logMessage);
if (file_name != NULL)
printf("[%s L %d] %s\r\n", file_name, line_number, logMessage);
else
printf("%s\r\n", logMessage);
#elif defined(MICRIUM)
BSP_Ser_Printf("%s\r\n", logMessage);
if (file_name != NULL)
BSP_Ser_Printf("[%s L %d] %s\r\n",
file_name, line_number, logMessage);
else
BSP_Ser_Printf("%s\r\n", logMessage);
#elif defined(WOLFSSL_MDK_ARM)
fflush(stdout) ;
printf("%s\n", logMessage);
if (file_name != NULL)
printf("[%s L %d] %s\n", file_name, line_number, logMessage);
else
printf("%s\n", logMessage);
fflush(stdout) ;
#elif defined(WOLFSSL_UTASKER)
fnDebugMsg((char*)logMessage);
fnDebugMsg("\r\n");
#elif defined(MQX_USE_IO_OLD)
fprintf(_mqxio_stderr, "%s\n", logMessage);
if (file_name != NULL)
fprintf(_mqxio_stderr, "[%s L %d] %s\n",
file_name, line_number, logMessage);
else
fprintf(_mqxio_stderr, "%s\n", logMessage);
#elif defined(WOLFSSL_APACHE_MYNEWT)
LOG_DEBUG(&mynewt_log, LOG_MODULE_DEFAULT, "%s\n", logMessage);
if (file_name != NULL)
LOG_DEBUG(&mynewt_log, LOG_MODULE_DEFAULT, "[%s L %d] %s\n",
file_name, line_number, logMessage);
else
LOG_DEBUG(&mynewt_log, LOG_MODULE_DEFAULT, "%s\n", logMessage);
#elif defined(WOLFSSL_ESPIDF)
ESP_LOGI("wolfssl", "%s", logMessage);
if (file_name != NULL)
ESP_LOGI("wolfssl", "[%s L %d] %s",
file_name, line_number, logMessage);
else
ESP_LOGI("wolfssl", "%s", logMessage);
#elif defined(WOLFSSL_ZEPHYR)
printk("%s\n", logMessage);
if (file_name != NULL)
printk("[%s L %d] %s\n", file_name, line_number, logMessage);
else
printk("%s\n", logMessage);
#elif defined(WOLFSSL_TELIT_M2MB)
M2M_LOG_INFO("%s\n", logMessage);
if (file_name != NULL)
M2M_LOG_INFO("[%s L %d] %s\n", file_name, line_number, logMessage);
else
M2M_LOG_INFO("%s\n", logMessage);
#elif defined(WOLFSSL_ANDROID_DEBUG)
__android_log_print(ANDROID_LOG_VERBOSE, "[wolfSSL]", "%s", logMessage);
if (file_name != NULL)
__android_log_print(ANDROID_LOG_VERBOSE, "[wolfSSL]", "[%s L %d] %s",
file_name, line_number, logMessage);
else
__android_log_print(ANDROID_LOG_VERBOSE, "[wolfSSL]", "%s",
logMessage);
#elif defined(WOLFSSL_XILINX)
xil_printf("%s\r\n", logMessage);
if (file_name != NULL)
xil_printf("[%s L %d] %s\r\n", file_name, line_number, logMessage);
else
xil_printf("%s\r\n", logMessage);
#elif defined(WOLFSSL_LINUXKM)
printk("%s\n", logMessage);
if (file_name != NULL)
printk("[%s L %d] %s\n", file_name, line_number, logMessage);
else
printk("%s\n", logMessage);
#elif defined(WOLFSSL_RENESAS_RA6M4)
myprintf("%s\n", logMessage);
if (file_name != NULL)
myprintf("[%s L %d] %s\n", file_name, line_number, logMessage);
else
myprintf("%s\n", logMessage);
#elif defined(STACK_SIZE_CHECKPOINT_MSG) && \
defined(HAVE_STACK_SIZE_VERBOSE) && defined(HAVE_STACK_SIZE_VERBOSE_LOG)
STACK_SIZE_CHECKPOINT_MSG(logMessage);
#else
if (log_prefix != NULL)
fprintf(stderr, "[%s]: %s\n", log_prefix, logMessage);
else
fprintf(stderr, "%s\n", logMessage);
if (log_prefix != NULL) {
if (file_name != NULL)
fprintf(stderr, "[%s]: [%s L %d] %s\n",
log_prefix, file_name, line_number, logMessage);
else
fprintf(stderr, "[%s]: %s\n", log_prefix, logMessage);
} else {
if (file_name != NULL)
fprintf(stderr, "[%s L %d] %s\n",
file_name, line_number, logMessage);
else
fprintf(stderr, "%s\n", logMessage);
}
#endif
}
}
Expand All @@ -340,6 +403,7 @@ static void wolfssl_log(const int logLevel, const char *const logMessage)
#ifndef WOLFSSL_MSG_EX_BUF_SZ
#define WOLFSSL_MSG_EX_BUF_SZ 100
#endif
#undef WOLFSSL_MSG_EX /* undo WOLFSSL_DEBUG_CODEPOINTS wrapper */
#ifdef __clang__
/* tell clang argument 1 is format */
__attribute__((__format__ (__printf__, 1, 0)))
Expand All @@ -354,16 +418,42 @@ void WOLFSSL_MSG_EX(const char* fmt, ...)
written = XVSNPRINTF(msg, sizeof(msg), fmt, args);
va_end(args);
if (written > 0)
wolfssl_log(INFO_LOG , msg);
wolfssl_log(INFO_LOG, NULL, 0, msg);
}
}

#ifdef WOLFSSL_DEBUG_CODEPOINTS
void WOLFSSL_MSG_EX2(const char *file, int line, const char* fmt, ...)
{
if (loggingEnabled) {
char msg[WOLFSSL_MSG_EX_BUF_SZ];
int written;
va_list args;
va_start(args, fmt);
written = XVSNPRINTF(msg, sizeof(msg), fmt, args);
va_end(args);
if (written > 0)
wolfssl_log(INFO_LOG, file, line, msg);
}
}
#endif

#endif

#undef WOLFSSL_MSG /* undo WOLFSSL_DEBUG_CODEPOINTS wrapper */
void WOLFSSL_MSG(const char* msg)
{
if (loggingEnabled)
wolfssl_log(INFO_LOG , msg);
wolfssl_log(INFO_LOG, NULL, 0, msg);
}

#ifdef WOLFSSL_DEBUG_CODEPOINTS
void WOLFSSL_MSG2(const char *file, int line, const char* msg)
{
if (loggingEnabled)
wolfssl_log(INFO_LOG, file, line, msg);
}
#endif

#ifndef LINE_LEN
#define LINE_LEN 16
Expand All @@ -378,7 +468,7 @@ void WOLFSSL_BUFFER(const byte* buffer, word32 length)
}

if (!buffer) {
wolfssl_log(INFO_LOG, "\tNULL");
wolfssl_log(INFO_LOG, NULL, 0, "\tNULL");
return;
}

Expand Down Expand Up @@ -408,32 +498,66 @@ void WOLFSSL_BUFFER(const byte* buffer, word32 length)
}
}

wolfssl_log(INFO_LOG, line);
wolfssl_log(INFO_LOG, NULL, 0, line);
buffer += LINE_LEN;
buflen -= LINE_LEN;
}
}


#undef WOLFSSL_ENTER /* undo WOLFSSL_DEBUG_CODEPOINTS wrapper */
void WOLFSSL_ENTER(const char* msg)
{
if (loggingEnabled) {
char buffer[WOLFSSL_MAX_ERROR_SZ];
XSNPRINTF(buffer, sizeof(buffer), "wolfSSL Entering %s", msg);
wolfssl_log(ENTER_LOG , buffer);
wolfssl_log(ENTER_LOG, NULL, 0, buffer);
}
}

#ifdef WOLFSSL_DEBUG_CODEPOINTS
void WOLFSSL_ENTER2(const char *file, int line, const char* msg)
{
if (loggingEnabled) {
char buffer[WOLFSSL_MAX_ERROR_SZ];
XSNPRINTF(buffer, sizeof(buffer), "wolfSSL Entering %s", msg);
wolfssl_log(ENTER_LOG, file, line, buffer);
}
}
#endif

#undef WOLFSSL_LEAVE /* undo WOLFSSL_DEBUG_CODEPOINTS wrapper */
void WOLFSSL_LEAVE(const char* msg, int ret)
{
if (loggingEnabled) {
char buffer[WOLFSSL_MAX_ERROR_SZ];
XSNPRINTF(buffer, sizeof(buffer), "wolfSSL Leaving %s, return %d",
msg, ret);
wolfssl_log(LEAVE_LOG , buffer);
wolfssl_log(LEAVE_LOG, NULL, 0, buffer);
}
}

#ifdef WOLFSSL_DEBUG_CODEPOINTS
void WOLFSSL_LEAVE2(const char *file, int line, const char* msg, int ret)
{
if (loggingEnabled) {
char buffer[WOLFSSL_MAX_ERROR_SZ];
XSNPRINTF(buffer, sizeof(buffer), "wolfSSL Leaving %s, return %d",
msg, ret);
wolfssl_log(LEAVE_LOG, file, line, buffer);
}
}
#endif

#ifdef WOLFSSL_DEBUG_CODEPOINTS
/* restore the wrappers */
#define WOLFSSL_MSG(msg) WOLFSSL_MSG2(__FILE__, __LINE__, msg)
#define WOLFSSL_ENTER(msg) WOLFSSL_ENTER2(__FILE__, __LINE__, msg)
#define WOLFSSL_LEAVE(msg, ret) WOLFSSL_LEAVE2(__FILE__, __LINE__, msg, ret)
#ifdef XVSNPRINTF
#define WOLFSSL_MSG_EX(fmt, args...) \
WOLFSSL_MSG_EX2(__FILE__, __LINE__, fmt, ## args)
#endif
#endif

WOLFSSL_API int WOLFSSL_IS_DEBUG_ON(void)
{
Expand Down Expand Up @@ -1537,7 +1661,7 @@ void WOLFSSL_ERROR(int error)

#ifdef DEBUG_WOLFSSL
if (loggingEnabled)
wolfssl_log(ERROR_LOG , buffer);
wolfssl_log(ERROR_LOG, NULL, 0, buffer);
#endif
}
}
Expand All @@ -1546,7 +1670,7 @@ void WOLFSSL_ERROR_MSG(const char* msg)
{
#ifdef DEBUG_WOLFSSL
if (loggingEnabled)
wolfssl_log(ERROR_LOG , msg);
wolfssl_log(ERROR_LOG, NULL, 0, msg);
#else
(void)msg;
#endif
Expand Down
19 changes: 19 additions & 0 deletions wolfssl/wolfcrypt/logging.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,25 @@ WOLFSSL_API void wolfSSL_SetLoggingPrefix(const char* prefix);
#define WOLFSSL_MSG_EX(...) WC_DO_NOTHING
#endif
WOLFSSL_API void WOLFSSL_MSG(const char* msg);
#ifdef WOLFSSL_DEBUG_CODEPOINTS
WOLFSSL_API void WOLFSSL_MSG2(
const char *file, int line, const char* msg);
WOLFSSL_API void WOLFSSL_ENTER2(
const char *file, int line, const char* msg);
WOLFSSL_API void WOLFSSL_LEAVE2(
const char *file, int line, const char* msg, int ret);
#define WOLFSSL_MSG(msg) WOLFSSL_MSG2(__FILE__, __LINE__, msg)
#define WOLFSSL_ENTER(msg) WOLFSSL_ENTER2(__FILE__, __LINE__, msg)
#define WOLFSSL_LEAVE(msg, ret) WOLFSSL_LEAVE2(__FILE__, __LINE__, msg, ret)
#ifdef XVSNPRINTF
WOLFSSL_API void WOLFSSL_MSG_EX2(
const char *file, int line, const char* fmt, ...);
#define WOLFSSL_MSG_EX(fmt, args...) \
WOLFSSL_MSG_EX2(__FILE__, __LINE__, fmt, ## args)
#else
#define WOLFSSL_MSG_EX2(...) WC_DO_NOTHING
#endif
#endif
WOLFSSL_API void WOLFSSL_BUFFER(const byte* buffer, word32 length);

#else
Expand Down

0 comments on commit 2c69e4a

Please sign in to comment.