Make assertion hit warnings optional in release builds.

Author: Rot127

CMakeLists.txt

@@ -79,6 +79,7 @@ option(CAPSTONE_USE_DEFAULT_ALLOC "Use default memory allocation functions" ON)
 option(CAPSTONE_USE_ARCH_REGISTRATION "Use explicit architecture registration" OFF)
 option(CAPSTONE_ARCHITECTURE_DEFAULT "Whether architectures are enabled by default" ON)
 option(CAPSTONE_DEBUG "Whether to enable extra debug assertions (enabled with CMAKE_BUILD_TYPE=Debug)" OFF)
+option(CAPSTONE_ASSERTION_WARNINGS "Warns about hit assertions in release builds." OFF)
 option(CAPSTONE_INSTALL "Generate install target" ${PROJECT_IS_TOP_LEVEL})
 option(ENABLE_ASAN "Enable address sanitizer" OFF)
 option(ENABLE_COVERAGE "Enable test coverage" OFF)

arch/BPF/BPFDisassembler.c

@@ -539,9 +539,7 @@ static bpf_insn op2insn_st(unsigned opcode, const uint32_t imm)
 		CASE(DW);
 	}
 
-	CS_ASSERT_RET_VAL(
-				false && "Malformed atomic BPF instruction",
-				BPF_INS_INVALID);
+	return BPF_INS_INVALID;
 }
 #undef CASE
 

cs_priv.h

@@ -106,6 +106,13 @@ extern cs_vsnprintf_t cs_vsnprintf;
 /// For the release build the @expr is not included.
 #ifdef CAPSTONE_DEBUG
 #define CS_ASSERT(expr) assert(expr)
+#elif CAPSTONE_ASSERTION_WARNINGS
+#define CS_ASSERT(expr) \
+do { \
+	if (!(expr)) { \
+		fprintf(stderr, "Hit assert: " #expr "\n"); \
+	} \
+} while(0)
 #else
 #define CS_ASSERT(expr)
 #endif
@@ -114,28 +121,32 @@ extern cs_vsnprintf_t cs_vsnprintf;
 /// In the release build it will check the @expr and return @val if false.
 #ifdef CAPSTONE_DEBUG
 #define CS_ASSERT_RET_VAL(expr, val) assert(expr)
-#else
+#elif CAPSTONE_ASSERTION_WARNINGS
 #define CS_ASSERT_RET_VAL(expr, val) \
 do { \
 	if (!(expr)) { \
 		fprintf(stderr, "Hit assert: " #expr "\n"); \
 		return val; \
 	} \
 } while(0)
+#else
+#define CS_ASSERT_RET_VAL(expr, val)
 #endif
 
 /// If compiled in debug mode it will assert(@expr).
 /// In the release build it will check the @expr and return if false.
 #ifdef CAPSTONE_DEBUG
 #define CS_ASSERT_RET(expr) assert(expr)
-#else
+#elif CAPSTONE_ASSERTION_WARNINGS
 #define CS_ASSERT_RET(expr) \
 do { \
 	if (!(expr)) { \
 		fprintf(stderr, "Hit assert: " #expr "\n"); \
 		return; \
 	} \
 } while(0)
+#else
+#define CS_ASSERT_RET(expr)
 #endif
 
 #endif

docs/cs_v6_release_guide.md

@@ -90,6 +90,8 @@ For `v7` we can then focus on other big features, like [SAIL](https://github.com
 
 - `clang-tidy` is now run on all files changed by a PR.
 - ASAN: All tests are now run with the address sanitizer enabled. This includes checking for leaks.
+- Many more asserts were added. They are only enabled for debug builds (with a few exceptions).
+  Enabling the build option `CAPSTONE_ASSERTION_WARNINGS` will print warnings in release builds if an assert is hit.
 
 **Instruction formats for PPC, SystemZ, LoongArch**