[PATCH net] tools/net/ynl: ethtool: fix crash when Hardware Clock info is missing

[PATCH net] tools/net/ynl: ethtool: fix crash when Hardware Clock info is missing

[Hangbin Liu]

Fix a crash in the ethtool YNL implementation when Hardware Clock information
is not present in the response. This ensures graceful handling of devices or
drivers that do not provide this optional field. e.g.

  Traceback (most recent call last):
    File "/net/tools/net/ynl/pyynl/./ethtool.py", line 438, in <module>
      main()
      ~~~~^^
    File "/net/tools/net/ynl/pyynl/./ethtool.py", line 341, in main
      print(f'PTP Hardware Clock: {tsinfo["phc-index"]}')
                                   ~~~~~~^^^^^^^^^^^^^
  KeyError: 'phc-index'

Fixes: f3d07b02b2b8 ("tools: ynl: ethtool testing tool")
Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
---
 tools/net/ynl/pyynl/ethtool.py | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/tools/net/ynl/pyynl/ethtool.py b/tools/net/ynl/pyynl/ethtool.py
index af7fddd7b085..cab6b576c876 100755
--- a/tools/net/ynl/pyynl/ethtool.py
+++ b/tools/net/ynl/pyynl/ethtool.py
@@ -338,16 +338,24 @@ def main():
         print('Capabilities:')
         [print(f'\t{v}') for v in bits_to_dict(tsinfo['timestamping'])]
 
-        print(f'PTP Hardware Clock: {tsinfo["phc-index"]}')
+        print(f'PTP Hardware Clock: {tsinfo.get("phc-index", "none")}')
 
-        print('Hardware Transmit Timestamp Modes:')
-        [print(f'\t{v}') for v in bits_to_dict(tsinfo['tx-types'])]
+        if 'tx-types' in tsinfo:
+            print('Hardware Transmit Timestamp Modes:')
+            [print(f'\t{v}') for v in bits_to_dict(tsinfo['tx-types'])]
+        else:
+            print('Hardware Transmit Timestamp Modes: none')
+
+        if 'rx-filters' in tsinfo:
+            print('Hardware Receive Filter Modes:')
+            [print(f'\t{v}') for v in bits_to_dict(tsinfo['rx-filters'])]
+        else:
+            print('Hardware Receive Filter Modes: none')
 
-        print('Hardware Receive Filter Modes:')
-        [print(f'\t{v}') for v in bits_to_dict(tsinfo['rx-filters'])]
+        if 'stats' in tsinfo and tsinfo['stats']:
+            print('Statistics:')
+            [print(f'\t{k}: {v}') for k, v in tsinfo['stats'].items()]
 
-        print('Statistics:')
-        [print(f'\t{k}: {v}') for k, v in tsinfo['stats'].items()]
         return
 
     print(f'Settings for {args.device}:')
-- 
2.46.0

Re: [PATCH net] tools/net/ynl: ethtool: fix crash when Hardware Clock info is missing

[Stanislav Fomichev]

On 05/08, Hangbin Liu wrote:
> Fix a crash in the ethtool YNL implementation when Hardware Clock information
> is not present in the response. This ensures graceful handling of devices or
> drivers that do not provide this optional field. e.g.
> 
>   Traceback (most recent call last):
>     File "/net/tools/net/ynl/pyynl/./ethtool.py", line 438, in <module>
>       main()
>       ~~~~^^
>     File "/net/tools/net/ynl/pyynl/./ethtool.py", line 341, in main
>       print(f'PTP Hardware Clock: {tsinfo["phc-index"]}')
>                                    ~~~~~~^^^^^^^^^^^^^
>   KeyError: 'phc-index'
> 
> Fixes: f3d07b02b2b8 ("tools: ynl: ethtool testing tool")
> Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>

Acked-by: Stanislav Fomichev <sdf@fomichev.me>

Re: [PATCH net] tools/net/ynl: ethtool: fix crash when Hardware Clock info is missing

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Thu,  8 May 2025 03:54:14 +0000 you wrote:
> Fix a crash in the ethtool YNL implementation when Hardware Clock information
> is not present in the response. This ensures graceful handling of devices or
> drivers that do not provide this optional field. e.g.
> 
>   Traceback (most recent call last):
>     File "/net/tools/net/ynl/pyynl/./ethtool.py", line 438, in <module>
>       main()
>       ~~~~^^
>     File "/net/tools/net/ynl/pyynl/./ethtool.py", line 341, in main
>       print(f'PTP Hardware Clock: {tsinfo["phc-index"]}')
>                                    ~~~~~~^^^^^^^^^^^^^
>   KeyError: 'phc-index'
> 
> [...]

Here is the summary with links:
  - [net] tools/net/ynl: ethtool: fix crash when Hardware Clock info is missing
    https://git.kernel.org/netdev/net/c/45375814eb3f

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html