Fix show int transceiver EEPROM crash for for Backplane cartridge + enhance EEPROM CLI output by mihirpat1 · Pull Request #4020 · sonic-net/sonic-utilities

mihirpat1 · 2025-08-07T00:03:48Z

Summary

This PR fixes a crash in the show interface transceiver eeprom command when dealing with Backplane cartridge modules and enhances the overall EEPROM CLI (show + sfputil) output consistency and organization.

This change should be merged along with sonic-net/sonic-platform-common#590

Following traceback is seen with the Backplane cartridge cables. Hence, we need to resolve the traceback.

root@admin:/home/admin# show int transceiver info Ethernet128
Traceback (most recent call last):
  File "/usr/local/bin/sfpshow", line 824, in <module>
    cli()
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/bin/sfpshow", line 764, in info
    sfp.get_eeprom()
  File "/usr/local/lib/python3.11/dist-packages/utilities_common/multi_asic.py", line 156, in wrapped_run_on_all_asics
    func(self,  *args, **kwargs)
  File "/usr/local/bin/sfpshow", line 641, in get_eeprom
    self.intf_eeprom[self.intf_name] = self.convert_interface_sfp_info_to_cli_output_string(
                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/bin/sfpshow", line 473, in convert_interface_sfp_info_to_cli_output_string
    sfp_info_output = self.convert_sfp_info_to_output_string(sfp_info_dict, sfp_firmware_info_dict)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/bin/sfpshow", line 354, in convert_sfp_info_to_output_string
    output += '{}{}: {}\n'.format(indent, data_map[key], sfp_info_dict[key])
                                                         ~~~~~~~~~~~~~^^^^^
KeyError: 'active_apsel_hostlane1'

🐛 Primary Bug Fix

Fixed crash for Backplane cartridge modules: Resolved issue where show interface transceiver eeprom command would crash when processing Backplane cartridge transceivers
- Using the sfp_info_dict rather than a pre-defined dictionary (CMIS_DATA_MAP, C_CMIS_DATA_MAP, QSFP_DATA_MAP, QSFP_DD_DATA_MAP, QSFP_DATA_MAP) to display the EEPROM fields. This helps to avoid modifying the pre-defined dictionary upon introducing new fields in sfp_info_dict for a new transceiver

🚀 EEPROM CLI Enhancements

Code Refactoring & Shared Utilities

Created shared utility functions in utilities_common/sfp_helper.py:
- get_data_map_sort_key(): Provides consistent sorting logic for SFP info keys
- get_transceiver_data_map(): Automatically selects appropriate data map based on transceiver type

Improved Field Organization

Consistent Field Ordering: Both sfputil and sfpshow now display transceiver fields in logical, sorted order

Code Quality Improvements

Removed Code Duplication: Eliminated redundant sorting and display logic between utilities
Better Maintainability: Shared functions make future updates and bug fixes easier

🧪 Testing

Verified fix resolves Backplane cartridge crash issue
Confirmed consistent field ordering across both CLIs

Field differences between nightly (left) and current changes (right) for CLI output of different types of transceivers
(the red and greyed out portion depict differences)

CMIS transceiver
show int transceiver info CLI

sfputil show eeprom CLI

CMIS transceiver with flat memory
show int transceiver info CLI

sfputil show eeprom CLI

C-CMIS transceiver
show int transceiver info CLI

sfputil show eeprom CLI

SFF-8636 with non-flat memory
show int transceiver info CLI

sfputil show eeprom CLI

SFF-8636 with flat memory
show int transceiver info CLI

sfputil show eeprom CLI

SFF-8436 with flat memory (DAC)
show int transceiver info CLI

sfputil show eeprom CLI

SFF-8472 transceiver
show int transceiver info CLI

sfputil show eeprom CLI

…nhance EEPROM CLI output Signed-off-by: Mihir Patel <patelmi@microsoft.com>

mssonicbld · 2025-08-07T00:03:56Z

/azp run

azure-pipelines · 2025-08-07T00:04:07Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-08-07T00:23:57Z

/azp run

azure-pipelines · 2025-08-07T00:24:08Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-08-07T00:33:16Z

/azp run

azure-pipelines · 2025-08-07T00:33:26Z

Azure Pipelines successfully started running 1 pipeline(s).

mihirpat1 · 2025-08-07T16:32:18Z

@az-pz Can you please help in reviewing this?

#### Description  This PR updates the `get_transceiver_info()` API in the CMIS module to remove fields from the returned `XCVR_INFO` dictionary that are dependent on the active application ID. These fields include: - host_electrical_interface - media_interface_code - host_lane_assignment_option - media_lane_assignment_option #### Motivation and Context  These fields are only meaningful when the active application ID is explicitly shown. Including them without context can lead to confusion or misinterpretation of transceiver capabilities. This change ensures the API response reflects only valid and context-aware data. #### How Has This Been Tested?  Please refer to the test section of sonic-net/sonic-utilities#4020 #### Additional Information (Optional) MSFT ADO - 34325583

…593)  #### Description  This PR updates the `get_transceiver_info()` API in the CMIS module to remove fields from the returned `XCVR_INFO` dictionary that are dependent on the active application ID. These fields include: - host_electrical_interface - media_interface_code - host_lane_assignment_option - media_lane_assignment_option #### Motivation and Context  These fields are only meaningful when the active application ID is explicitly shown. Including them without context can lead to confusion or misinterpretation of transceiver capabilities. This change ensures the API response reflects only valid and context-aware data. #### How Has This Been Tested?  Please refer to the test section of sonic-net/sonic-utilities#4020 #### Additional Information (Optional) MSFT ADO - 34325583

prgeor · 2025-08-09T01:37:32Z

utilities_common/sfp_helper.py

+        return QSFP_DATA_MAP  # Default fallback
+
+    is_sfp_cmis = is_transceiver_cmis(sfp_info_dict)
+    is_sfp_c_cmis = 'supported_max_tx_power' in sfp_info_dict


@mihirpat1 use optoe API is_coherent_module() ?

@prgeor I think invoking the is_coherent_module API may not be the ideal thing to do since is_coherent_module API accesses the transceiver EEPROM directly. However, the current caller of get_transceiver_data_map API is meant to retrieve data from the redis-db rather than accessing the transceiver EEPROM directly.

@mihirpat1 in that case should we define is_transceiver_coherent(sfp_dict) ? And use that?

@prgeor Addressed this now

prgeor

@mihirpat1 can you check the copilot review comments?

mssonicbld · 2025-08-12T03:58:37Z

/azp run

azure-pipelines · 2025-08-12T03:58:48Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR fixes a crash in the show interface transceiver eeprom command when dealing with Backplane cartridge modules and enhances EEPROM CLI output consistency between sfputil and sfpshow commands.

Fixed KeyError crash for Backplane cartridge modules by using dynamic field iteration instead of hardcoded data maps
Created shared utility functions for consistent field ordering and transceiver type detection
Improved code maintainability by eliminating duplicate sorting logic between CLI utilities

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
utilities_common/sfp_helper.py	Added shared utility functions for transceiver type detection and consistent field sorting
sfputil/main.py	Updated to use shared utilities and dynamic field iteration to prevent KeyError crashes
scripts/sfpshow	Updated to use shared utilities and handle unknown fields gracefully
tests/sfputil_test.py	Updated test expectations for new field ordering and output format
tests/sfp_test.py	Updated test expectations for additional fields in output
tests/mock_tables/state_db.json	Updated mock data to reflect new field handling

sfputil/main.py

mssonicbld · 2025-08-12T14:30:20Z

/azp run

azure-pipelines · 2025-08-12T14:30:31Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-08-14T00:37:55Z

Cherry-pick PR to 202505: #4032

…nhance EEPROM CLI output (sonic-net#4020) * Fix show int transceiver EEPROM crash for for Backplane cartridge + enhance EEPROM CLI output Signed-off-by: Mihir Patel <patelmi@microsoft.com> * Fixed SA warning * Added None check for sfp_firmware_info_dict * Added is_transceiver_c_cmis * Added new line before get_data_map_sort_key --------- Signed-off-by: Mihir Patel <patelmi@microsoft.com>

Fix show int transceiver EEPROM crash for for Backplane cartridge + e…

56889b3

…nhance EEPROM CLI output Signed-off-by: Mihir Patel <patelmi@microsoft.com>

mihirpat1 requested a review from Copilot August 7, 2025 00:03

mihirpat1 added the Request for 202505 Branch label Aug 7, 2025

This comment was marked as outdated.

Sign in to view

Fixed SA warning

a6f2fd5

mihirpat1 requested a review from Copilot August 7, 2025 00:26

This comment was marked as outdated.

Sign in to view

Added None check for sfp_firmware_info_dict

45ca698

mihirpat1 requested a review from Copilot August 7, 2025 00:33

This comment was marked as outdated.

Sign in to view

mihirpat1 mentioned this pull request Aug 7, 2025

[CMIS] Remove application-dependent fields from get_transceiver_info sonic-net/sonic-platform-common#590

Merged

mihirpat1 marked this pull request as ready for review August 7, 2025 02:13

az-pz approved these changes Aug 7, 2025

View reviewed changes

mssonicbld mentioned this pull request Aug 9, 2025

[action] [PR:590] [CMIS] Remove application-dependent fields from get_transceiver_info sonic-net/sonic-platform-common#593

Merged

prgeor reviewed Aug 9, 2025

View reviewed changes

prgeor reviewed Aug 12, 2025

View reviewed changes

Added is_transceiver_c_cmis

55b048f

mihirpat1 requested a review from Copilot August 12, 2025 03:58

Copilot AI reviewed Aug 12, 2025

View reviewed changes

sfputil/main.py Show resolved Hide resolved

sfputil/main.py Show resolved Hide resolved

Added new line before get_data_map_sort_key

331ccbe

prgeor approved these changes Aug 13, 2025

View reviewed changes

prgeor merged commit 19594b9 into sonic-net:master Aug 13, 2025
7 checks passed

yejianquan added the Approved for 202505 Branch label Aug 14, 2025

mssonicbld mentioned this pull request Aug 14, 2025

[action] [PR:4020] Fix show int transceiver EEPROM crash for for Backplane cartridge + enhance EEPROM CLI output #4032

Merged

mssonicbld added the Created PR to 202505 Branch label Aug 14, 2025

mssonicbld added Included in 202505 Branch and removed Created PR to 202505 Branch labels Aug 18, 2025

Conversation

mihirpat1 commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

🐛 Primary Bug Fix

🚀 EEPROM CLI Enhancements

Code Refactoring & Shared Utilities

Improved Field Organization

Code Quality Improvements

🧪 Testing

Uh oh!

mssonicbld commented Aug 7, 2025

Uh oh!

azure-pipelines bot commented Aug 7, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

mssonicbld commented Aug 7, 2025

Uh oh!

azure-pipelines bot commented Aug 7, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

mssonicbld commented Aug 7, 2025

Uh oh!

azure-pipelines bot commented Aug 7, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

mihirpat1 commented Aug 7, 2025

Uh oh!

prgeor Aug 9, 2025

Choose a reason for hiding this comment

Uh oh!

mihirpat1 Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prgeor Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

mihirpat1 Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

prgeor left a comment

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Aug 12, 2025

Uh oh!

azure-pipelines bot commented Aug 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Aug 12, 2025

Uh oh!

azure-pipelines bot commented Aug 12, 2025

Uh oh!

Uh oh!

mssonicbld commented Aug 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

mihirpat1 commented Aug 7, 2025 •

edited

Loading

mihirpat1 Aug 9, 2025 •

edited

Loading