From 5bd3dd5fb6f9a582d938eb34ccfd31b5452a8541 Mon Sep 17 00:00:00 2001
From: Cary R <cygcary@yahoo.com>
Date: Wed, 21 Nov 2007 18:22:38 -0800
Subject: [PATCH] Suppress duplicate variable definitions in VCD header.

The LXT and LXT2 formats ignore/work with duplicate variables in
$dumpvars() commands, but VCD output includes extra definitions that
may cause some confusion. This patch checks for duplicates and prints
a warning when they are being suppressed.

It also corrects some error messages in the LXT and LXT2 files to not
reference VCD and some other message cleanup.
---
 vpi/sys_lxt.c  |  4 ++--
 vpi/sys_lxt2.c |  4 ++--
 vpi/sys_vcd.c  | 53 +++++++++++++++++++++++++++++++++++++++++++++++---
 3 files changed, 54 insertions(+), 7 deletions(-)

diff --git a/vpi/sys_lxt.c b/vpi/sys_lxt.c
index 266eae95f..91fe77d92 100644
--- a/vpi/sys_lxt.c
+++ b/vpi/sys_lxt.c
@@ -26,7 +26,7 @@
 # include "sys_priv.h"
 
 /*
- * This file contains the implementations of the VCD related
+ * This file contains the implementations of the LXT related
  * funcitons.
  */
 
@@ -323,7 +323,7 @@ inline static int install_dumpvars_callback(void)
 	    return 0;
 
       if (dumpvars_status == 2) {
-	    vpi_mcd_printf(1, "VCD Error:"
+	    vpi_mcd_printf(1, "LXT warning:"
 			   " $dumpvars ignored,"
 			   " previously called at simtime %lu\n",
 			   dumpvars_time);
diff --git a/vpi/sys_lxt2.c b/vpi/sys_lxt2.c
index 5963d024d..75e08a2e8 100644
--- a/vpi/sys_lxt2.c
+++ b/vpi/sys_lxt2.c
@@ -26,7 +26,7 @@
 # include "sys_priv.h"
 
 /*
- * This file contains the implementations of the VCD related
+ * This file contains the implementations of the LXT2 related
  * funcitons.
  */
 
@@ -324,7 +324,7 @@ inline static int install_dumpvars_callback(void)
 	    return 0;
 
       if (dumpvars_status == 2) {
-	    vpi_mcd_printf(1, "VCD Error:"
+	    vpi_mcd_printf(1, "LXT2 warning:"
 			   " $dumpvars ignored,"
 			   " previously called at simtime %lu\n",
 			   dumpvars_time);
diff --git a/vpi/sys_vcd.c b/vpi/sys_vcd.c
index 7590caff3..edde342eb 100644
--- a/vpi/sys_vcd.c
+++ b/vpi/sys_vcd.c
@@ -144,10 +144,11 @@ static void show_this_item_x(struct vcd_info*info)
 
 
 /*
- * managed qsorted list of scope names for duplicates bsearching
+ * managed qsorted list of scope names/variables for duplicates bsearching
  */
 
 struct vcd_names_list_s vcd_tab = { 0 };
+struct vcd_names_list_s vcd_var = { 0 };
 
 
 static int dumpvars_status = 0; /* 0:fresh 1:cb installed, 2:callback done */
@@ -277,7 +278,7 @@ inline static int install_dumpvars_callback(void)
 	    return 0;
 
       if (dumpvars_status == 2) {
-	    vpi_mcd_printf(1, "VCD Error:"
+	    vpi_mcd_printf(1, "VCD warning:"
 			   " $dumpvars ignored,"
 			   " previously called at simtime %" PLI_UINT64_FMT "\n",
 			   dumpvars_time);
@@ -584,6 +585,14 @@ static void scan_item(unsigned depth, vpiHandle item, int skip)
 	  case vpiTimeVar:
 	  case vpiReg:  type = "reg";    }
 
+	      /* Skip this signal if it has already been included. */
+	    if (vcd_names_search(&vcd_var, vpi_get_str(vpiFullName, item))) {
+		  vpi_printf("VCD warning: skipping signal %s, it was "
+		             "previously included.\n",
+		             vpi_get_str(vpiFullName, item));
+		  break;
+	    }
+
 	    if (skip)
 		  break;
 
@@ -643,6 +652,14 @@ static void scan_item(unsigned depth, vpiHandle item, int skip)
 
 	  case vpiRealVar:
 
+	      /* Skip this signal if it has already been included. */
+	    if (vcd_names_search(&vcd_var, vpi_get_str(vpiFullName, item))) {
+		  vpi_printf("VCD warning: skipping signal %s, it was "
+		             "previously included.\n",
+		             vpi_get_str(vpiFullName, item));
+		  break;
+	    }
+
 	    if (skip)
 		  break;
 
@@ -853,15 +870,45 @@ static PLI_INT32 sys_dumpvars_calltf(PLI_BYTE8*name)
       }
 
       for ( ; item; item = argv ? vpi_scan(argv) : 0x0) {
+	    const char *scname;
+	    int add_var = 0;
+   
+	    vcd_names_sort(&vcd_tab);
+
+	      /* If this is a signal make sure it has not already
+	       * been included. */
+	    switch (vpi_get(vpiType, item)) {
+	        case vpiIntegerVar:
+	        case vpiNet:
+	        case vpiRealVar:
+	        case vpiReg:
+	        case vpiTimeVar:
+		  scname = vpi_get_str(vpiFullName, vpi_handle(vpiScope, item));
+		  if (vcd_names_search(&vcd_tab, scname)) {
+		        vpi_mcd_printf(1, "VCD warning: skipping signal %s, "
+		                       "it was previously included.\n",
+		                       vpi_get_str(vpiFullName, item));
+		        continue;
+		  } else {
+		        add_var = 1;
+		  }
+	    }
 
 	    int dep = draw_scope(item);
 
-	    vcd_names_sort(&vcd_tab);
 	    scan_item(depth, item, 0);
 
 	    while (dep--) {
 		  fprintf(dump_file, "$upscope $end\n");
 	    }
+
+	      /* Add this signal to the variable list so we can verify it
+	       * is not included twice. This must be done after it has
+	       * been added */
+	    if (add_var) {
+		  vcd_names_add(&vcd_var, vpi_get_str(vpiFullName, item));
+		  vcd_names_sort(&vcd_var);
+	    }
       }
 
       return 0;