From a16f5bc7090e8acdce72a9c9b1fcb3343256d5b0 Mon Sep 17 00:00:00 2001
From: Cary R <cygcary@yahoo.com>
Date: Sun, 30 Dec 2007 12:19:36 -0800
Subject: [PATCH] Update driver-vpi/* to match iverilog-vpi.sh

This patch updates the MinGW C version of iverilog-vpi to match the
shell version. This allows the vpi tests in the test suite to be run.
---
 driver-vpi/Makefile.in |  13 +-
 driver-vpi/config.h.in |   8 ++
 driver-vpi/main.c      | 279 +++++++++++++++++++++++++----------------
 iverilog-vpi.sh        |   2 +-
 4 files changed, 190 insertions(+), 112 deletions(-)
 create mode 100644 driver-vpi/config.h.in

diff --git a/driver-vpi/Makefile.in b/driver-vpi/Makefile.in
index 78c50a860..d166d562f 100644
--- a/driver-vpi/Makefile.in
+++ b/driver-vpi/Makefile.in
@@ -16,12 +16,12 @@
 #    59 Temple Place - Suite 330
 #    Boston, MA 02111-1307, USA
 #
-#ident "$Id: Makefile.in,v 1.7 2004/10/13 22:01:34 steve Exp $"
+#ident "$Id: Makefile.in,v 1.7.2.1 2006/10/04 17:08:59 steve Exp $"
 #
 #
 SHELL = /bin/sh
 
-VERSION = 0.8
+VERSION = 0.8.3
 
 prefix = @prefix@
 exec_prefix = @exec_prefix@
@@ -48,7 +48,7 @@ LDFLAGS = @LDFLAGS@
 all: iverilog-vpi@EXEEXT@
 
 clean:
-	rm -f *.o
+	rm -f *.o config.h
 	rm -f iverilog-vpi@EXEEXT@
 
 distclean: clean
@@ -60,9 +60,14 @@ iverilog-vpi@EXEEXT@: $O
 	$(CC) $(LDFLAGS) $O -o iverilog-vpi@EXEEXT@ @EXTRALIBS@
 
 
-main.o: main.c
+main.o: main.c config.h
 	$(CC) $(CPPFLAGS) $(CFLAGS) -c $(srcdir)/main.c
 
+config.h: config.h.in
+	sed -e 's;@IVLCC@;@CC@;' -e 's;@IVLCXX@;@CXX@;' \
+	    -e 's;@IVLCFLAGS@;@CXXFLAGS@;' \
+	    -e 's;@SHARED@;@shared@;' $< > $@
+
 # Windows specific...
 res.o: res.rc
 	windres -i res.rc -o res.o
diff --git a/driver-vpi/config.h.in b/driver-vpi/config.h.in
new file mode 100644
index 000000000..ca1005555
--- /dev/null
+++ b/driver-vpi/config.h.in
@@ -0,0 +1,8 @@
+/* For now do not put the Icarus Verilog include or library paths here.
+ * They are generated from a registry entry the user must set (-ivl=).
+ * This may change in the future once I have thought about it more. */
+#define IVERILOG_VPI_CC        "@IVLCC@"
+#define IVERILOG_VPI_CXX       "@IVLCXX@"
+#define IVERILOG_VPI_CFLAGS    " @IVLCFLAGS@"
+#define IVERILOG_VPI_LDFLAGS   "@SHARED@"
+#define IVERILOG_VPI_LDLIBS    "-lveriuser -lvpi"
diff --git a/driver-vpi/main.c b/driver-vpi/main.c
index df325f8e9..9facd443e 100644
--- a/driver-vpi/main.c
+++ b/driver-vpi/main.c
@@ -32,28 +32,27 @@
 
 #include <windows.h>
 
-/* Macros used for compiling and linking */
+static void setup_ivl_environment();
 
-#define IVERILOG_VPI_CC        "gcc"				/* no .exe extension  */
-#define IVERILOG_VPI_CXX       "gcc"				/* no .exe extension  */
-#define IVERILOG_VPI_CFLAGS    "-O"					/* -I appended  later */
-#define IVERILOG_VPI_LD        "gcc"				/* no .exe extension  */
-#define IVERILOG_VPI_LDFLAGS   "-shared -Wl,--enable-auto-image-base"
-#define IVERILOG_VPI_LDLIBS    "-lveriuser -lvpi"	/* -L prepended later */
+/* The compile options: compiler, flags, etc. are in here */
+#include "config.h"
 
 /* pointers to global strings */
 
 static struct global_strings {
-	char *pCCSRC;		/* list of C source files */
-	char *pCXSRC;		/* list of C++ source files */
+	char *pCCSRC;		/* list of C source files (*.c) */
+	char *pCXSRC;		/* list of C++ source files (*.cc, *.cpp) */
 	char *pOBJ;			/* list of object files */
 	char *pLIB;			/* list of library files */
+	char *pINCS;			/* list of include directories */
+	char *pDEFS;			/* list of definitions */
 	char *pOUT;			/* output file name (.vpi extension), if 0 length then no source files specified */
 	char *pMINGW;		/* path to MinGW directory */
 	char *pIVL;			/* path to IVL directory */
 	char *pCFLAGS;		/* CFLAGS option */
 	char *pLDLIBS;		/* LDLIBS option */
 	char *pNewPath;		/* new PATH environment variable setting */
+	char *pLD;		/* what to use for a linker */
 } gstr;
 
 
@@ -70,6 +69,8 @@ static void myExit(int exitVal)
 	deInitDynString(gstr.pCXSRC);
 	deInitDynString(gstr.pOBJ);
 	deInitDynString(gstr.pLIB);
+	deInitDynString(gstr.pINCS);
+	deInitDynString(gstr.pDEFS);
 	deInitDynString(gstr.pOUT);
 	deInitDynString(gstr.pMINGW);
 	deInitDynString(gstr.pIVL);
@@ -84,7 +85,7 @@ static void myExit(int exitVal)
 
 static void usage()
 {
-	fprintf(stderr,"usage: iverilog-vpi [--name=name] [-llibrary] [-mingw=dir] [-ivl=dir] sourcefile...\n");
+	fprintf(stderr,"usage: iverilog-vpi [src and obj files]...\n");
 	fprintf(stderr,"   or  iverilog-vpi -mingw=dir\n");
 	fprintf(stderr,"   or  iverilog-vpi -ivl=dir\n");
 	myExit(1);
@@ -110,12 +111,16 @@ static void init()
 	initDynString(&gstr.pCXSRC);
 	initDynString(&gstr.pOBJ);
 	initDynString(&gstr.pLIB);
+	initDynString(&gstr.pINCS);
+	initDynString(&gstr.pDEFS);
 	initDynString(&gstr.pOUT);
 	initDynString(&gstr.pMINGW);
 	initDynString(&gstr.pIVL);
 	initDynString(&gstr.pCFLAGS);
 	initDynString(&gstr.pLDLIBS);
 	initDynString(&gstr.pNewPath);
+	  /* By default use the C compiler to link the programs. */
+	gstr.pLD = IVERILOG_VPI_CC;
 }
 
 /* return true if "str" is terminated with with "end", case insensitive */
@@ -281,67 +286,120 @@ static int parse(int argc, char *argv[])
 	char dot_o_ext[]    = ".o";
 	char name_option[]  = "--name=";
 	char lib_option[]   = "-l";
+	char inc_option[]   = "-I";
 	char mingw_option[] = "-mingw=";
 	char ivl_option[]   = "-ivl=";
+	char def_option[]   = "-D";
 
-	if (argc == 1)
-		return 0;
+	if (argc == 1) return 0;
 
 	for (idx=1; idx<argc; ++idx) {
-		if (endsIn(dot_c_ext,argv[idx])) {				/* check for C source files */
+		  /* Check for C source files (*.c) */
+		if (endsIn(dot_c_ext, argv[idx])) {
 			++srcFileCnt;
-			append(&gstr.pCCSRC,argv[idx]);
-			append(&gstr.pCCSRC," ");
+			append(&gstr.pCCSRC, argv[idx]);
+			append(&gstr.pCCSRC, " ");
 			if (!*gstr.pOUT)
-			   assignn(&gstr.pOUT,argv[idx],strlen(argv[idx])-strlen(dot_c_ext));
+			   assignn(&gstr.pOUT, argv[idx],
+			           strlen(argv[idx])-strlen(dot_c_ext));
 		}
-		else if (endsIn(dot_cc_ext,argv[idx])) {		/* check for C++ source files */
+		  /* Check for C++ source files (*.cc) */
+		else if (endsIn(dot_cc_ext, argv[idx])) {
+			  /* We need to link with the C++ compiler. */
+			gstr.pLD = IVERILOG_VPI_CXX;
 			++srcFileCnt;
-			append(&gstr.pCXSRC,argv[idx]);
-			append(&gstr.pCXSRC," ");
+			append(&gstr.pCXSRC, argv[idx]);
+			append(&gstr.pCXSRC, " ");
 			if (!*gstr.pOUT)
-			   assignn(&gstr.pOUT,argv[idx],strlen(argv[idx])-strlen(dot_cc_ext));
+			   assignn(&gstr.pOUT, argv[idx],
+			           strlen(argv[idx])-strlen(dot_cc_ext));
 		}
-		else if (endsIn(dot_cpp_ext,argv[idx])) {		/* check for C++ source files */
+		  /* Check for C++ source files (*.cpp) */
+		else if (endsIn(dot_cpp_ext, argv[idx])) {
+			  /* We need to link with the C++ compiler. */
+			gstr.pLD = IVERILOG_VPI_CXX;
 			++srcFileCnt;
-			append(&gstr.pCXSRC,argv[idx]);
-			append(&gstr.pCXSRC," ");
+			append(&gstr.pCXSRC, argv[idx]);
+			append(&gstr.pCXSRC, " ");
 			if (!*gstr.pOUT)
-			   assignn(&gstr.pOUT,argv[idx],strlen(argv[idx])-strlen(dot_cpp_ext));
+			   assignn(&gstr.pOUT, argv[idx],
+			           strlen(argv[idx])-strlen(dot_cpp_ext));
 		}
-		else if (endsIn(dot_o_ext,argv[idx])) {			/* check for compiled object files */
+		  /* Check for compiled object files */
+		else if (endsIn(dot_o_ext, argv[idx])) {
 			++srcFileCnt;
-			append(&gstr.pOBJ,argv[idx]);
 			append(&gstr.pOBJ," ");
+			append(&gstr.pOBJ, argv[idx]);
 			if (!*gstr.pOUT)
-			   assignn(&gstr.pOUT,argv[idx],strlen(argv[idx])-strlen(dot_o_ext));
+			   assignn(&gstr.pOUT, argv[idx],
+			           strlen(argv[idx])-strlen(dot_o_ext));
 		}
-		else if (startsWith(name_option,argv[idx])) {	/* check for --name option */
-			assignn(&gstr.pOUT,argv[idx]+sizeof(name_option)-1,strlen(argv[idx])-(sizeof(name_option)-1));
+		  /* Check for the --name option */
+		else if (startsWith(name_option, argv[idx])) {
+			assignn(&gstr.pOUT, argv[idx]+sizeof(name_option)-1,
+			        strlen(argv[idx])-(sizeof(name_option)-1));
 		}
-		else if (startsWith(lib_option,argv[idx])) {	/* check for -l option */
-			append(&gstr.pLIB,argv[idx]);
-			append(&gstr.pLIB," ");
+		  /* Check for the -l option */
+		else if (startsWith(lib_option, argv[idx])) {
+			append(&gstr.pLIB, " ");
+			append(&gstr.pLIB, argv[idx]);
 		}
-		else if (startsWith(mingw_option,argv[idx]))	/* check for -mingw option */
-			assignn(&gstr.pMINGW,argv[idx]+sizeof(mingw_option)-1,strlen(argv[idx])-(sizeof(mingw_option)-1));
-		else if (startsWith(ivl_option,argv[idx]))		/* check for -ivl   option */
-			assignn(&gstr.pIVL,argv[idx]+sizeof(ivl_option)-1,strlen(argv[idx])-(sizeof(ivl_option)-1));
-		else
-			return 0;	/* different from iverilog-vpi.sh, we don't ignore accept arguments */
+		  /* Check for the -I option */
+		else if (startsWith(inc_option, argv[idx])) {
+			append(&gstr.pINCS, " ");
+			append(&gstr.pINCS, argv[idx]);
+		}
+		  /* Check for the -D option */
+		else if (startsWith(def_option, argv[idx])) {
+			append(&gstr.pDEFS, " ");
+			append(&gstr.pDEFS, argv[idx]);
+		}
+		  /* Check for the -mingw option */
+		else if (startsWith(mingw_option, argv[idx]))
+			assignn(&gstr.pMINGW, argv[idx]+sizeof(mingw_option)-1,
+			        strlen(argv[idx])-(sizeof(mingw_option)-1));
+		  /* Check for the -ivl   option */
+		else if (startsWith(ivl_option, argv[idx]))
+			assignn(&gstr.pIVL, argv[idx]+sizeof(ivl_option)-1,
+			        strlen(argv[idx])-(sizeof(ivl_option)-1));
+		  /* Check for the --cflags option */
+		else if (stricmp("--cflags", argv[idx]) == 0) {
+			setup_ivl_environment();
+			printf("%s\n", gstr.pCFLAGS);
+			myExit(0);
+		}
+		  /* Check for the --ldflags option */
+		else if (stricmp("--ldflags", argv[idx]) == 0) {
+			printf("%s\n", IVERILOG_VPI_LDFLAGS);
+			myExit(0);
+		}
+		  /* Check for the --ldlibs option */
+		else if (stricmp("--ldlibs", argv[idx]) == 0) {
+			setup_ivl_environment();
+			printf("%s\n", gstr.pLDLIBS);
+			myExit(0);
+		}
+		  /* Check for the --install-dir option */
+		else if (stricmp("--install-dir", argv[idx]) == 0) {
+			setup_ivl_environment();
+			printf("%s\\\\lib\\\\ivl\\\\.\n", gstr.pIVL);
+			myExit(0);
+		}
+		  /* This is different than iverilog-vpi.sh, we don't
+		   * ignore unknown arguments */
+		else return 0;
 	}
 
-	if (0 == srcFileCnt)
-		assign(&gstr.pOUT,"");				/* in case they used --name with no source files */
+	  /* In case there is a --name without source/object files */
+	if (0 == srcFileCnt) assign(&gstr.pOUT,"");
 
-	if (!*gstr.pOUT) {						/* normally it's an error if there are no *.c,*.cc,*.o files */
-		if (!*gstr.pMINGW && !*gstr.pIVL)	/* unless they are just setting the IVL or MinGW registry entries */
-			usage();
-	}
-	else {
-		append(&gstr.pOUT,".vpi");			/* the result file should have a .vpi extension */
-		append(&gstr.pOUT," ");
-	}
+	  /* Normally it's an error if there are no source or object files */
+	  /* Unless we are setting the IVL or MinGW registry entries */
+	if (!*gstr.pOUT) {
+		if (!*gstr.pMINGW && !*gstr.pIVL) return 0;
+	} else
+		  /* We have a valid result file so add the .vpi extension */
+		append(&gstr.pOUT, ".vpi");
 
 	return 1;
 }
@@ -411,9 +469,7 @@ static void setup_mingw_environment()
 	if (*gstr.pMINGW) {
 		checkMingwDir(gstr.pMINGW);
 		SetRegistryKey(IVL_REGKEY_MINGW,gstr.pMINGW);
-	}
-	else
-		if (!GetRegistryKey(IVL_REGKEY_MINGW,&gstr.pMINGW)) {
+	} else if (!GetRegistryKey(IVL_REGKEY_MINGW,&gstr.pMINGW)) {
 			fprintf(stderr,"error: can not locate the MinGW root directory, use the -mingw option of\n");
 			fprintf(stderr,"       iverilog-vpi.exe to point to the MinGW root directory.  For\n");
 			fprintf(stderr,"       a Windows command shell the option would be something like\n");
@@ -422,13 +478,15 @@ static void setup_mingw_environment()
 			myExit(5);
 		}
 
-	assign(&gstr.pNewPath,"PATH=");			/* create new path */
+	  /* Create new path with MinGW in it */
+	assign(&gstr.pNewPath,"PATH=");
 	append(&gstr.pNewPath,gstr.pMINGW);
 	appendBackSlash(&gstr.pNewPath);
 	append(&gstr.pNewPath,"bin;");
 	append(&gstr.pNewPath,pOldPATH);
 
-	_putenv(gstr.pNewPath);					/* place new path in environment variable */
+	  /* Place new path in environment */
+	_putenv(gstr.pNewPath);
 }
 
 /* see if we can find iverilog root */
@@ -440,9 +498,7 @@ static void setup_ivl_environment()
 	if (*gstr.pIVL) {
 		checkIvlDir(gstr.pIVL);
 		SetRegistryKey(IVL_REGKEY_IVL,gstr.pIVL);
-	}
-	else
-		if (!GetRegistryKey(IVL_REGKEY_IVL,&gstr.pIVL)) {
+	} else if (!GetRegistryKey(IVL_REGKEY_IVL,&gstr.pIVL)) {
 			fprintf(stderr,"error: can not locate the Icarus Verilog root directory, use the -ivl option\n");
 			fprintf(stderr,"       of iverilog-vpi.exe to point to the Icarus Verilog root directory.\n");
 			fprintf(stderr,"       For a Windows command shell the option would be something like\n");
@@ -451,16 +507,14 @@ static void setup_ivl_environment()
 			myExit(6);
 		}
 
-	/* build up the CFLAGS option string */
-
+	  /* Build up the CFLAGS option string */
 	assign(&gstr.pCFLAGS,IVERILOG_VPI_CFLAGS);
 	append(&gstr.pCFLAGS," -I");
 	append(&gstr.pCFLAGS,gstr.pIVL);
 	appendBackSlash(&gstr.pCFLAGS);
 	append(&gstr.pCFLAGS,"include");
 
-	/* build up the LDFLAGS option string */
-
+	  /* Build up the LDFLAGS option string */
 	assign(&gstr.pLDLIBS,"-L");
 	append(&gstr.pLDLIBS,gstr.pIVL);
 	appendBackSlash(&gstr.pLDLIBS);
@@ -470,37 +524,47 @@ static void setup_ivl_environment()
 
 /* compile source modules */
 
-static void compile(char *pSource, char **pObject, char *ext, int *compile_errors, char *compiler)
+static void compile(char *pSource, char **pObject, int *compile_errors, char *compiler)
 {
 	char *ptr1 = pSource;
-	char *ptr2 = strchr(pSource,' ');
-	char *buf=0,*src=0,*obj=0;
+	char *ptr2 = strchr(ptr1, ' ');
+	char *buf=0, *src=0, *obj=0;
 
 	while (ptr2) {
 		int len = ptr2 - ptr1;
-		assignn(&src,ptr1,len);
+		char *ostart;
+		int olen;
+		assignn(&src, ptr1, len);
 
-		assignn(&obj,ptr1,len-strlen(ext));		/* strip off the extension */
-		append (&obj,".o");
+		  /* Build the object file name */
+		ostart = strrchr(ptr1, '/') + 1;
+		olen = strrchr(ptr1, '.') - ostart;
+		assignn(&obj, ostart, olen);
+		append(&obj, ".o");
 
-		assign (&buf,compiler);
-		append (&buf," -c -o ");
-		append (&buf,obj);
-		append (&buf," ");
-		append (&buf,gstr.pCFLAGS);
-		append (&buf," ");
-		append (&buf,src);
+		  /* Build the compile line */
+		assign(&buf, compiler);
+		append(&buf, " -c -o ");
+		append(&buf, obj);
+		append(&buf, " ");
+		append(&buf, gstr.pDEFS);
+		append(&buf, " ");
+		append(&buf, gstr.pCFLAGS);
+		append(&buf, " ");
+		append(&buf, gstr.pINCS);
+		append(&buf, " ");
+		append(&buf, src);
 
-		append (pObject,obj);
-		append (pObject," ");
+		append (pObject, " ");
+		append (pObject, obj);
 
-		printf("%s\n",buf);
+		printf("Compiling %s...\n", src);
 
-		if (system(buf))
-			++*compile_errors;
+		if (system(buf)) ++*compile_errors;
 
-		ptr1 = ptr2 + 1;					/* advance to next token */
-		ptr2 = strchr(ptr1,' ');
+		  /* advance to next token */
+		ptr1 = ptr2 + 1;
+		ptr2 = strchr(ptr1, ' ');
 	}
 
 	free(buf);
@@ -515,43 +579,44 @@ static void compile_and_link()
 	char *buf=0;
 	int iRet, compile_errors = 0;
 
-	/* print out the mingw and ivl directories to help the user debug problems */
+	  /* To make the output match iverilog-vpi.sh do not print out the
+	   * root directories */
 
-	printf("info:  %s will be used as the MinGW root directory.\n",gstr.pMINGW);
+//	printf("MinGW root directory:  %s.\n", gstr.pMINGW);
 	checkMingwDir(gstr.pMINGW);
 
-	printf("info:  %s will be used as the Icarus Verilog root directory.\n",gstr.pIVL);
+//	printf("Icarus Verilog root directory:  %s.\n", gstr.pIVL);
 	checkIvlDir(gstr.pIVL);
 
-	/* compile */
-
-	compile(gstr.pCCSRC,&gstr.pOBJ,".c" ,&compile_errors,IVERILOG_VPI_CC );		/* compile the C   source files */
-	compile(gstr.pCXSRC,&gstr.pOBJ,".cc",&compile_errors,IVERILOG_VPI_CXX);		/* compile the C++ source files */
+	  /* compile the C source files (*.c) */
+	compile(gstr.pCCSRC, &gstr.pOBJ, &compile_errors, IVERILOG_VPI_CC );
+	  /* compile the C++ source files (*.cc, *.cpp) */
+	compile(gstr.pCXSRC, &gstr.pOBJ, &compile_errors, IVERILOG_VPI_CXX);
 
 	if (compile_errors) {
-		fprintf(stderr,"iverilog-vpi: Some %d files failed to compile.\n",compile_errors);
+		fprintf(stderr,"iverilog-vpi: %d file(s) failed to compile.\n",
+		        compile_errors);
 		myExit(2);
 	}
 
-	/* link */
+	  /* link */
+	assign(&buf, gstr.pLD);
+	append(&buf, " -o ");
+	append(&buf, gstr.pOUT);
+	append(&buf, " ");
+	append(&buf, IVERILOG_VPI_LDFLAGS);
+	append(&buf, " ");
+	append(&buf, gstr.pOBJ);
+	append(&buf, " ");
+	append(&buf, gstr.pLIB);
+	append(&buf, " ");
+	append(&buf, gstr.pLDLIBS);
 
-	assign(&buf,IVERILOG_VPI_LD);
-	append(&buf," -o ");
-	append(&buf,gstr.pOUT);				/* has a trailing space */
-	append(&buf,IVERILOG_VPI_LDFLAGS);
-	append(&buf," ");
-	append(&buf,gstr.pOBJ)				/* has a trailing space */;
-	append(&buf,gstr.pLIB);				/* has a trailing space */
-	append(&buf,gstr.pLDLIBS);
-
-	printf("%s\n",buf);
+	printf("Making %s from %s...\n", gstr.pOUT,gstr.pOBJ);
 
 	iRet = system(buf);
-
 	free(buf);
-
-	if (iRet)
-		myExit(3);
+	if (iRet) myExit(3);
 }
 
 /* program execution starts here */
@@ -560,14 +625,14 @@ int main(int argc, char *argv[])
 {
 	init();
 
-	if (!parse(argc,argv))
-		usage();
+	if (!parse(argc,argv)) usage();
 
 	setup_mingw_environment();
 	setup_ivl_environment();
 
-	if (*gstr.pOUT)				/* are there any *.c,*.cc,*.o files specified */
-		compile_and_link();
+	  /* are there any source or object files specified */
+	if (*gstr.pOUT) compile_and_link();
 
 	myExit(0);
+	return 0; // eliminate warnings.
 }
diff --git a/iverilog-vpi.sh b/iverilog-vpi.sh
index d2512cc40..cf8738637 100644
--- a/iverilog-vpi.sh
+++ b/iverilog-vpi.sh
@@ -157,7 +157,7 @@ done
 
 if test $compile_errors -gt 0
 then
-    echo "Some ($compile_errors) files failed to compile."
+    echo "$0: $compile_errors file(s) failed to compile."
     exit $compile_errors
 fi