Improve tracing raises

Author: mat-hek

CMakeLists.txt

@@ -29,6 +29,8 @@ find_package(Elixir)
 find_package(Gleam)
 
 set(SANITIZER "address" CACHE STRING "Enable Address Sanitizer") # Include address, memory, or undefined sanitizer
+option(AVM_ENABLE_TRACE "Enable opcode-level tracing" OFF)
+option(AVM_ENABLE_TRACE_RAISE "Enable tracing raised errors" OFF)
 
 option(AVM_DISABLE_FP "Disable floating point support." OFF)
 option(AVM_DISABLE_SMP "Disable SMP." OFF)
@@ -41,7 +43,7 @@ option(AVM_RELEASE "Build an AtomVM release" OFF)
 option(AVM_CREATE_STACKTRACES "Create stacktraces" ON)
 option(AVM_BUILD_RUNTIME_ONLY "Only build the AtomVM runtime" OFF)
 option(COVERAGE "Build for code coverage" OFF)
-option(AVM_PRINT_PROCESS_CRASH_DUMPS "Print crash reports when processes die with non-standard reasons" ON)
+option(AVM_PRINT_PROCESS_CRASH_DUMPS "Print crash reports when processes die with non-standard reasons" OFF)
 
 # JIT & execution of precompiled code
 if(NOT Erlang_VERSION VERSION_GREATER_EQUAL "23")

src/libAtomVM/CMakeLists.txt

@@ -162,6 +162,14 @@ elseif(SANITIZER STREQUAL "undefined")
     target_link_options(libAtomVM PUBLIC -fsanitize=undefined)
 endif()
 
+if (AVM_ENABLE_TRACE)
+    target_compile_definitions(libAtomVM PUBLIC ENABLE_TRACE)
+endif()
+
+if (AVM_ENABLE_TRACE_RAISE)
+    target_compile_definitions(libAtomVM PUBLIC ENABLE_TRACE_RAISE)
+endif()
+
 target_link_libraries(libAtomVM PUBLIC m)
 include(CheckCSourceCompiles)
 set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} -Werror=unknown-pragmas")

src/libAtomVM/bif.c

@@ -44,11 +44,13 @@
 #pragma GCC diagnostic pop
 
 #define RAISE_ERROR(error_type_atom) \
+    TRACE_RAISE;                     \
     ctx->x[0] = ERROR_ATOM;          \
     ctx->x[1] = (error_type_atom);   \
     return term_invalid_term();
 
 #define RAISE_ERROR_BIF(fail_label, error_type_atom) \
+    TRACE_RAISE;                                     \
     if (fail_label == 0) {                           \
         ctx->x[0] = ERROR_ATOM;                      \
         ctx->x[1] = (error_type_atom);               \

src/libAtomVM/nifs.c

@@ -4128,7 +4128,7 @@ static term nif_erlang_fun_info_2(Context *ctx, int argc, term argv[])
             RAISE_ERROR(BADARG_ATOM);
     }
 
-    if (UNLIKELY(memory_ensure_free_with_roots(ctx, TUPLE_SIZE(2), 2, (term[]){ key, value }, MEMORY_CAN_SHRINK) != MEMORY_GC_OK)) {
+    if (UNLIKELY(memory_ensure_free_with_roots(ctx, TUPLE_SIZE(2), 2, (term[]) { key, value }, MEMORY_CAN_SHRINK) != MEMORY_GC_OK)) {
         RAISE_ERROR(OUT_OF_MEMORY_ATOM);
     }
     term fun_info_tuple = term_alloc_tuple(2, &ctx->heap);
@@ -5694,8 +5694,8 @@ static term nif_erlang_nif_error(Context *ctx, int argc, term argv[])
     UNUSED(argc);
     UNUSED(argv);
 
-    fprintf(stderr, "Nif not found, aborting\n");
-    AVM_ABORT();
+    fprintf(stderr, "Nif not found\n");
+    RAISE_ERROR(NIF_NOT_FOUND_ERROR_ATOM);
 }
 
 #ifndef AVM_NO_JIT

src/libAtomVM/nifs.h

@@ -29,13 +29,15 @@
 #include "atom.h"
 #include "context.h"
 #include "exportedfunction.h"
+#include "trace.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 #define VALIDATE_VALUE(value, verify_function) \
     if (UNLIKELY(!verify_function((value)))) { \
+        TRACE_RAISE;                           \
         argv[0] = ERROR_ATOM;                  \
         argv[1] = BADARG_ATOM;                 \
         return term_invalid_term();            \
@@ -44,6 +46,7 @@ extern "C" {
 #define RAISE_ERROR(error_type_atom) \
     ctx->x[0] = ERROR_ATOM;          \
     ctx->x[1] = (error_type_atom);   \
+    TRACE_RAISE;                     \
     return term_invalid_term();
 
 const struct Nif *nifs_get(const char *mfa);

src/libAtomVM/opcodesswitch.h

@@ -84,6 +84,7 @@ extern "C" {
 #undef RAISE_ERROR
 #endif
 #define RAISE_ERROR(error_type_atom) \
+    TRACE_RAISE;                     \
     SET_ERROR(error_type_atom)       \
     goto handle_error;
 
@@ -7551,6 +7552,15 @@ HOT_FUNC int scheduler_entry_point(GlobalContext *glb)
 
 handle_error:
         {
+            if (x_regs[0] == ERROR_ATOM && x_regs[1] == NIF_NOT_FOUND_ERROR_ATOM) {
+                fprintf(stderr, "nif_not_found_error raised, printing crash dump and aborting\n");
+                context_dump(ctx);
+                AVM_ABORT();
+            }
+            #ifdef ENABLE_TRACE_RAISE
+                fprintf(stderr, "TRACE RAISE: raise detected, dumping process context\n");
+                context_dump(ctx);
+            #endif
             int target_label = context_get_catch_label(ctx, &mod);
             if (target_label) {
 #if AVM_NO_JIT

src/libAtomVM/popcorn/popcorn_atoms.def

@@ -2,3 +2,4 @@ X(TRIM_ATOM, "\x4", "trim")
 X(TRIM_ALL_ATOM, "\x8", "trim_all")
 X(STDOUT_ATOM, "\x6", "stdout")
 X(STDERR_ATOM, "\x6", "stderr")
+X(NIF_NOT_FOUND_ERROR_ATOM, "\x13", "nif_not_found_error")

src/libAtomVM/trace.h

@@ -20,17 +20,24 @@
 
 #ifndef _TRACE_H_
 #define _TRACE_H_
-
 #ifndef TRACE
 #ifdef ENABLE_TRACE
-#define TRACE printf
+#define TRACE(args...) fprintf(stderr, args)
 #define DEBUG_FAIL_NULL(expr) assert((expr) != NULL)
 #else
 #define TRACE(...)
 #define DEBUG_FAIL_NULL(expr)
 #endif
 #endif
 
+#ifndef TRACE_RAISE
+#ifdef ENABLE_TRACE_RAISE
+#define TRACE_RAISE fprintf(stderr, "TRACE RAISE: raise from C at %s:%u\n", __FILE_NAME__, __LINE__)
+#else
+#define TRACE_RAISE
+#endif
+#endif
+
 #define USED_BY_TRACE(x) \
     (void) (x)