Added remove_stale_transceiver_info function

Author: mihirpat1

sonic-xcvrd/tests/test_xcvrd.py

@@ -1899,6 +1899,50 @@ def mock_get_sfp(port):
         assert sfp_obj_dict[1] == mock_sfp_obj_1
         assert sfp_obj_dict[2] == mock_sfp_obj_2
 
+    @pytest.mark.parametrize(
+        "logical_ports, transceiver_presence, expected_removed_ports",
+        [
+            # Test case 1: No transceivers are present
+            (["Ethernet0", "Ethernet1"], [False, False], ["Ethernet0", "Ethernet1"]),
+            # Test case 2: Some transceivers are present
+            (["Ethernet0", "Ethernet1"], [True, False], ["Ethernet1"]),
+            # Test case 3: All transceivers are present
+            (["Ethernet0", "Ethernet1"], [True, True], []),
+            # Test case 4: No logical ports
+            ([], [], []),
+        ],
+    )
+    @patch('xcvrd.xcvrd.del_port_sfp_dom_info_from_db')
+    @patch('xcvrd.xcvrd._wrapper_get_presence')
+    def test_remove_stale_transceiver_info(self, mock_get_presence, mock_del_port_sfp_dom_info_from_db,
+                                           logical_ports, transceiver_presence, expected_removed_ports):
+        # Mock the DaemonXcvrd class and its dependencies
+        mock_xcvrd = DaemonXcvrd(SYSLOG_IDENTIFIER)
+        mock_port_mapping_data = MagicMock()
+        mock_xcvrd.xcvr_table_helper = MagicMock()
+        mock_xcvrd.xcvr_table_helper.get_intf_tbl.return_value = MagicMock()
+
+        # Mock logical ports and their mappings
+        mock_port_mapping_data.logical_port_list = logical_ports
+        mock_port_mapping_data.get_asic_id_for_logical_port.side_effect = lambda port: 0
+        mock_port_mapping_data.get_logical_to_physical.side_effect = lambda port: [logical_ports.index(port)]
+
+        mock_get_presence.side_effect = lambda physical_port: transceiver_presence[physical_port]
+
+        # Mock the interface table
+        mock_intf_tbl = mock_xcvrd.xcvr_table_helper.get_intf_tbl.return_value
+        mock_intf_tbl.get.side_effect = lambda port: (port in logical_ports, None)
+
+        # Call the function
+        mock_xcvrd.remove_stale_transceiver_info(mock_port_mapping_data)
+
+        # Verify that the correct ports were removed
+        for port in logical_ports:
+            if port in expected_removed_ports:
+                mock_del_port_sfp_dom_info_from_db.assert_any_call(port, mock_port_mapping_data, [mock_intf_tbl])
+            else:
+                assert (port, mock_port_mapping_data, [mock_intf_tbl]) not in mock_del_port_sfp_dom_info_from_db.call_args_list
+
     @patch('xcvrd.xcvrd.DaemonXcvrd.init')
     @patch('xcvrd.xcvrd.DaemonXcvrd.deinit')
     @patch('xcvrd.xcvrd.DomInfoUpdateTask.start')
@@ -4149,6 +4193,7 @@ def test_DaemonXcvrd_init_deinit_fastboot_enabled(self):
         with patch("subprocess.check_output") as mock_run:
             mock_run.return_value = "true"
             xcvrd.initialize_port_init_control_fields_in_port_table = MagicMock()
+            xcvrd.remove_stale_transceiver_info = MagicMock()
 
             xcvrd.init()
 
@@ -4191,6 +4236,7 @@ def test_DaemonXcvrd_init_deinit_cold(self):
         with patch("subprocess.check_output") as mock_run:
             mock_run.return_value = "false"
             xcvrdaemon.initialize_port_init_control_fields_in_port_table = MagicMock()
+            xcvrdaemon.remove_stale_transceiver_info = MagicMock()
 
             xcvrdaemon.init()
 

sonic-xcvrd/xcvrd/dom/utilities/db/utils.py

@@ -1,4 +1,4 @@
-import time
+from datetime import datetime
 from swsscommon import swsscommon
 from xcvrd.xcvrd_utilities.utils import XCVRDUtils
 
@@ -84,9 +84,13 @@ def update_flag_metadata_tables(self, logical_port_name, curr_flag_dict,
                                     flag_change_count_table, flag_last_set_time_table, flag_last_clear_time_table,
                                     table_name_for_logging):
         """
-        Updates the metadata tables for flag table.
-        Compares the current flag values with the database values and updates the metadata accordingly based on the changes
-        between the two.
+        Updates the metadata tables for a flag table.
+
+        This method compares the current flag values with the values stored in the database.
+        If there are changes, it updates the metadata tables accordingly, including:
+        - Change count
+        - Last set time
+        - Last clear time
 
         Args:
             logical_port_name (str): Logical port name.
@@ -128,11 +132,17 @@ def beautify_info_dict(self, info_dict):
             if not isinstance(v, str):
                 info_dict[k] = str(v)
 
-    def get_current_time(self):
-        """"
-        Returns the current time in the format "Day Mon DD HH:MM:SS YYYY" (local time)
+    def get_current_time(self, time_format="%a %b %d %H:%M:%S %Y"):
+        """
+        Returns the current time in the specified format (UTC time).
+
+        Args:
+            time_format (str): The format in which to return the time. Defaults to "Day Mon DD HH:MM:SS YYYY".
+
+        Returns:
+            str: The current time in UTC.
         """
-        return time.strftime("%a %b %d %H:%M:%S %Y", time.localtime())
+        return datetime.utcnow().strftime(time_format)
 
     def _initialize_metadata_tables(self, logical_port_name, curr_flag_dict,
                                     flag_change_count_table, flag_last_set_time_table,

sonic-xcvrd/xcvrd/xcvrd.py

@@ -1101,7 +1101,7 @@ def task_worker(self):
 
                 # double-check the HW presence before moving forward
                 sfp = platform_chassis.get_sfp(pport)
-                if not sfp.get_presence():
+                if not _wrapper_get_presence(pport):
                     self.update_port_transceiver_status_table_sw_cmis_state(lport, CMIS_STATE_REMOVED)
                     continue
 
@@ -2132,6 +2132,40 @@ def initialize_sfp_obj_dict(self, port_mapping_data):
 
         return sfp_obj_dict
 
+    def remove_stale_transceiver_info(self, port_mapping_data):
+        """
+        Remove stale entries from the TRANSCEIVER_INFO table for ports where the transceiver is no longer present.
+
+        This function iterates through all logical ports in the provided port mapping data. For each port:
+        - It checks if the TRANSCEIVER_INFO table entry exists.
+        - If the entry exists and the transceiver is absent, the entry is removed from the table.
+
+        Args:
+            port_mapping_data (PortMapping): The port mapping data containing logical-to-physical port mappings.
+
+        Returns:
+            None
+        """
+        logical_port_list = port_mapping_data.logical_port_list
+        for lport in logical_port_list:
+            asic_index = port_mapping_data.get_asic_id_for_logical_port(lport)
+            intf_tbl = self.xcvr_table_helper.get_intf_tbl(asic_index)
+            if not intf_tbl:
+                continue
+
+            found, _ = intf_tbl.get(lport)
+            if found:
+                # If transceiver is absent, remove the entry from TRANSCEIVER_INFO table
+                pport_list = port_mapping_data.get_logical_to_physical(lport)
+                if not pport_list:
+                    self.log_error(f"Remove stale transceiver info: No physical port found for lport {lport}")
+                    continue
+                pport = pport_list[0]
+
+                if not _wrapper_get_presence(pport):
+                    self.log_notice(f"Remove stale transceiver info: Transceiver is absent for lport {lport}")
+                    del_port_sfp_dom_info_from_db(lport, port_mapping_data, [intf_tbl])
+
     # Initialize daemon
     def init(self):
         global platform_sfputil
@@ -2182,6 +2216,12 @@ def init(self):
         self.initialize_port_init_control_fields_in_port_table(port_mapping_data)
         self.sfp_obj_dict = self.initialize_sfp_obj_dict(port_mapping_data)
 
+        # Remove the TRANSCEIVER_INFO table if the transceiver is absent.
+        # This ensures stale entries are cleaned up when a transceiver is removed while xcvrd is not running.
+        # Performed in the init() method to ensure the table is cleared before starting child threads.
+        # Note: Other transceiver-related tables are cleared during xcvrd deinitialization.
+        self.remove_stale_transceiver_info(port_mapping_data)
+
         return port_mapping_data
 
     # Deinitialize daemon