ci(performance): Add SuperPi like test

Author: lucasssvaz

tests/performance/fibonacci/fibonacci.ino

@@ -1,6 +1,7 @@
 #include <Arduino.h>
 
-#define N_RUNS 3 // Number of runs to average
+// Number of runs to average
+#define N_RUNS 3
 
 // Fibonacci number to calculate. Keep between 35 and 45.
 #define FIB_N 40
@@ -36,7 +37,7 @@ void setup(){
     sum += times[i];
   }
   uint32_t avg = sum / N_RUNS;
-  Serial.printf("Average time: %lu.%03lu s\n", avg/1000, avg%1000);
+  Serial.printf("Average time: %lu.%03lu s\n", avg / 1000, avg % 1000);
 }
 
 void loop(){

tests/performance/fibonacci/test_fibonacci.py

@@ -2,12 +2,12 @@
 import logging
 import os
 
-LOGGER = logging.getLogger(__name__)
+def test_fibonacci(dut, request):
+    LOGGER = logging.getLogger(__name__)
 
-# Fibonacci results starting from fib(35) to fib(45)
-fib_results = [9227465, 14930352, 24157817, 39088169, 63245986, 102334155, 165580141, 267914296, 433494437, 701408733]
+    # Fibonacci results starting from fib(35) to fib(45)
+    fib_results = [9227465, 14930352, 24157817, 39088169, 63245986, 102334155, 165580141, 267914296, 433494437, 701408733]
 
-def test_fibonacci(dut, request):
     # Match "Runs: %d"
     res = dut.expect(r"Runs: (\d+)", timeout=60)
     runs = int(res.group(0).decode("utf-8").split(" ")[1])
@@ -32,7 +32,7 @@ def test_fibonacci(dut, request):
     LOGGER.info("Average time on {} runs: {} s".format(runs, avg_time))
 
     # Create JSON with results and write it to file
-    # Always create a JSON with the format (so it can be merged later on):
+    # Always create a JSON with this format (so it can be merged later on):
     # { TEST_NAME_STR: TEST_RESULTS_DICT }
     results = {
         "fibonacci": {
@@ -44,7 +44,8 @@ def test_fibonacci(dut, request):
     }
 
     current_folder = os.path.dirname(request.path)
-    with open(current_folder + "/result_fibonacci.json", "w") as f:
+    report_file = os.path.join(current_folder, "result_fibonacci.json")
+    with open(report_file, "w") as f:
         try:
             f.write(json.dumps(results))
         except Exception as e:

tests/performance/superpi/fftsg_h.cpp

@@ -0,0 +1,88 @@
+/*
+  Based on "Calculation of PI(= 3.14159...) using FFT and AGM" by T.Ooura, Nov. 1999.
+  https://github.com/Fibonacci43/SuperPI
+  Modified for Arduino by Lucas Saavedra Vaz, 2024.
+*/
+
+#pragma once
+
+#include <math.h>
+
+#ifndef M_PI_2
+#define M_PI_2 1.570796326794896619231321691639751442098584699687
+#endif
+#ifndef WR5000 /* cos(M_PI_2*0.5000) */
+#define WR5000 0.707106781186547524400844362104849039284835937688
+#endif
+#ifndef WR2500 /* cos(M_PI_2*0.2500) */
+#define WR2500 0.923879532511286756128183189396788286822416625863
+#endif
+#ifndef WI2500 /* sin(M_PI_2*0.2500) */
+#define WI2500 0.382683432365089771728459984030398866761344562485
+#endif
+#ifndef WR1250 /* cos(M_PI_2*0.1250) */
+#define WR1250 0.980785280403230449126182236134239036973933730893
+#endif
+#ifndef WI1250 /* sin(M_PI_2*0.1250) */
+#define WI1250 0.195090322016128267848284868477022240927691617751
+#endif
+#ifndef WR3750 /* cos(M_PI_2*0.3750) */
+#define WR3750 0.831469612302545237078788377617905756738560811987
+#endif
+#ifndef WI3750 /* sin(M_PI_2*0.3750) */
+#define WI3750 0.555570233019602224742830813948532874374937190754
+#endif
+
+#ifndef CDFT_RECURSIVE_N     /* length of the recursive FFT mode */
+#define CDFT_RECURSIVE_N 512 /* <= (L1 cache size) / 16 */
+#endif
+
+#ifndef CDFT_LOOP_DIV /* control of the CDFT's speed & tolerance */
+#define CDFT_LOOP_DIV 32
+#endif
+
+#ifndef RDFT_LOOP_DIV /* control of the RDFT's speed & tolerance */
+#define RDFT_LOOP_DIV 64
+#endif
+
+#ifndef DCST_LOOP_DIV /* control of the DCT,DST's speed & tolerance */
+#define DCST_LOOP_DIV 64
+#endif
+
+void bitrv1(int n, double *a);
+void bitrv2(int n, double *a);
+void bitrv208(double *a);
+void bitrv208neg(double *a);
+void bitrv216(double *a);
+void bitrv216neg(double *a);
+void bitrv2conj(int n, double *a);
+void cdft(int n, int isgn, double *a);
+void cftb040(double *a);
+void cftb1st(int n, double *a);
+void cftbsub(int n, double *a);
+void cftexp1(int n, double *a);
+void cftexp2(int n, double *a);
+void cftf040(double *a);
+void cftf081(double *a);
+void cftf082(double *a);
+void cftf161(double *a);
+void cftf162(double *a);
+void cftfsub(int n, double *a);
+void cftfx41(int n, double *a);
+void cftfx42(int n, double *a);
+void cftmdl1(int n, double *a);
+void cftmdl2(int n, double *a);
+void cftrec1(int n, double *a);
+void cftrec2(int n, double *a);
+void cftx020(double *a);
+void dctsub(int n, double *a);
+void dctsub4(int n, double *a);
+void ddct(int n, int isgn, double *a);
+void ddst(int n, int isgn, double *a);
+void dfct(int n, double *a);
+void dfst(int n, double *a);
+void dstsub(int n, double *a);
+void dstsub4(int n, double *a);
+void rdft(int n, int isgn, double *a);
+void rftbsub(int n, double *a);
+void rftfsub(int n, double *a);

tests/performance/superpi/fftsg_h.h

@@ -0,0 +1,47 @@
+/*
+  Based on "Calculation of PI(= 3.14159...) using FFT and AGM" by T.Ooura, Nov. 1999.
+  https://github.com/Fibonacci43/SuperPI
+  Modified for Arduino by Lucas Saavedra Vaz, 2024.
+*/
+
+#pragma once
+
+#include <ctype.h>
+
+#define PI_FFTC_VER "ver. LG1.1.2-MP1.5.2a.memsave"
+
+/* Please check the following macros before compiling */
+#ifndef DBL_ERROR_MARGIN
+#define DBL_ERROR_MARGIN 0.4 /* must be < 0.5 */
+#endif
+
+#define DGTINT     short int /* sizeof(DGTINT) == 2 */
+#define DGTINT_MAX SHRT_MAX
+
+#define DGT_PACK       10
+#define DGT_PACK_LINE  5
+#define DGT_LINE_BLOCK 20
+
+void pi_calc(int nfft);
+void mp_load_0(int n, int radix, int out[]);
+void mp_load_1(int n, int radix, int out[]);
+void mp_round(int n, int radix, int m, int inout[]);
+int mp_cmp(int n, int radix, int in1[], int in2[]);
+void mp_add(int n, int radix, int in1[], int in2[], int out[]);
+void mp_sub(int n, int radix, int in1[], int in2[], int out[]);
+void mp_imul(int n, int radix, int in1[], int in2, int out[]);
+int mp_idiv(int n, int radix, int in1[], int in2, int out[]);
+void mp_idiv_2(int n, int radix, int in[], int out[]);
+double mp_mul_radix_test(int n, int radix, int nfft, double tmpfft[]);
+void mp_mul(int n, int radix, int in1[], int in2[], int out[], int tmp[], int nfft, double tmp1fft[], double tmp2fft[], double tmp3fft[]);
+void mp_squ(int n, int radix, int in[], int out[], int tmp[], int nfft, double tmp1fft[], double tmp2fft[]);
+void mp_mulhf(int n, int radix, int in1[], int in2[], int out[], int tmp[], int nfft, double in1fft[], double tmpfft[]);
+void mp_mulhf_use_in1fft(int n, int radix, double in1fft[], int in2[], int out[], int tmp[], int nfft, double tmpfft[]);
+void mp_squhf_use_infft(int n, int radix, double infft[], int in[], int out[], int tmp[], int nfft, double tmpfft[]);
+void mp_mulh(int n, int radix, int in1[], int in2[], int out[], int nfft, double in1fft[], double outfft[]);
+void mp_squh(int n, int radix, int in[], int out[], int nfft, double outfft[]);
+int mp_inv(int n, int radix, int in[], int out[], int tmp1[], int tmp2[], int nfft, double tmp1fft[], double tmp2fft[]);
+int mp_sqrt(int n, int radix, int in[], int out[], int tmp1[], int tmp2[], int nfft, double tmp1fft[], double tmp2fft[]);
+int mp_invisqrt(int n, int radix, int in, int out[], int tmp1[], int tmp2[], int nfft, double tmp1fft[], double tmp2fft[]);
+void mp_sprintf(int n, int log10_radix, int in[], char out[]);
+void mp_sscanf(int n, int log10_radix, char in[], int out[]);

tests/performance/superpi/pi_fftcs.cpp

@@ -0,0 +1,39 @@
+#include <Arduino.h>
+
+#include "pi_fftcs.h"
+
+// Number of runs to average
+#define N_RUNS 3
+
+// Number of decimal digits to calculate
+#define DIGITS (1 << 14)
+
+uint32_t times[N_RUNS];
+
+void setup(){
+  Serial.begin(115200);
+  while (!Serial) delay(10);
+
+  log_d("Starting PI calculation");
+  Serial.printf("Runs: %d\n", N_RUNS);
+  Serial.printf("Digits: %d\n", DIGITS);
+  for (int i = 0; i < N_RUNS; i++) {
+    log_d("Run %d", i);
+    unsigned long start = millis();
+    pi_calc(DIGITS);
+    unsigned long end = millis();
+    times[i] = end - start;
+    log_d("Run %d: %lu.%03lu s\n", i, times[i]/1000, times[i]%1000);
+  }
+
+  uint32_t sum = 0;
+  for (int i = 0; i < N_RUNS; i++) {
+    sum += times[i];
+  }
+  uint32_t avg = sum / N_RUNS;
+  Serial.printf("Average time: %lu.%03lu s\n", avg / 1000, avg % 1000);
+}
+
+void loop(){
+  vTaskDelete(NULL);
+}

tests/performance/superpi/pi_fftcs.h

@@ -0,0 +1,40 @@
+import json
+import logging
+import os
+
+def test_superpi(dut, request):
+    LOGGER = logging.getLogger(__name__)
+
+    # Match "Runs: %d"
+    res = dut.expect(r"Runs: (\d+)", timeout=60)
+    runs = int(res.group(0).decode("utf-8").split(" ")[1])
+    LOGGER.info("Number of runs: {}".format(runs))
+
+    # Match "Digits: %d"
+    res = dut.expect(r"Digits: (\d+)", timeout=60)
+    digits = int(res.group(0).decode("utf-8").split(" ")[1])
+    LOGGER.info("Number of decimal digits: {}".format(digits))
+
+    # Match "Average time: %lu.%03lu s"
+    res = dut.expect(r"Average time: (\d+)\.(\d+) s", timeout=300)
+    avg_time = float(res.group(0).decode("utf-8").split(" ")[2])
+    LOGGER.info("Average time on {} runs: {} s".format(runs, avg_time))
+
+    # Create JSON with results and write it to file
+    # Always create a JSON with this format (so it can be merged later on):
+    # { TEST_NAME_STR: TEST_RESULTS_DICT }
+    results = {
+        "superpi": {
+            "runs": runs,
+            "digits": digits,
+            "avg_time": avg_time
+        }
+    }
+
+    current_folder = os.path.dirname(request.path)
+    report_file = os.path.join(current_folder, "result_superpi.json")
+    with open(report_file, "w") as f:
+        try:
+            f.write(json.dumps(results))
+        except Exception as e:
+            LOGGER.warning("Failed to write results to file: {}".format(e))