Add timing assert system

examples/app_assert/src/fn_assert.c

@@ -4,10 +4,10 @@
 #define XASSERT_UNIT FN_ASSERT
 #define XASSERT_ENABLE_ASSERTIONS_FN_ASSERT 1 /* Enable assertions*/
 #define XASSERT_ENABLE_DEBUG_FN_ASSERT 1    /* Enable printing debug message when asserting */
+#define XASSERT_ENABLE_LINE_NUMBERS 1 /* Enable line numbers in assert messages */
 
 #include <xassert.h>
 
-
 void fn_assert(int x)
 {
     assert(x > 5 && msg("assert from fn_assert()"));

examples/app_timed_block/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.21)
+include($ENV{XMOS_CMAKE_PATH}/xcommon.cmake)
+project(app_assert)
+
+set(APP_HW_TARGET XK-EVK-XU316)
+
+include(${CMAKE_CURRENT_LIST_DIR}/../deps.cmake)
+
+set(APP_COMPILER_FLAGS -DXASSERT_ENABLE_ASSERTIONS=0 -DXASSERT_ENABLE_LINE_NUMBERS=1)   # Override from source files
+
+set(XMOS_SANDBOX_DIR ${CMAKE_CURRENT_LIST_DIR}/../../../)
+
+XMOS_REGISTER_APP()

examples/app_timed_block/src/fn_assert.xc

@@ -0,0 +1,19 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#define XASSERT_UNIT FN_ASSERT
+#define XASSERT_ENABLE_TIMING_ASSERTIONS_FN_ASSERT 1 /* Enable timing assertions*/
+#define XASSERT_ENABLE_DEBUG_FN_ASSERT             1  /* Enable printing debug message when asserting */
+
+#include <xs1.h>
+#include <xassert.h>
+
+void fn_assert()
+{
+    XASSERT_TIMED_BLOCK("test", 1000,
+        timer t;
+        unsigned time;
+        t :> time;
+        t when timerafter(time + 5000) :> void;
+    );
+}

examples/app_timed_block/src/fn_no_assert.xc

@@ -0,0 +1,19 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#define XASSERT_UNIT FN_ASSERT
+#define XASSERT_ENABLE_ASSERTIONS_FN_ASSERT 0 /* Disable assertions*/
+#define XASSERT_ENABLE_DEBUG_FN_ASSERT 1      /* Enable printing debug message when asserting */
+
+#include <xs1.h>
+#include <xassert.h>
+
+void fn_no_assert()
+{
+    XASSERT_TIMED_BLOCK("test", 1000,
+        timer t;
+        unsigned time;
+        t :> time;
+        t when timerafter(time + 50) :> void;
+    );
+}

examples/app_timed_block/src/main.c

@@ -0,0 +1,11 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+extern void fn_no_assert(void);
+extern void fn_assert(void);
+
+int main() {
+    fn_no_assert(); // This shouldn't assert
+    fn_assert();   // This asserts
+    return 0;
+}

examples/app_timed_block/src/xassert_conf.h

@@ -0,0 +1,4 @@
+// Copyright 2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#define XASSERT_ENABLE_LINE_NUMBERS 1

examples/app_timed_loop/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.21)
+include($ENV{XMOS_CMAKE_PATH}/xcommon.cmake)
+project(app_assert)
+
+set(APP_HW_TARGET XK-EVK-XU316)
+
+include(${CMAKE_CURRENT_LIST_DIR}/../deps.cmake)
+
+set(APP_COMPILER_FLAGS -DXASSERT_ENABLE_ASSERTIONS=0)   # Override from source files
+
+set(XMOS_SANDBOX_DIR ${CMAKE_CURRENT_LIST_DIR}/../../../)
+
+XMOS_REGISTER_APP()

examples/app_timed_loop/src/fn_assert.xc

@@ -0,0 +1,23 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#define XASSERT_UNIT FN_ASSERT
+#define XASSERT_ENABLE_TIMING_ASSERTIONS_FN_ASSERT 1 /* Enable timing assertions*/
+#define XASSERT_ENABLE_DEBUG_FN_ASSERT             1 /* Enable printing debug message when asserting */
+#define XASSERT_ENABLE_LINE_NUMBERS                1 /* Enable line numbers in assertions */
+#include <xs1.h>
+#include <xassert.h>
+
+void fn_assert()
+{
+    timer t;
+    unsigned time;
+    t :> time;
+
+    for(int i = 0; i< 5; i++)
+    {
+        time += (i * 5000);
+        t when timerafter(time) :> void;
+        xassert_loop_freq("test loop", 10000);
+    }
+}

examples/app_timed_loop/src/fn_no_assert.xc

@@ -0,0 +1,25 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#define XASSERT_UNIT FN_ASSERT
+#define XASSERT_ENABLE_ASSERTIONS_FN_ASSERT 0 /* Enable assertions*/
+#define XASSERT_ENABLE_DEBUG_FN_ASSERT 1    /* Enable printing debug message when asserting */
+
+#include <xs1.h>
+#include <xassert.h>
+#include <print.h>
+
+void fn_no_assert()
+{
+    timer t;
+    unsigned time;
+    t :> time;
+
+
+    for(int i = 0; i< 5; i++)
+    {
+        time += (i * 5000);
+        t when timerafter(time) :> void;
+        xassert_loop_freq("test loop", 10000);
+    }
+}

examples/app_timed_loop/src/main.c

@@ -0,0 +1,11 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+extern void fn_no_assert(void);
+extern void fn_assert(void);
+
+int main() {
+    fn_no_assert(); // This shouldn't assert
+    fn_assert();   // This asserts
+    return 0;
+}

examples/app_timing_loop_exception/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.21)
+include($ENV{XMOS_CMAKE_PATH}/xcommon.cmake)
+project(app_assert)
+
+set(APP_HW_TARGET XK-EVK-XU316)
+
+include(${CMAKE_CURRENT_LIST_DIR}/../deps.cmake)
+
+set(APP_COMPILER_FLAGS -DXASSERT_ENABLE_ASSERTIONS=0)   # Override from source files
+
+set(XMOS_SANDBOX_DIR ${CMAKE_CURRENT_LIST_DIR}/../../../)
+
+XMOS_REGISTER_APP()

examples/app_timing_loop_exception/src/fn_no_assert.xc

@@ -0,0 +1,34 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#define XASSERT_UNIT FN_ASSERT
+#define XASSERT_ENABLE_TIMING_ASSERTIONS_FN_ASSERT 1 /* Enable timing assertions*/
+#define XASSERT_ENABLE_DEBUG_FN_ASSERT             1 /* Enable printing debug message when asserting */
+#define XASSERT_ENABLE_LINE_NUMBERS                1 /* Enable line numbers in assertions */
+#include <xs1.h>
+#include <xassert.h>
+
+void fn_assert()
+{
+    timer t;
+    unsigned time;
+    t :> time;
+
+    for(int i = 0; i< 5; i++)
+    {
+        int delay = 1000;
+
+        xassert_loop_freq("test loop", 10000);
+
+        if(i == 3)
+        {
+            delay *= 50;
+
+            /* Due to this added exception the assertion will not fail */
+            xassert_loop_exception("test loop");
+        }
+
+        time += delay;
+        t when timerafter(time) :> void;
+    }
+}

examples/app_timing_loop_exception/src/main.c

@@ -0,0 +1,10 @@
+// Copyright 2024-2025 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+extern void fn_no_assert(void);
+extern void fn_assert(void);
+
+int main() {
+    fn_no_assert(); // This shouldn't assert
+    return 0;
+}