Install build rules

Makefile.macros

@@ -16,6 +16,16 @@
 #   - libfoo_TEST_EXTRA_LDFLAGS:
 #     additional LDFLAGS to be passed to link each test binary;
 #     use this to pull in external libraries (not built in this project)
+#   - libfoo_SOVERSION:
+#     SOVERSION that is recorded in linker options whenever a binary
+#     is dynamically linked against this library
+#     Should be increased for every incompatible ABI change if library
+#     is deemed to be ABI-stable).
+#     REQUIRED if shared library builds are enabled
+#   - libfoo_VERSION:
+#     Detailed version of library. Should be increased with every
+#     feature addition if library is assumed to be forward-ABI-compatible
+#     REQUIRED if shared library builds are enabled
 #
 # Depending on configuration builds only static or both
 # static and dynamic library. Depending on configuration

Makefile.rules

@@ -5,7 +5,7 @@ EXECUTABLES += $(TARGET_EXECUTABLES) $(TEST_EXECUTABLES) $(COVERAGE_EXECUTABLES)
 
 GENERATED_FILES += $(EXECUTABLES)
 
-all: $(SHARED_LIBRARIES) $(STATIC_LIBRARIES) $(EXECUTABLES)
+all: $(SHARED_LIBRARIES) $(STATIC_LIBRARIES) $(EXECUTABLES) $(PKGCONFIG_FILES)
 
 # commands for generating various types of targets
 
@@ -25,27 +25,34 @@ $(BUILD_OUT_PREFIX)%.la: %.cpp
 	$(CXX) -c $(CXXFLAGS) $(CPPFLAGS) -o $@ $<
 
 # static libraries
-$(BUILD_OUT_PREFIX)%.a: BASENAME=$(patsubst %.a, %, $@)
+$(BUILD_OUT_PREFIX)%.a: BASENAME=$(patsubst $(BUILD_OUT_PREFIX)%.a, %, $@)
 $(BUILD_OUT_PREFIX)%.a:
 	@mkdir -p $(dir $@)
 	rm -f $@
 	ar cqv $@ $^
 	ranlib $@
 
 # dynamic libraries
-$(BUILD_OUT_PREFIX)%.so: BASENAME=$(patsubst %.so,%,$@)
+$(BUILD_OUT_PREFIX)%.so: BASENAME=$(patsubst $(BUILD_OUT_PREFIX)%.so,%,$@)
 $(BUILD_OUT_PREFIX)%.so:
 	@mkdir -p $(dir $@)
 	rm -rf $@ $@.$($(BASENAME)_VERSION) $@.$($(BASENAME)_SOVERSION)
-	$(DYNAMIC_MODULE_LINK) -o $@.$($(BASENAME)_VERSION) $^ -Wl,-soname -Wl,$@.$($(BASENAME)_SOVERSION) $(LIBS)
-	ln -sf $@.$($(BASENAME)_VERSION) $@.$($(BASENAME)_SOVERSION)
-	ln -sf $@.$($(BASENAME)_VERSION) $@
+	$(DYNAMIC_MODULE_LINK) -o $@.$($(BASENAME)_VERSION) $^ -Wl,-soname -Wl,$(BASENAME).so.$($(BASENAME)_SOVERSION) $(LIBS)
+	ln -sf $(BASENAME).so.$($(BASENAME)_VERSION) $@.$($(BASENAME)_SOVERSION)
+	ln -sf $(BASENAME).so.$($(BASENAME)_VERSION) $@
 
 # binaries
 $(EXECUTABLES):
 	@mkdir -p $(dir $@)
 	$(EXECUTABLE_LINK) -o $@ $(filter %.la, $^) $(filter %.lo, $^) $(LDFLAGS) $(LIBS)
 
+################################################################################
+# pkgconfig substitution rules
+
+$(BUILD_OUT_PREFIX)%.pc: %.pc.in
+	@mkdir -p $(dir $@)
+	sed -e "s!@libdir@!$(libdir)!" -e "s!@includedir@!$(includedir)!" <$^ >$@
+
 ################################################################################
 # Installation rules
 
@@ -68,11 +75,12 @@ install-static: $(STATIC_LIBRARIES)
 		$(INSTALL) -m 644 -v $$file $(DESTDIR)$(libdir)/ ; \
 	done
 
-install-shared: $(patsubst %.so,install-shared-%,$(SHARED_LIBRARIES))
+install-shared: $(patsubst $(BUILD_OUT_PREFIX)%.so,install-shared-%,$(SHARED_LIBRARIES))
 install-shared-%: BASENAME=$(patsubst install-shared-%,%,$@)
 install-shared-%:
+	echo "$@"
 	mkdir -p $(DESTDIR)$(libdir)/
-	$(INSTALL) -m 755 -v $(BASENAME).so.$($(BASENAME)_VERSION) $(DESTDIR)$(libdir)/
+	$(INSTALL) -m 755 -v $(BUILD_OUT_PREFIX)$(BASENAME).so.$($(BASENAME)_VERSION) $(DESTDIR)$(libdir)/
 	$(RM) -rf $(DESTDIR)$(libdir)/$(BASENAME).so $(DESTDIR)$(libdir)/$(BASENAME).so.$($(BASENAME)_SOVERSION)
 	ln -sf $(BASENAME).so.$($(BASENAME)_VERSION) $(DESTDIR)$(libdir)/$(BASENAME).so
 	ln -sf $(BASENAME).so.$($(BASENAME)_VERSION) $(DESTDIR)$(libdir)/$(BASENAME).so.$($(BASENAME)_SOVERSION)
@@ -151,24 +159,26 @@ $(BUILD_OUT_PREFIX)%.coverage.la: %.cpp
 $(COVERAGE_TESTS): $(BUILD_OUT_PREFIX)%.coverage : $(BUILD_OUT_PREFIX)%.coverage.la
 $(COVERAGE_TESTS): LDFLAGS += -pthread $(COVERAGEFLAGS)
 
-coverage: $(COVERAGE_TESTS) .PHONY
+coverage: $(COVERAGE_TESTS)
 	for CTEST in $(COVERAGE_TESTS) ; do $$CTEST ; done
 	mkdir -p $(BUILD_OUT_PREFIX)coverage
 	gcovr $(BUILD_OUT_PREFIX) --html-details -o $(BUILD_OUT_PREFIX)coverage/coverage.html
 
 endif
 
+.PHONY: coverage
+
 ################################################################################
 # Documentation rules
 
 docclean:
-	rm -rf doc
+	rm -rf docs
 
-docs: .PHONY
+docs:
 	mkdir -p docs
 	doxygen doxygen.conf
 
-.PHONY:
+.PHONY: docs
 
 #################################################################################
 # Clang format rules

configure.sh

@@ -4,13 +4,18 @@ set -eu
 # Default values for all tunables.
 TARGET="release"
 ENABLE_ASSERTS="no"
+ENABLE_SHARED="no"
 LLVM_CONFIG_BIN="llvm-config-16"
 ENABLE_COVERAGE="no"
 ENABLE_HLS=
 CIRCT_PATH=
 ENABLE_MLIR=
 MLIR_PATH=
 MLIR_LDFLAGS=
+INSTALL=install
+prefix="/usr/local"
+includedir=""
+libdir=""
 
 function usage()
 {
@@ -27,6 +32,7 @@ function usage()
 	echo "  --enable-mlir PATH    Sets the path to the MLIR RVSDG Dialect and enables"
 	echo "                        building the MLIR backend and frontend. [${MLIR_PATH}]"
 	echo "  --enable-coverage     Enable test coverage computation target."
+	echo "  --enable-shared       Enable building shared libraries."
 	echo "  --help                Prints this message and stops."
 	echo
 	echo "Influential variables that can be set:"
@@ -51,6 +57,10 @@ while [[ "$#" -ge 1 ]] ; do
 			ENABLE_ASSERTS="yes"
 			shift
 			;;
+		--enable-shared)
+			ENABLE_SHARED="yes"
+			shift
+			;;
 		--llvm-config)
 			shift
 			LLVM_CONFIG_BIN="$1"
@@ -70,6 +80,18 @@ while [[ "$#" -ge 1 ]] ; do
 			usage >&2
 			exit 1
 			;;
+		--prefix=*)
+			prefix="${1#--prefix=}"
+			shift
+			;;
+		--includedir=*)
+			includedir="${1#--includedir=}"
+			shift
+			;;
+		--libdir=*)
+			libdir="${1#--libdir=}"
+			shift
+			;;
 		*=*)
 			VARNAME=${1%%=*}
 			VARVAL=${1#*=}
@@ -83,6 +105,13 @@ while [[ "$#" -ge 1 ]] ; do
 	esac
 done
 
+if [ "${includedir}" == "" ] ; then
+	includedir="${prefix}/include"
+fi
+
+if [ "${libdir}" == "" ] ; then
+	libdir="${prefix}/lib"
+fi
 
 CXXFLAGS_COMMON="--std=c++17 -Wall -Wpedantic -Wextra -Wno-unused-parameter -Werror -Wfatal-errors -gdwarf-4 -g"
 CPPFLAGS_COMMON="-I. -Itests"
@@ -138,6 +167,12 @@ MLIR_PATH=${MLIR_PATH}
 MLIR_LDFLAGS=${MLIR_LDFLAGS}
 LLVMCONFIG=${LLVM_CONFIG_BIN}
 ENABLE_COVERAGE=${ENABLE_COVERAGE}
+ENABLE_SHARED=${ENABLE_SHARED}
+
+INSTALL=${INSTALL}
+prefix=${prefix}
+libdir=${libdir}
+includedir=${includedir}
 EOF
 	if [ ! -z "${CXX-}" ] ; then
 		echo "CXX=${CXX}"

debian/changelog

@@ -0,0 +1,5 @@
+jlm (0.0.1) UNRELEASED; urgency=medium
+
+  * Initial packaging
+
+ -- Helge Bahmann <[email protected]>  Sun, 04 Feb 2024 17:20:30 +0100

debian/compat

@@ -0,0 +1 @@
+10

debian/control

@@ -0,0 +1,43 @@
+Source: jlm
+Priority: optional
+Maintainer: Helge Bahmann <[email protected]>
+Build-Depends: debhelper (>= 9)
+Standards-Version: 3.9.8
+Section: libs
+
+Package: libjlmutil-dev
+Section: libdevel
+Architecture: any
+Depends: libjlmutil0 (= ${binary:Version}), ${misc:Depends}
+Description: Common utilities for jlm.
+ Common utilities for jlm.
+ .
+ Provides shared utility library for other jlm libraries.
+
+Package: libjlmutil0
+Architecture: any
+Depends: ${misc:Depends}, ${shlibs:Depends}
+Description: Common utilities for jlm.
+ Common utilities for jlm.
+ .
+ Provides shared utility library for other jlm libraries.
+
+Package: librvsdg-dev
+Section: libdevel
+Architecture: any
+Depends: librvsdg0 (= ${binary:Version}), ${misc:Depends}, libjlmutil-dev
+Description: RVSDG compiler IR library.
+ RVSDG compiler IR library.
+ .
+ Library that implements the RVSDG (regionalized value state dependence
+ graph) compiler intermediate representation.
+
+Package: librvsdg0
+Architecture: any
+Depends: ${misc:Depends}, ${shlibs:Depends}
+Description: RVSDG compiler IR library.
+ RVSDG compiler IR library.
+ .
+ Library that implements the RVSDG (regionalized value state dependence
+ graph) compiler intermediate representation.
+

debian/libjlmutil-dev.install

@@ -0,0 +1,4 @@
+usr/include/jlm/util/*
+usr/lib/*/libjlmutil.so
+usr/lib/*/libjlmutil.a
+usr/lib/*/pkgconfig/libjlmutil.pc

debian/libjlmutil0.install

@@ -0,0 +1 @@
+usr/lib/*/libjlmutil.so.0*

debian/librvsdg-dev.install

@@ -0,0 +1,4 @@
+usr/include/jlm/rvsdg/*
+usr/lib/*/librvsdg.so
+usr/lib/*/librvsdg.a
+usr/lib/*/pkgconfig/librvsdg.pc

debian/librvsdg0.install

@@ -0,0 +1 @@
+usr/lib/*/librvsdg.so.0*

debian/rules

@@ -0,0 +1,14 @@
+#!/usr/bin/make -f
+%:
+	dh $@
+
+.PHONY: override_dh_strip override_dh_auto_configure
+
+override_dh_auto_clean:
+	rm -rf build build-* docs
+
+override_dh_auto_configure:
+	./configure.sh --enable-shared --prefix=/usr --libdir=/usr/lib/$(DEB_HOST_MULTIARCH)
+
+override_dh_strip:
+	dh_strip --automatic-dbgsym

debian/source/format

@@ -0,0 +1 @@
+3.0 (native)

debian/source/options

@@ -0,0 +1 @@
+tar-ignore = ".git/*"

jlm/hls/Makefile.sub

@@ -46,11 +46,13 @@ libhls_TESTS += \
 
 libhls_TEST_LIBS += \
 	libhls \
-	libllvm \
+	libjlmllvm \
 	librvsdg \
-	libutil \
+	libjlmutil \
 	libjlmtest \
 
 libhls_TEST_EXTRA_LDFLAGS = $(shell $(LLVMCONFIG) --ldflags --libs --system-libs)
+libhls_VERSION = 0.0.1
+libhls_SOVERSION = 0
 
 $(eval $(call common_library,libhls))

jlm/llvm/Makefile.sub

@@ -1,7 +1,7 @@
 # Copyright 2019 Nico Reißmann <[email protected]>
 # See COPYING for terms of redistribution.
 
-libllvm_SOURCES = \
+libjlmllvm_SOURCES = \
     jlm/llvm/backend/jlm2llvm/instruction.cpp \
     jlm/llvm/backend/jlm2llvm/jlm2llvm.cpp \
     jlm/llvm/backend/jlm2llvm/type.cpp \
@@ -61,7 +61,7 @@ libllvm_SOURCES = \
     jlm/llvm/opt/reduction.cpp \
     jlm/llvm/opt/unroll.cpp \
 
-libllvm_HEADERS = \
+libjlmllvm_HEADERS = \
 	jlm/llvm/opt/unroll.hpp \
 	jlm/llvm/opt/DeadNodeElimination.hpp \
 	jlm/llvm/opt/inlining.hpp \
@@ -124,7 +124,7 @@ libllvm_HEADERS = \
 	jlm/llvm/backend/jlm2llvm/instruction.hpp \
 	jlm/llvm/backend/jlm2llvm/context.hpp \
 
-libllvm_TESTS += \
+libjlmllvm_TESTS += \
 	tests/jlm/llvm/backend/llvm/r2j/test-empty-gamma \
 	tests/jlm/llvm/backend/llvm/r2j/test-partial-gamma \
 	tests/jlm/llvm/backend/llvm/r2j/test-recursive-data \
@@ -180,12 +180,14 @@ libllvm_TESTS += \
 	tests/jlm/llvm/opt/test-push \
 	tests/jlm/llvm/opt/test-unroll \
 
-libllvm_TEST_LIBS = \
+libjlmllvm_TEST_LIBS = \
 	libjlmtest \
-	libllvm \
+	libjlmllvm \
 	librvsdg \
-	libutil \
+	libjlmutil \
 
-libllvm_TEST_EXTRA_LDFLAGS = $(shell $(LLVMCONFIG) --ldflags --libs --system-libs)
+libjlmllvm_TEST_EXTRA_LDFLAGS = $(shell $(LLVMCONFIG) --ldflags --libs --system-libs)
+libjlmllvm_VERSION = 0.0.1
+libjlmllvm_SOVERSION = 0
 
-$(eval $(call common_library,libllvm))
+$(eval $(call common_library,libjlmllvm))

jlm/llvm/ir/operators/operators.hpp

@@ -2680,7 +2680,7 @@ class Memcpy final : public jlm::rvsdg::simple_op
 };
 
 /*
-  FIXME: This function should be in librvsdg and not in libllvm.
+  FIXME: This function should be in librvsdg and not in libjlmllvm.
 */
 static inline jlm::rvsdg::node *
 input_node(const jlm::rvsdg::input * input)

jlm/mlir/Makefile.sub

@@ -15,9 +15,9 @@ libmlir_TESTS += \
 
 libmlir_TEST_LIBS += \
 	libmlir \
-	libllvm \
+	libjlmllvm \
 	librvsdg \
-	libutil \
+	libjlmutil \
 	libjlmtest \
 
 libmlir_TEST_EXTRA_LDFLAGS = \
@@ -27,4 +27,7 @@ libmlir_TEST_EXTRA_LDFLAGS = \
         -lMLIRJLM \
         -lMLIRRVSDG \
 
+libmlir_VERSION = 0.0.1
+libmlir_SOVERSION = 0
+
 $(eval $(call common_library,libmlir))

jlm/rvsdg/Makefile.sub

@@ -82,6 +82,11 @@ librvsdg_TESTS = \
 librvsdg_TEST_LIBS = \
 	libjlmtest \
 	librvsdg \
-	libutil \
+	libjlmutil \
+
+librvsdg_VERSION = 0.0.1
+librvsdg_SOVERSION = 0
 
 $(eval $(call common_library,librvsdg))
+
+PKGCONFIG_FILES += $(BUILD_OUT_PREFIX)jlm/rvsdg/librvsdg.pc

jlm/rvsdg/librvsdg.pc.in

@@ -0,0 +1,10 @@
+libdir = @libdir@
+includedir = @includedir@
+
+Name: librvsdg
+Description: rvsdg representation library
+Version: 0.0.1
+URL: https://github.com/phate/jlm
+Libs: -L${libdir} -lrvsdg
+Requires: libjlmutil
+Cflags: -I${includedir}