ethtool module info only reports hex info

Thanks for taking the time to report this bug and trying to make Ubuntu better.

AFAIU you are claiming a change of behavior of ethtool from Bionic (18.04) to Jammy (22.04). I do not see any crash and I do not know whether this was a conscious decision from upstream (maybe not). I checked the upstream NEWS file to see if I could spot something there:

https://git.kernel.org/pub/scm/network/ethtool/ethtool.git/tree/NEWS

But nothing in a first glance. Maybe we should get in touch with upstream to better understand this change of behavior between version 5.4 and 5.16. Could you please raise this with them? According to the project's page:

https://mirrors.edge.kernel.org/pub/software/network/ethtool/

This is how one should report a bug:

"Bug reports should be sent to the maintainer, Michal Kubecek <email address hidden>, and to the netdev mailing list <email address hidden>."

If you do that, please share a link to the discussion here so we can track it.

I have reported this upstream as requested. Link to the mailing list: https://lists.openwall.net/netdev/2023/11/23/118

The suggested patch from Ido Schimmel solved this issue: https://lists.openwall.net/netdev/2023/11/23/177
Tested on ethtool source version 6.6

Thanks for the upstream bug report, Ivar.

Ido mentioned that there may be other identifiers missing. It would be nice to wait a couple weeks before trying to backport something here to ensure we have a complete/final fix for this one.

Still, I am adding this bug to the server team backlog so it can be picked up by the Ubuntu Server team soon.

Right, I do not see more activity on this. I think we can try to release a SRU to fix this issue, if more comes in the future we fix them in another SRU.

From the upstream discussion (and what Ivar tested), all we need is this single line patch:

diff --git a/netlink/module-eeprom.c b/netlink/module-eeprom.c
index 49833a2a6a38..8b19f8e28c72 100644
--- a/netlink/module-eeprom.c
+++ b/netlink/module-eeprom.c
@@ -216,6 +216,8 @@ static int eeprom_parse(struct cmd_context *ctx)

        switch (request.data[0]) {
 #ifdef ETHTOOL_ENABLE_PRETTY_DUMP
+ case SFF8024_ID_SOLDERED_MODULE:
        case SFF8024_ID_SFP:
                return sff8079_show_all_nl(ctx);
        case SFF8024_ID_QSFP:

I will be preparing an update with this patch and doing the SRU paper work.

Ivar, I'll need you to perform the test with the fixed version when the time comes, ok?

Very good. I'll test when a fixed version is ready

I have tested all 4 versions from the PPA, and they are working as expected
Attached a test log output.
Thanks

Thanks for testing already Ivar! I'll need you again once the SRU team accepts those packages in -proposed, so you can test the packages from there instead of my PPA.

This bug was fixed in the package ethtool - 1:6.6-1ubuntu1

---------------
ethtool (1:6.6-1ubuntu1) noble; urgency=medium

  * d/p/0001-Fix-ethtool-module-info-in-human-readable-mode.patch: add
    upstream patch to avoid hex dump report even in human-readable mode
    (LP: #2043983).

 -- Lucas Kanashiro <email address hidden> Tue, 12 Dec 2023 17:20:14 -0300

Hello Ivar, or anyone else affected,

Accepted ethtool into mantic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ethtool/1:6.5-1ubuntu0.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-mantic to verification-done-mantic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-mantic. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Hello Ivar, or anyone else affected,

Accepted ethtool into lunar-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ethtool/1:6.1-1ubuntu0.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-lunar to verification-done-lunar. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-lunar. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Hello Ivar, or anyone else affected,

Accepted ethtool into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ethtool/1:5.16-1ubuntu0.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-jammy to verification-done-jammy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-jammy. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

All autopkgtests for the newly accepted ethtool (1:5.16-1ubuntu0.1) for jammy have finished running.
The following regressions have been reported in tests triggered by the package:

chrony/4.2-2ubuntu2 (s390x)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/jammy/update_excuses.html#ethtool

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

All autopkgtests for the newly accepted ethtool (1:6.1-1ubuntu0.1) for lunar have finished running.
The following regressions have been reported in tests triggered by the package:

chrony/4.3-1ubuntu4 (armhf, s390x)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/lunar/update_excuses.html#ethtool

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

Ivar, could you please help us testing the fix available in -proposed? We need that to release the the fix to -updates.

The version of ethtool in the proposed pocket of Lunar that was purported to fix this bug report has been removed because the target series has reached its End of Life.

Ivar, could you still test the fixes in the supported releases? They are in -proposed and need verification to be released to -updates. TIA!

Hi, sorry for late testing. I have now been able to test on a target with correct fiber connector, and all looks good!
Downloaded deb package from http://archive.ubuntu.com/ubuntu/pool/main/e/ethtool/ repo. In this repo, the 6.1 version is missing so I have only tested 6.1 package earlier (see comment 2023-12-13).
In this test I have tested
5.16-1ubuntu0.1
6.5-1ubuntu0.1
6.6-1ubuntu1
Attached test report

Thanks for testing it Ivar, appreciated!

Thank you for testing! This gives me confidence that the bug itself is correctly fixed. However, I note that you've been testing the deb only, apparently all on a single release. That means that the dependencies used in your testing don't match the dependencies that would be used in those actual releases.

I think it would be appropriate to ensure that the package basically still works on each relevant release with its own set of dependencies before releasing it. Given the nature of the fix I don't think it's necessary to do this on this particular hardware though - anything it works with would do.

Please could someone verify that the ethtool packages in jammy-proposed and mantic-proposed still work *on those respective releases*, and confirm the package versions tested? Once done, please flip the tags back. Thanks!

Comment 15 also still needs addressing. I'll submit a retry now to see if that helps.

My bad Robie. I did not notice that Ivar tested everything on the same system/Ubuntu release. I'll run the test plan here, even not being able to reproduce the issue locally, on the missing releases, to make sure that it is not fully broken.

Hum, it seems I cannot test it in a LXD vm:

root@ethtool-mantic:~# dpkg -l | grep ethtool
ii ethtool 1:6.5-1ubuntu0.1 amd64 display or change Ethernet device settings
root@ethtool-mantic:~# ethtool -m enp5s0
netlink error: Operation not supported

root@ethtool-jammy:~# dpkg -l | grep ethtool
ii ethtool 1:5.16-1ubuntu0.1 amd64 display or change Ethernet device settings
root@ethtool-jammy:~# ethtool -m enp5s0
netlink error: Operation not supported

Verification done on mantic-proposed.

Same output on non-affected interface type (e.g., 0x03, SFP), i.e., no regressions.

Fixed output on affected interface type (i.e., 0x02, soldered), i.e., as expected.
(* This has been verified by changing the type in GDB and checking output as below.)

Consistent output between affected and unaffected interface types, i.e., no changes
other than the changed type's value/string.

Environment:
---

 $ lsb_release -cs
 No LSB modules are available.
 mantic

 $ ls -1d /sys/class/net/*
 /sys/class/net/enp161s0f0
 /sys/class/net/enp161s0f1
 /sys/class/net/enp193s0f0
 /sys/class/net/enp193s0f1
 /sys/class/net/enp68s0f0
 /sys/class/net/enp68s0f1
 /sys/class/net/lo

Before:
---

 $ apt-cache policy ethtool
 ethtool:
   Installed: 1:6.5-1
   Candidate: 1:6.5-1
   Version table:
  *** 1:6.5-1 500
  500 http://archive.ubuntu.com/ubuntu mantic/main amd64 Packages
  100 /var/lib/dpkg/status

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ethtool -m $NIC; echo; done > ethtool_-m.release 2>&1

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ./ethtool-gdb.sh -m $NIC; echo; done > ethtool-gdb_-m.release 2>&1

After:
---

 $ sudo add-apt-repository -yp proposed
 $ sudo apt install -y -t mantic-proposed ethtool

 $ apt-cache policy ethtool
 ethtool:
   Installed: 1:6.5-1ubuntu0.1
   Candidate: 1:6.5-1ubuntu0.1
   Version table:
  *** 1:6.5-1ubuntu0.1 100
  100 http://archive.ubuntu.com/ubuntu mantic-proposed/main amd64 Packages
  100 /var/lib/dpkg/status
      1:6.5-1 500
  500 http://archive.ubuntu.com/ubuntu mantic/main amd64 Packages

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ethtool -m $NIC; echo; done > ethtool_-m.proposed 2>&1

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ./ethtool-gdb.sh -m $NIC; echo; done > ethtool-gdb_-m.proposed 2>&1

Comparison:
---

Output files:

 $ ls -lh ethtool{,-gdb}_-m.{release,proposed}
 -rw-rw-r-- 1 ubuntu ubuntu 9.2K Apr 1 22:36 ethtool-gdb_-m.proposed
 -rw-rw-r-- 1 ubuntu ubuntu 1.7K Apr 1 22:36 ethtool-gdb_-m.release
 -rw-rw-r-- 1 ubuntu ubuntu 9.3K Apr 1 22:36 ethtool_-m.proposed
 -rw-rw-r-- 1 ubuntu ubuntu 9.3K Apr 1 22:35 ethtool_-m.release

No output changes for unaffected interfaces:
(just differences on temperature/voltage sensors which are expected.)

 $ diff -U0 ethtool_-m.release ethtool_-m.proposed
 --- ethtool_-m.release 2024-04-01 22:35:52.871974728 +0000
 +++ ethtool_-m.proposed 2024-04-01 22:36:13.748294254 +0000
 @@ -36,2 +36,2 @@
 - Module temperature : 31.73 degrees C / 89.11 degrees F
 - Module voltage : 3.2703 V
 + Module temperature : 30.06 degrees C / 86.11 degrees F
 + Module voltage : 3.2656 V
 @@ -118 +118 @@
 - Module temperature : 36.42 degrees C / 97.56 degrees F
 + Module temperature : 38.09 degrees C / 100.55 degrees F

Fixed output for affected (* with GDB) interfaces:

 $ diff -U0 ethtool-gdb_-m.release ethtool-gdb_-m.proposed
 --- ethtool-gdb_-m.release ...

Verification done on jammy-proposed.

Same output on non-affected interface type (e.g., 0x03, SFP), i.e., no regressions.

Fixed output on affected interface type (i.e., 0x02, soldered), i.e., as expected.
(* This has been verified by changing the type in GDB and checking output as below.)

Consistent output between affected and unaffected interface types, i.e., no changes
other than the changed type's value/string.

Environment:
---

 $ lsb_release -cs
 jammy

 $ ls -1d /sys/class/net/*
 /sys/class/net/enp161s0f0
 /sys/class/net/enp161s0f1
 /sys/class/net/enp193s0f0
 /sys/class/net/enp193s0f1
 /sys/class/net/enp68s0f0
 /sys/class/net/enp68s0f1
 /sys/class/net/lo

Before:
---

 $ apt-cache policy ethtool
 ethtool:
   Installed: 1:5.16-1
   Candidate: 1:5.16-1
   Version table:
  *** 1:5.16-1 500
  500 http://archive.ubuntu.com/ubuntu jammy/main amd64 Packages
  100 /var/lib/dpkg/status

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ethtool -m $NIC; echo; done > ethtool_-m.release 2>&1

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ./ethtool-gdb.sh -m $NIC; echo; done > ethtool-gdb_-m.release 2>&1

After:
---

 $ sudo add-apt-repository -yp proposed
 $ sudo apt install -y -t jammy-proposed ethtool

 $ apt-cache policy ethtool
 ethtool:
   Installed: 1:5.16-1ubuntu0.1
   Candidate: 1:5.16-1ubuntu0.1
   Version table:
  *** 1:5.16-1ubuntu0.1 500
  500 http://archive.ubuntu.com/ubuntu jammy-proposed/main amd64 Packages
  100 /var/lib/dpkg/status
      1:5.16-1 500
  500 http://archive.ubuntu.com/ubuntu jammy/main amd64 Packages

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ethtool -m $NIC; echo; done > ethtool_-m.proposed 2>&1

 for NIC in /sys/class/net/en*; do NIC=$(basename $NIC); echo $NIC; sudo ./ethtool-gdb.sh -m $NIC; echo; done > ethtool-gdb_-m.proposed 2>&1
Comparison:
---

Output files:

 $ ls -lh ethtool{,-gdb}_-m.{release,proposed}
 -rw-rw-r-- 1 ubuntu ubuntu 4.4K Apr 1 23:18 ethtool-gdb_-m.proposed
 -rw-rw-r-- 1 ubuntu ubuntu 1.8K Apr 1 23:19 ethtool-gdb_-m.release
 -rw-rw-r-- 1 ubuntu ubuntu 4.1K Apr 1 23:16 ethtool_-m.proposed
 -rw-rw-r-- 1 ubuntu ubuntu 4.1K Apr 1 23:11 ethtool_-m.release

No output changes for unaffected interfaces:
(just differences on temperature/voltage sensors which are expected.)

 $ diff -U0 ethtool_-m.release ethtool_-m.proposed
 $

Fixed output for affected (* with GDB) interfaces:

 $ diff -U0 ethtool-gdb_-m.release ethtool-gdb_-m.proposed
 --- ethtool-gdb_-m.release 2024-04-01 23:19:32.280414940 +0000
 +++ ethtool-gdb_-m.proposed 2024-04-01 23:18:30.643454466 +0000
 @@ -3,10 +3,31 @@
 -Offset Values
 ------- ------
 -0x0000: 03 04 07 10 00 00 00 40 00 0c 00 06 67 00 00 00
 ...
 -0x0070: 50 b5 1b 00 00 00 00 00 00 00 00 00 68 44 3d 5f
 +464 ./sfpid.c: No such file or directory.
 + Identifier : 0x02 (module soldered to motherboard)
 + Extended identifier : 0x04 (GBIC/SFP defined by 2-wire interface ID)
 + Connector : 0x07 (LC)
 + Transceiver codes ...

Robie's requests in comment #25 are addressed, AFAICT.

> Please could someone verify that the ethtool packages in jammy-proposed and mantic-proposed
> still work *on those respective releases*, and confirm the package versions tested?
> Once done, please flip the tags back. Thanks!

The tests cover interface types that are not-affected (eg, 0x03) and affected (eg, 0x02; simulated with GDB to exercise the code path changed).
All outputs looked consistent and without regressions.

This bug was fixed in the package ethtool - 1:6.5-1ubuntu0.1

---------------
ethtool (1:6.5-1ubuntu0.1) mantic; urgency=medium

  * d/p/0001-Fix-ethtool-module-info-in-human-readable-mode.patch: add
    upstream patch to avoid hex dump report even in human-readable mode
    (LP: #2043983).

 -- Lucas Kanashiro <email address hidden> Tue, 12 Dec 2023 17:32:39 -0300

The verification of the Stable Release Update for ethtool has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

This bug was fixed in the package ethtool - 1:5.16-1ubuntu0.1

---------------
ethtool (1:5.16-1ubuntu0.1) jammy; urgency=medium

  * d/p/0001-Fix-ethtool-module-info-in-human-readable-mode.patch: add
    upstream patch to avoid hex dump report even in human-readable mode
    (LP: #2043983).

 -- Lucas Kanashiro <email address hidden> Tue, 12 Dec 2023 17:52:33 -0300