Merge pull request #8011 from osamahammad21/odb-database-chip

ODB: chip table hash and add a test case

Author: osamahammad21

src/odb/include/odb/db.h

@@ -6935,7 +6935,7 @@ class dbChip : public dbObject
     HIER
   };
 
-  std::string getName() const;
+  const char* getName() const;
 
   void setOffset(Point offset);
 
@@ -6994,6 +6994,8 @@ class dbChip : public dbObject
   bool isTsv() const;
 
   // User Code Begin dbChip
+
+  ChipType getChipType() const;
   ///
   /// Get the top-block of this chip.
   /// Returns nullptr if a top-block has NOT been created.
@@ -7002,10 +7004,11 @@ class dbChip : public dbObject
 
   ///
   /// Create a new chip.
-  /// Returns nullptr if a chip already exists.
   /// Returns nullptr if there is no database technology.
   ///
-  static dbChip* create(dbDatabase* db);
+  static dbChip* create(dbDatabase* db,
+                        const std::string& name = "",
+                        ChipType type = ChipType::DIE);
 
   ///
   /// Translate a database-id back to a pointer.
@@ -7024,7 +7027,11 @@ class dbDatabase : public dbObject
  public:
   dbSet<dbChip> getChips() const;
 
+  dbChip* findChip(const char* name) const;
+
   // User Code Begin dbDatabase
+
+  void setTopChip(dbChip* chip);
   ///
   /// Return the libs contained in the database. A database can contain
   /// multiple libs.

src/odb/src/codeGenerator/gen.py

@@ -20,7 +20,8 @@
     get_hash_table_type,
     get_ref_type,
     get_table_name,
-    get_template_type,
+    is_template_type,
+    get_template_types,
     is_bit_fields,
     is_hash_table,
     is_pass_by_ref,
@@ -55,9 +56,7 @@ def make_parent_field(parent, relation):
     field["table"] = True
     field["dbSetGetter"] = True
     field["components"] = [field["name"]]
-    field["flags"] = ["cmp", "serial", "diff", "no-set", "get"] + relation.get(
-        "flags", []
-    )
+    field["flags"] = ["no-set"] + relation.get("flags", [])
     if "page_size" in relation:
         field["page_size"] = relation["page_size"]
     if "schema" in relation:
@@ -74,10 +73,12 @@ def make_parent_hash_field(parent, relation, parent_field):
     """Adds a hash table field to the parent of a hashed relationsip"""
     field = {}
     field["name"] = parent_field["name"][:-4] + "hash_"
-    field["type"] = "dbHashTable<_" + relation["child"] + ">"
+    page_size_part = f", {relation['page_size']}" if "page_size" in relation else ""
+    field["type"] = f"dbHashTable<_{relation['child']}{page_size_part}>"
     field["components"] = [field["name"]]
     field["table_name"] = parent_field["name"]
-    field["flags"] = ["cmp", "serial", "diff", "no-set", "get"]
+    field["flags"] = ["no-set"]
+    field["flags"].extend(relation.get("flags", []))
     parent["fields"].append(field)
     if "dbHashTable.h" not in parent["h_includes"]:
         parent["h_includes"].append("dbHashTable.h")
@@ -89,7 +90,8 @@ def make_child_next_field(child, relation):
     """Adds a next entry field to the child of a hashed relationsip"""
     inChildNextEntry = {"name": "_next_entry"}
     inChildNextEntry["type"] = "dbId<_" + relation["child"] + ">"
-    inChildNextEntry["flags"] = ["cmp", "serial", "diff", "private", "no-deep"]
+    inChildNextEntry["flags"] = ["private"]
+    inChildNextEntry["flags"].extend(relation.get("flags", []))
     child["fields"].append(inChildNextEntry)
     logging.debug(f"Add hash field {inChildNextEntry['name']} to {relation['child']}")
 
@@ -138,21 +140,20 @@ def add_field_attributes(field, klass, flags_struct, schema):
     #
     # This needs documentation
     #
-    template_class_name = None
-    tmp = get_template_type(field["type"])
-    while tmp is not None:
-        template_class_name = tmp
-        tmp = get_template_type(tmp)
-
-    if template_class_name is not None:
-        if (
-            template_class_name not in klass["declared_classes"]
-            and template_class_name not in std
-            and "no-template" not in field["flags"]
-            and klass["name"] != template_class_name[1:]
-            and klass["name"] + "::" != template_class_name[0 : len(klass["name"]) + 2]
-        ):
-            klass["declared_classes"].append(template_class_name)
+    if is_template_type(field["type"]):
+        for template_class_name in get_template_types(field["type"]):
+            if (
+                template_class_name not in klass["declared_classes"]
+                and template_class_name not in std
+                and not template_class_name.isdigit()
+                and template_class_name != "false"
+                and template_class_name != "true"
+                and "no-template" not in field["flags"]
+                and klass["name"] != template_class_name[1:]
+                and klass["name"] + "::"
+                != template_class_name[0 : len(klass["name"]) + 2]
+            ):
+                klass["declared_classes"].append(template_class_name)
     ####
     ####
     ####

src/odb/src/codeGenerator/helper.py

@@ -132,8 +132,11 @@ def is_hash_table(type_name):
 def get_hash_table_type(type_name):
     if not is_hash_table(type_name) or len(type_name) < 13:
         return None
-
-    return type_name[12:-1] + "*"
+    types = get_template_types(type_name[12:-1])
+    for type in types:
+        if type.find("db") != -1:
+            return type + "*"
+    return None
 
 
 def is_pass_by_ref(type_name):
@@ -148,18 +151,37 @@ def is_set_by_ref(type_name):
     )
 
 
-def _is_template_type(type_name):
+def is_template_type(type_name):
     open_bracket = type_name.find("<")
     if open_bracket == -1:
         return False
-
     closed_bracket = type_name.find(">")
 
     return closed_bracket >= open_bracket
 
 
+def _is_comma_divided(type_name):
+    comma = type_name.find(",")
+    return comma != -1
+
+
+def get_template_types(type_name):
+    # extract all template types from a type name
+    if is_template_type(type_name):
+        return get_template_types(get_template_type(type_name))
+    elif _is_comma_divided(type_name):
+        # split and strip in one line
+        types = [t.strip() for t in type_name.split(",")]
+        for i in range(len(types)):
+            if types[i].isdigit() or types[i] == "true" or types[i] == "false":
+                types.pop(i)
+        return types
+    else:
+        return [type_name]
+
+
 def get_template_type(type_name):
-    if not _is_template_type(type_name):
+    if not is_template_type(type_name):
         return None
     num_brackets = 1
 

src/odb/src/codeGenerator/schema.json

@@ -376,9 +376,10 @@
       "parent":"dbDatabase",
       "child":"dbChip",
       "type":"1_n",
-      "tbl_name":"_chip_tbl",
+      "tbl_name":"chip_tbl_",
       "flags": ["no-serial"],
-      "page_size": 2
+      "page_size": 2,
+      "hash": true
     }
   ]
 }

src/odb/src/codeGenerator/schema/chip/dbChip.json

@@ -19,9 +19,10 @@
   ],
   "fields": [
     {
-      "name": "name_",
-      "type": "std::string",
+      "name": "_name",
+      "type": "char *",
       "schema": "db_schema_chip_extended",
+      "default": "nullptr",
       "flags": ["no-set"]
     },
     {

src/odb/src/db/dbBlock.cpp

@@ -1532,15 +1532,15 @@ dbChip* dbBlock::getChip()
 {
   _dbBlock* block = (_dbBlock*) this;
   _dbDatabase* db = block->getDatabase();
-  _dbChip* chip = db->_chip_tbl->getPtr(block->_chip);
+  _dbChip* chip = db->chip_tbl_->getPtr(block->_chip);
   return (dbChip*) chip;
 }
 
 dbBlock* dbBlock::getParent()
 {
   _dbBlock* block = (_dbBlock*) this;
   _dbDatabase* db = block->getDatabase();
-  _dbChip* chip = db->_chip_tbl->getPtr(block->_chip);
+  _dbChip* chip = db->chip_tbl_->getPtr(block->_chip);
   if (!block->_parent.isValid()) {
     return nullptr;
   }
@@ -1572,7 +1572,7 @@ dbSet<dbBlock> dbBlock::getChildren()
 {
   _dbBlock* block = (_dbBlock*) this;
   _dbDatabase* db = getImpl()->getDatabase();
-  _dbChip* chip = db->_chip_tbl->getPtr(block->_chip);
+  _dbChip* chip = db->chip_tbl_->getPtr(block->_chip);
   return dbSet<dbBlock>(block, chip->_block_itr);
 }
 

src/odb/src/db/dbChip.cpp

@@ -4,8 +4,6 @@
 // Generator Code Begin Cpp
 #include "dbChip.h"
 
-#include <string>
-
 #include "dbBlock.h"
 #include "dbBlockItr.h"
 #include "dbDatabase.h"
@@ -22,7 +20,7 @@ template class dbTable<_dbChip>;
 
 bool _dbChip::operator==(const _dbChip& rhs) const
 {
-  if (name_ != rhs.name_) {
+  if (_name != rhs._name) {
     return false;
   }
   if (type_ != rhs.type_) {
@@ -76,6 +74,9 @@ bool _dbChip::operator==(const _dbChip& rhs) const
   if (*_prop_tbl != *rhs._prop_tbl) {
     return false;
   }
+  if (_next_entry != rhs._next_entry) {
+    return false;
+  }
 
   // User Code Begin ==
   if (*_block_tbl != *rhs._block_tbl) {
@@ -99,6 +100,7 @@ bool _dbChip::operator<(const _dbChip& rhs) const
 
 _dbChip::_dbChip(_dbDatabase* db)
 {
+  _name = nullptr;
   type_ = 0;
   offset_ = {};
   width_ = 0;
@@ -131,7 +133,7 @@ _dbChip::_dbChip(_dbDatabase* db)
 dbIStream& operator>>(dbIStream& stream, _dbChip& obj)
 {
   if (obj.getDatabase()->isSchema(db_schema_chip_extended)) {
-    stream >> obj.name_;
+    stream >> obj._name;
   }
   if (obj.getDatabase()->isSchema(db_schema_chip_extended)) {
     stream >> obj.type_;
@@ -183,14 +185,17 @@ dbIStream& operator>>(dbIStream& stream, _dbChip& obj)
   stream >> *obj._block_tbl;
   stream >> *obj._prop_tbl;
   stream >> *obj._name_cache;
+  if (obj.getDatabase()->isSchema(db_schema_chip_hash_table)) {
+    stream >> obj._next_entry;
+  }
   // User Code End >>
   return stream;
 }
 
 dbOStream& operator<<(dbOStream& stream, const _dbChip& obj)
 {
   dbOStreamScope scope(stream, "dbChip");
-  stream << obj.name_;
+  stream << obj._name;
   stream << obj.type_;
   stream << obj.offset_;
   stream << obj.width_;
@@ -211,6 +216,7 @@ dbOStream& operator<<(dbOStream& stream, const _dbChip& obj)
   stream << *obj._block_tbl;
   stream << NamedTable("prop_tbl", obj._prop_tbl);
   stream << *obj._name_cache;
+  stream << obj._next_entry;
   // User Code End <<
   return stream;
 }
@@ -244,6 +250,9 @@ void _dbChip::collectMemInfo(MemInfo& info)
 
 _dbChip::~_dbChip()
 {
+  if (_name) {
+    free((void*) _name);
+  }
   delete _prop_tbl;
   // User Code Begin Destructor
   delete _block_tbl;
@@ -259,10 +268,10 @@ _dbChip::~_dbChip()
 //
 ////////////////////////////////////////////////////////////////////
 
-std::string dbChip::getName() const
+const char* dbChip::getName() const
 {
   _dbChip* obj = (_dbChip*) this;
-  return obj->name_;
+  return obj->_name;
 }
 
 void dbChip::setOffset(Point offset)
@@ -448,6 +457,13 @@ bool dbChip::isTsv() const
 }
 
 // User Code Begin dbChipPublicMethods
+
+dbChip::ChipType dbChip::getChipType() const
+{
+  _dbChip* obj = (_dbChip*) this;
+  return (dbChip::ChipType) obj->type_;
+}
+
 dbBlock* dbChip::getBlock()
 {
   _dbChip* chip = (_dbChip*) this;
@@ -459,31 +475,35 @@ dbBlock* dbChip::getBlock()
   return (dbBlock*) chip->_block_tbl->getPtr(chip->_top);
 }
 
-dbChip* dbChip::create(dbDatabase* db_)
+dbChip* dbChip::create(dbDatabase* db_, const std::string& name, ChipType type)
 {
   _dbDatabase* db = (_dbDatabase*) db_;
-
-  if (db->_chip != 0) {
-    return nullptr;
+  _dbChip* chip = db->chip_tbl_->create();
+  chip->_name = safe_strdup(name.c_str());
+  chip->type_ = (uint) type;
+  if (db->_chip == 0) {
+    db->_chip = chip->getOID();
   }
-
-  _dbChip* chip = db->_chip_tbl->create();
-  db->_chip = chip->getOID();
+  db->chip_hash_.insert(chip);
   return (dbChip*) chip;
 }
 
 dbChip* dbChip::getChip(dbDatabase* db_, uint dbid_)
 {
   _dbDatabase* db = (_dbDatabase*) db_;
-  return (dbChip*) db->_chip_tbl->getPtr(dbid_);
+  return (dbChip*) db->chip_tbl_->getPtr(dbid_);
 }
 
 void dbChip::destroy(dbChip* chip_)
 {
   _dbChip* chip = (_dbChip*) chip_;
   _dbDatabase* db = chip->getDatabase();
+  if (db->_chip == chip->getOID()) {
+    db->_chip = 0;
+  }
   dbProperty::destroyProperties(chip);
-  db->_chip_tbl->destroy(chip);
+  db->chip_hash_.remove(chip);
+  db->chip_tbl_->destroy(chip);
   db->_chip = 0;
 }
 // User Code End dbChipPublicMethods