Update ICV defaults for RHEL9, fix version_number() (#886)

* Update ICV defaults for RHEL9, fix version_number()

The BWRC servers migrated to RHEL9, and with that, our old
setup using S-2021.06-SP3-2 for the default ICV version
is not functional.

In general, users of RHEL9 should adopt W-2024.09-4 from Synopsys
for ICV and V-2023.09-SP2 for ICVWB.

Synopsys now defaults to install these newer ICV versions
at the /icvalidator/ directory instead of /icv/, so
the ICV_HOME env var should reflect this.

Finally, SynopsysTool.version_number() fails to correctly
parse W-2024.09-4. This change fixes that, and includes
regression unit tests to ensure previous versions of ICV
can still be successfully parsed

* Fix test_synopsys_tool static analyzer test failure

* Add comment to icv/defaults.yml for old ICV versions

Old ICV (<2024) versions will be found at /icv/ instead
of /icvalidator/

Author: daniellovell

hammer/common/synopsys/__init__.py

@@ -32,13 +32,25 @@ def version_number(self, version: str) -> int:
         """
         Assumes versions look like NAME-YYYY.MM-SPMINOR.
         Assumes less than 100 minor versions.
+        
+        Handles various version formats:
+        - NAME-YYYY.MM (no minor version)
+        - NAME-YYYY.MM-N (where N is a number like 4)
+        - NAME-YYYY.MM-SPN (where SP is a prefix and N is a number)
+        - NAME-YYYY.MM-PREFIXN (where PREFIX is any text and N is a number)
         """
         date = "-".join(version.split("-")[1:])  # type: str
         year = int(date.split(".")[0])  # type: int
         month = int(date.split(".")[1][:2])  # type: int
         minor_version = 0  # type: int
         if "-" in date:
-            minor_version = int(date.split("-")[1][2:])
+            minor_part = date.split("-")[1]
+            # Try to handle both formats: with prefix (like "SP4") and without (like "4")
+            # If the minor part starts with non-digits, skip them
+            for i, char in enumerate(minor_part):
+                if char.isdigit():
+                    minor_version = int(minor_part[i:])
+                    break
         return (year * 100 + month) * 100 + minor_version
 
     @property

hammer/drc/icv/defaults.yml

@@ -1,22 +1,24 @@
 # Default settings for ICV DRC, for project/technology configuration and overriding.
 drc.icv:
+    # Note: Older versions of ICV are often located at /icv/ instead of /icvalidator/.
+    # If you are using an older version, you should change the path in addition to the version.
     # Location of the binary
-    icv_drc_bin: "${synopsys.synopsys_home}/icv/${drc.icv.version}/bin/LINUX.64/icv"
+    icv_drc_bin: "${synopsys.synopsys_home}/icvalidator/${drc.icv.version}/bin/LINUX.64/icv"
     icv_drc_bin_meta: lazysubst
 
-    icv_vue_bin: "${synopsys.synopsys_home}/icv/${drc.icv.version}/bin/LINUX.64/icv_vue"
+    icv_vue_bin: "${synopsys.synopsys_home}/icvalidator/${drc.icv.version}/bin/LINUX.64/icv_vue"
     icv_vue_bin_meta: lazysubst
 
     icvwb_bin: "${synopsys.synopsys_home}/icvwb/${drc.icv.icvwb_version}/bin/icvwb"
     icvwb_bin_meta: lazysubst
 
-    ICV_HOME_DIR: "${synopsys.synopsys_home}/icv/${drc.icv.version}"
+    ICV_HOME_DIR: "${synopsys.synopsys_home}/icvalidator/${drc.icv.version}"
     ICV_HOME_DIR_meta: lazysubst
 
     # type: str
-    version: "S-2021.06-SP3-2"
+    version: "W-2024.09-4"
     # type: str
-    icvwb_version: "S-2021.06-SP2"
+    icvwb_version: "V-2023.09-SP2"
     # Port for VUE (violation browser) to communicate with ICVWB (layout browser)
     # Any open port 1000 to 65536 allowed
     # type: int

hammer/lvs/icv/defaults.yml

@@ -1,25 +1,27 @@
 # Default settings for ICV lvs, for project/technology configuration and overriding.
 lvs.icv:
+    # Note: Older versions of ICV are often located at /icv/ instead of /icvalidator/.
+    # If you are using an older version, you should change the path in addition to the version.
     # Location of the binary
-    icv_lvs_bin: "${synopsys.synopsys_home}/icv/${lvs.icv.version}/bin/LINUX.64/icv"
+    icv_lvs_bin: "${synopsys.synopsys_home}/icvalidator/${lvs.icv.version}/bin/LINUX.64/icv"
     icv_lvs_bin_meta: lazysubst
 
-    icv_nettran_bin: "${synopsys.synopsys_home}/icv/${lvs.icv.version}/bin/LINUX.64/icv_nettran"
+    icv_nettran_bin: "${synopsys.synopsys_home}/icvalidator/${lvs.icv.version}/bin/LINUX.64/icv_nettran"
     icv_nettran_bin_meta: lazysubst
 
-    icv_vue_bin: "${synopsys.synopsys_home}/icv/${lvs.icv.version}/bin/LINUX.64/icv_vue"
+    icv_vue_bin: "${synopsys.synopsys_home}/icvalidator/${lvs.icv.version}/bin/LINUX.64/icv_vue"
     icv_vue_bin_meta: lazysubst
 
     icvwb_bin: "${synopsys.synopsys_home}/icvwb/${lvs.icv.icvwb_version}/bin/icvwb"
     icvwb_bin_meta: lazysubst
 
-    ICV_HOME_DIR: "${synopsys.synopsys_home}/icv/${lvs.icv.version}"
+    ICV_HOME_DIR: "${synopsys.synopsys_home}/icvalidator/${lvs.icv.version}"
     ICV_HOME_DIR_meta: lazysubst
 
     # type: str
-    version: "S-2021.06-SP3-2"
+    version: "W-2024.09-4"
     # type: str
-    icvwb_version: "S-2021.06-SP2"
+    icvwb_version: "V-2023.09-SP2"
     # Port for VUE (violation browser) to communicate with ICVWB (layout browser)
     # Any open port 1000 to 65536 allowed
     # type: int

tests/test_synopsys_tool.py

@@ -0,0 +1,48 @@
+import unittest
+import sys
+import os
+
+# Add the hammer path to the import path
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from hammer.common.synopsys import SynopsysTool
+
+class TestSynopsysTool(unittest.TestCase):
+    """Test the SynopsysTool class"""
+    
+    def setUp(self):
+        # Create an instance of SynopsysTool for testing
+        class MinimalSynopsysTool(SynopsysTool):
+            def tool_config_prefix(self):
+                return "synopsys"
+            
+            def get_setting(self, key, nullvalue=None):
+                return nullvalue
+                
+            # Implement the abstract property steps
+            @property
+            def steps(self):
+                return []
+        
+        self.tool = MinimalSynopsysTool()
+    
+    def test_version_number_icv_formats(self):
+        """Test actual ICV version formats."""
+        # Test S-2021.06-SP3-2 format
+        version1 = "S-2021.06-SP3-2"
+        expected1 = (2021 * 100 + 6) * 100 + 3  # The method should extract 3 from SP3-2
+        self.assertEqual(self.tool.version_number(version1), expected1)
+        
+        # Test W-2024.09-4 format
+        version2 = "W-2024.09-4"
+        expected2 = (2024 * 100 + 9) * 100 + 4
+        self.assertEqual(self.tool.version_number(version2), expected2)
+        
+        # Test V-2023.09-SP2 format
+        version3 = "V-2023.09-SP2"
+        expected3 = (2023 * 100 + 9) * 100 + 2
+        self.assertEqual(self.tool.version_number(version3), expected3)
+
+
+if __name__ == '__main__':
+    unittest.main()