Skip to contentSkip to conversation

igc: fix a log entry using uninitialized netdev

PATCH In review Corinna Vinschen 5 participants 7 messages Apr 23, 2024 – May 7, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 igc: fix a log entry using uninitialized netdev

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC added
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

Now the log message is fine:

[    5.200987] igc 0000:01:00.0 eth0: PHC added
---
 drivers/net/ethernet/intel/igc/igc_main.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/net/ethernet/intel/igc/igc_main.c +3 -2
index d9bd001af7ba..e5900d004071 100644
@@ -6927,8 +6927,6 @@ static int igc_probe(struct pci_dev *pdev,
 	device_set_wakeup_enable(&adapter->pdev->dev,
 				 adapter->flags & IGC_FLAG_WOL_SUPPORTED);
 
-	igc_ptp_init(adapter);
-
 	igc_tsn_clear_schedule(adapter);
 
 	/* reset the hardware with the new settings */
@@ -6950,6 +6948,9 @@ static int igc_probe(struct pci_dev *pdev,
 	/* Check if Media Autosense is enabled */
 	adapter->ei = *ei;
 
+	/* do hw tstamp init after resetting */
+	igc_ptp_init(adapter);
+
 	/* print pcie link status and MAC address */
 	pcie_print_link_status(pdev);
 	netdev_info(netdev, "MAC: %pM\n", netdev->dev_addr);
Signature · 1 line
2.44.0
#1 lore raw

PATCH 1/1 igc: fix a log entry using uninitialized netdev

Quoted 11 lines

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC
added
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Quoted 7 lines

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

Now the log message is fine:

[    5.200987] igc 0000:01:00.0 eth0: PHC added
Quoted 33 lines
---
 drivers/net/ethernet/intel/igc/igc_main.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/net/ethernet/intel/igc/igc_main.c +0 -2
index d9bd001af7ba..e5900d004071 100644
@@ -6927,8 +6927,6 @@ static int igc_probe(struct pci_dev *pdev,
 	device_set_wakeup_enable(&adapter->pdev->dev,
 				 adapter->flags &
 IGC_FLAG_WOL_SUPPORTED);
 
-	igc_ptp_init(adapter);
-
 	igc_tsn_clear_schedule(adapter);
 

/* reset the hardware with the new settings */ @@ -6950,6 +6948,9
@@ static int igc_probe(struct pci_dev *pdev,

drivers/net/ethernet/intel/igc/igc_main.c +3 -1
 	/* Check if Media Autosense is enabled */
 	adapter->ei = *ei;
 
+	/* do hw tstamp init after resetting */
+	igc_ptp_init(adapter);
+
 	/* print pcie link status and MAC address */
 	pcie_print_link_status(pdev);
 	netdev_info(netdev, "MAC: %pM\n", netdev->dev_addr);
--

2.44.0

#2 lore raw
In reply to Corinna Vinschen
Quoted 11 lines · Corinna Vinschen

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC added
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

The network stack can start sending and receiving packet before register_netdev() returns. This is typical of NFS root for example. Is there anything in igc_ptp_init() which could cause such packet transfers to explode?

A better fix is to allocate the device name earlier. A few drivers call dev_alloc_name().

Andrew

#3 lore raw
Quoted 9 lines · Andrew Lunn
Quoted 8 lines · Corinna Vinschen

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC added
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Quoted 9 lines
Quoted 3 lines

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

The network stack can start sending and receiving packet before register_netdev() returns. This is typical of NFS root for example. Is there anything in igc_ptp_init() which could cause such packet transfers to explode?

There might be a very narrow window (probably impossible?), what I can see is:

1. the netdevice is exposed to userspace;
2. userspace does the SIOCSHWTSTAMP ioctl() to enable TX timestamps;
3. userspace sends a packet that is going to be timestamped;

if this happens before igc_ptp_init() is called, adapter->ptp_tx_lock is going to be uninitialized, and (3) is going to crash.

If there's anything that makes this impossible/extremely unlikely, the patch looks good:

Cheers,

Signature · 1 line
Vinicius
#4 lore raw
Quoted 24 lines · Vinicius Costa Gomes
Quoted 9 lines · Andrew Lunn
Quoted 8 lines · Corinna Vinschen

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC added
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Quoted 9 lines
Quoted 3 lines

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

The network stack can start sending and receiving packet before register_netdev() returns. This is typical of NFS root for example. Is there anything in igc_ptp_init() which could cause such packet transfers to explode?

There might be a very narrow window (probably impossible?), what I can see is:

Quoted 6 lines

1. the netdevice is exposed to userspace;
2. userspace does the SIOCSHWTSTAMP ioctl() to enable TX timestamps;
3. userspace sends a packet that is going to be timestamped;

if this happens before igc_ptp_init() is called, adapter->ptp_tx_lock is going to be uninitialized, and (3) is going to crash.

The same would then be possible on igb as well, wouldn't it?

Quoted 9 lines

If there's anything that makes this impossible/extremely unlikely, the patch looks good:

Cheers,

Signature · 1 line
Vinicius

Corinna

#5 lore raw
Quoted 25 lines · Corinna Vinschen
Quoted 24 lines · Vinicius Costa Gomes
Quoted 9 lines · Andrew Lunn
Quoted 8 lines · Corinna Vinschen

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC added
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Quoted 9 lines
Quoted 3 lines

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

The network stack can start sending and receiving packet before register_netdev() returns. This is typical of NFS root for example. Is there anything in igc_ptp_init() which could cause such packet transfers to explode?

There might be a very narrow window (probably impossible?), what I can see is:

Quoted 9 lines
Quoted 6 lines

1. the netdevice is exposed to userspace;
2. userspace does the SIOCSHWTSTAMP ioctl() to enable TX timestamps;
3. userspace sends a packet that is going to be timestamped;

if this happens before igc_ptp_init() is called, adapter->ptp_tx_lock is going to be uninitialized, and (3) is going to crash.

The same would then be possible on igb as well, wouldn't it?

Given how many years igb is being used, perhaps "possible" is too strong :-)

On igb what exists is slightly different, as there's no ptp_tx_lock there, the "problem" there is trying to enqueue a job on a workqueue that is going to be uninitialized, during this time window.

And to be sure, I am still uncertain that this is possible.

Quoted 7 lines
Quoted 7 lines

If there's anything that makes this impossible/extremely unlikely, the patch looks good:

Quoted 7 lines
Quoted 3 lines

Cheers,

Signature · 1 line
Vinicius

Corinna

Cheers,

Signature · 1 line
Vinicius
Tested-by on v1 1/1
#6 lore raw
In reply to Corinna Vinschen
Quoted 12 lines · Corinna Vinschen

During successful probe, igc logs this:

[    5.133667] igc 0000:01:00.0 (unnamed net_device) (uninitialized): PHC added
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The reason is that igc_ptp_init() is called very early, even before register_netdev() has been called. So the netdev_info() call works on a partially uninitialized netdev.

Fix this by calling igc_ptp_init() after register_netdev(), right after the media autosense check, just as in igb. Add a comment, just as in igb.

Quoted 8 lines

Now the log message is fine:

[    5.200987] igc 0000:01:00.0 eth0: PHC added
---
  drivers/net/ethernet/intel/igc/igc_main.c | 5 +++--
  1 file changed, 3 insertions(+), 2 deletions(-)