Changeset 491 for trunk/kernel/kern/printk.h

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.

File:

• trunk/kernel/kern/printk.h (modified) (2 diffs)

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__ );                                         \
+  }                                                                               \
+}
 
 /**********************************************************************************