Skip to contentSkip to conversation

tools: ynl: change the comment about header guards

PATCH In review Jakub Kicinski 2 participants 2 messages Jun 16, 2023

Subsystems (3)
lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH 1/1 tools: ynl: change the comment about header guards

Przemek suggests that I shouldn't accuse GCC of witchcraft, there is a simpler explanation for why we need manual define.

scripts/headers_install.sh modifies the guard.

This also solves the mystery of why I needed to include the header conditionally. I had the wrong guards for most cases but ethtool.

---
 tools/net/ynl/Makefile.deps | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)
tools/net/ynl/Makefile.deps +6 -10
index 524fc4bb586b..cbf4cdfc4fed 100644
@@ -9,20 +9,16 @@
 
 UAPI_PATH:=../../../../include/uapi/
 
-# If the header does not exist at all in the system path - let the
-# compiler fall back to the kernel header via -Idirafter.
-# GCC seems to ignore header guard if the header is different, so we need
-# to specify the -D$(hdr_guard).
+# scripts/headers_install.sh strips "_UAPI" from header guards so we
+# need the explicit -D to avoid multiple definitions.
 # And we need to define HASH indirectly because GNU Make 4.2 wants it escaped
 # and Gnu Make 4.4 wants it without escaping.
 
 HASH := \#
 
-get_hdr_inc=$(if $(shell echo "$(HASH)include <linux/$(2)>" | \
-			 cpp >>/dev/null 2>/dev/null && echo yes),\
-		-D$(1) -include $(UAPI_PATH)/linux/$(2))
+get_hdr_inc=-D$(1) -include $(UAPI_PATH)/linux/$(2)
 
-CFLAGS_devlink:=$(call get_hdr_inc,_UAPI_LINUX_DEVLINK_H_,devlink.h)
+CFLAGS_devlink:=$(call get_hdr_inc,_LINUX_DEVLINK_H_,devlink.h)
 CFLAGS_ethtool:=$(call get_hdr_inc,_LINUX_ETHTOOL_NETLINK_H_,ethtool_netlink.h)
-CFLAGS_handshake:=$(call get_hdr_inc,_UAPI_LINUX_HANDSHAKE_H,handshake.h)
-CFLAGS_netdev:=$(call get_hdr_inc,_UAPI_LINUX_NETDEV_H,netdev.h)
+CFLAGS_handshake:=$(call get_hdr_inc,_LINUX_HANDSHAKE_H,handshake.h)
+CFLAGS_netdev:=$(call get_hdr_inc,_LINUX_NETDEV_H,netdev.h)
Signature · 1 line
2.40.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 23 lines · Jakub Kicinski

Przemek suggests that I shouldn't accuse GCC of witchcraft, there is a simpler explanation for why we need manual define.

scripts/headers_install.sh modifies the guard.

This also solves the mystery of why I needed to include the header conditionally. I had the wrong guards for most cases but ethtool.

---
  tools/net/ynl/Makefile.deps | 16 ++++++----------
  1 file changed, 6 insertions(+), 10 deletions(-)
tools/net/ynl/Makefile.deps +0 -0
index 524fc4bb586b..cbf4cdfc4fed 100644
@@ -9,20 +9,16 @@
 
  UAPI_PATH:=../../../../include/uapi/
 

tools/net/ynl/Makefile.deps line 17

Quoted 10 lines
tools/net/ynl/Makefile.deps +2 -4
-# If the header does not exist at all in the system path - let the
-# compiler fall back to the kernel header via -Idirafter.
-# GCC seems to ignore header guard if the header is different, so we need
-# to specify the -D$(hdr_guard).
+# scripts/headers_install.sh strips "_UAPI" from header guards so we
+# need the explicit -D to avoid multiple definitions.
  # And we need to define HASH indirectly because GNU Make 4.2 wants it escaped
  # and Gnu Make 4.4 wants it without escaping.
 
  HASH := \#

HASH, including explanation around it, could also go away now

tools/net/ynl/Makefile.deps line 24

Quoted 13 lines
tools/net/ynl/Makefile.deps +4 -6
-get_hdr_inc=$(if $(shell echo "$(HASH)include <linux/$(2)>" | \
-			 cpp >>/dev/null 2>/dev/null && echo yes),\
-		-D$(1) -include $(UAPI_PATH)/linux/$(2))
+get_hdr_inc=-D$(1) -include $(UAPI_PATH)/linux/$(2)
 
-CFLAGS_devlink:=$(call get_hdr_inc,_UAPI_LINUX_DEVLINK_H_,devlink.h)
+CFLAGS_devlink:=$(call get_hdr_inc,_LINUX_DEVLINK_H_,devlink.h)
  CFLAGS_ethtool:=$(call get_hdr_inc,_LINUX_ETHTOOL_NETLINK_H_,ethtool_netlink.h)
-CFLAGS_handshake:=$(call get_hdr_inc,_UAPI_LINUX_HANDSHAKE_H,handshake.h)
-CFLAGS_netdev:=$(call get_hdr_inc,_UAPI_LINUX_NETDEV_H,netdev.h)
+CFLAGS_handshake:=$(call get_hdr_inc,_LINUX_HANDSHAKE_H,handshake.h)
+CFLAGS_netdev:=$(call get_hdr_inc,_LINUX_NETDEV_H,netdev.h)