From 565d28a6bcb4c72fe29a28eb3acf7e02bf721cfd Mon Sep 17 00:00:00 2001
From: Alexandre Abadie <alexandre.abadie@inria.fr>
Date: Thu, 27 May 2021 14:25:09 +0200
Subject: [PATCH] tools/iotlab-testbed: add support for remote debugging

---
 dist/testbed-support/iotlab-debug.sh          | 70 +++++++++++++++++++
 .../makefile.iotlab.single.inc.mk             | 18 +++--
 2 files changed, 83 insertions(+), 5 deletions(-)
 create mode 100755 dist/testbed-support/iotlab-debug.sh

diff --git a/dist/testbed-support/iotlab-debug.sh b/dist/testbed-support/iotlab-debug.sh
new file mode 100755
index 000000000000..b63a5f58723c
--- /dev/null
+++ b/dist/testbed-support/iotlab-debug.sh
@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+
+# This script wraps IoT-LAB remote debugging tools so they can be used with
+# debug and debug-server targets.
+
+# @author       Alexandre Abadie <alexandre.abadie@inria.fr>
+
+IOTLAB_NODE=$1
+IOTLAB_NODE_LIST=$2
+IOTLAB_AUTHORITY=$3
+IOTLAB_EXP_ID=$4
+ELFFILE=$5
+SERVER_ONLY=$6
+
+# GDB command, usually a separate command for each platform (e.g. arm-none-eabi-gdb)
+: "${GDB:=gdb-multiarch}"
+# Debugger client command, can be used to wrap GDB in a front-end
+: "${DBG:=${GDB}}"
+# Default GDB port
+: "${GDB_PORT:=3333}"
+
+# If run from the SSH frontend the remote is the iotlab node hostname. If run
+# locally, the GDB server is exposed via an SSH tunnel, so the GDB remote is
+# localhost in this case.
+if [ ! -z "${IOT_LAB_FRONTEND_FQDN}" ]
+then
+    GDB_REMOTE=${IOTLAB_NODE}
+    # Use a blocking interactive command to simulate the SSH tunnel
+    REMOTE_ACCESS_COMMAND="tee &"
+else
+    GDB_REMOTE=localhost
+    REMOTE_ACCESS_COMMAND="ssh -L 3333:${IOTLAB_NODE}:${GDB_PORT} -N ${IOTLAB_AUTHORITY} &"
+fi
+
+# Default debugger flags,
+: "${DBG_FLAGS:=-q -ex \"target remote ${GDB_REMOTE}:${GDB_PORT}\"}"
+
+# temporary file that contains the iotlab SSH tunnel pid
+IOTLAB_DEBUG_PIDFILE=$(mktemp -t "iotlab_debug_pid.XXXXXXXXXX")
+# will be called by trap
+cleanup() {
+    # shellcheck disable=SC2086
+    iotlab-node --jmespath='keys(@)[0]' --format='lambda ret: exit(int(ret))' --debug-stop ${IOTLAB_EXP_ID} ${IOTLAB_NODE_LIST}
+    # shellcheck disable=SC2046
+    kill $(cat "${IOTLAB_DEBUG_PIDFILE}")
+    rm -f "${IOTLAB_DEBUG_PIDFILE}"
+    exit 0
+}
+# cleanup after script terminates
+trap 'cleanup ${IOTLAB_DEBUG_PIDFILE}' EXIT
+
+# Start the GDB server on the IoT-LAB node
+# shellcheck disable=SC2086
+iotlab-node --jmespath='keys(@)[0]' --format='lambda ret: exit(int(ret))' --debug-start ${IOTLAB_EXP_ID} ${IOTLAB_NODE_LIST}
+
+# open SSH tunnel to GDB server running on the IoT-LAB node
+sh -c "\
+    ${REMOTE_ACCESS_COMMAND} \
+    echo \$! > ${IOTLAB_DEBUG_PIDFILE}" &
+
+if [ ! -z "${SERVER_ONLY}" ]
+then
+    # Block until CTRL-C is sent
+    read -r -d ""
+else
+    # don't trap on Ctrl+C, because GDB keeps running
+    trap '' INT
+    # Start the debugger and connect to the GDB server
+    sh -c "${DBG} ${DBG_FLAGS} ${ELFFILE}"
+fi
diff --git a/dist/testbed-support/makefile.iotlab.single.inc.mk b/dist/testbed-support/makefile.iotlab.single.inc.mk
index b659903f48d0..b831b1873eb6 100644
--- a/dist/testbed-support/makefile.iotlab.single.inc.mk
+++ b/dist/testbed-support/makefile.iotlab.single.inc.mk
@@ -221,8 +221,16 @@ else
 
 endif
 
-# Debugger not supported
-DEBUGGER =
-DEBUGGER_FLAGS =
-DEBUGSERVER =
-DEBUGSERVER_FLAGS =
+ifneq (,$(filter firefly iotlab-a8-m3 zigduino,$(BOARD)))
+  # Debugger not supported on these boards
+  DEBUGGER =
+  DEBUGGER_FLAGS =
+  DEBUGSERVER =
+  DEBUGSERVER_FLAGS =
+else
+  DEBUGGER_COMMON_FLAGS = "$(firstword $(subst ., ,$(IOTLAB_NODE)))" "$(_IOTLAB_NODELIST)" "$(_IOTLAB_AUTHORITY)" "$(_IOTLAB_EXP_ID)"
+  DEBUGGER = $(RIOTBASE)/dist/testbed-support/iotlab-debug.sh
+  DEBUGGER_FLAGS = $(DEBUGGER_COMMON_FLAGS) "$(ELFFILE)"
+  DEBUGSERVER = $(DEBUGGER)
+  DEBUGSERVER_FLAGS = $(DEBUGGER_COMMON_FLAGS) "" "1"
+endif