patch 'build: hide local symbols in shared libraries' has been queued to stable release 21.11.1

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 21.11.1

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 03/14/22. 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/026470bafaa02cba0d46ed7b7e835262399a009a

Thanks.

Kevin

---
>From 026470bafaa02cba0d46ed7b7e835262399a009a Mon Sep 17 00:00:00 2001
From: Thomas Monjalon <thomas at monjalon.net>
Date: Sun, 6 Mar 2022 10:20:23 +0100
Subject: [PATCH] build: hide local symbols in shared libraries

[ upstream commit b403498e14229ee903c8fff9baefcb72894062f3 ]

The symbols which are not listed in the version script
are exported by default.
Adding a local section with a wildcard make non-listed functions
and variables as hidden, as it should be in all version.map files.

These are the changes done in the shared libraries:
- DF .text  Base          auxiliary_add_device
- DF .text  Base          auxiliary_dev_exists
- DF .text  Base          auxiliary_dev_iterate
- DF .text  Base          auxiliary_insert_device
- DF .text  Base          auxiliary_is_ignored_device
- DF .text  Base          auxiliary_match
- DF .text  Base          auxiliary_on_scan
- DF .text  Base          auxiliary_scan
- DO .bss   Base          auxiliary_bus_logtype
- DO .data  Base          auxiliary_bus
- DO .bss   Base          gpu_logtype

There is no impact on regexdev library.

Because these local symbols were exported as non-internal
in DPDK 21.11, any change in these functions would break the ABI.
Exception rules are added for these experimental libraries,
so the ABI check will skip them until the next ABI version.

A check is added to avoid such miss in future.

Fixes: 1afce3086cf4 ("bus/auxiliary: introduce auxiliary bus")
Fixes: 8b8036a66e3d ("gpudev: introduce GPU device class library")

Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
---
 devtools/check-symbol-maps.sh     | 7 +++++++
 devtools/libabigail.abignore      | 8 ++++++++
 drivers/bus/auxiliary/version.map | 2 ++
 lib/gpudev/version.map            | 2 ++
 lib/regexdev/version.map          | 2 ++
 5 files changed, 21 insertions(+)

diff --git a/devtools/check-symbol-maps.sh b/devtools/check-symbol-maps.sh
index 5bd290ac97..8266fdf9ea 100755
--- a/devtools/check-symbol-maps.sh
+++ b/devtools/check-symbol-maps.sh
@@ -54,3 +54,10 @@ if [ -n "$duplicate_symbols" ] ; then
 fi
 
+local_miss_maps=$(grep -L 'local: \*;' $@)
+if [ -n "$local_miss_maps" ] ; then
+    echo "Found maps without local catch-all:"
+    echo "$local_miss_maps"
+    ret=1
+fi
+
 exit $ret
diff --git a/devtools/libabigail.abignore b/devtools/libabigail.abignore
index 1bdf533228..004fd53180 100644
--- a/devtools/libabigail.abignore
+++ b/devtools/libabigail.abignore
@@ -20,2 +20,10 @@
 [suppress_file]
         soname_regexp = ^librte_common_mlx5\.
+
+; Ignore visibility fix of local functions in experimental auxiliary driver
+[suppress_file]
+        soname_regexp = ^librte_bus_auxiliary\.
+
+; Ignore visibility fix of local functions in experimental gpudev library
+[suppress_file]
+        soname_regexp = ^librte_gpudev\.
diff --git a/drivers/bus/auxiliary/version.map b/drivers/bus/auxiliary/version.map
index a52260657c..dc993e84ff 100644
--- a/drivers/bus/auxiliary/version.map
+++ b/drivers/bus/auxiliary/version.map
@@ -5,3 +5,5 @@ EXPERIMENTAL {
 	rte_auxiliary_register;
 	rte_auxiliary_unregister;
+
+	local: *;
 };
diff --git a/lib/gpudev/version.map b/lib/gpudev/version.map
index 2e414c65cc..34186ab7f1 100644
--- a/lib/gpudev/version.map
+++ b/lib/gpudev/version.map
@@ -36,3 +36,5 @@ INTERNAL {
 	rte_gpu_notify;
 	rte_gpu_release;
+
+	local: *;
 };
diff --git a/lib/regexdev/version.map b/lib/regexdev/version.map
index 988b909638..3c6e9fffa1 100644
--- a/lib/regexdev/version.map
+++ b/lib/regexdev/version.map
@@ -27,4 +27,6 @@ EXPERIMENTAL {
 	rte_regexdev_xstats_names_get;
 	rte_regexdev_xstats_reset;
+
+	local: *;
 };
 
-- 
2.34.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2022-03-10 12:05:31.983846663 +0000
+++ 0027-build-hide-local-symbols-in-shared-libraries.patch	2022-03-10 12:05:31.323630914 +0000
@@ -1 +1 @@
-From b403498e14229ee903c8fff9baefcb72894062f3 Mon Sep 17 00:00:00 2001
+From 026470bafaa02cba0d46ed7b7e835262399a009a Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit b403498e14229ee903c8fff9baefcb72894062f3 ]
+
@@ -35 +36,0 @@
-Cc: stable at dpdk.org
@@ -62 +63 @@
-index 18c11c80c6..c618f20032 100644
+index 1bdf533228..004fd53180 100644
@@ -65 +66 @@
-@@ -33,2 +33,10 @@
+@@ -20,2 +20,10 @@
@@ -87 +88 @@
-index b23e3fd6eb..a2c8ce5759 100644
+index 2e414c65cc..34186ab7f1 100644
@@ -90 +91 @@
-@@ -40,3 +40,5 @@ INTERNAL {
+@@ -36,3 +36,5 @@ INTERNAL {