Merge pull request #63 from Luos-io/assert

Add assertion management, fix #62

Author: Nicolas Rabault

.github/workflows/build.yml

@@ -1,7 +1,6 @@
 name: Build
 
 on:
-  pull_request:
   push:
     branches:
       - master

.github/workflows/dev-build.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches-ignore:
       - master
+  
 
 jobs:
 
@@ -45,6 +46,8 @@ jobs:
         # Save branch name
         branch_name=$(git branch --show-current)
         origine_branch_name="origin/${branch_name}"
+        echo current branch name is ${branch_name}
+
         # Step back and get dependancies
         cd ..
 
@@ -55,6 +58,8 @@ jobs:
         then
           echo A dependant branch have been found on LuosHAL
           git checkout $branch_name
+        else
+          echo use master branch on LuosHAL
         fi
         cd ..
 
@@ -65,6 +70,8 @@ jobs:
         then
           echo A dependant branch have been found on Examples
           git checkout $branch_name
+        else
+          echo use master branch on Examples
         fi
         cd ..
 

.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 **/.DS_Store
+*.icloud
+**/*.icloud
 .vscode/

Robus/src/msg_alloc.c

@@ -46,6 +46,7 @@
 #include "config.h"
 #include "msg_alloc.h"
 #include "luos_hal.h"
+#include "luos_utils.h"
 
 /*******************************************************************************
  * Definitions
@@ -412,11 +413,7 @@ static inline error_return_t MsgAlloc_ClearMsgSpace(void *from, void *to)
  ******************************************************************************/
 static inline void MsgAlloc_ClearMsgTask(void)
 {
-    if (msg_tasks_stack_id > MAX_MSG_NB)
-    {
-        while (1)
-            ;
-    }
+    LUOS_ASSERT(msg_tasks_stack_id <= MAX_MSG_NB);
     for (uint16_t rm = 0; rm < msg_tasks_stack_id; rm++)
     {
         msg_tasks[rm] = msg_tasks[rm + 1];
@@ -466,11 +463,7 @@ void MsgAlloc_UsedMsgEnd(void)
  ******************************************************************************/
 static inline void MsgAlloc_ClearLuosTask(uint16_t luos_task_id)
 {
-    if ((luos_task_id > luos_tasks_stack_id) || (luos_tasks_stack_id > MAX_MSG_NB))
-    {
-        while (1)
-            ;
-    }
+    LUOS_ASSERT((luos_task_id <= luos_tasks_stack_id) || (luos_tasks_stack_id <= MAX_MSG_NB));
     for (uint16_t rm = luos_task_id; rm < luos_tasks_stack_id; rm++)
     {
         luos_tasks[rm] = luos_tasks[rm + 1];

Robus/src/robus.c

@@ -14,6 +14,7 @@
 #include "context.h"
 #include "luos_hal.h"
 #include "msg_alloc.h"
+#include "luos_utils.h"
 
 /*******************************************************************************
  * Definitions
@@ -287,12 +288,7 @@ uint16_t Robus_TopologyDetection(ll_container_t *ll_container)
     if (Robus_DetectNextNodes(ll_container) == FAILED)
     {
         // check the number of retry we made
-        if (redetect_nb > 4)
-        {
-            // Too many retry just, there is no hope too succeed.
-            while (1)
-                ;
-        }
+        LUOS_ASSERT((redetect_nb <= 4));
         // Detection fail, restart it
         redetect_nb++;
         goto redetect;
@@ -464,4 +460,4 @@ static error_return_t Robus_MsgHandler(msg_t *input)
 node_t *Robus_GetNode(void)
 {
     return (node_t *)&ctx.node;
-}
+}

inc/container_structs.h

@@ -14,6 +14,21 @@
 /*******************************************************************************
  * Definitions
  ******************************************************************************/
+/* store informations about luos stats
+ * please refer to the documentation
+ */
+typedef struct __attribute__((__packed__))
+{
+    union
+    {
+        struct __attribute__((__packed__))
+        {
+            memory_stats_t memory;
+            uint8_t max_loop_time_ms;
+        };
+        uint8_t unmap[sizeof(memory_stats_t) + 1]; /*!< streamable form. */
+    };
+} luos_stats_t;
 /* This structure is used to create containers version
  * please refer to the documentation
  */
@@ -70,7 +85,8 @@ typedef struct __attribute__((__packed__)) container_t
     uint8_t alias[MAX_ALIAS_SIZE];         /*!< container alias. */
     timed_update_t auto_refresh;           /*!< container auto refresh context. */
     revision_t revision;                   /*!< container firmware version. */
-    container_stats_t statistic;
+    luos_stats_t *node_statistics;         /*!< Node level statistics. */
+    container_stats_t statistics;          /*!< container level statistics. */
 } container_t;
 
 typedef void (*CONT_CB)(container_t *container, msg_t *msg);

inc/luos.h

@@ -7,6 +7,7 @@
 #ifndef LUOS_H
 #define LUOS_H
 
+#include "luos_utils.h"
 #include "luos_list.h"
 #include "container_structs.h"
 #include "routing_table.h"
@@ -18,22 +19,9 @@
  ******************************************************************************/
 
 /******************************************************************************
- * @struct luos_stats_t
- * @brief store informations about luos stats
+ * @struct general_stats_t
+ * @brief format all datas to be sent trough msg
  ******************************************************************************/
-typedef struct __attribute__((__packed__))
-{
-    union
-    {
-        struct __attribute__((__packed__))
-        {
-            memory_stats_t memory;
-            uint8_t max_loop_time_ms;
-        };
-        uint8_t unmap[sizeof(memory_stats_t) + 1]; /*!< streamable form. */
-    };
-} luos_stats_t;
-
 typedef struct __attribute__((__packed__))
 {
     union

inc/luos_utils.h

@@ -0,0 +1,50 @@
+/******************************************************************************
+ * @file luos utils
+ * @brief some tools used to debug
+ * @author Luos
+ * @version 0.0.0
+ ******************************************************************************/
+#ifndef LUOS_UTILS_H
+#define LUOS_UTILS_H
+
+#include <stdint.h>
+/*******************************************************************************
+ * Definitions
+ ******************************************************************************/
+
+#define LUOS_ASSERTION
+
+#ifdef LUOS_ASSERTION
+#define LUOS_ASSERT(expr) \
+    if (!(expr))          \
+    Luos_assert(__FILE__, __LINE__)
+#else
+#define LUOS_ASSERT(expr)
+#endif
+
+/* This structure is used to manage node assertion informations
+ */
+typedef struct __attribute__((__packed__))
+{
+    union
+    {
+        struct __attribute__((__packed__))
+        {
+            uint32_t line;
+            char file[100];
+        };
+        uint8_t unmap[100 + sizeof(uint32_t)];
+    };
+} luos_assert_t;
+
+/*******************************************************************************
+ * Variables
+ ******************************************************************************/
+
+/*******************************************************************************
+ * Function
+ ******************************************************************************/
+
+void Luos_assert(char *file, uint32_t line);
+
+#endif /* LUOS_UTILS_H */

inc/routing_table.h

@@ -75,6 +75,7 @@ void RoutingTB_ComputeRoutingTableEntryNB(void);
 void RoutingTB_DetectContainers(container_t *container);
 void RoutingTB_ConvertNodeToRoutingTable(routing_table_t *entry, node_t *node);
 void RoutingTB_ConvertContainerToRoutingTable(routing_table_t *entry, container_t *container);
+void RoutingTB_RemoveNode(uint16_t nodeid);
 void RoutingTB_RemoveOnRoutingTable(uint16_t id);
 void RoutingTB_Erase(void);
 routing_table_t *RoutingTB_Get(void);

library.json

@@ -2,7 +2,7 @@
     "name": "Luos",
     "keywords": "robus,network,microservice,luos,operating system,os,embedded,communication,module,ST",
     "description": "Luos turns your embedded system into modules like microservices architecture does it in software.",
-    "version": "1.0.1",
+    "version": "1.1.0",
     "authors": {
         "name": "Luos",
         "url": "https://luos.io"