20230223-refactor-test-c-error-codes (#6135)

* wolfcrypt/test/test.{c,h}: refactor to capture and encode error retvals using WC_TEST_RET_*() macros (based on line numbers), and print line and return code in err_sys().
* wolfcrypt/test/test.h: cast back to int in WC_TEST_RET_ENC(), to fix MSVC warning.
* configure.ac: add shake128 and shake256 to enable-all and enable-all-crypto;
* wolfcrypt/benchmark/benchmark.c: fix gating for bench_shake128() from !defined(WOLFSSL_NO_SHAKE128) to defined(WOLFSSL_SHAKE128).
* wolfcrypt/test/test.h: add WC_TEST_RET_TAG_* and WC_TEST_RET_DEC_TAG(), and refactor WC_TEST_RET_{ENC,DEC}_*() macros to implement the tag mechanism;
* add render_error_message() with tag-specific rendering of error strings;
* wolfcrypt/test/test.c: smallstack refactor of shake128_test() and shake128_absorb_test();
* wolfcrypt/test/test.c: change gating around mp_test() and related routines from defined(HAVE_VALGRIND) to defined(WOLFSSL_PUBLIC_MP);
* smallstack refactor of mp_test();
* refactor a slew of WC_TEST_RET_ENC_NC associated with XFOPEN/XFREAD to be WC_TEST_RET_ENC_ERRNO, and add error detection for XFREAD (previously silently tolerating zero retvals).
* wolfcrypt/test/test.c: build mp_test() only if WOLFSSL_SP_MATH_ALL or USE_FAST_MATH (in addition to WOLFSSL_PUBLIC_MP), because many general purpose functions such as sp_mulmod() are gated out in SP builds without WOLFSSL_SP_MATH_ALL.
* wolfcrypt/test/test.c: fix array bounds flubs in shake128_test();
* don't print_fiducials() in wolfcrypt_test() header, but rather, after render_error_message() in err_sys().
* wolfcrypt/test/test.{c,h}: wrap some overlong lines, and fix an unused-variable warning in mp_test_set_is_bit().
* wolfcrypt/test/test.c: fixes for several misplaced and several missing WC_TEST_RET_ENC_EC()s.

configure.ac

@@ -688,6 +688,8 @@ then
     test "$enable_camellia" = "" && enable_camellia=yes
     test "$enable_ripemd" = "" && enable_ripemd=yes
     test "$enable_sha224" = "" && enable_sha224=yes
+    test "$enable_shake128" = "" && enable_shake128=yes
+    test "$enable_shake256" = "" && enable_shake256=yes
     test "$enable_sessioncerts" = "" && enable_sessioncerts=yes
     test "$enable_keygen" = "" && enable_keygen=yes
     test "$enable_certgen" = "" && enable_certgen=yes
@@ -872,6 +874,8 @@ then
     test "$enable_camellia" = "" && enable_camellia=yes
     test "$enable_ripemd" = "" && enable_ripemd=yes
     test "$enable_sha224" = "" && enable_sha224=yes
+    test "$enable_shake128" = "" && enable_shake128=yes
+    test "$enable_shake256" = "" && enable_shake256=yes
     test "$enable_sessioncerts" = "" && enable_sessioncerts=yes
     test "$enable_keygen" = "" && enable_keygen=yes
     test "$enable_certgen" = "" && enable_certgen=yes

wolfcrypt/benchmark/benchmark.c

@@ -5439,7 +5439,7 @@ exit:
 }
 #endif /* WOLFSSL_NOSHA3_512 */
 
-#ifndef WOLFSSL_NO_SHAKE128
+#ifdef WOLFSSL_SHAKE128
 void bench_shake128(int useDeviceID)
 {
     wc_Shake hash[BENCH_MAX_PENDING];
@@ -5532,7 +5532,7 @@ exit:
 
     WC_FREE_ARRAY(digest, BENCH_MAX_PENDING, HEAP_HINT);
 }
-#endif /* WOLFSSL_NO_SHAKE128 */
+#endif /* WOLFSSL_SHAKE128 */
 
 #ifdef WOLFSSL_SHAKE256
 void bench_shake256(int useDeviceID)

wolfcrypt/test/test.h

@@ -42,10 +42,54 @@ int wolfcrypt_test_main(int argc, char** argv);
 int wolf_test_task(void);
 #endif
 
+#ifndef WC_TEST_RET_HAVE_CUSTOM_MACROS
+
+#define WC_TEST_RET_TAG_NC     0
+#define WC_TEST_RET_TAG_EC     1
+#define WC_TEST_RET_TAG_ERRNO  2
+#define WC_TEST_RET_TAG_I      3
+
+#define WC_TEST_RET_ENC(line, i, tag)                           \
+        (-((line) + ((int)((unsigned)(i) & 0x7ff) * 100000) + ((tag) << 29)))
+
+#ifndef WC_TEST_RET_LN
+#define WC_TEST_RET_LN __LINE__
+#endif
+
+/* encode no code */
+#define WC_TEST_RET_ENC_NC WC_TEST_RET_ENC(WC_TEST_RET_LN, 0, WC_TEST_RET_TAG_NC)
+
+/* encode positive integer */
+#define WC_TEST_RET_ENC_I(i) WC_TEST_RET_ENC(WC_TEST_RET_LN, i, WC_TEST_RET_TAG_I)
+
+/* encode error code (negative integer) */
+#define WC_TEST_RET_ENC_EC(ec) WC_TEST_RET_ENC(WC_TEST_RET_LN, -(ec), WC_TEST_RET_TAG_EC)
+
+/* encode system/libc error code */
+#if defined(HAVE_ERRNO_H) && !defined(NO_FILESYSTEM) && \
+    !defined(NO_STDIO_FILESYSTEM) && !defined(WOLFSSL_USER_IO)
+#include <errno.h>
+#define WC_TEST_RET_ENC_ERRNO WC_TEST_RET_ENC(WC_TEST_RET_LN, errno, WC_TEST_RET_TAG_ERRNO)
+#else
+#define WC_TEST_RET_ENC_ERRNO WC_TEST_RET_ENC_NC
+#endif
+
+#define WC_TEST_RET_DEC_TAG(x) ((-(x)) >> 29)
+
+/* decode line number */
+#define WC_TEST_RET_DEC_LN(x) (((-(x)) & ~(3 << 29)) % 100000)
+
+/* decode integer or errno */
+#define WC_TEST_RET_DEC_I(x) (((-(x)) & ~(3 << 29)) / 100000)
+
+/* decode error code */
+#define WC_TEST_RET_DEC_EC(x) (-WC_TEST_RET_DEC_I(x))
+
+#endif /* !WC_TEST_RET_HAVE_CUSTOM_MACROS */
+
 #ifdef __cplusplus
     }  /* extern "C" */
 #endif
 
 
 #endif /* WOLFCRYPT_TEST_H */
-