vvp: build and install libvvp as a versioned shared library

Uses the package version for the SONAME and full library version.

For linking, a pkg-config file is generated, and when building on
Windows, an import library is created that can be used with both
GCC and MSVC compilers.

On non-Windows platforms, all object files are compiled with -fPIC
to ensure compatibility with shared libraries.

The shared library is assumed to be ABI-stable within the same
major version, so the SONAME reflects only the major version
number.

Author: rhabacker

Makefile.in

@@ -159,7 +159,7 @@ else
 	rm vvp/vvp$(suffix).exe
 endif
 else
-	vvp/vvp -M- -M./vpi ./check.vvp | grep 'Hello, World'
+	LD_LIBRARY_PATH=$(srcdir)/vvp vvp/vvp -M- -M./vpi ./check.vvp | grep 'Hello, World'
 endif
 
 clean:

configure.ac

@@ -8,6 +8,11 @@ AC_SUBST([VERSION_MINOR], [VER_MINOR])
 AC_SUBST([VERSION_EXTRA], [" (VER_EXTRA)"])
 AC_SUBST([VERSION], ["VER_MAJOR.VER_MINOR (VER_EXTRA)"])
 
+# setup libvvp soversion, which depends on abi not package version
+AC_SUBST([LIBVVP_SOVERSION], [1])
+# setup libvvp version
+AC_SUBST([LIBVVP_VERSION], [VER_MAJOR.VER_MINOR])
+
 AC_CONFIG_SRCDIR([netlist.h])
 AC_CONFIG_HEADERS([config.h])
 AC_CONFIG_HEADERS([_pli_types.h])

vvp/Makefile.in

@@ -33,6 +33,7 @@ mandir = @mandir@
 # It is a little different from the generic includedir.
 includedir = @includedir@/iverilog$(suffix)
 pdfdir = @docdir@
+pkgconfigdir = @libdir@/pkgconfig
 
 # For a cross compile these defines will need to be set accordingly.
 HOSTCC = @CC@
@@ -62,9 +63,17 @@ CXXFLAGS = @WARNING_FLAGS@ @WARNING_FLAGS_CXX@ @CXXFLAGS@
 LDFLAGS = @rdynamic@ @LDFLAGS@
 LIBS = @LIBS@ @EXTRALIBS@
 
+LIBVVP_VERSION = @LIBVVP_VERSION@
+LIBVVP_SOVERSION = @LIBVVP_SOVERSION@
+
 ifeq (@WIN32@,yes)
 SLDIR=$(bindir)
 SLEXT=dll
+ifeq (@MINGW32@,yes)
+IMPEXT=dll.a
+else
+IMPEXT=lib
+endif
 else
 SLDIR=$(libdir)
 SLEXT=so
@@ -105,7 +114,7 @@ else
 	rm -f vvp$(suffix).exe
 endif
 else
-	./vvp -M../vpi $(srcdir)/examples/hello.vvp | grep 'Hello, World.'
+	LD_LIBRARY_PATH=. ./vvp -M../vpi $(srcdir)/examples/hello.vvp | grep 'Hello, World.'
 endif
 
 clean:
@@ -136,16 +145,32 @@ dep:
 
 ifeq (@LIBVVP@,yes)
 
-CPPFLAGS+= -fpic
+ifeq (@WIN32@,yes)
+else
+CXXFLAGS+= -fPIC
+CFLAGS+= -fPIC
+endif
 
 # To avoid setting LD_LIBRARY_PATH when running vvp from the build tree,
 # add option -Wl,-rpath=`pwd` to the CXX command below.
 
 vvp@EXEEXT@: main.o $(srcdir)/vvp.def libvvp$(suffix).$(SLEXT)
 	$(CXX) $(LDFLAGS) -o vvp@EXEEXT@ main.o -L. $(LDFLAGS) -lvvp$(suffix) $(LIBS)
 
+ifeq (@MINGW32@,yes)
+libvvp$(suffix).$(SLEXT): $O
+	$(CXX) -shared $(LDFLAGS) -o libvvp$(suffix)-$(LIBVVP_SOVERSION).$(SLEXT) -Wl,--out-implib libvvp$(suffix).$(IMPEXT) $O $(LIBS) $(dllib)
+else
 libvvp$(suffix).$(SLEXT): $O
-	$(CXX) -shared $(LDFLAGS) -o libvvp$(suffix).$(SLEXT) $O $(LIBS) $(dllib)
+	$(CXX) -shared $(LDFLAGS) \
+		-Wl,-soname,libvvp$(suffix).$(SLEXT).$(LIBVVP_SOVERSION) \
+		-o libvvp$(suffix).$(SLEXT).$(LIBVVP_VERSION) \
+		$O $(LIBS) $(dllib)
+	ln -sf libvvp$(suffix).$(SLEXT).$(LIBVVP_VERSION) \
+		libvvp$(suffix).$(SLEXT).$(LIBVVP_SOVERSION)
+	ln -sf libvvp$(suffix).$(SLEXT).$(LIBVVP_SOVERSION) \
+		libvvp$(suffix).$(SLEXT)
+endif
 else
 ifeq (@WIN32@,yes)
 # To support cocotb, we export the VPI functions directly. This allows
@@ -221,7 +246,7 @@ stamp-config-h: $(srcdir)/config.h.in ../config.status
 	cd ..; ./config.status --header=vvp/config.h
 config.h: stamp-config-h
 
-install: all installdirs installfiles
+install: all installdirs installfiles installpkgconfig
 
 F = ./vvp@EXEEXT@ $(srcdir)/libvvp.h $(INSTALL_DOC)
 
@@ -234,7 +259,20 @@ installpdf: vvp.pdf installdirs
 installfiles: $(F) | installdirs
 	$(INSTALL_PROGRAM) ./vvp@EXEEXT@ "$(DESTDIR)$(bindir)/vvp$(suffix)@EXEEXT@"
 ifeq (@LIBVVP@,yes)
-	$(INSTALL_PROGRAM) ./libvvp$(suffix).$(SLEXT) "$(DESTDIR)$(SLDIR)/libvvp$(suffix).$(SLEXT)"
+ifeq (@WIN32@,yes)
+	$(INSTALL_PROGRAM) ./libvvp$(suffix)-$(LIBVVP_SOVERSION).$(SLEXT) "$(DESTDIR)$(bindir)/libvvp$(suffix)-$(LIBVVP_SOVERSION).$(SLEXT)"
+	$(INSTALL_PROGRAM) ./libvvp$(suffix).$(IMPEXT) "$(DESTDIR)$(libdir)/libvvp$(suffix).$(IMPEXT)"
+else
+	# Install real library
+	$(INSTALL_PROGRAM) ./libvvp$(suffix).$(SLEXT).$(LIBVVP_VERSION) \
+	  "$(DESTDIR)$(SLDIR)/libvvp$(suffix).$(SLEXT).$(LIBVVP_VERSION)"
+	# SONAME symlink (runtime)
+	ln -sf libvvp$(suffix).$(SLEXT).$(LIBVVP_VERSION) \
+	  "$(DESTDIR)$(SLDIR)/libvvp$(suffix).$(SLEXT).$(LIBVVP_SOVERSION)"
+	# Linker symlink (devel)
+	ln -sf libvvp$(suffix).$(SLEXT).$(LIBVVP_SOVERSION) \
+	  "$(DESTDIR)$(SLDIR)/libvvp$(suffix).$(SLEXT)"
+endif
 	$(INSTALL_DATA) $(srcdir)/libvvp.h "$(DESTDIR)$(includedir)/libvvp.h"
 endif
 
@@ -244,6 +282,9 @@ installdirs: $(srcdir)/../mkinstalldirs
 		"$(DESTDIR)$(INSTALL_DOCDIR)" \
 		"$(DESTDIR)$(INSTALL_PDFDIR)"
 
+installpkgconfig:
+	$(INSTALL) -d $(DESTDIR)$(pkgconfigdir)
+	$(INSTALL_DATA) libvvp.pc $(DESTDIR)$(pkgconfigdir)
 
 uninstall: $(UNINSTALL32)
 	rm -f "$(DESTDIR)$(bindir)/vvp$(suffix)@EXEEXT@"

vvp/libvvp.pc.in

@@ -0,0 +1,10 @@
+prefix=@prefix@
+exec_prefix=@exec_prefix@
+libdir=@libdir@
+includedir=@includedir@
+
+Name: libvvp
+Version: @LIBVVP_VERSION@
+Description: Icarus Verilog VVP runtime library
+Libs: -L${libdir} -lvvp
+Cflags: -I${includedir}/iverilog