From ce8029250c8cda7527772b65dfccd7ee1654b10a Mon Sep 17 00:00:00 2001
From: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
Date: Fri, 7 Jun 2024 14:15:22 +0300
Subject: [PATCH] tools: Initial version of IPC4 tx message logger using eBPF

The bpftrace script will tap into the entry of sof_ipc4_log_header() which
is always called but only prints if dynamic debugging is enabled. It's
parameter list is not expected to be changed.

The bpftrace must be installed to be able to use the script
sudo pacman -S bpftrace
sudo emerge -a bpftrace
sudo apt install bpftrace
sudo dnf install bpftrace

To use the script:
sudo ./tools/sof-ipc4-msg-trace.bt
or
sudo bpftrace tools/sof-ipc4-msg-trace.bt

It will start logging the sent messages (including payloads) and received
notification with exception of 0x1b060000 - trace update.

To stop the logging, just terminate the script with CTRL+C

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
---
 tools/sof-ipc4-msg-trace.bt | 63 +++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100755 tools/sof-ipc4-msg-trace.bt

diff --git a/tools/sof-ipc4-msg-trace.bt b/tools/sof-ipc4-msg-trace.bt
new file mode 100755
index 00000000..f23638ad
--- /dev/null
+++ b/tools/sof-ipc4-msg-trace.bt
@@ -0,0 +1,63 @@
+#!/usr/bin/bpftrace
+
+struct sof_ipc4_msg {
+	union {
+		unsigned long header_u64;
+		struct {
+			unsigned int primary;
+			unsigned int extension;
+		};
+	};
+
+	unsigned long data_size;
+	void *data_ptr;
+};
+
+BEGIN
+{
+	printf("SOF IPC4 tx message logging. Ctrl-C to end.\n\n");
+}
+
+/*
+ * Log the sent IPC4 messages, ignoring the 0x1b060000 notification
+ * from firmware (trace update)
+ * The message payload is printed as bytes, arranged by 16 bytes/line
+ */
+kprobe:sof_ipc4_log_header {
+	$msg = (struct sof_ipc4_msg *)arg2;
+
+	if ($msg->primary != 0x1b060000 && arg3 == 1 && $msg->data_size != 0) {
+		printf("%s : 0x%x|0x%x [data size:: %llu]\n", str(arg1),
+		       $msg->primary, $msg->extension, $msg->data_size);
+		if (!strcontains(str(arg1), "done")) {
+			$count = (int64) $msg->data_size;
+			$ptr = (uint8*) $msg->data_ptr;
+			$line = 0;
+
+			printf("Message payload:\n");
+			while ($line < 500) {
+				if ($count <= 16) {
+					printf("%rh\n", buf($ptr, $count));
+					break;
+				}
+
+				printf("%rh\n", buf($ptr, 16));
+				$count -= 16;
+				if ($count == 0) {
+					break;
+				}
+				$ptr += 16;
+				$line++;
+			}
+		} else {
+			printf("\n");
+		}
+	} else if ($msg->primary != 0x1b060000) {
+		printf("%s : 0x%x|0x%x\n", str(arg1), $msg->primary,
+		       $msg->extension);
+		if (strcontains(str(arg1), "done")) {
+			printf("\n");
+		}
+	}
+}
+