Skip to contentSkip to conversation

include: deprecate libnetfilter_queue/linux_nfnetlink_queue.h

PATCH In review Pablo Neira Ayuso 2 participants 6 messages Aug 10, 2021 – Aug 12, 2021 netfilter

lore
Share & tools
lore

Pablo Neira Ayuso

author maintainer
#0 lore raw

PATCH 1/1 include: deprecate libnetfilter_queue/linux_nfnetlink_queue.h

Emit a warning to notify users that this file is deprecated.

---
 include/libnetfilter_queue/libnetfilter_queue.h    | 2 --
 include/libnetfilter_queue/linux_nfnetlink_queue.h | 2 ++
 src/libnetfilter_queue.c                           | 1 +
 utils/nfqnl_test.c                                 | 1 +
 4 files changed, 4 insertions(+), 2 deletions(-)
include/libnetfilter_queue/libnetfilter_queue.h +0 -2
index a19122f10ec6..42a3a45f27e1 100644
@@ -16,8 +16,6 @@
 #include <sys/time.h>
 #include <libnfnetlink/libnfnetlink.h>
 
-#include <libnetfilter_queue/linux_nfnetlink_queue.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
include/libnetfilter_queue/linux_nfnetlink_queue.h +2 -0
index caa67884482c..84f5d96c0a7b 100644
@@ -1,6 +1,8 @@
 #ifndef _NFNETLINK_QUEUE_H
 #define _NFNETLINK_QUEUE_H
 
+#warning "#include <libnetfilter_queue/linux_nfnetlink_queue.h> is deprecated, use #include <linux/netfilter/nfnetlink_queue.h> instead."
+
 #ifndef aligned_u64
 #define aligned_u64 unsigned long long __attribute__((aligned(8)))
 #endif
src/libnetfilter_queue.c +1 -0
index ef3b21101998..11a4e7c51cc0 100644
@@ -29,6 +29,7 @@
 #include <errno.h>
 #include <netinet/in.h>
 #include <sys/socket.h>
+#include <linux/netfilter/nfnetlink_queue.h>
 
 #include <libnfnetlink/libnfnetlink.h>
 #include <libnetfilter_queue/libnetfilter_queue.h>
utils/nfqnl_test.c +1 -0
index 5e76ffe48cc7..682f3d79d45a 100644
@@ -5,6 +5,7 @@
 #include <netinet/in.h>
 #include <linux/types.h>
 #include <linux/netfilter.h>		/* for NF_ACCEPT */
+#include <linux/netfilter/nfnetlink_queue.h>
 #include <errno.h>
 
 #include <libnetfilter_queue/libnetfilter_queue.h>
Signature · 1 line
2.20.1
#1 lore raw

Hi Pablo,

Quoted 61 lines · Pablo Neira Ayuso

Emit a warning to notify users that this file is deprecated.

---
 include/libnetfilter_queue/libnetfilter_queue.h    | 2 --
 include/libnetfilter_queue/linux_nfnetlink_queue.h | 2 ++
 src/libnetfilter_queue.c                           | 1 +
 utils/nfqnl_test.c                                 | 1 +
 4 files changed, 4 insertions(+), 2 deletions(-)
include/libnetfilter_queue/libnetfilter_queue.h +0 -2
index a19122f10ec6..42a3a45f27e1 100644
@@ -16,8 +16,6 @@
 #include <sys/time.h>
 #include <libnfnetlink/libnfnetlink.h>
 
-#include <libnetfilter_queue/linux_nfnetlink_queue.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
include/libnetfilter_queue/linux_nfnetlink_queue.h +2 -0
index caa67884482c..84f5d96c0a7b 100644
@@ -1,6 +1,8 @@
 #ifndef _NFNETLINK_QUEUE_H
 #define _NFNETLINK_QUEUE_H
 
+#warning "#include <libnetfilter_queue/linux_nfnetlink_queue.h> is deprecated, use #include <linux/netfilter/nfnetlink_queue.h> instead."
+
 #ifndef aligned_u64
 #define aligned_u64 unsigned long long __attribute__((aligned(8)))
 #endif
src/libnetfilter_queue.c +1 -0
index ef3b21101998..11a4e7c51cc0 100644
@@ -29,6 +29,7 @@
 #include <errno.h>
 #include <netinet/in.h>
 #include <sys/socket.h>
+#include <linux/netfilter/nfnetlink_queue.h>
 
 #include <libnfnetlink/libnfnetlink.h>
 #include <libnetfilter_queue/libnetfilter_queue.h>
utils/nfqnl_test.c +1 -1
index 5e76ffe48cc7..682f3d79d45a 100644
@@ -5,6 +5,7 @@
 #include <netinet/in.h>
 #include <linux/types.h>
 #include <linux/netfilter.h>		/* for NF_ACCEPT */
+#include <linux/netfilter/nfnetlink_queue.h>
 #include <errno.h>
 
 #include <libnetfilter_queue/libnetfilter_queue.h>
--
Quoted 2 lines

2.20.1

Suggest you leave include/libnetfilter_queue/libnetfilter_queue.h unaltered.

That way, if a user fails to insert linux/netfilter/nfnetlink_queue.h at all, he will get the warning. With the patched libnetfilter_queue.h, he will get compilation errors where previously he did not.

Otherwise all good.

BTW if a user doesn't have kernel headers he's in for a hard time anyway: the verdict helpers need linux/netfilter.h for NF_ACCEPT &c.

Cheers ... Duncan.

author maintainer
#2 lore raw

On Wed, Aug 11, 2021 at 04:21:40PM +1000, Duncan Roe wrote:
[...]

Quoted 5 lines

Suggest you leave include/libnetfilter_queue/libnetfilter_queue.h unaltered.

That way, if a user fails to insert linux/netfilter/nfnetlink_queue.h at all, he will get the warning. With the patched libnetfilter_queue.h, he will get compilation errors where previously he did not.

OK, done and pushed it out. Thanks.

#3 lore raw
Quoted 9 lines · Pablo Neira Ayuso

On Wed, Aug 11, 2021 at 04:21:40PM +1000, Duncan Roe wrote:
[...]

Quoted 5 lines

Suggest you leave include/libnetfilter_queue/libnetfilter_queue.h unaltered.

That way, if a user fails to insert linux/netfilter/nfnetlink_queue.h at all, he will get the warning. With the patched libnetfilter_queue.h, he will get compilation errors where previously he did not.

OK, done and pushed it out. Thanks.

You really didn't need all these extra #include lines. The only source that doesn't compile with "#include <libnetfilter_queue/linux_nfnetlink_queue.h>" removed from libnetfilter_queue.h is libnetfilter_queue.c.

So, only src/libnetfilter_queue.c needed
"#include <linux/netfilter/nfnetlink_queue.h>". If in the future any of the others were changed so nfnetlink_queue.h *was* required, the person doing the change would get the warning and insert the #include then.

Worth a v2?

Cheers ... Duncan.

author maintainer
#4 lore raw
Quoted 9 lines · Duncan Roe
Quoted 8 lines · Pablo Neira Ayuso

On Wed, Aug 11, 2021 at 04:21:40PM +1000, Duncan Roe wrote:
[...]

Quoted 5 lines

Suggest you leave include/libnetfilter_queue/libnetfilter_queue.h unaltered.

That way, if a user fails to insert linux/netfilter/nfnetlink_queue.h at all, he will get the warning. With the patched libnetfilter_queue.h, he will get compilation errors where previously he did not.

Quoted 5 lines
Quoted 1 line

OK, done and pushed it out. Thanks.

You really didn't need all these extra #include lines. The only source that doesn't compile with "#include <libnetfilter_queue/linux_nfnetlink_queue.h>" removed from libnetfilter_queue.h is libnetfilter_queue.c.

Those are needed, otherwise libnetfilter_queue emits warnings all over the place.

#5 lore raw
Quoted 10 lines · Pablo Neira Ayuso
Quoted 9 lines · Duncan Roe
Quoted 8 lines · Pablo Neira Ayuso

On Wed, Aug 11, 2021 at 04:21:40PM +1000, Duncan Roe wrote:
[...]

Quoted 5 lines

Suggest you leave include/libnetfilter_queue/libnetfilter_queue.h unaltered.

That way, if a user fails to insert linux/netfilter/nfnetlink_queue.h at all, he will get the warning. With the patched libnetfilter_queue.h, he will get compilation errors where previously he did not.

Quoted 8 lines
Quoted 5 lines
Quoted 1 line

OK, done and pushed it out. Thanks.

You really didn't need all these extra #include lines. The only source that doesn't compile with "#include <libnetfilter_queue/linux_nfnetlink_queue.h>" removed from libnetfilter_queue.h is libnetfilter_queue.c.

Those are needed, otherwise libnetfilter_queue emits warnings all over the place.

Of course, thank you. I'll send a v3 of "Insert SYNOPSIS sections for man pages"

Cheers ... Duncan.