Skip to contentSkip to conversation

add missing includes and forward declarations to networking includes under linux/

PATCH Superseded Jakub Kicinski 2 participants 3 messages Jul 23, 2022 – Jul 26, 2022

Subsystems (10)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH 1/1 add missing includes and forward declarations to networking includes under linux/

Similarly to a recent include/net/ cleanup, this patch adds missing includes to networking headers under include/linux. All these problems are currently masked by the existing users including the missing dependency before the broken header.

---
 include/linux/atm_tcp.h         | 3 +++
 include/linux/dsa/tag_qca.h     | 6 ++++++
 include/linux/hippidevice.h     | 4 ++++
 include/linux/if_eql.h          | 1 +
 include/linux/if_hsr.h          | 4 ++++
 include/linux/if_rmnet.h        | 2 ++
 include/linux/if_tap.h          | 2 ++
 include/linux/mdio/mdio-xgene.h | 4 ++++
 include/linux/nl802154.h        | 2 ++
 include/linux/phy_fixed.h       | 3 +++
 include/linux/ppp-comp.h        | 2 +-
 include/linux/ppp_channel.h     | 2 ++
 include/linux/ptp_kvm.h         | 2 ++
 include/linux/ptp_pch.h         | 4 ++++
 include/linux/seq_file_net.h    | 1 +
 include/linux/sungem_phy.h      | 2 ++
 include/linux/usb/usbnet.h      | 6 ++++++
 include/net/llc_s_st.h          | 6 ++++++
 18 files changed, 55 insertions(+), 1 deletion(-)
include/linux/atm_tcp.h +3 -0
index c8ecf6f68fb5..ba4fe690bff0 100644
@@ -9,6 +9,9 @@
 
 #include <uapi/linux/atm_tcp.h>
 
+struct atm_tcp_ops;
+struct atm_vcc;
+struct module;
 
 struct atm_tcp_ops {
 	int (*attach)(struct atm_vcc *vcc,int itf);
include/linux/dsa/tag_qca.h +6 -0
index 4359fb0221cf..e357df561e55 100644
@@ -3,6 +3,12 @@
 #ifndef __TAG_QCA_H
 #define __TAG_QCA_H
 
+#include <linux/types.h>
+
+struct dsa_switch;
+struct net_device;
+struct sk_buff;
+
 #define QCA_HDR_LEN	2
 #define QCA_HDR_VERSION	0x2
 
include/linux/hippidevice.h +4 -0
index 9dc01f7ab5b4..07414c241e65 100644
@@ -23,6 +23,10 @@
 
 #ifdef __KERNEL__
 
+struct neigh_parms;
+struct net_device;
+struct sk_buff;
+
 struct hippi_cb {
 	__u32	ifield;
 };
include/linux/if_eql.h +1 -0
index d75601d613cc..07f9b660b741 100644
@@ -21,6 +21,7 @@
 
 #include <linux/timer.h>
 #include <linux/spinlock.h>
+#include <net/net_trackers.h>
 #include <uapi/linux/if_eql.h>
 
 typedef struct slave {
include/linux/if_hsr.h +4 -0
index 408539d5ea5f..0404f5bf4f30 100644
@@ -2,6 +2,10 @@
 #ifndef _LINUX_IF_HSR_H_
 #define _LINUX_IF_HSR_H_
 
+#include <linux/types.h>
+
+struct net_device;
+
 /* used to differentiate various protocols */
 enum hsr_version {
 	HSR_V0 = 0,
include/linux/if_rmnet.h +2 -0
index 10e7521ecb6c..839d1e48b85e 100644
@@ -5,6 +5,8 @@
 #ifndef _LINUX_IF_RMNET_H_
 #define _LINUX_IF_RMNET_H_
 
+#include <linux/types.h>
+
 struct rmnet_map_header {
 	u8 flags;			/* MAP_CMD_FLAG, MAP_PAD_LEN_MASK */
 	u8 mux_id;
include/linux/if_tap.h +2 -0
index 915a187cfabd..f21f87952b20 100644
@@ -2,6 +2,8 @@
 #ifndef _LINUX_IF_TAP_H_
 #define _LINUX_IF_TAP_H_
 
+struct file;
+
 #if IS_ENABLED(CONFIG_TAP)
 struct socket *tap_get_socket(struct file *);
 struct ptr_ring *tap_get_ptr_ring(struct file *file);
include/linux/mdio/mdio-xgene.h +4 -0
index 8af93ada8b64..9e588965dc83 100644
@@ -8,6 +8,10 @@
 #ifndef __MDIO_XGENE_H__
 #define __MDIO_XGENE_H__
 
+#include <linux/bits.h>
+#include <linux/spinlock.h>
+#include <linux/types.h>
+
 #define BLOCK_XG_MDIO_CSR_OFFSET	0x5000
 #define BLOCK_DIAG_CSR_OFFSET		0xd000
 #define XGENET_CONFIG_REG_ADDR		0x20
include/linux/nl802154.h +2 -0
index b22782225f27..cbe5fd1dd2e7 100644
@@ -8,6 +8,8 @@
 #ifndef NL802154_H
 #define NL802154_H
 
+#include <net/netlink.h>
+
 #define IEEE802154_NL_NAME "802.15.4 MAC"
 #define IEEE802154_MCAST_COORD_NAME "coordinator"
 #define IEEE802154_MCAST_BEACON_NAME "beacon"
include/linux/phy_fixed.h +3 -0
index 52bc8e487ef7..1acafd86ab13 100644
@@ -2,6 +2,8 @@
 #ifndef __PHY_FIXED_H
 #define __PHY_FIXED_H
 
+#include <linux/types.h>
+
 struct fixed_phy_status {
 	int link;
 	int speed;
@@ -12,6 +14,7 @@ struct fixed_phy_status {
 
 struct device_node;
 struct gpio_desc;
+struct net_device;
 
 #if IS_ENABLED(CONFIG_FIXED_PHY)
 extern int fixed_phy_change_carrier(struct net_device *dev, bool new_carrier);
include/linux/ppp-comp.h +1 -1
index 9d3ffc8f5ea6..fb847e47f148 100644
@@ -9,7 +9,7 @@
 
 #include <uapi/linux/ppp-comp.h>
 
-
+struct compstat;
 struct module;
 
 /*
include/linux/ppp_channel.h +2 -0
index 91f9a928344e..45e6e427ceb8 100644
@@ -20,6 +20,8 @@
 #include <linux/poll.h>
 #include <net/net_namespace.h>
 
+struct net_device_path;
+struct net_device_path_ctx;
 struct ppp_channel;
 
 struct ppp_channel_ops {
include/linux/ptp_kvm.h +2 -0
index f960a719f0d5..c2e28deef33a 100644
@@ -8,6 +8,8 @@
 #ifndef _PTP_KVM_H_
 #define _PTP_KVM_H_
 
+#include <linux/types.h>
+
 struct timespec64;
 struct clocksource;
 
include/linux/ptp_pch.h +4 -0
index 51818198c292..7ba643b62c15 100644
@@ -10,6 +10,10 @@
 #ifndef _PTP_PCH_H_
 #define _PTP_PCH_H_
 
+#include <linux/types.h>
+
+struct pci_dev;
+
 void pch_ch_control_write(struct pci_dev *pdev, u32 val);
 u32  pch_ch_event_read(struct pci_dev *pdev);
 void pch_ch_event_write(struct pci_dev *pdev, u32 val);
include/linux/seq_file_net.h +1 -0
index b97912fdbae7..79638395bc32 100644
@@ -3,6 +3,7 @@
 #define __SEQ_FILE_NET_H__
 
 #include <linux/seq_file.h>
+#include <net/net_trackers.h>
 
 struct net;
 extern struct net init_net;
include/linux/sungem_phy.h +2 -0
index 3a11fa41a131..c505f30e8b68 100644
@@ -2,6 +2,8 @@
 #ifndef __SUNGEM_PHY_H__
 #define __SUNGEM_PHY_H__
 
+#include <linux/types.h>
+
 struct mii_phy;
 
 /* Operations supported by any kind of PHY */
include/linux/usb/usbnet.h +6 -0
index 1b4d72d5e891..b42b72391a8d 100644
@@ -23,6 +23,12 @@
 #ifndef	__LINUX_USB_USBNET_H
 #define	__LINUX_USB_USBNET_H
 
+#include <linux/mii.h>
+#include <linux/netdevice.h>
+#include <linux/skbuff.h>
+#include <linux/types.h>
+#include <linux/usb.h>
+
 /* interface from usbnet core to each USB networking link we handle */
 struct usbnet {
 	/* housekeeping */
include/net/llc_s_st.h +6 -0
index c4359e203013..ed5b2fa40d32 100644
@@ -12,6 +12,12 @@
  * See the GNU General Public License for more details.
  */
 
+#include <linux/types.h>
+#include <net/llc_s_ac.h>
+#include <net/llc_s_ev.h>
+
+struct llc_sap_state_trans;
+
 #define LLC_NR_SAP_STATES	2       /* size of state table */
 
 /* structures and types */
Signature · 1 line
2.37.1
maintainer
#1 lore raw
Quoted 32 lines · Jakub Kicinski

Similarly to a recent include/net/ cleanup, this patch adds missing includes to networking headers under include/linux. All these problems are currently masked by the existing users including the missing dependency before the broken header.

---
 include/linux/atm_tcp.h         | 3 +++
 include/linux/dsa/tag_qca.h     | 6 ++++++
 include/linux/hippidevice.h     | 4 ++++
 include/linux/if_eql.h          | 1 +
 include/linux/if_hsr.h          | 4 ++++
 include/linux/if_rmnet.h        | 2 ++
 include/linux/if_tap.h          | 2 ++
 include/linux/mdio/mdio-xgene.h | 4 ++++
 include/linux/nl802154.h        | 2 ++
 include/linux/phy_fixed.h       | 3 +++
 include/linux/ppp-comp.h        | 2 +-
 include/linux/ppp_channel.h     | 2 ++
 include/linux/ptp_kvm.h         | 2 ++
 include/linux/ptp_pch.h         | 4 ++++
 include/linux/seq_file_net.h    | 1 +
 include/linux/sungem_phy.h      | 2 ++
 include/linux/usb/usbnet.h      | 6 ++++++
 include/net/llc_s_st.h          | 6 ++++++
 18 files changed, 55 insertions(+), 1 deletion(-)
include/linux/atm_tcp.h +0 -0
index c8ecf6f68fb5..ba4fe690bff0 100644

include/linux/atm_tcp.h line 12

Quoted 4 lines
include/linux/atm_tcp.h +1 -0
@@ -9,6 +9,9 @@
 
 #include <uapi/linux/atm_tcp.h>
 
+struct atm_tcp_ops;

This looks not needed? 'struct atm_tcp_ops' is defined a few lines below...

Quoted 10 lines
include/linux/atm_tcp.h +2 -0
+struct atm_vcc;
+struct module;
 
 struct atm_tcp_ops {
 	int (*attach)(struct atm_vcc *vcc,int itf);
include/linux/dsa/tag_qca.h +0 -0
index 4359fb0221cf..e357df561e55 100644

include/linux/dsa/tag_qca.h line 9

Quoted 7 lines
include/linux/dsa/tag_qca.h +4 -0
@@ -3,6 +3,12 @@
 #ifndef __TAG_QCA_H
 #define __TAG_QCA_H
 
+#include <linux/types.h>
+
+struct dsa_switch;
+struct net_device;

It looks like 'struct net_device' is not used in this header file.

Quoted 5 lines
include/linux/dsa/tag_qca.h +2 -0
+struct sk_buff;
+
 #define QCA_HDR_LEN	2
 #define QCA_HDR_VERSION	0x2
 

[...]

include/linux/if_tap.h line 5

Quoted 9 lines
include/linux/if_tap.h +1 -0
index 915a187cfabd..f21f87952b20 100644
@@ -2,6 +2,8 @@
 #ifndef _LINUX_IF_TAP_H_
 #define _LINUX_IF_TAP_H_
 
+struct file;

I guess even:

struct socket;
struct ptr_ring;

are needed, and you can remove the forward declaration from the #else branch.

Quoted 9 lines
include/linux/if_tap.h +1 -0
+
 #if IS_ENABLED(CONFIG_TAP)
 struct socket *tap_get_socket(struct file *);
 struct ptr_ring *tap_get_ptr_ring(struct file *file);
include/linux/mdio/mdio-xgene.h +0 -0
index 8af93ada8b64..9e588965dc83 100644

include/linux/mdio/mdio-xgene.h line 14

Quoted 7 lines
include/linux/mdio/mdio-xgene.h +4 -0
@@ -8,6 +8,10 @@
 #ifndef __MDIO_XGENE_H__
 #define __MDIO_XGENE_H__
 
+#include <linux/bits.h>
+#include <linux/spinlock.h>
+#include <linux/types.h>
+

possibly even:

struct clk;
struct device;
struct mii_bus;

used below.

Quoted 3 lines
include/linux/mdio/mdio-xgene.h +0 -0
 #define BLOCK_XG_MDIO_CSR_OFFSET	0x5000
 #define BLOCK_DIAG_CSR_OFFSET		0xd000
 #define XGENET_CONFIG_REG_ADDR		0x20

[...]

include/linux/sungem_phy.h line 7

Quoted 11 lines
include/linux/sungem_phy.h +2 -0
index 3a11fa41a131..c505f30e8b68 100644
@@ -2,6 +2,8 @@
 #ifndef __SUNGEM_PHY_H__
 #define __SUNGEM_PHY_H__
 
+#include <linux/types.h>
+
 struct mii_phy;

Possibly even:

struct net_device;

used below.

Quoted 7 lines
include/linux/sungem_phy.h +0 -0
 /* Operations supported by any kind of PHY */
include/linux/usb/usbnet.h +0 -0
index 1b4d72d5e891..b42b72391a8d 100644

include/linux/usb/usbnet.h line 29

Quoted 7 lines
include/linux/usb/usbnet.h +4 -0
@@ -23,6 +23,12 @@
 #ifndef	__LINUX_USB_USBNET_H
 #define	__LINUX_USB_USBNET_H
 
+#include <linux/mii.h>
+#include <linux/netdevice.h>
+#include <linux/skbuff.h>
+#include <linux/types.h>

'linux/types.h' should not be needed: already included via skbuff.h -> atomic.h -> types.h

include/linux/usb/usbnet.h line 34

Quoted 5 lines
include/linux/usb/usbnet.h +2 -0
+#include <linux/usb.h>
+
 /* interface from usbnet core to each USB networking link we handle */
 struct usbnet {
 	/* housekeeping */

Cheers,

Paolo

author maintainer
#2 lore raw
Quoted 5 lines · On Tue, 26 Jul 2022 12:00:47 +0200 Paolo Abeni wrote:
Quoted 4 lines · Jakub Kicinski

Similarly to a recent include/net/ cleanup, this patch adds missing includes to networking headers under include/linux. All these problems are currently masked by the existing users including the missing dependency before the broken header.

Thanks for the detailed review!

Quoted 10 lines

include/linux/if_tap.h line 5

Quoted 7 lines
include/linux/if_tap.h +1 -0
@@ -2,6 +2,8 @@
 #ifndef _LINUX_IF_TAP_H_
 #define _LINUX_IF_TAP_H_
 
+struct file;  

I guess even:

Quoted 5 lines

struct socket;
struct ptr_ring;

are needed, and you can remove the forward declaration from the #else branch.

Let me move the includes which are later on int the file, for some reason, up.

Quoted 18 lines
Quoted 8 lines
include/linux/if_tap.h +0 -0
 #if IS_ENABLED(CONFIG_TAP)
 struct socket *tap_get_socket(struct file *);
 struct ptr_ring *tap_get_ptr_ring(struct file *file);
include/linux/mdio/mdio-xgene.h +0 -0
index 8af93ada8b64..9e588965dc83 100644

include/linux/mdio/mdio-xgene.h line 14

Quoted 7 lines
include/linux/mdio/mdio-xgene.h +4 -0
@@ -8,6 +8,10 @@
 #ifndef __MDIO_XGENE_H__
 #define __MDIO_XGENE_H__
 
+#include <linux/bits.h>
+#include <linux/spinlock.h>
+#include <linux/types.h>
+  

possibly even:

Quoted 5 lines

struct clk;
struct device;
struct mii_bus;

used below.

I don't understand why but apparently using a struct type in another struct is considered a forward declaration.

09:05 ~$ cat /tmp/one.c
int some_func(struct bla *b);

int main()

{
	return 0;
}
09:05 ~$ gcc -W -Wall -Wextra -O2 /tmp/one.c  -o /dev/null
/tmp/one.c:1:22: warning: ‘struct bla’ declared inside parameter list will not be visible outside of this definition or declaration
    1 | int some_func(struct bla *b);
      |                      ^~~
09:05 ~$ cat /tmp/two.c 
struct other {
	struct bla *b;
};

int some_func(struct bla *b);

int main()

{
	return 0;
}

09:05 ~$ gcc -W -Wall -Wextra -O2 /tmp/two.c -o /dev/null 09:05 ~$

Quoted 5 lines
Quoted 5 lines
include/linux/mdio/mdio-xgene.h +1 -0
+++ b/include/linux/sungem_phy.h
@@ -2,6 +2,8 @@
 #ifndef __SUNGEM_PHY_H__
 #define __SUNGEM_PHY_H__
 
Quoted 7 lines

include/linux/mdio/mdio-xgene.h line 7

Quoted 3 lines
include/linux/mdio/mdio-xgene.h +2 -0
+#include <linux/types.h>
+
 struct mii_phy;  

Possibly even:

struct net_device;

Same story.

Quoted 9 lines
Quoted 9 lines
include/linux/mdio/mdio-xgene.h +0 -0
 /* Operations supported by any kind of PHY */
include/linux/usb/usbnet.h +0 -0
index 1b4d72d5e891..b42b72391a8d 100644
@@ -23,6 +23,12 @@
 #ifndef	__LINUX_USB_USBNET_H
 #define	__LINUX_USB_USBNET_H
 
Quoted 7 lines

include/linux/usb/usbnet.h line 29

Quoted 4 lines
include/linux/usb/usbnet.h +4 -0
+#include <linux/mii.h>
+#include <linux/netdevice.h>
+#include <linux/skbuff.h>
+#include <linux/types.h>  

'linux/types.h' should not be needed: already included via skbuff.h -> atomic.h -> types.h

Yea... sometimes I added it sometimes I didn't.. :) I don't think the explicit include hurts.

Quoted 3 lines
Quoted 3 lines
include/linux/usb/usbnet.h +2 -0
+#include <linux/usb.h>
+
 /* interface from usbnet core to each USB networking link we handle */