Merge pull request The-OpenROAD-Project#7960 from osamahammad21/odb-gen-objtype

ODB: Hash dbObjectType and use that hash in serialization and deserialization.

Author: osamahammad21

src/odb/include/odb/dbObject.h

@@ -169,4 +169,7 @@ class dbObject
   ~dbObject() = default;
 };
 
+dbIStream& operator>>(dbIStream& stream, dbObjectType& type);
+dbOStream& operator<<(dbOStream& stream, dbObjectType type);
+
 }  // namespace odb

src/odb/include/odb/dbStream.h

@@ -141,12 +141,6 @@ class dbOStream
     return *this;
   }
 
-  dbOStream& operator<<(dbObjectType c)
-  {
-    writeValueAsBytes(c);
-    return *this;
-  }
-
   template <class T1, class T2>
   dbOStream& operator<<(const std::pair<T1, T2>& p)
   {
@@ -375,12 +369,6 @@ class dbIStream
     return *this;
   }
 
-  dbIStream& operator>>(dbObjectType& c)
-  {
-    _f.read(reinterpret_cast<char*>(&c), sizeof(c));
-    return *this;
-  }
-
   template <class T1, class T2>
   dbIStream& operator>>(std::pair<T1, T2>& p)
   {

src/odb/src/codeGenerator/gen.py

@@ -27,6 +27,7 @@
     is_set_by_ref,
     is_ref,
     std,
+    fnv1a_32,
 )
 
 # map types to their header if it isn't equal to their name
@@ -291,6 +292,7 @@ def generate(schema, env, includeDir, srcDir, keep_empty):
     generate_relations(schema)
 
     to_be_merged = []
+    hash_dict = {}
     for klass in schema["classes"]:
         # Adding functional name to fields and extracting field components
         flags_struct = {
@@ -311,6 +313,19 @@ def generate(schema, env, includeDir, srcDir, keep_empty):
                 if "odb/db.h" not in klass["h_includes"]:
                     klass["h_includes"].append("odb/db.h")
                 break
+        # Add hash to class
+        if "hash" not in klass:
+            hash_value = fnv1a_32(klass["name"])
+        else:
+            hash_value = int(klass["hash"], 16)
+
+        if hash_value in hash_dict:
+            # Collision detected, error out
+            raise ValueError(
+                f"Collision detected for {klass['name']} with {hash_dict[hash_value]}"
+            )
+        hash_dict[hash_value] = klass["name"]
+        klass["hash"] = f"0x{hash_value:08X}"
 
         # Generating files
         for template_file in ["impl.h", "impl.cpp"]:

src/odb/src/codeGenerator/helper.py

@@ -177,3 +177,13 @@ def get_ref_type(type_name):
         return None
 
     return type_name[6:-1] + "*"
+
+
+def fnv1a_32(string):
+    FNV_prime = 0x01000193
+    hash_value = 0x811C9DC5
+    for c in string:
+        hash_value ^= ord(c)
+        hash_value = (hash_value * FNV_prime) % (1 << 32)
+
+    return hash_value

src/odb/src/codeGenerator/templates/dbObject.cpp

@@ -3,3 +3,15 @@
   "{{klass.name}}",
 {% endfor %}
 //Generator Code End ObjectNames
+
+//Generator Code Begin HashToObjectType
+{% for klass in schema.classes|sort(attribute='name') %}
+  { {{klass.hash}}, {{klass.name}}Obj},
+{% endfor %}
+//Generator Code End HashToObjectType
+
+//Generator Code Begin ObjectTypeToHash
+{% for klass in schema.classes|sort(attribute='name') %}
+  { {{klass.name}}Obj, {{klass.hash}} },
+{% endfor %}
+//Generator Code End ObjectTypeToHash

src/odb/src/db/dbObject.cpp

@@ -2,6 +2,7 @@
 // Copyright (c) 2019-2025, The OpenROAD Authors
 
 #include <cstring>
+#include <unordered_map>
 
 #include "dbCore.h"
 #include "dbDatabase.h"
@@ -139,6 +140,236 @@ static const char* name_tbl[] = {"dbDatabase",
                                  "dbProperty",
                                  "dbName"};
 
+static const std::unordered_map<uint32_t, dbObjectType> hash_to_object_type
+    = {{0x0, dbDatabaseObj},
+
+       // Design Objects
+       {0x1, dbChipObj},
+       {0x2, dbGdsLibObj},
+       {0x3, dbBlockObj},
+       {0x4, dbInstHdrObj},
+       {0x5, dbInstObj},
+       {0x6, dbNetObj},
+       {0x7, dbBTermObj},
+       {0x8, dbITermObj},
+       {0x9, dbBoxObj},
+       {0xA, dbViaObj},
+       {0xB, dbTrackGridObj},
+       {0xC, dbObstructionObj},
+       {0xD, dbBlockageObj},
+       {0xE, dbWireObj},
+       {0xF, dbSWireObj},
+       {0x10, dbSBoxObj},
+       {0x11, dbCapNodeObj},
+       {0x12, dbRSegObj},
+       {0x13, dbCCSegObj},
+       {0x14, dbRowObj},
+       {0x15, dbFillObj},
+       {0x16, dbRegionObj},
+       {0x17, dbHierObj},
+       {0x18, dbBPinObj},
+       // Generator Code Begin HashToObjectType
+       {0x663302D5, dbAccessPointObj},
+       {0x12B22B2C, dbBusPortObj},
+       {0xEE4BAB67, dbCellEdgeSpacingObj},
+       {0x7C713BD7, dbDftObj},
+       {0x645E6090, dbGCellGridObj},
+       {0xCC5EB4AD, dbGDSARefObj},
+       {0xE4D136A3, dbGDSBoundaryObj},
+       {0x2A7E2FFE, dbGDSBoxObj},
+       {0xE38B6A0A, dbGDSPathObj},
+       {0x85F207E7, dbGDSSRefObj},
+       {0x99297302, dbGDSStructureObj},
+       {0x90DFB402, dbGDSTextObj},
+       {0xA0D52ACE, dbGlobalConnectObj},
+       {0x7A16F67A, dbGroupObj},
+       {0xE76AA1E9, dbGuideObj},
+       {0xB6738B19, dbIsolationObj},
+       {0x861F1D0A, dbLevelShifterObj},
+       {0x2B46CE60, dbLogicPortObj},
+       {0xEB83E7A1, dbMarkerObj},
+       {0x4D3FFF1D, dbMarkerCategoryObj},
+       {0x05DBC7F0, dbMasterEdgeTypeObj},
+       {0x0FD3C974, dbMetalWidthViaMapObj},
+       {0x7EBE8F33, dbModBTermObj},
+       {0xAFA31C35, dbModInstObj},
+       {0xFAC1E1FA, dbModITermObj},
+       {0xDFD34354, dbModNetObj},
+       {0x9F568C6F, dbModuleObj},
+       {0x6D3EE435, dbNetTrackObj},
+       {0x110F3173, dbPolygonObj},
+       {0x7352FE40, dbPowerDomainObj},
+       {0x7D280800, dbPowerSwitchObj},
+       {0xBF9698BF, dbScanChainObj},
+       {0x05CD9D4A, dbScanInstObj},
+       {0xD398101E, dbScanListObj},
+       {0x534639A0, dbScanPartitionObj},
+       {0x2BA03C39, dbScanPinObj},
+       {0x4ED3B51C, dbTechLayerObj},
+       {0x2C0432EB, dbTechLayerAreaRuleObj},
+       {0x1904C344, dbTechLayerArraySpacingRuleObj},
+       {0x598158F4, dbTechLayerCornerSpacingRuleObj},
+       {0xE1F72282, dbTechLayerCutClassRuleObj},
+       {0xFFC5F736, dbTechLayerCutEnclosureRuleObj},
+       {0xB78E788B, dbTechLayerCutSpacingRuleObj},
+       {0x79DFAE70, dbTechLayerCutSpacingTableDefRuleObj},
+       {0xA5373824, dbTechLayerCutSpacingTableOrthRuleObj},
+       {0x49B1981B, dbTechLayerEolExtensionRuleObj},
+       {0x88B0E445, dbTechLayerEolKeepOutRuleObj},
+       {0x139CF020, dbTechLayerForbiddenSpacingRuleObj},
+       {0x0AD77253, dbTechLayerKeepOutZoneRuleObj},
+       {0xA65D53B9, dbTechLayerMaxSpacingRuleObj},
+       {0x4BA55CDE, dbTechLayerMinCutRuleObj},
+       {0x6BE58714, dbTechLayerMinStepRuleObj},
+       {0x49E7A7BD, dbTechLayerSpacingEolRuleObj},
+       {0xA223F41D, dbTechLayerSpacingTablePrlRuleObj},
+       {0x7C5FB405, dbTechLayerTwoWiresForbiddenSpcRuleObj},
+       {0x7BF3D392, dbTechLayerWidthTableRuleObj},
+       {0xF73FA7DF, dbTechLayerWrongDirSpacingRuleObj},
+       // Generator Code End HashToObjectType
+
+       // Lib Objects
+       {0x52, dbLibObj},
+       {0x53, dbGDSLibObj},
+       {0x54, dbSiteObj},
+       {0x55, dbMasterObj},
+       {0x56, dbMPinObj},
+       {0x57, dbMTermObj},
+       {0x58, dbTechAntennaPinModelObj},
+
+       // Tech Objects
+       {0x59, dbTechObj},
+       {0x5A, dbTechViaObj},
+       {0x5B, dbTechNonDefaultRuleObj},
+       {0x5C, dbTechLayerRuleObj},
+       {0x5D, dbTechSameNetRuleObj},
+       {0x5E, dbTechLayerSpacingRuleObj},
+       {0x5F, dbTechMinCutRuleObj},
+       {0x60, dbTechMinEncRuleObj},
+       {0x61, dbTechV55InfluenceEntryObj},
+       {0x62, dbTechLayerAntennaRuleObj},
+       {0x63, dbTechViaRuleObj},
+       {0x64, dbTechViaGenerateRuleObj},
+       {0x65, dbTechViaLayerRuleObj},
+
+       {0x66, dbPropertyObj},
+       {0x67, dbNameObj}};
+
+static const std::unordered_map<dbObjectType, uint32_t> object_type_to_hash
+    = {{dbDatabaseObj, 0x0},
+
+       // Design Objects
+       {dbChipObj, 0x1},
+       {dbGdsLibObj, 0x2},
+       {dbBlockObj, 0x3},
+       {dbInstHdrObj, 0x4},
+       {dbInstObj, 0x5},
+       {dbNetObj, 0x6},
+       {dbBTermObj, 0x7},
+       {dbITermObj, 0x8},
+       {dbBoxObj, 0x9},
+       {dbViaObj, 0xA},
+       {dbTrackGridObj, 0xB},
+       {dbObstructionObj, 0xC},
+       {dbBlockageObj, 0xD},
+       {dbWireObj, 0xE},
+       {dbSWireObj, 0xF},
+       {dbSBoxObj, 0x10},
+       {dbCapNodeObj, 0x11},
+       {dbRSegObj, 0x12},
+       {dbCCSegObj, 0x13},
+       {dbRowObj, 0x14},
+       {dbFillObj, 0x15},
+       {dbRegionObj, 0x16},
+       {dbHierObj, 0x17},
+       {dbBPinObj, 0x18},
+       // Generator Code Begin ObjectTypeToHash
+       {dbAccessPointObj, 0x663302D5},
+       {dbBusPortObj, 0x12B22B2C},
+       {dbCellEdgeSpacingObj, 0xEE4BAB67},
+       {dbDftObj, 0x7C713BD7},
+       {dbGCellGridObj, 0x645E6090},
+       {dbGDSARefObj, 0xCC5EB4AD},
+       {dbGDSBoundaryObj, 0xE4D136A3},
+       {dbGDSBoxObj, 0x2A7E2FFE},
+       {dbGDSPathObj, 0xE38B6A0A},
+       {dbGDSSRefObj, 0x85F207E7},
+       {dbGDSStructureObj, 0x99297302},
+       {dbGDSTextObj, 0x90DFB402},
+       {dbGlobalConnectObj, 0xA0D52ACE},
+       {dbGroupObj, 0x7A16F67A},
+       {dbGuideObj, 0xE76AA1E9},
+       {dbIsolationObj, 0xB6738B19},
+       {dbLevelShifterObj, 0x861F1D0A},
+       {dbLogicPortObj, 0x2B46CE60},
+       {dbMarkerObj, 0xEB83E7A1},
+       {dbMarkerCategoryObj, 0x4D3FFF1D},
+       {dbMasterEdgeTypeObj, 0x05DBC7F0},
+       {dbMetalWidthViaMapObj, 0x0FD3C974},
+       {dbModBTermObj, 0x7EBE8F33},
+       {dbModInstObj, 0xAFA31C35},
+       {dbModITermObj, 0xFAC1E1FA},
+       {dbModNetObj, 0xDFD34354},
+       {dbModuleObj, 0x9F568C6F},
+       {dbNetTrackObj, 0x6D3EE435},
+       {dbPolygonObj, 0x110F3173},
+       {dbPowerDomainObj, 0x7352FE40},
+       {dbPowerSwitchObj, 0x7D280800},
+       {dbScanChainObj, 0xBF9698BF},
+       {dbScanInstObj, 0x05CD9D4A},
+       {dbScanListObj, 0xD398101E},
+       {dbScanPartitionObj, 0x534639A0},
+       {dbScanPinObj, 0x2BA03C39},
+       {dbTechLayerObj, 0x4ED3B51C},
+       {dbTechLayerAreaRuleObj, 0x2C0432EB},
+       {dbTechLayerArraySpacingRuleObj, 0x1904C344},
+       {dbTechLayerCornerSpacingRuleObj, 0x598158F4},
+       {dbTechLayerCutClassRuleObj, 0xE1F72282},
+       {dbTechLayerCutEnclosureRuleObj, 0xFFC5F736},
+       {dbTechLayerCutSpacingRuleObj, 0xB78E788B},
+       {dbTechLayerCutSpacingTableDefRuleObj, 0x79DFAE70},
+       {dbTechLayerCutSpacingTableOrthRuleObj, 0xA5373824},
+       {dbTechLayerEolExtensionRuleObj, 0x49B1981B},
+       {dbTechLayerEolKeepOutRuleObj, 0x88B0E445},
+       {dbTechLayerForbiddenSpacingRuleObj, 0x139CF020},
+       {dbTechLayerKeepOutZoneRuleObj, 0x0AD77253},
+       {dbTechLayerMaxSpacingRuleObj, 0xA65D53B9},
+       {dbTechLayerMinCutRuleObj, 0x4BA55CDE},
+       {dbTechLayerMinStepRuleObj, 0x6BE58714},
+       {dbTechLayerSpacingEolRuleObj, 0x49E7A7BD},
+       {dbTechLayerSpacingTablePrlRuleObj, 0xA223F41D},
+       {dbTechLayerTwoWiresForbiddenSpcRuleObj, 0x7C5FB405},
+       {dbTechLayerWidthTableRuleObj, 0x7BF3D392},
+       {dbTechLayerWrongDirSpacingRuleObj, 0xF73FA7DF},
+       // Generator Code End ObjectTypeToHash
+
+       // Lib Objects
+       {dbLibObj, 0x52},
+       {dbGDSLibObj, 0x53},
+       {dbSiteObj, 0x54},
+       {dbMasterObj, 0x55},
+       {dbMPinObj, 0x56},
+       {dbMTermObj, 0x57},
+       {dbTechAntennaPinModelObj, 0x58},
+
+       // Tech Objects
+       {dbTechObj, 0x59},
+       {dbTechViaObj, 0x5A},
+       {dbTechNonDefaultRuleObj, 0x5B},
+       {dbTechLayerRuleObj, 0x5C},
+       {dbTechSameNetRuleObj, 0x5D},
+       {dbTechLayerSpacingRuleObj, 0x5E},
+       {dbTechMinCutRuleObj, 0x5F},
+       {dbTechMinEncRuleObj, 0x60},
+       {dbTechV55InfluenceEntryObj, 0x61},
+       {dbTechLayerAntennaRuleObj, 0x62},
+       {dbTechViaRuleObj, 0x63},
+       {dbTechViaGenerateRuleObj, 0x64},
+       {dbTechViaLayerRuleObj, 0x65},
+
+       {dbPropertyObj, 0x66},
+       {dbNameObj, 0x67}};
+
 const char* dbObject::getTypeName() const
 {
   return name_tbl[getImpl()->getType()];
@@ -182,4 +413,18 @@ bool compare_by_id(const dbObject* lhs, const dbObject* rhs)
   return compare_by_id(lhs_owner, rhs_owner);
 }
 
+dbIStream& operator>>(dbIStream& stream, dbObjectType& type)
+{
+  uint32_t hash;
+  stream >> hash;
+  type = hash_to_object_type.at(hash);
+  return stream;
+}
+
+dbOStream& operator<<(dbOStream& stream, dbObjectType type)
+{
+  stream << object_type_to_hash.at(type);
+  return stream;
+}
+
 }  // namespace odb