patch 'eal/linux: unregister alarm callback before free' has been queued to stable release 24.11.3

[Kevin Traynor <ktraynor@redhat.com>]

Hi,

FYI, your patch has been queued to stable release 24.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 07/23/25. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/28861cd46f6c52379a43e43059aa0ade08a180ce

Thanks.

Kevin

---
From 28861cd46f6c52379a43e43059aa0ade08a180ce Mon Sep 17 00:00:00 2001
From: Rui Ferreira <rui.ferreira1@h-partners.com>
Date: Fri, 30 May 2025 09:18:43 +0100
Subject: [PATCH] eal/linux: unregister alarm callback before free

[ upstream commit d84bf0d9aeb474d89a412b6af8e947b16bfcb895 ]

This was flagged by Address sanitizer as a use after free. The
intr_handle ptr is shared between the main thread and the interrupt
thread. The interrupt thread can dereference the ptr after free (from
the alarm callback). free is called when the main thread cleans up.

The interrupt thread never terminates (eal_intr_thread_main) so
use rte_intr_callback_unregister_sync during cleanup to
ensure the callback is removed before freeing the ptr.

To be more defensive clear out the pointer and registration
variable if we can unregister.

rte_intr_callback_unregister_sync may (optionally) use traces
so the alarm cleanup must happen before eal_trace_fini to avoid
accessing freed memory.

Bugzilla ID: 1683
Fixes: 90b13ab8d4f7 ("alarm: remove direct access to interrupt handle")

Signed-off-by: Rui Ferreira <rui.ferreira1@h-partners.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@huawei.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 .mailmap                  | 1 +
 lib/eal/linux/eal.c       | 2 +-
 lib/eal/linux/eal_alarm.c | 9 ++++++++-
 3 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/.mailmap b/.mailmap
index 9211e53fc7..2acdcfd272 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1325,4 +1325,5 @@ Roy Franz <roy.franz@cavium.com>
 Roy Pledge <roy.pledge@nxp.com>
 Roy Shterman <roy.shterman@vastdata.com>
+Rui Ferreira <rui.ferreira1@h-partners.com>
 Ruifeng Wang <ruifeng.wang@arm.com>
 Rushil Gupta <rushilg@google.com>
diff --git a/lib/eal/linux/eal.c b/lib/eal/linux/eal.c
index b1e63e37fc..a13d8f559a 100644
--- a/lib/eal/linux/eal.c
+++ b/lib/eal/linux/eal.c
@@ -1324,8 +1324,8 @@ rte_eal_cleanup(void)
 	rte_mp_channel_cleanup();
 	eal_bus_cleanup();
+	rte_eal_alarm_cleanup();
 	rte_trace_save();
 	eal_trace_fini();
 	eal_mp_dev_hotplug_cleanup();
-	rte_eal_alarm_cleanup();
 	/* after this point, any DPDK pointers will become dangling */
 	rte_eal_memory_detach();
diff --git a/lib/eal/linux/eal_alarm.c b/lib/eal/linux/eal_alarm.c
index 9fe14ade63..44748c7650 100644
--- a/lib/eal/linux/eal_alarm.c
+++ b/lib/eal/linux/eal_alarm.c
@@ -57,5 +57,12 @@ void
 rte_eal_alarm_cleanup(void)
 {
-	rte_intr_instance_free(intr_handle);
+	/* unregister callback using intr_handle in interrupt thread */
+	int ret = rte_intr_callback_unregister_sync(intr_handle,
+						eal_alarm_callback, (void *)-1);
+	if (ret >= 0) {
+		rte_intr_instance_free(intr_handle);
+		intr_handle = NULL;
+		handler_registered = 0;
+	}
 }
 
-- 
2.50.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2025-07-18 20:29:14.068439178 +0100
+++ 0088-eal-linux-unregister-alarm-callback-before-free.patch	2025-07-18 20:29:10.994907527 +0100
@@ -1 +1 @@
-From d84bf0d9aeb474d89a412b6af8e947b16bfcb895 Mon Sep 17 00:00:00 2001
+From 28861cd46f6c52379a43e43059aa0ade08a180ce Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit d84bf0d9aeb474d89a412b6af8e947b16bfcb895 ]
+
@@ -24 +25,0 @@
-Cc: stable@dpdk.org
@@ -36 +37 @@
-index fb90483bee..9135f06efc 100644
+index 9211e53fc7..2acdcfd272 100644
@@ -39 +40 @@
-@@ -1340,4 +1340,5 @@ Roy Franz <roy.franz@cavium.com>
+@@ -1325,4 +1325,5 @@ Roy Franz <roy.franz@cavium.com>
@@ -44 +45 @@
- Rupesh Chiluka <rchiluka@marvell.com>
+ Rushil Gupta <rushilg@google.com>
@@ -46 +47 @@
-index 20f777b8b0..de90ab3b86 100644
+index b1e63e37fc..a13d8f559a 100644
@@ -49 +50 @@
-@@ -1329,8 +1329,8 @@ rte_eal_cleanup(void)
+@@ -1324,8 +1324,8 @@ rte_eal_cleanup(void)
@@ -60 +61 @@
-index b216a007a3..eb6a21d4f0 100644
+index 9fe14ade63..44748c7650 100644
@@ -63 +64 @@
-@@ -58,5 +58,12 @@ void
+@@ -57,5 +57,12 @@ void