[dpdk-stable] patch 'build: support drivers symlink on Windows' has been queued to stable release 20.11.3

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 20.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/14/21. 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/bluca/dpdk-stable

This queued commit can be viewed at:
https://github.com/bluca/dpdk-stable/commit/c5b7b05e91596475171c745b58e850c026b1d074

Thanks.

Luca Boccassi

---
>From c5b7b05e91596475171c745b58e850c026b1d074 Mon Sep 17 00:00:00 2001
From: Nick Connolly <nick.connolly at mayadata.io>
Date: Mon, 26 Apr 2021 11:07:32 +0100
Subject: [PATCH] build: support drivers symlink on Windows

[ upstream commit cd27047dbee1eda0e8ed12300bc035636d89607b ]

The symlink-drivers-solibs.sh script was disabled as part of 'install'
for Windows because there is no support for shell scripts. However,
this means that driver related DLLs are not present in the installed
'libdir' directory. Add a python script to perform the install and use
it for Windows if the version of meson supports using an external
program with add_install_script (>= 0.55.0).

On Windows, symbolic links are somewhat problematic since the
SeCreateSymbolicLinkPrivilege is required to be able to create them.
In addition, different cross-compilation environments handle symbolic
links differently, e.g. WSL, Msys2, Cygwin. Rather than trying to
distinguish these scenarios, the python script will perform a file copy
for any Windows specific names.

On Windows, the shared library outputs have different names depending
upon which toolset has been used to build them. The script currently
handles Clang and GCC.

On Linux the functionality is unchanged, but could be replaced with the
python script once the required minimum version of meson is >= 0.55.0.

Signed-off-by: Nick Connolly <nick.connolly at mayadata.io>
Tested-by: Narcisa Vasile <navasile at linux.microsoft.com>
Acked-by: Narcisa Vasile <navasile at linux.microsoft.com>
Reviewed-by: Bruce Richardson <bruce.richardson at intel.com>
---
 MAINTAINERS                          |  1 +
 buildtools/symlink-drivers-solibs.py | 49 ++++++++++++++++++++++++++++
 config/meson.build                   |  4 +++
 3 files changed, 54 insertions(+)
 create mode 100644 buildtools/symlink-drivers-solibs.py

diff --git a/MAINTAINERS b/MAINTAINERS
index f45c8c1b13..dcde2ab5e1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -103,6 +103,7 @@ F: buildtools/gen-pmdinfo-cfile.sh
 F: buildtools/list-dir-globs.py
 F: buildtools/pkg-config/
 F: buildtools/symlink-drivers-solibs.sh
+F: buildtools/symlink-drivers-solibs.py
 F: devtools/test-meson-builds.sh
 
 Public CI
diff --git a/buildtools/symlink-drivers-solibs.py b/buildtools/symlink-drivers-solibs.py
new file mode 100644
index 0000000000..9c999508a9
--- /dev/null
+++ b/buildtools/symlink-drivers-solibs.py
@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2021 Intel Corporation
+
+import os
+import sys
+import glob
+import shutil
+
+# post-install script for meson/ninja builds to symlink the PMDs stored in
+# $libdir/dpdk/pmds-*/ to $libdir. This is needed as some PMDs depend on
+# others, e.g. PCI device PMDs depending on the PCI bus driver.
+
+# parameters to script are paths relative to install prefix:
+# 1. directory for installed regular libs e.g. lib64
+# 2. subdirectory of libdir where the PMDs are
+# 3. directory for installed regular binaries e.g. bin
+
+os.chdir(os.environ['MESON_INSTALL_DESTDIR_PREFIX'])
+
+lib_dir = sys.argv[1]
+pmd_subdir = sys.argv[2]
+bin_dir = sys.argv[3]
+pmd_dir = os.path.join(lib_dir, pmd_subdir)
+
+# copy Windows PMDs to avoid any issues with symlinks since the
+# build could be a cross-compilation under WSL, Msys or Cygnus.
+# the filenames are dependent upon the specific toolchain in use.
+
+def copy_pmd_files(pattern, to_dir):
+	for file in glob.glob(os.path.join(pmd_dir, pattern)):
+		to = os.path.join(to_dir, os.path.basename(file))
+		shutil.copy2(file, to)
+		print(to + ' -> ' + file)
+
+copy_pmd_files('*rte_*.dll', bin_dir)
+copy_pmd_files('*rte_*.pdb', bin_dir)
+copy_pmd_files('*rte_*.lib', lib_dir)
+copy_pmd_files('*rte_*.dll.a', lib_dir)
+
+# symlink shared objects
+
+os.chdir(lib_dir)
+for file in glob.glob(os.path.join(pmd_subdir, 'librte_*.so*')):
+	to = os.path.basename(file)
+	if os.path.exists(to):
+		os.remove(to)
+	os.symlink(file, to)
+	print(to + ' -> ' + file)
diff --git a/config/meson.build b/config/meson.build
index 5b7439aefb..b2734fc0cf 100644
--- a/config/meson.build
+++ b/config/meson.build
@@ -61,6 +61,10 @@ if not is_windows
 	meson.add_install_script('../buildtools/symlink-drivers-solibs.sh',
 			get_option('libdir'),
 			pmd_subdir_opt)
+elif meson.version().version_compare('>=0.55.0')
+	# 0.55.0 is required to use external program with add_install_script
+	meson.add_install_script(py3, '../buildtools/symlink-drivers-solibs.py',
+			get_option('libdir'), pmd_subdir_opt, get_option('bindir'))
 endif
 
 # set the machine type and cflags for it
-- 
2.30.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-07-12 13:41:42.366018406 +0100
+++ 0111-build-support-drivers-symlink-on-Windows.patch	2021-07-12 13:41:36.922131610 +0100
@@ -1 +1 @@
-From cd27047dbee1eda0e8ed12300bc035636d89607b Mon Sep 17 00:00:00 2001
+From c5b7b05e91596475171c745b58e850c026b1d074 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit cd27047dbee1eda0e8ed12300bc035636d89607b ]
+
@@ -27,2 +28,0 @@
-Cc: stable at dpdk.org
-
@@ -41 +41 @@
-index d5a6cee20b..a7eadba130 100644
+index f45c8c1b13..dcde2ab5e1 100644
@@ -44 +44 @@
-@@ -105,6 +105,7 @@ F: buildtools/call-sphinx-build.py
+@@ -103,6 +103,7 @@ F: buildtools/gen-pmdinfo-cfile.sh
@@ -50 +49,0 @@
- F: devtools/check-meson.py
@@ -51,0 +51 @@
+ Public CI
@@ -108 +108 @@
-index 9f56fab1fe..e80421003b 100644
+index 5b7439aefb..b2734fc0cf 100644
@@ -111,4 +111,4 @@
-@@ -59,6 +59,10 @@ eal_pmd_path = join_paths(get_option('prefix'), driver_install_path)
- if not is_windows
-     meson.add_install_script('../buildtools/symlink-drivers-solibs.sh',
-             get_option('libdir'), pmd_subdir_opt)
+@@ -61,6 +61,10 @@ if not is_windows
+ 	meson.add_install_script('../buildtools/symlink-drivers-solibs.sh',
+ 			get_option('libdir'),
+ 			pmd_subdir_opt)
@@ -116,3 +116,3 @@
-+    # 0.55.0 is required to use external program with add_install_script
-+    meson.add_install_script(py3, '../buildtools/symlink-drivers-solibs.py',
-+            get_option('libdir'), pmd_subdir_opt, get_option('bindir'))
++	# 0.55.0 is required to use external program with add_install_script
++	meson.add_install_script(py3, '../buildtools/symlink-drivers-solibs.py',
++			get_option('libdir'), pmd_subdir_opt, get_option('bindir'))
@@ -121 +121 @@
- # init disable/enable driver lists that will be populated in different places
+ # set the machine type and cflags for it