Skip to contentSkip to conversation

bus/pci/windows: guard against sdk/dpdk guid collision

PATCH Superseded Tyler Retzlaff 4 participants 9 messages Jan 12, 2021 – Jan 15, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bus/pci/windows: guard against sdk/dpdk guid collision

DEVCLASS and DEVINTERFACE guids are defined/managed by the windows platform sdk headers.

* hide dpdk defined GUID_DEVCLASS_NETUIO and GUID_DEVINTERFACE_NETUIO if the NTDDI_VERSION >= 0x0A00000A
* include <ndisguid.h> for windows sdk defined GUID_DEVINTERFACE_NETUIO

---
 drivers/bus/pci/windows/pci_netuio.c | 2 ++
 drivers/bus/pci/windows/pci_netuio.h | 2 ++
 2 files changed, 4 insertions(+)
drivers/bus/pci/windows/pci_netuio.c +2 -0
index 670194839..e2bf45724 100644
@@ -7,6 +7,8 @@
 #include <rte_log.h>
 #include <rte_eal.h>
 
+#include <ndisguid.h>
+
 #include "private.h"
 #include "pci_netuio.h"
 
drivers/bus/pci/windows/pci_netuio.h +2 -0
index 9a77806b5..2bf5a201a 100644
@@ -5,6 +5,7 @@
 #ifndef _PCI_NETUIO_H_
 #define _PCI_NETUIO_H_
 
+#if (! defined(NTDDI_WIN10_FE) || NTDDI_VERSION < NTDDI_WIN10_FE)
 /* GUID definition for device class netUIO */
 DEFINE_GUID(GUID_DEVCLASS_NETUIO, 0x78912bc1, 0xcb8e, 0x4b28,
 	0xa3, 0x29, 0xf3, 0x22, 0xeb, 0xad, 0xbe, 0x0f);
@@ -12,6 +13,7 @@ DEFINE_GUID(GUID_DEVCLASS_NETUIO, 0x78912bc1, 0xcb8e, 0x4b28,
 /* GUID definition for the netuio device interface */
 DEFINE_GUID(GUID_DEVINTERFACE_NETUIO, 0x08336f60, 0x0679, 0x4c6c,
 	0x85, 0xd2, 0xae, 0x7c, 0xed, 0x65, 0xff, 0xf7);
+#endif
 
 /* IOCTL code definitions */
 #define IOCTL_NETUIO_MAP_HW_INTO_USERSPACE \
Signature · 1 line
2.29.0.vfs.0.0
#1 lore raw

PATCH v2 1/1 bus/pci/windows: guard against sdk/dpdk guid collision

DEVCLASS and DEVINTERFACE guids are defined/managed by the windows platform sdk headers.

* hide dpdk defined GUID_DEVCLASS_NETUIO and GUID_DEVINTERFACE_NETUIO if the NTDDI_VERSION >= 0x0A00000A
* include <ndisguid.h> for windows sdk defined GUID_DEVINTERFACE_NETUIO

---
 drivers/bus/pci/windows/pci_netuio.c | 2 ++
 drivers/bus/pci/windows/pci_netuio.h | 2 ++
 2 files changed, 4 insertions(+)
drivers/bus/pci/windows/pci_netuio.c +2 -0
index 670194839..e2bf45724 100644
@@ -7,6 +7,8 @@
 #include <rte_log.h>
 #include <rte_eal.h>
 
+#include <ndisguid.h>
+
 #include "private.h"
 #include "pci_netuio.h"
 
drivers/bus/pci/windows/pci_netuio.h +2 -0
index 9a77806b5..f72c6cc38 100644
@@ -5,6 +5,7 @@
 #ifndef _PCI_NETUIO_H_
 #define _PCI_NETUIO_H_
 
+#if (!defined(NTDDI_WIN10_FE) || NTDDI_VERSION < NTDDI_WIN10_FE)
 /* GUID definition for device class netUIO */
 DEFINE_GUID(GUID_DEVCLASS_NETUIO, 0x78912bc1, 0xcb8e, 0x4b28,
 	0xa3, 0x29, 0xf3, 0x22, 0xeb, 0xad, 0xbe, 0x0f);
@@ -12,6 +13,7 @@ DEFINE_GUID(GUID_DEVCLASS_NETUIO, 0x78912bc1, 0xcb8e, 0x4b28,
 /* GUID definition for the netuio device interface */
 DEFINE_GUID(GUID_DEVINTERFACE_NETUIO, 0x08336f60, 0x0679, 0x4c6c,
 	0x85, 0xd2, 0xae, 0x7c, 0xed, 0x65, 0xff, 0xf7);
+#endif
 
 /* IOCTL code definitions */
 #define IOCTL_NETUIO_MAP_HW_INTO_USERSPACE \
Signature · 1 line
2.29.0.vfs.0.0
#2 lore raw

PATCH v3 1/1 pci/windows: fix build with SDK >= 10.0.20253

NetUIO device class and interface GUIDs are defined in system headers starting from platform SDK v10.0.20253. Inspect SDK version to avoid redefinition.

Pre-release SDKs do not promise compatibility and a narrow subset of SDKs may still be subject to redefinition.

Fixes c76ec01b4591 (bus/pci: support netuio on Windows)
---
 drivers/bus/pci/windows/pci_netuio.c | 6 ++++++
 drivers/bus/pci/windows/pci_netuio.h | 2 ++
 2 files changed, 8 insertions(+)
drivers/bus/pci/windows/pci_netuio.c +6 -0
index 670194839..1bf9133f7 100644
@@ -7,6 +7,12 @@
 #include <rte_log.h>
 #include <rte_eal.h>
 
+#ifdef __MINGW32__
+#include <ddk/ndisguid.h>
+#else
+#include <ndisguid.h>
+#endif
+
 #include "private.h"
 #include "pci_netuio.h"
 
drivers/bus/pci/windows/pci_netuio.h +2 -0
index 9a77806b5..2f6c97ea7 100644
@@ -5,6 +5,7 @@
 #ifndef _PCI_NETUIO_H_
 #define _PCI_NETUIO_H_
 
+#if !defined(NTDDI_WIN10_FE) || NTDDI_VERSION < NTDDI_WIN10_FE
 /* GUID definition for device class netUIO */
 DEFINE_GUID(GUID_DEVCLASS_NETUIO, 0x78912bc1, 0xcb8e, 0x4b28,
 	0xa3, 0x29, 0xf3, 0x22, 0xeb, 0xad, 0xbe, 0x0f);
@@ -12,6 +13,7 @@ DEFINE_GUID(GUID_DEVCLASS_NETUIO, 0x78912bc1, 0xcb8e, 0x4b28,
 /* GUID definition for the netuio device interface */
 DEFINE_GUID(GUID_DEVINTERFACE_NETUIO, 0x08336f60, 0x0679, 0x4c6c,
 	0x85, 0xd2, 0xae, 0x7c, 0xed, 0x65, 0xff, 0xf7);
+#endif
 
 /* IOCTL code definitions */
 #define IOCTL_NETUIO_MAP_HW_INTO_USERSPACE \
Signature · 1 line
2.29.0.vfs.0.0
Acked-by on v3 1/1
#3 lore raw

Re: [dpdk-dev] [PATCH v3] pci/windows: fix build with SDK >= 10.0.20253

Quoted 11 lines · Tyler Retzlaff

NetUIO device class and interface GUIDs are defined in system headers starting from platform SDK v10.0.20253. Inspect SDK version to avoid redefinition.

Pre-release SDKs do not promise compatibility and a narrow subset of SDKs may still be subject to redefinition.

Fixes c76ec01b4591 (bus/pci: support netuio on Windows)
#4 lore raw

Re: [dpdk-dev] [PATCH v3] pci/windows: fix build with SDK >= 10.0.20253

14/01/2021 23:06, Dmitry Kozlyuk:

Quoted 8 lines · Tyler Retzlaff
Quoted 7 lines

NetUIO device class and interface GUIDs are defined in system headers starting from platform SDK v10.0.20253. Inspect SDK version to avoid redefinition.

Pre-release SDKs do not promise compatibility and a narrow subset of SDKs may still be subject to redefinition.

Quoted 6 lines
Quoted 4 lines
Fixes c76ec01b4591 (bus/pci: support netuio on Windows)

Applied, thanks

Acked-by on v3 1/1
#5 lore raw

Re: [dpdk-dev] [PATCH v3] pci/windows: fix build with SDK >= 10.0.20253

In reply to Tyler Retzlaff
Quoted 7 lines · Tyler Retzlaff

NetUIO device class and interface GUIDs are defined in system headers starting from platform SDK v10.0.20253. Inspect SDK version to avoid redefinition.

Pre-release SDKs do not promise compatibility and a narrow subset of SDKs may still be subject to redefinition.

Quoted 9 lines
Fixes c76ec01b4591 (bus/pci: support netuio on Windows)
---
  drivers/bus/pci/windows/pci_netuio.c | 6 ++++++
  drivers/bus/pci/windows/pci_netuio.h | 2 ++
  2 files changed, 8 insertions(+)

Quick q: Do you know when this new SDK will be available publicly?

ranjit m.

#6 lore raw

Re: [dpdk-dev] [PATCH v3] pci/windows: fix build with SDK >= 10.0.20253

Quoted 1 line · Ranjit Menon

Quick q: Do you know when this new SDK will be available publicly?

there are periodic release of the sdk [2] that match the versions of windows available through the windows insider program [1].

i can see the latest available appears to be 20279 (so later) than the kit i referenced in the change. so to answer your question a newer kit is available now. just remember preview kits do not provide a compatibility guarantee i.e. api and abi may change

[1] https://insider.windows.com/en-us/
[2] https://www.microsoft.com/en-us/software-download/windowsinsiderpreviewSDK

#7 lore raw
In reply to Tyler Retzlaff
Quoted 2 lines · Tyler Retzlaff

DEVCLASS and DEVINTERFACE guids are defined/managed by the windows platform sdk headers.

Please write names and acronyms in proper case in all human-readable text (commit subject except topic, commit message, log messages).

Quoted 3 lines

* hide dpdk defined GUID_DEVCLASS_NETUIO and GUID_DEVINTERFACE_NETUIO if the NTDDI_VERSION >= 0x0A00000A
* include <ndisguid.h> for windows sdk defined GUID_DEVINTERFACE_NETUIO

This translates the code almost verbatim, not needed. Instead you could state which SDK versions are affected. Suggested wording:

pci/windows: fix build with SDK 10.0.xxxxx

NetUIO device class and interface GUIDs are defined in system headers starting from platform SDK v10.0.xxxxx. Inspect SDK version to avoid redefinition.

Fixes hhhhhhhhhhhh ("...")

I can't find which "xxxxx" corresponds to NTDDI_WIN10_FE.

"hhhhhhhhhhhh" are 12 chars of the hash of the commit which introduced the code you fixed. "..." is said commit subject. This info is needed to backport your fix to stable branch, so that it can also be built with newer SDK. May not be very important until Windows port gets its users, I mostly tell it to illustrate the process.

Quoted 1 line

+#if (! defined(NTDDI_WIN10_FE) || NTDDI_VERSION < NTDDI_WIN10_FE)

Braces are redundant here and DPDK style is to avoid them (see rte_common.h).

#8 lore raw
Quoted 6 lines · Dmitry Kozlyuk

pci/windows: fix build with SDK 10.0.xxxxx

NetUIO device class and interface GUIDs are defined in system headers starting from platform SDK v10.0.xxxxx. Inspect SDK version to avoid redefinition.

Quoted 6 lines
Fixes hhhhhhhhhhhh ("...")

I can't find which "xxxxx" corresponds to NTDDI_WIN10_FE.

there won't be a specific sdk/kit that corresponds. the best i can offer is to include in the message the latest sdk/kit version for that platform version.

also be aware since there is no 1:1 alignment between NTDDI_VERSION and the sdk/kit build where the conflicting GUID definitions were introduced there will still be a subset of eal/pre-release kits if installed that will lead to compilation failure of dpdk even with this change. i'll also add a note in the commit message about this limitation.

windows doesn't promise api compatibility for pre-release kits and there is no approved mechanism / versioning to provide such compatibility.

Quoted 5 lines

"hhhhhhhhhhhh" are 12 chars of the hash of the commit which introduced the code you fixed. "..." is said commit subject. This info is needed to backport your fix to stable branch, so that it can also be built with newer SDK. May not be very important until Windows port gets its users, I mostly tell it to illustrate the process.

yes, understood this one is definitely appropriate for backport

Quoted 3 lines
Quoted 1 line

+#if (! defined(NTDDI_WIN10_FE) || NTDDI_VERSION < NTDDI_WIN10_FE)

Braces are redundant here and DPDK style is to avoid them (see rte_common.h).

yes, sorry will fix. best part is i don't like redundant braces i just added them because i encounter so many people who do. (can't win really)