Issue chipsalliance#859: vpiModule & vpiInterface are part of standard

Follow up to a previous change where vpiModule & vpiInterface were renamed to vpiModuleInst & vpiInterfaceInst, respectively. This is flawed and doesn't meet the vpi standard. Reverting the names back to vpiModule & vpiInterface. However, the classes generated against the models remain named module_inst & interface_inst.
hs-apotell · Jan 15, 2023 · f40dead · f40dead
1 parent be2f18d
commit f40dead
Show file tree

Hide file tree

Showing 24 changed files with 88 additions and 81 deletions.
diff --git a/include/sv_vpi_user.h b/include/sv_vpi_user.h
@@ -33,7 +33,7 @@ extern "C" {
 
 /****************************** OBJECT TYPES ******************************/
 #define vpiPackage                            600
-#define vpiInterfaceInst                      601
+#define vpiInterface                          601
 #define vpiProgram                            602
 #define vpiInterfaceArray                     603
 #define vpiProgramArray                       604

diff --git a/include/vpi_user.h b/include/vpi_user.h
@@ -151,7 +151,7 @@ typedef PLI_UINT32 *vpiHandle;
 #define vpiMemory             29   /* behavioral memory */
 #define vpiMemoryWord         30   /* single word of memory */
 #define vpiModPath            31   /* module path for path delays */
-#define vpiModuleInst         32   /* module instance */
+#define vpiModule             32   /* module instance */
 #define vpiNamedBegin         33   /* named block statement */
 #define vpiNamedEvent         34   /* event variable */
 #define vpiNamedFork          35   /* named fork-join block */

diff --git a/model/design.yaml b/model/design.yaml
@@ -51,7 +51,7 @@
     card: any
   - class: allInterfaces
     type: interface_inst
-    vpi_obj: vpiInterfaceInst
+    vpi_obj: vpiInterface
     vpi: uhdmallInterfaces
     card: any
   - class: allUdps
@@ -66,7 +66,7 @@
     card: any
   - class: allModules
     type: module_inst
-    vpi_obj: vpiModuleInst
+    vpi_obj: vpiModule
     vpi: uhdmallModules
     card: any
   - class_ref: typespecs
@@ -95,6 +95,6 @@
     card: any
   - class: topModules
     type: module_inst
-    vpi_obj: vpiModuleInst
+    vpi_obj: vpiModule
     vpi: uhdmtopModules
     card: any
diff --git a/model/gen_scope.yaml b/model/gen_scope.yaml
@@ -58,7 +58,7 @@
     card: any
   - obj_ref: modules
     name: modules
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: any
   - obj_ref: module_arrays
@@ -102,7 +102,7 @@
     card: any
   - obj_ref: interfaces
     name: interface_inst
-    vpi: vpiInterfaceInst
+    vpi: vpiInterface
     type: interface_inst
     card: any
   - obj_ref: interface_arrays

diff --git a/model/instance.yaml b/model/instance.yaml
@@ -138,7 +138,7 @@
     card: any
   - obj_ref: module_inst
     name: module_inst
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: 1
   - class_ref: instance

diff --git a/model/instance_array.yaml b/model/instance_array.yaml
@@ -57,7 +57,7 @@
     card: any
   - obj_ref: modules
     name: modules
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: any
   - class_ref: elem_typespec

diff --git a/model/interface_inst.yaml b/model/interface_inst.yaml
@@ -22,7 +22,7 @@
     type: int
     card: 1
   - property: type
-    name: vpiInterfaceInst
+    name: vpiInterface
     vpi: vpiType
     type: unsigned int
     card: 1
@@ -72,7 +72,7 @@
     card: any  
   - obj_ref: interfaces
     name: interface_inst
-    vpi: vpiInterfaceInst
+    vpi: vpiInterface
     type: interface_inst
     card: any
   - obj_ref: interface_arrays

diff --git a/model/modport.yaml b/model/modport.yaml
@@ -27,6 +27,6 @@
     card: any
   - obj_ref: interface_inst
     name: interface_inst
-    vpi: vpiInterfaceInst
+    vpi: vpiInterface
     type: interface_inst
     card: 1
diff --git a/model/module_inst.yaml b/model/module_inst.yaml
@@ -22,7 +22,7 @@
     type: int
     card: 1
   - property: type
-    name: vpiModuleInst
+    name: vpiModule
     vpi: vpiType
     type: unsigned int
     card: 1
@@ -68,7 +68,7 @@
     card: any
   - obj_ref: interfaces
     name: interface_inst
-    vpi: vpiInterfaceInst
+    vpi: vpiInterface
     type: interface_inst
     card: any
   - obj_ref: interface_arrays
@@ -83,7 +83,7 @@
     card: any
   - obj_ref: modules
     name: modules
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: any
   - obj_ref: module_arrays

diff --git a/model/nets.yaml b/model/nets.yaml
@@ -158,6 +158,6 @@
     card: 1
   - obj_ref: module_inst
     name: module_inst
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: 1
diff --git a/model/ports.yaml b/model/ports.yaml
@@ -82,6 +82,6 @@
     card: 1
   - obj_ref: module_inst
     name: module_inst
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: 1
diff --git a/model/process_stmt.yaml b/model/process_stmt.yaml
@@ -22,7 +22,7 @@
     card: 1
   - obj_ref: module_inst
     name: module_inst
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: 1
   - obj_ref: attributes

diff --git a/model/program.yaml b/model/program.yaml
@@ -38,7 +38,7 @@
     card: 1
   - obj_ref: interfaces
     name: interface_inst
-    vpi: vpiInterfaceInst
+    vpi: vpiInterface
     type: interface_inst
     card: any
   - group_ref: expr_dist

diff --git a/model/tchk.yaml b/model/tchk.yaml
@@ -18,7 +18,7 @@
   - obj_ref: module_inst
     name: module_inst
     type: module_inst
-    vpi: vpiModuleInst
+    vpi: vpiModule
     card: 1
   - class_ref: expr
     name: expr

diff --git a/model/test.yaml b/model/test.yaml
@@ -27,12 +27,12 @@
     vpi: vpiTopModule
     card: 1
   - obj_ref: modules
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: any
 
 - obj_def: design
   - class: uhdmAllModules
     type: module_inst
-    vpi_obj: vpiModuleInst
+    vpi_obj: vpiModule
     card: any
diff --git a/model/variables.yaml b/model/variables.yaml
@@ -118,7 +118,7 @@
     card: 1
   - obj_ref: module_inst
     name: module_inst
-    vpi: vpiModuleInst
+    vpi: vpiModule
     type: module_inst
     card: 1
   - class_ref: instance

diff --git a/scripts/VpiListener.py b/scripts/VpiListener.py
@@ -6,8 +6,8 @@ def _get_listeners(classname, vpi, type, card):
     listeners = []
 
     if card == '1':
-        # upward vpiModuleInst, vpiInterfaceInst relation (when card == 1, pointing to the parent object) creates loops in visitors
-        if vpi in ['vpiParent', 'vpiInstance', 'vpiModuleInst', 'vpiInterfaceInst', 'vpiUse', 'vpiProgram', 'vpiClassDefn', 'vpiPackage', 'vpiUdp']:
+        # upward vpiModule, vpiInterface relation (when card == 1, pointing to the parent object) creates loops in visitors
+        if vpi in ['vpiParent', 'vpiInstance', 'vpiModule', 'vpiInterface', 'vpiUse', 'vpiProgram', 'vpiClassDefn', 'vpiPackage', 'vpiUdp']:
             return listeners
 
         if 'func_call' in classname and vpi == 'vpiFunction':

diff --git a/scripts/config.py b/scripts/config.py
@@ -111,6 +111,11 @@ def get_modellist_filepath():
 
 
 def make_vpi_name(classname):
+    classname_overrides = {
+      'module_inst': 'module',
+      'interface_inst': 'interface'
+    }
+    classname = classname_overrides.get(classname, classname)
     vpiclasstype = f'vpi{classname[:1].upper()}{classname[1:]}'
 
     underscore = False
@@ -125,7 +130,7 @@ def make_vpi_name(classname):
         else:
             vpiclasstype += ch
 
-    overrides = {
+    vpiname_overrides = {
       'vpiForkStmt': 'vpiFork',
       'vpiForStmt': 'vpiFor',
       'vpiIoDecl': 'vpiIODecl',
@@ -149,4 +154,4 @@ def make_vpi_name(classname):
       'vpiSwitchTran': 'vpiSwitch',
     }
 
-    return overrides.get(vpiclasstype, vpiclasstype)
+    return vpiname_overrides.get(vpiclasstype, vpiclasstype)
diff --git a/scripts/vpi_visitor_cpp.py b/scripts/vpi_visitor_cpp.py
@@ -9,7 +9,7 @@ def _get_implementation(classname, vpi, card):
     if card == '1':
         shallow_visit = 'false'
 
-        if vpi in ['vpiParent', 'vpiInstance', 'vpiModuleInst', 'vpiInterfaceInst', 'vpiUse', 'vpiProgram', 'vpiClassDefn', 'vpiPackage', 'vpiUdp']:
+        if vpi in ['vpiParent', 'vpiInstance', 'vpiModule', 'vpiInterface', 'vpiUse', 'vpiProgram', 'vpiClassDefn', 'vpiPackage', 'vpiUdp']:
             # Prevent walking upwards and makes the UHDM output cleaner
             # Prevent loop in Standard VPI
             shallow_visit = 'true'