Changeset 491

Timestamp:

Aug 22, 2018, 11:55:11 PM (6 years ago)

Author:

viala@…

Message:

Change assert to be a macro

Ease using of static analyser and add debuging facility.

Location:

trunk/kernel/kern

Files:

• printk.c (modified) (1 diff)
• printk.h (modified) (2 diffs)

trunk/kernel/kern/printk.c

@@ -386 +386 @@
 
 ////////////////////////////////////
-void assert( bool_t       condition,
-             const char * function_name,
-             char       * format, ... )
-{
-    va_list       args;
-    uint32_t      save_sr;
-
-    if( condition == false )
+void __panic( const char * file_name,
+              const char * function_name,
+              uint32_t     line,
+              cycle_t      cycle,
+              char       * format,
+              ... )
+{
+    // get pointers on TXT0 chdev
+    xptr_t    txt0_xp = chdev_dir.txt_tx[0];
+    cxy_t     txt0_cxy = GET_CXY(txt0_xp);
+    chdev_t * txt0_ptr = GET_PTR(txt0_xp);
+
+    // get extended pointer on remote TXT0 lock
+    xptr_t lock_txt0_xp = XPTR(txt0_cxy, &txt0_ptr->wait_lock);
+
+    // get TXT0 lock in busy waiting mode
     {
-        // get pointers on TXT0 chdev
-        xptr_t    txt0_xp  = chdev_dir.txt_tx[0];
-        cxy_t     txt0_cxy = GET_CXY( txt0_xp );
-        chdev_t * txt0_ptr = GET_PTR( txt0_xp );
-
-        // get extended pointer on remote TXT0 lock
-        xptr_t  lock_xp = XPTR( txt0_cxy , &txt0_ptr->wait_lock );
-
-        // get TXT0 lock in busy waiting mode
-        remote_spinlock_lock_busy( lock_xp , &save_sr );
-
-        // call nolock_printk to print core, function_name, and cycle
-        nolock_printk("\n[PANIC] in %s => core[%x,%d] blocked at cycle %d : " ,
-        function_name, local_cxy, CURRENT_THREAD->core->lid, (uint32_t)hal_get_cycles() );
+        uint32_t save_sr;
+        remote_spinlock_lock_busy(lock_txt0_xp, &save_sr);
+
+        thread_t *current = CURRENT_THREAD;
+        nolock_printk(
+            "\n[PANIC] in %s: line %d | funct %s | cycle %d\n"
+            "core[%x,%d] | thread %x in process %x\n"
+            "            | thread_ptr %x | procress_ptr %x\n",
+            file_name, line, function_name, (uint32_t) cycle,
+            local_cxy, current->core->lid, current->trdid, current->process->pid,
+            current, current->process);
 
         // call kernel_printf on TXT0, in busy waiting to print format
-        va_start( args , format );
-        kernel_printf( format , &args );
-        va_end( args );
+        va_list args;
+        va_start(args, format);
+        kernel_printf(format, &args);
+        va_end(args);
 
         // release TXT0 lock
-        remote_spinlock_unlock_busy( lock_xp , save_sr );
-
-        // suicide
-        while( 1 ) asm volatile ("nop");
-    }
+        remote_spinlock_unlock_busy(lock_txt0_xp, save_sr);
+    }
+
+    // suicide
+    hal_core_sleep();
 }
 

trunk/kernel/kern/printk.h

@@ -44 +44 @@
 #include <stdarg.h>
 
+#include <hal_special.h> // hal_get_cycles()
 
 /**********************************************************************************
@@ -82 +83 @@
 void nolock_printk( char* format, ... );
 
-/**********************************************************************************
- * This function displays a formated message on kernel TXT0 terminal,
+
+/**********************************************************************************
+ * Private function designed to be called by the assert macro (below)
+ **********************************************************************************
+ * @ file_name     : File where the assert macro was invoked
+ * @ function_name : Name of the calling function.
+ * @ line          : Line number where the assert macro was invoked
+ * @ cycle         : Cycle where the macro was invoked
+ * @ format        : Formatted string
+ * ...             : arguments of the format string
+ *
+ * See assert macro documentation for information about printed information.
+ *********************************************************************************/
+void __panic( const char * file_name,
+              const char * function_name,
+              uint32_t     line,
+              cycle_t      cycle,
+              const char * format, ... )
+__attribute__((__noreturn__));
+
+/**********************************************************************************
+ * This macro displays a formated message on kernel TXT0 terminal,
  * and forces the calling core in sleeping mode if a Boolean condition is false.
- * This function is actually used to debug the kernel...
+ * Actually used to debug the kernel.
+ *
+ * Information printed by assert:
+ * Current running thread:
+ *   - thread descriptior adress
+ *   - thread id (trdid)
+ *
+ * Current Process:
+ *   - Process descriptor adress
+ *   - Process id (pid)
+ *
+ * Current Core:
+ *   - local cluster position (local_cxy)
+ *   - local core id (lid)
+ *
+ * File name (__FILE__) and were the assert is invoked.
+ * And the assert message.
+ *
+ * Cycle: before the assert branchment.
+ * Note: cycle may change due to compiler optimisation.
+ *
+ * Exemple:
+ * assert( my_ptr != NULL, "my_ptr should not be NULL")
  **********************************************************************************
  * @ condition     : condition that must be true.
- * @ function_name : name of the calling function.
  * @ format        : formatted string
  *********************************************************************************/
-void assert( bool_t       condition,
-             const char * function_name,
-             char       * format , ... );
+#define assert( expr, format, ... ) { uint32_t __line_at_expansion = __LINE__;    \
+  const volatile cycle_t __assert_cycle = hal_get_cycles();                       \
+  if ( ( expr ) == false ) {                                                      \
+    __panic( __FILE__, __FUNCTION__,                                              \
+             __line_at_expansion, __assert_cycle,                                 \
+             ( format ), ##__VA_ARGS__ );                                         \
+  }                                                                               \
+}
 
 /**********************************************************************************