bsdkm: update readme, cleanup overlong lines.

Author: philljj

bsdkm/README.md

@@ -10,7 +10,7 @@ Supported features:
 - crypto acceleration: AES-NI, AVX, etc.
 
 Planned features:
-- kernel opencrypto driver registration.
+- kernel opencrypto driver registration (supported for internal testing presently).
 - full wolfSSL in kernel (kernel TLS).
 
 ## Building and Installing
@@ -44,10 +44,12 @@ sudo kldunload libwolfssl
 
 ### options
 
-| freebsdkm option                 | description                              |
-| :------------------------------- | :--------------------------------------- |
-| --with-bsd-export-syms=LIST      | Export list of symbols as global. <br>. Options are 'all', 'none', or <br> comma separated list of symbols. |
-| --with-kernel-source=PATH        | Path to kernel tree root (default `/usr/src/sys`) |
+| freebsdkm option                   | description                              |
+| :--------------------------------- | :--------------------------------------- |
+| --with-bsd-export-syms=LIST        | Export list of symbols as global. <br>. Options are 'all', 'none', or <br> comma separated list of symbols. |
+| --with-kernel-source=PATH          | Path to kernel tree root (default `/usr/src/sys`) |
+| --enable-kernel-benchmarks         | Run wolfcrypt benchmark at module load    |
+| --enable-freebsdkm-crypto-register | Register with the FreeBSD kernel opencrypto <br>framework (preliminary, for testing) |
 
 ### FIPS
 

bsdkm/x86_vecreg.c

@@ -142,12 +142,14 @@ int wolfkmod_vecreg_save(int flags_unused)
     if (is_fpu_kern_thread(0)) {
         /* kernel fpu threads are special, do nothing. They own a
          * persistent, dedicated fpu context. */
+        #if defined(WOLFSSL_BSDKM_FPU_DEBUG)
         printf("info: wolfkmod_vecreg_save: is fpu kern thread\n");
+        #endif
         return (0);
     }
 
     if (curthread->td_pcb->pcb_flags & PCB_KERNFPU) {
-        /* fpu context already active. check td_tid and
+        /* kern fpu is active for this thread. check td_tid and
          * increment nesting level. */
         lwpid_t td_tid = wolfkmod_fpu_get_tid();
         if (td_tid != curthread->td_tid) {
@@ -158,7 +160,7 @@ int wolfkmod_vecreg_save(int flags_unused)
         fpu_states[PCPU_GET(cpuid)].nest++;
     }
     else {
-        /* fpu context not active, call fpu_kern_enter().
+        /* kern fpu not active for this thread, call fpu_kern_enter().
          * after calling fpu_kern_enter():
          *   - kernel fpu is enabled
          *   - migration is disabled
@@ -190,14 +192,18 @@ void wolfkmod_vecreg_restore(void)
     if (is_fpu_kern_thread(0)) {
         /* kernel fpu threads are special, do nothing. They own a
          * persistent, dedicated fpu context. */
+        #if defined(WOLFSSL_BSDKM_FPU_DEBUG)
         printf("info: wolfkmod_vecreg_restore: is fpu kern thread\n");
+        #endif
         return;
     }
 
     if (curthread->td_pcb->pcb_flags & PCB_KERNFPU) {
-        if (fpu_states[PCPU_GET(cpuid)].td_tid != curthread->td_tid) {
-            printf("error: wolfkmod_vecreg_restore: got tid = %d, expected %d\n",
-                   fpu_states[PCPU_GET(cpuid)].td_tid, curthread->td_tid);
+        /* kern fpu is active for this thread. check tid and nesting level. */
+        lwpid_t td_tid = wolfkmod_fpu_get_tid();
+        if (td_tid != curthread->td_tid) {
+            printf("error: wolfkmod_vecreg_restore: got tid = %d, "
+                   "expected %d\n", td_tid, curthread->td_tid);
             return;
         }
 
@@ -206,7 +212,7 @@ void wolfkmod_vecreg_restore(void)
             fpu_states[PCPU_GET(cpuid)].nest--;
         }
 
-        /* if last level, zero the thread id and call fpu_kern_leave */
+        /* if last level, zero the thread id then call fpu_kern_leave */
         if (fpu_states[PCPU_GET(cpuid)].nest == 0) {
             fpu_states[PCPU_GET(cpuid)].td_tid = 0;
             wolfkmod_fpu_kern_leave();

configure.ac

@@ -832,17 +832,12 @@ AC_ARG_WITH([bsd-export-syms],
 
 if test "x$ENABLED_BSDKM" = "xyes"
 then
-    #AX_SIMD_CC_COMPILER_FLAGS
-    # wolfcrypt only for now.
+    # note: bsdkm is wolfcrypt only for now.
     HAVE_KERNEL_MODE=yes
     KERNEL_MODE_DEFAULTS=yes
     ENABLED_NO_LIBRARY=yes
     ENABLED_BENCHMARK=no
 
-    # todo: remove, leaving for notes for now.
-    #ENABLED_ASM=no
-    #AM_CFLAGS="$AM_CFLAGS -DTFM_NO_ASM -DWOLFSSL_NO_ASM"
-
     output_objdir="$(realpath "$output_objdir")/bsdkm"
 
     AM_CFLAGS="$AM_CFLAGS -DWOLFSSL_BSDKM -DWC_SIPHASH_NO_ASM"
@@ -862,7 +857,6 @@ then
     fi
     AC_SUBST([KERNEL_ROOT])
     AC_SUBST([BSDKM_EXPORT_SYMS])
-
 fi
 
 if test "x$ENABLED_BSDKM_REGISTER" = "xyes"

wolfcrypt/benchmark/benchmark.c

@@ -2685,7 +2685,7 @@ static WC_INLINE void bench_stats_start(int* count, double* start)
 
 #if defined(WOLFSSL_USE_SAVE_VECTOR_REGISTERS)
     #define bench_stats_start(count, start) do {                               \
-        SAVE_VECTOR_REGISTERS(WOLFSSL_DEBUG_PRINTF(                                          \
+        SAVE_VECTOR_REGISTERS(WOLFSSL_DEBUG_PRINTF(                            \
             "ERROR: SAVE_VECTOR_REGISTERS failed for benchmark run.");         \
                               return; );                                       \
         bench_stats_start(count, start);                                       \