wolfcrypt/src/logging.c, wolfssl/wolfcrypt/error-crypt.h, and wolfssl/wolfcrypt/logging.h: implement WOLFSSL_DEBUG_TRACE_ERROR_CODES_INIT_STATE, wc_debug_trace_error_codes_enabled(), and wc_debug_trace_error_codes_set(), to allow runtime control of error tracing.

Author: douzzer

wolfcrypt/src/logging.c

@@ -1822,12 +1822,38 @@ void WOLFSSL_ERROR_MSG(const char* msg)
 
 #endif  /* DEBUG_WOLFSSL || WOLFSSL_NGINX || WOLFSSL_HAPROXY */
 
+#ifdef WOLFSSL_DEBUG_TRACE_ERROR_CODES
+
+#ifndef WOLFSSL_DEBUG_TRACE_ERROR_CODES_INIT_STATE
+    #define WOLFSSL_DEBUG_TRACE_ERROR_CODES_INIT_STATE 1
+#endif
+
+#ifdef WOLFSSL_ATOMIC_OPS
+static wolfSSL_Atomic_Int wc_debug_trace_error_codes_state =
+    WOLFSSL_ATOMIC_INITIALIZER(WOLFSSL_DEBUG_TRACE_ERROR_CODES_INIT_STATE);
+#else
+static int wc_debug_trace_error_codes_state =
+    WOLFSSL_DEBUG_TRACE_ERROR_CODES_INIT_STATE;
+#endif
+
+int wc_debug_trace_error_codes_enabled(void) {
+    return WOLFSSL_ATOMIC_LOAD(wc_debug_trace_error_codes_state);
+}
+
+int wc_debug_trace_error_codes_set(int state) {
+    return wolfSSL_Atomic_Int_Exchange(&wc_debug_trace_error_codes_state,
+                                       state);
+}
+
+#endif /* WOLFSSL_DEBUG_TRACE_ERROR_CODES */
+
 #ifdef WOLFSSL_DEBUG_BACKTRACE_ERROR_CODES
 
 #ifdef WOLFSSL_LINUXKM
 
-void wc_backtrace_render(void) {
+int wc_backtrace_render(void) {
     dump_stack();
+    return 0;
 }
 
 #else /* !WOLFSSL_LINUXKM */
@@ -1900,22 +1926,24 @@ static int backtrace_init(struct backtrace_state **backtrace_state) {
     return 0;
 }
 
-void wc_backtrace_render(void) {
+int wc_backtrace_render(void) {
     static wolfSSL_Mutex backtrace_mutex
         WOLFSSL_MUTEX_INITIALIZER_CLAUSE(backtrace_mutex);
     static struct backtrace_state *backtrace_state = NULL;
     int depth = 0;
+    int ret;
 
 #ifndef WOLFSSL_MUTEX_INITIALIZER
     static wolfSSL_Atomic_Int init_count = 0;
     if (init_count != 1) {
         int cur_init_count = wolfSSL_Atomic_Int_FetchSub(&init_count, 1);
         if (cur_init_count != 0) {
             (void)wolfSSL_Atomic_Int_FetchAdd(&init_count, 1);
-            return;
+            return DEADLOCK_AVERTED_E;
         }
-        if (wc_InitMutex(&backtrace_mutex) != 0)
-            return;
+        ret = wc_InitMutex(&backtrace_mutex);
+        if (ret != 0)
+            return ret;
         /* set init_count to 1, race-free: (-1) - (0-2) = 1 */
         (void)wolfSSL_Atomic_Int_FetchSub(&init_count, cur_init_count - 2);
     }
@@ -1925,13 +1953,14 @@ void wc_backtrace_render(void) {
      * BACKTRACE_SUPPORTS_THREADS == 1, so we serialize the render op.  this
      * helpfully mutexes the initialization too.
      */
-    if (wc_LockMutex(&backtrace_mutex) != 0)
-        return;
+    ret = wc_LockMutex(&backtrace_mutex);
+    if (ret != 0)
+        return ret;
 
     if (backtrace_state == NULL) {
         if (backtrace_init(&backtrace_state) < 0) {
             wc_UnLockMutex(&backtrace_mutex);
-            return;
+            return BAD_STATE_E;
         }
     }
 
@@ -1943,6 +1972,8 @@ void wc_backtrace_render(void) {
                    (void *)&depth);
 
     wc_UnLockMutex(&backtrace_mutex);
+
+    return 0;
 }
 #endif /* !WOLFSSL_LINUXKM */
 

wolfssl/wolfcrypt/error-crypt.h

@@ -344,23 +344,38 @@ WOLFSSL_ABI WOLFSSL_API const char* wc_GetErrorString(int error);
 #if defined(WOLFSSL_DEBUG_TRACE_ERROR_CODES) && \
         (defined(BUILDING_WOLFSSL) || \
          defined(WOLFSSL_DEBUG_TRACE_ERROR_CODES_ALWAYS))
-    WOLFSSL_API extern void wc_backtrace_render(void);
+    WOLFSSL_API extern int wc_backtrace_render(void);
     #define WC_NO_ERR_TRACE(label) (CONST_NUM_ERR_ ## label)
     #ifndef WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE
         #ifdef WOLFSSL_DEBUG_BACKTRACE_ERROR_CODES
             #define WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE wc_backtrace_render()
         #else
-            #define WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE (void)0
+            #define WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE 0
         #endif
     #endif
     #ifndef WC_ERR_TRACE
-        #define WC_ERR_TRACE(label)                                   \
-            ( WOLFSSL_DEBUG_PRINTF_FN(WOLFSSL_DEBUG_PRINTF_FIRST_ARGS \
-                                      "ERR TRACE: %s L %d %s (%d)\n", \
-                      __FILE__, __LINE__, #label, label),             \
-              WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE,                  \
-              label                                                   \
-            )
+        #ifdef __GNUC__
+            #define WC_ERR_TRACE(label)                                   \
+                ({ if (wc_debug_trace_error_codes_enabled()) {            \
+                    (void)WOLFSSL_DEBUG_PRINTF_FN(                        \
+                                          WOLFSSL_DEBUG_PRINTF_FIRST_ARGS \
+                                          "ERR TRACE: %s L %d %s (%d)\n", \
+                                      __FILE__, __LINE__, #label, label); \
+                    (void)WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE; }        \
+                  (label);                                                \
+                })
+        #else /* ! __GNUC__ */
+            #define WC_ERR_TRACE(label)                                   \
+                ((void)(wc_debug_trace_error_codes_enabled() &&           \
+                          WOLFSSL_DEBUG_PRINTF_FN(                        \
+                                          WOLFSSL_DEBUG_PRINTF_FIRST_ARGS \
+                                          "ERR TRACE: %s L %d %s (%d)\n", \
+                                     __FILE__, __LINE__, #label, label)), \
+                 (void)(wc_debug_trace_error_codes_enabled() &&           \
+                          WOLFSSL_DEBUG_BACKTRACE_RENDER_CLAUSE),         \
+                  (label)                                                 \
+                )
+        #endif /* ! __GNUC__ */
     #endif
     #include <wolfssl/debug-trace-error-codes.h>
 #else

wolfssl/wolfcrypt/logging.h

@@ -579,6 +579,11 @@ WOLFSSL_API void wolfSSL_SetLoggingPrefix(const char* prefix);
     #error "Failed: Cannot WOLFSSL_DEBUG_CERTS with WOLFSSL_DEBUG_ERRORS_ONLY"
 #endif
 
+#ifdef WOLFSSL_DEBUG_TRACE_ERROR_CODES
+    WOLFSSL_API int wc_debug_trace_error_codes_enabled(void);
+    WOLFSSL_API int wc_debug_trace_error_codes_set(int state);
+#endif
+
 #ifdef __cplusplus
 }
 #endif