Skip to content

Add config option checks to netfilter headers.

Jeremy Sowden netfilter-devel 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest30 patches 3 repliesIn review
  2. v129 patches 0 repliesSuperseded

Changes in v2 from the cover letter

* fixes for build errors reported by the kbuild test robot;
* corrected placement of new NF_TPROXY config option.

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/30netfilter: add include guard to nf_conntrack_h323_types.hinclude/linux/netfilter/nf_conntrack_h323_types.h+5 -00 replies
2/30netfilter: add include guard to nf_conntrack_labels.h.include/net/netfilter/nf_conntrack_labels.h+8 -30 replies
3/30netfilter: fix include guard comment.include/net/netfilter/nf_flow_table.h+1 -10 replies
4/30netfilter: add GPL-2.0 SPDX ID's to a couple of headers.include/linux/netfilter_ipv4.h include/linux/netfilter_ipv6.h+4 -20 replies
5/30netfilter: remove trailing white-space.include/linux/netfilter/x_tables.h include/linux/netfilter_ipv6.h include/net/netfilter/nf_conntrack_expect.h +5 more+13 -130 replies
6/30netfilter: fix Kconfig formatting error.net/netfilter/Kconfig+1 -10 replies
7/30netfilter: remove stray semicolons.include/net/netfilter/nf_conntrack_acct.h include/net/netfilter/nf_conntrack_ecache.h+2 -20 replies
8/30netfilter: remove unused function declarations.include/linux/netfilter_ipv4/ip_tables.h include/linux/netfilter_ipv6/ip6_tables.h+1 -40 replies
9/30netfilter: remove unused includes.net/bridge/netfilter/nf_conntrack_bridge.c net/ipv6/netfilter/nf_socket_ipv6.c net/netfilter/xt_physdev.c+0 -30 replies
10/30netfilter: include the right header in nf_conntrack_zones.h.include/net/netfilter/nf_conntrack_zones.h+2 -10 replies
11/30netfilter: fix inclusions of <linux/netfilter/nf_nat.h>.include/net/netfilter/nf_nat.h net/netfilter/nf_nat_core.c net/sched/act_ct.c+8 -50 replies
12/30netfilter: added missing includes.include/net/netfilter/nf_conntrack_core.h include/net/netfilter/nf_nat.h include/net/netfilter/nf_nat_masquerade.h +7 more+17 -100 replies
13/30netfilter: inline three headers.include/linux/netfilter/xt_hashlimit.h include/linux/netfilter/xt_physdev.h include/linux/netfilter_bridge/ebt_802_3.h +3 more+16 -350 replies
14/30netfilter: remove superfluous header.include/net/netfilter/ipv6/nf_conntrack_icmpv6.h include/net/netfilter/nf_conntrack.h net/netfilter/nf_conntrack_proto_icmpv6.c+0 -230 replies
15/30netfilter: move inline function to a more appropriate header.include/linux/netfilter_ipv6.h include/linux/netfilter_ipv6/ip6_tables.h net/ipv6/netfilter/ip6t_ipv6header.c +1 more+16 -160 replies
16/30netfilter: move code between synproxy headers.include/net/netfilter/nf_conntrack_synproxy.h include/net/netfilter/nf_synproxy.h+38 -390 replies
17/30netfilter: move struct definition function to a more appropriate header.include/linux/netfilter.h include/linux/netfilter_ipv6.h include/net/netfilter/nf_conntrack_bridge.h +2 more+23 -230 replies
18/30netfilter: use consistent style when defining inline functions in nf_conntrack_ecache.h.include/net/netfilter/nf_conntrack_ecache.h+50 -320 replies
19/30netfilter: replace defined(CONFIG...) || defined(CONFIG...MODULE) with IS_ENABLED(CONFIG...).include/linux/netfilter.h include/linux/netfilter/ipset/ip_set_getport.h include/net/netfilter/nf_conntrack_extend.h +1 more+5 -50 replies
20/30netfilter: wrap union nf_conntrack_proto members in CONFIG_NF_CT_PROTO_* check.include/net/netfilter/nf_conntrack.h+6 -00 replies
21/30netfilter: wrap inline synproxy function in CONFIG_NETFILTER_SYNPROXY check.include/net/netfilter/nf_conntrack_synproxy.h+2 -00 replies
22/30netfilter: wrap inline timeout function in CONFIG_NETFILTER_TIMEOUT check.include/net/netfilter/nf_conntrack_timeout.h+4 -00 replies
23/30netfilter: wrap some nat-related conntrack code in a CONFIG_NF_NAT check.net/netfilter/nf_conntrack_core.c+4 -00 replies
24/30netfilter: wrap some ipv6 tables code in a CONFIG_NF_TABLES_IPV6 check.net/netfilter/nft_chain_filter.c+4 -00 replies
25/30netfilter: wrap some conntrack code in a CONFIG_NF_CONNTRACK check.include/linux/netfilter/nf_conntrack_zones_common.h+4 -00 replies
26/30netfilter: add CONFIG_NETFILTER check to linux/netfilter.h.include/linux/netfilter.h+7 -00 replies
27/30netfilter: add NF_TPROXY config option.net/ipv4/netfilter/Kconfig net/ipv6/netfilter/Kconfig net/netfilter/Kconfig+5 -00 replies
28/30netfilter: add IP_SET_BITMAP config option.net/netfilter/ipset/Kconfig+6 -00 replies
29/30netfilter: add IP_SET_HASH config option.net/netfilter/ipset/Kconfig+15 -00 replies
30/30netfilter: wrap headers in CONFIG checks.include/linux/netfilter/ipset/ip_set.h include/linux/netfilter/ipset/ip_set_bitmap.h include/linux/netfilter/ipset/ip_set_getport.h +75 more+363 -1110 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.

Read the v2 thread

Cover letter [PATCH nf-next v2 00/30] Add config option checks to netfilter headers.

In a previous patch-series [0], I removed all netfilter headers from the blacklist of headers which could not be compiled standalone. I did so by fixing the specific compilation failures of the headers in the list, usually by adding a preprocessor conditional to check whether a particu- lar config option was enabled and disable some function definition or struct member which depended on that option. While this was effective, it was not wholly satisfactory since it left a scattering of seemingly random ifdefs throughout the headers.

0 - https://lore.kernel.org/netfilter-devel/[email protected]/T/

The reason why these ad-hoc conditionals were necessary is that there were inconsistencies in how existing checks were used to disable code when particular options were turned off. For example, a header A.h might define a struct S which was only available if a particular config option C was enabled, but A.h might be included by header B.h, which defined a struct T with a struct S member without checking for C. If A.h and B.h were included in X.c, which was only compiled if C was enabled, everything worked as expected; however, trying to compile B.h standalone when C was disabled would result in a compilation failure.

This patch-series represents an attempt to provide a more comprehensive solution by identifying the config options relevant to each header and adding the appropriate conditionals to it where they do not already exist. In the majority of cases, a particular header is only included by files tied to a particular config option, whether CONFIG_NETFILTER or something more specific, and the whole of it can be wrapped in one conditional.

For historical reasons, there are some headers which include their uapi siblings and are themselves included elsewhere only for stuff in the uapi headers. Rather than change all those include directives, I have chosen to leave the uapi include directives outside the conditionals.

The patch series is structured as follows.

1-2)

Addition of header guards. The first of these, by Masahiro Yamada, is already in the nf tree; I've put it here to ensure that all the later changes apply cleanly on top of it.

3-8)

Some miscellaneous fixes.

9-12)

Addition and removal of include directives.

13-14)

Removal of some headers.

15-17)

Moving code between headers.

18)

Refactoring of some inline functions.

19)

Replacement of some if defined(...) instances with if IS_ENABLED(...).

20-26)

Addition of conditionals to sections of code, mostly in headers.

27-29)

Addition of new config options for use in later conditionals.

30)

Wrapping of entire headers in one conditional each, removing existing ones wrapping smaller sections of code.

I wasn't quite sure how to present this last change-set. In the branch I've been using for development, I have the headers grouped into a commit per config-option, but that would have meant an addi- tional 44 patches, so I squashed them all before sending the series, although it has resulted in a 2,000-line patch that touches 78 files.

Changes since v1:

* fixes for build errors reported by the kbuild test robot;
* corrected placement of new NF_TPROXY config option.

Jeremy Sowden (29):
netfilter: add include guard to nf_conntrack_labels.h.
netfilter: fix include guard comment.
netfilter: add GPL-2.0 SPDX ID's to a couple of headers.
netfilter: remove trailing white-space.
netfilter: fix Kconfig formatting error.
netfilter: remove stray semicolons.
netfilter: remove unused function declarations.
netfilter: remove unused includes.
netfilter: include the right header in nf_conntrack_zones.h.
netfilter: fix inclusions of <linux/netfilter/nf_nat.h>.
netfilter: added missing includes.
netfilter: inline three headers.
netfilter: remove superfluous header.
netfilter: move inline function to a more appropriate header.
netfilter: move code between synproxy headers.
netfilter: move struct definition function to a more appropriate
header.
netfilter: use consistent style when defining inline functions in
nf_conntrack_ecache.h.
netfilter: replace defined(CONFIG...) || defined(CONFIG...MODULE) with

    IS_ENABLED(CONFIG...).

netfilter: wrap union nf_conntrack_proto members in
CONFIG_NF_CT_PROTO_* check.
netfilter: wrap inline synproxy function in CONFIG_NETFILTER_SYNPROXY
check.
netfilter: wrap inline timeout function in CONFIG_NETFILTER_TIMEOUT
check.
netfilter: wrap some nat-related conntrack code in a CONFIG_NF_NAT
check.
netfilter: wrap some ipv6 tables code in a CONFIG_NF_TABLES_IPV6
check.
netfilter: wrap some conntrack code in a CONFIG_NF_CONNTRACK check.
netfilter: add CONFIG_NETFILTER check to linux/netfilter.h.
netfilter: add NF_TPROXY config option.
netfilter: add IP_SET_BITMAP config option.
netfilter: add IP_SET_HASH config option.
netfilter: wrap headers in CONFIG checks.

Masahiro Yamada (1):
netfilter: add include guard to nf_conntrack_h323_types.h

 include/linux/netfilter.h                     | 16 +++-
 include/linux/netfilter/ipset/ip_set.h        |  7 +-
 include/linux/netfilter/ipset/ip_set_bitmap.h |  4 +
 .../linux/netfilter/ipset/ip_set_getport.h    |  6 +-
 include/linux/netfilter/ipset/ip_set_hash.h   |  3 +
 include/linux/netfilter/ipset/ip_set_list.h   |  3 +
 include/linux/netfilter/ipset/pfxlen.h        |  4 +
 include/linux/netfilter/nf_conntrack_amanda.h |  6 ++
 include/linux/netfilter/nf_conntrack_common.h |  4 +
 include/linux/netfilter/nf_conntrack_dccp.h   |  4 +
 include/linux/netfilter/nf_conntrack_ftp.h    |  8 +-
 include/linux/netfilter/nf_conntrack_h323.h   |  4 +
 .../linux/netfilter/nf_conntrack_h323_asn1.h  |  4 +
 .../linux/netfilter/nf_conntrack_h323_types.h |  9 ++
 include/linux/netfilter/nf_conntrack_irc.h    |  4 +
 include/linux/netfilter/nf_conntrack_pptp.h   |  4 +
 .../linux/netfilter/nf_conntrack_proto_gre.h  |  6 ++
 include/linux/netfilter/nf_conntrack_sane.h   |  5 +
 include/linux/netfilter/nf_conntrack_sctp.h   |  5 +
 include/linux/netfilter/nf_conntrack_sip.h    |  4 +
 include/linux/netfilter/nf_conntrack_snmp.h   |  4 +
 include/linux/netfilter/nf_conntrack_tcp.h    |  3 +
 include/linux/netfilter/nf_conntrack_tftp.h   |  4 +
 .../netfilter/nf_conntrack_zones_common.h     |  8 ++
 include/linux/netfilter/nfnetlink.h           |  7 +-
 include/linux/netfilter/nfnetlink_acct.h      |  6 ++
 include/linux/netfilter/nfnetlink_osf.h       |  4 +
 include/linux/netfilter/x_tables.h            | 15 ++-
 include/linux/netfilter/xt_hashlimit.h        | 11 ---
 include/linux/netfilter/xt_physdev.h          |  8 --
 include/linux/netfilter_arp/arp_tables.h      |  8 +-
 include/linux/netfilter_bridge/ebt_802_3.h    | 12 ---
 include/linux/netfilter_bridge/ebtables.h     | 10 +-
 include/linux/netfilter_ipv4.h                |  7 +-
 include/linux/netfilter_ipv4/ip_tables.h      | 17 ++--
 include/linux/netfilter_ipv6.h                | 31 ++++--
 include/linux/netfilter_ipv6/ip6_tables.h     | 28 ++----
 include/net/netfilter/br_netfilter.h          | 14 +--
 .../net/netfilter/ipv4/nf_conntrack_ipv4.h    |  4 +
 include/net/netfilter/ipv4/nf_defrag_ipv4.h   |  4 +
 include/net/netfilter/ipv4/nf_dup_ipv4.h      |  4 +
 include/net/netfilter/ipv4/nf_reject.h        |  4 +
 .../net/netfilter/ipv6/nf_conntrack_icmpv6.h  | 21 -----
 .../net/netfilter/ipv6/nf_conntrack_ipv6.h    |  4 +
 include/net/netfilter/ipv6/nf_defrag_ipv6.h   |  4 +
 include/net/netfilter/ipv6/nf_dup_ipv6.h      |  4 +
 include/net/netfilter/ipv6/nf_reject.h        |  4 +
 include/net/netfilter/nf_conntrack.h          | 21 ++---
 include/net/netfilter/nf_conntrack_acct.h     | 19 ++--
 include/net/netfilter/nf_conntrack_bridge.h   | 11 +--
 include/net/netfilter/nf_conntrack_core.h     | 22 +++--
 include/net/netfilter/nf_conntrack_count.h    |  4 +
 include/net/netfilter/nf_conntrack_ecache.h   | 94 ++++++++++++-------
 include/net/netfilter/nf_conntrack_expect.h   |  8 +-
 include/net/netfilter/nf_conntrack_extend.h   |  8 +-
 include/net/netfilter/nf_conntrack_helper.h   |  6 ++
 include/net/netfilter/nf_conntrack_l4proto.h  |  7 +-
 include/net/netfilter/nf_conntrack_labels.h   | 15 ++-
 include/net/netfilter/nf_conntrack_seqadj.h   |  4 +
 include/net/netfilter/nf_conntrack_synproxy.h | 43 +--------
 include/net/netfilter/nf_conntrack_timeout.h  |  8 ++
 .../net/netfilter/nf_conntrack_timestamp.h    |  6 +-
 include/net/netfilter/nf_conntrack_tuple.h    |  8 +-
 include/net/netfilter/nf_conntrack_zones.h    |  3 +-
 include/net/netfilter/nf_dup_netdev.h         |  4 +
 include/net/netfilter/nf_flow_table.h         | 10 +-
 include/net/netfilter/nf_log.h                |  4 +
 include/net/netfilter/nf_nat.h                | 26 ++---
 include/net/netfilter/nf_nat_helper.h         |  5 +
 include/net/netfilter/nf_nat_masquerade.h     |  5 +
 include/net/netfilter/nf_nat_redirect.h       |  4 +
 include/net/netfilter/nf_queue.h              |  8 +-
 include/net/netfilter/nf_reject.h             |  4 +
 include/net/netfilter/nf_socket.h             |  4 +
 include/net/netfilter/nf_synproxy.h           | 46 ++++++++-
 include/net/netfilter/nf_tables.h             | 17 +---
 include/net/netfilter/nf_tables_core.h        |  5 +
 include/net/netfilter/nf_tables_ipv4.h        |  4 +
 include/net/netfilter/nf_tables_ipv6.h        | 10 +-
 include/net/netfilter/nf_tables_offload.h     |  4 +
 include/net/netfilter/nf_tproxy.h             |  4 +
 include/net/netfilter/nft_fib.h               |  5 +
 include/net/netfilter/nft_meta.h              |  4 +
 include/net/netfilter/nft_reject.h            |  4 +
 include/net/netfilter/xt_rateest.h            |  4 +
 net/bridge/netfilter/ebt_802_3.c              |  8 +-
 net/bridge/netfilter/nf_conntrack_bridge.c    | 15 ++-
 net/ipv4/netfilter/Kconfig                    |  9 +-
 net/ipv4/netfilter/Makefile                   |  2 +-
 net/ipv6/netfilter.c                          |  4 +-
 net/ipv6/netfilter/Kconfig                    |  1 +
 net/ipv6/netfilter/ip6t_ipv6header.c          |  4 +-
 net/ipv6/netfilter/nf_log_ipv6.c              |  4 +-
 net/ipv6/netfilter/nf_socket_ipv6.c           |  1 -
 net/netfilter/Kconfig                         | 11 ++-
 net/netfilter/Makefile                        |  2 +-
 net/netfilter/ipset/Kconfig                   | 21 +++++
 net/netfilter/nf_conntrack_core.c             |  4 +
 net/netfilter/nf_conntrack_ecache.c           |  1 +
 net/netfilter/nf_conntrack_expect.c           |  2 +
 net/netfilter/nf_conntrack_helper.c           |  5 +-
 net/netfilter/nf_conntrack_proto_icmpv6.c     |  1 -
 net/netfilter/nf_conntrack_timeout.c          |  1 +
 net/netfilter/nf_flow_table_core.c            |  1 +
 net/netfilter/nf_nat_core.c                   |  6 +-
 net/netfilter/nft_chain_filter.c              |  4 +
 net/netfilter/nft_flow_offload.c              |  3 +-
 net/netfilter/xt_connlimit.c                  |  2 +
 net/netfilter/xt_hashlimit.c                  |  7 +-
 net/netfilter/xt_physdev.c                    |  6 +-
 net/sched/act_ct.c                            |  2 +-
 111 files changed, 628 insertions(+), 327 deletions(-)
 delete mode 100644 include/linux/netfilter/xt_hashlimit.h
 delete mode 100644 include/linux/netfilter/xt_physdev.h
 delete mode 100644 include/linux/netfilter_bridge/ebt_802_3.h
 delete mode 100644 include/net/netfilter/ipv6/nf_conntrack_icmpv6.h
Signature · 1 line
2.23.0.rc1