commit 610315423dea0e60edc1727c46599b4641742228
parent 54f0e6c39a5d962a021af9778dcc6247fd036c96
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 22 Nov 2023 11:11:15 +0100
Write a POSIX Makefile to replace CMake
The build procedure is written in POSIX make, which the user can
configure via the config.mk file. The make.sh script contains commands
that could be found directly in POSIX make, but which are placed here to
simplify writing the Makefile. Finally, a pkg-config file is provided to
link the library as an external dependency.
In addition to the features already provided in its CMake alternative,
this Makefile supports the use of static libraries and provides an
uninstall target. It also enable compiler and linker options that
activate various hardening features aimed at increasing the security and
robustness of generated binaries. In any case, the main motivation
behind its writing is to use a good old well-established standard with
simple features, available on all UNIX systems, thus simplifying its
portability and support while being much lighter.
Diffstat:
| A | Makefile | | | 236 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | config.mk | | | 94 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | make.sh | | | 70 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | senc3d.pc.in | | | 12 | ++++++++++++ |
4 files changed, 412 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -0,0 +1,236 @@
+# Copyright (C) 2018-2020, 2023 |Méso|Star> (contact@meso-star.com)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+.POSIX:
+.SUFFIXES: # Clean up default inference rules
+
+include config.mk
+
+LIBNAME_STATIC = libsenc3d.a
+LIBNAME_SHARED = libsenc3d.so
+LIBNAME = $(LIBNAME_$(LIB_TYPE))
+
+################################################################################
+# Library building
+################################################################################
+SRC =\
+ src/senc3d_descriptor.c\
+ src/senc3d_device.c\
+ src/senc3d_enclosure.c\
+ src/senc3d_scene.c\
+ src/senc3d_scene_analyze.c
+OBJ = $(SRC:.c=.o)
+DEP = $(SRC:.c=.d)
+
+build_library: .config $(DEP)
+ @$(MAKE) -fMakefile $$(for i in $(DEP); do echo -f $${i}; done) \
+ $$(if [ -n "$(LIBNAME)" ]; then \
+ echo "$(LIBNAME)"; \
+ else \
+ echo "$(LIBNAME_SHARED)"; \
+ fi)
+
+$(DEP) $(OBJ): config.mk
+
+$(LIBNAME_SHARED): $(OBJ)
+ $(CC) $(CFLAGS_SO) $(DPDC_CFLAGS) -o $@ $(OBJ) $(LDFLAGS_SO) $(DPDC_LIBS)
+
+$(LIBNAME_STATIC): libsenc3d.o
+ $(AR) -rc $@ $?
+ $(RANLIB) $@
+
+libsenc3d.o: $(OBJ)
+ $(LD) -r $(OBJ) -o $@
+ $(OBJCOPY) $(OCPFLAGS) $@
+
+.config: config.mk
+ @if ! $(PKG_CONFIG) --atleast-version $(RSYS_VERSION) rsys; then \
+ echo "rsys $(RSYS_VERSION) not found" >&2; exit 1; fi
+ @if ! $(PKG_CONFIG) --atleast-version $(S3D_VERSION) s3d; then \
+ echo "s3d $(S3D_VERSION) not found" >&2; exit 1; fi
+ @echo "config done" > $@
+
+.SUFFIXES: .c .d .o
+.c.d:
+ @$(CC) $(CFLAGS_SO) $(DPDC_CFLAGS) -MM -MT "$(@:.d=.o) $@" $< -MF $@
+
+.c.o:
+ $(CC) $(CFLAGS_SO) $(DPDC_CFLAGS) -DSENC3D_SHARED_BUILD -c $< -o $@
+
+################################################################################
+# Installation
+################################################################################
+pkg:
+ sed -e 's#@PREFIX@#$(PREFIX)#g'\
+ -e 's#@VERSION@#$(VERSION)#g'\
+ -e 's#@RSYS_VERSION@#$(RSYS_VERSION)#g'\
+ -e 's#@S3D_VERSION@#$(S3D_VERSION)#g'\
+ senc3d.pc.in > senc3d.pc
+
+senc3d-local.pc: senc3d.pc.in
+ sed -e '1d'\
+ -e 's#^includedir=.*#includedir=./src/#'\
+ -e 's#^libdir=.*#libdir=./#'\
+ -e 's#@VERSION@#$(VERSION)#g'\
+ -e 's#@RSYS_VERSION@#$(RSYS_VERSION)#g'\
+ -e 's#@S3D_VERSION@#$(S3D_VERSION)#g'\
+ senc3d.pc.in > $@
+
+install: build_library pkg
+ @$(SHELL) make.sh install "$(DESTDIR)$(PREFIX)/lib" $(LIBNAME)
+ @$(SHELL) make.sh install "$(DESTDIR)$(PREFIX)/lib/pkgconfig" senc3d.pc
+ @$(SHELL) make.sh install "$(DESTDIR)$(PREFIX)/include/star" \
+ src/senc3d.h src/senc3d_sXd_helper.h src/sencX3d.h src/sencX3d_undefs.h
+ @$(SHELL) make.sh install "$(DESTDIR)$(PREFIX)/share/doc/star-enclosures-3d" \
+ COPYING README.md
+
+uninstall:
+ rm -f "$(DESTDIR)$(PREFIX)/lib/$(LIBNAME)"
+ rm -f "$(DESTDIR)$(PREFIX)/lib/pkgconfig/senc3d.pc"
+ rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-enclosures-3d/COPYING"
+ rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-enclosures-3d/README.md"
+ rm -f "$(DESTDIR)$(PREFIX)/include/star/senc3d.h"
+ rm -f "$(DESTDIR)$(PREFIX)/include/star/senc3d_sXd_helper.h"
+ rm -f "$(DESTDIR)$(PREFIX)/include/star/sencX3d.h"
+ rm -f "$(DESTDIR)$(PREFIX)/include/star/sencX3d_undefs.h"
+
+################################################################################
+# Miscellaneous targets
+################################################################################
+all: build_library build_tests
+
+clean: clean_test
+ rm -f $(OBJ) $(TEST_OBJ) $(TEST_OBJ_SSP) $(TEST_OBJ_S3DUT) $(LIBNAME)
+ rm -f .config .test libsenc3d.o senc3d.pc senc3d-local.pc
+
+distclean: clean
+ rm -f $(DEP) $(TEST_DEP) $(TEST_DEP_SSP) $(TEST_DEP_S3DUT)
+
+lint:
+ shellcheck -o all make.sh
+
+################################################################################
+# Tests
+################################################################################
+TEST_SRC =\
+ src/test_senc3d_bad_grouping.c\
+ src/test_senc3d_cube_behind_cube.c\
+ src/test_senc3d_cube_in_cube.c\
+ src/test_senc3d_cube_on_cube.c\
+ src/test_senc3d_device.c\
+ src/test_senc3d_enclosure.c\
+ src/test_senc3d_inconsistant_cube.c\
+ src/test_senc3d_invalid_scenes.c\
+ src/test_senc3d_multi_media.c\
+ src/test_senc3d_scene.c\
+ src/test_senc3d_some_enclosures.c\
+ src/test_senc3d_some_triangles.c\
+ src/test_senc3d_unspecified_medium.c\
+ src/test_senc3d_zero_distance.c
+TEST_OBJ = $(TEST_SRC:.c=.o)
+TEST_DEP = $(TEST_SRC:.c=.d)
+
+# Tests that require Star-SP
+TEST_SRC_SSP = src/test_senc3d_sample_enclosure.c
+TEST_OBJ_SSP = $(TEST_SRC_SSP:.c=.o)
+TEST_DEP_SSP = $(TEST_SRC_SSP:.c=.d)
+SSP_FOUND = $(PKG_CONFIG) --atleast-version $(SSP_VERSION) star-sp
+
+# Tests that require Star-3DUT
+TEST_SRC_S3DUT =\
+ src/test_senc3d_many_enclosures.c\
+ src/test_senc3d_many_triangles.c
+TEST_OBJ_S3DUT = $(TEST_SRC_S3DUT:.c=.o)
+TEST_DEP_S3DUT = $(TEST_SRC_S3DUT:.c=.d)
+S3DUT_FOUND = $(PKG_CONFIG) --atleast-version $(S3DUT_VERSION) s3dut
+
+PKG_CONFIG_LOCAL = PKG_CONFIG_PATH="./:$${PKG_CONFIG_PATH}" $(PKG_CONFIG)
+SENC3D_CFLAGS = $$($(PKG_CONFIG_LOCAL) $(PCFLAGS) --cflags senc3d-local.pc)
+SENC3D_LIBS = $$($(PKG_CONFIG_LOCAL) $(PCFLAGS) --libs senc3d-local.pc)
+
+build_tests: build_library $(TEST_DEP) .test
+ @if $(SSP_FOUND); then $(MAKE) $(TEST_DEP_SSP); fi; \
+ if $(S3DUT_FOUND); then $(MAKE) $(TEST_DEP_S3DUT); fi; \
+ $(MAKE) -fMakefile -f.test \
+ $$(for i in $(TEST_DEP); do echo -f"$${i}"; done) \
+ $$(if $(SSP_FOUND); then \
+ for i in $(TEST_DEP_SSP); do echo -f"$${i}"; done; \
+ fi) \
+ $$(if $(S3DUT_FOUND); then \
+ for i in $(TEST_DEP_S3DUT); do echo -f"$${i}"; done; \
+ fi) \
+ test_bin
+
+test: build_tests
+ @$(SHELL) make.sh run_test $(TEST_SRC)
+ @if $(SSP_FOUND); then $(SHELL) make.sh run_test $(TEST_SRC_SSP); fi
+ @if $(S3DUT_FOUND); then $(SHELL) make.sh run_test $(TEST_SRC_S3DUT); fi
+
+.test: Makefile
+ @{ $(SHELL) make.sh config_test $(TEST_SRC) ; \
+ if $(SSP_FOUND); then $(SHELL) make.sh config_test $(TEST_SRC_SSP); fi; \
+ if $(S3DUT_FOUND); then $(SHELL) make.sh config_test $(TEST_SRC_S3DUT); fi } \
+ > $@
+
+clean_test:
+ @$(SHELL) make.sh clean_test $(TEST_SRC) $(TEST_SRC_SSP) $(TEST_SRC_S3DUT)
+
+$(TEST_DEP): config.mk senc3d-local.pc
+ @$(CC) $(CFLAGS_EXE) $(SENC3D_CFLAGS) $(RSYS_CFLAGS) \
+ -MM -MT "$(@:.d=.o) $@" $(@:.d=.c) -MF $@
+
+$(TEST_DEP_SSP): config.mk senc3d-local.pc
+ @$(CC) $(CFLAGS_EXE) $(SENC3D_CFLAGS) $(RSYS_CFLAGS) $(SSP_CFLAGS) \
+ -MM -MT "$(@:.d=.o) $@" $(@:.d=.c) -MF $@
+
+$(TEST_DEP_S3DUT): config.mk senc3d-local.pc
+ @$(CC) $(CFLAGS_EXE) $(SENC3D_CFLAGS) $(RSYS_CFLAGS) $(S3DUT_CFLAGS) \
+ -MM -MT "$(@:.d=.o) $@" $(@:.d=.c) -MF $@
+
+$(TEST_OBJ): config.mk senc3d-local.pc
+ $(CC) $(CFLAGS_EXE) $(SENC3D_CFLAGS) $(RSYS_CFLAGS) -c $(@:.o=.c) -o $@
+
+$(TEST_OBJ_SSP): config.mk senc3d-local.pc
+ $(CC) $(CFLAGS_EXE) $(SENC3D_CFLAGS) $(RSYS_CFLAGS) $(SSP_CFLAGS) -c $(@:.o=.c) -o $@
+
+$(TEST_OBJ_S3DUT): config.mk senc3d-local.pc
+ $(CC) $(CFLAGS_EXE) $(SENC3D_CFLAGS) $(RSYS_CFLAGS) $(S3DUT_CFLAGS) -c $(@:.o=.c) -o $@
+
+test_senc3d_bad_grouping \
+test_senc3d_cube_behind_cube \
+test_senc3d_cube_in_cube \
+test_senc3d_cube_on_cube \
+test_senc3d_device \
+test_senc3d_inconsistant_cube \
+test_senc3d_invalid_scenes \
+test_senc3d_multi_media \
+test_senc3d_scene \
+test_senc3d_some_enclosures \
+test_senc3d_some_triangles \
+test_senc3d_unspecified_medium \
+test_senc3d_zero_distance \
+: config.mk senc3d-local.pc $(LIBNAME)
+ $(CC) $(CFLAGS_EXE) -o $@ src/$@.o $(LDFLAGS_EXE) $(SENC3D_LIBS) $(RSYS_LIBS)
+
+test_senc3d_enclosure: config.mk senc3d-local.pc $(LIBNAME)
+ $(CC) $(CFLAGS_EXE) -o $@ src/$@.o $(LDFLAGS_EXE) $(SENC3D_LIBS) $(RSYS_LIBS) $(S3D_LIBS)
+
+test_senc3d_many_enclosures \
+test_senc3d_many_triangles \
+: config.mk senc3d-local.pc $(LIBNAME)
+ $(CC) $(CFLAGS_EXE) -o $@ src/$@.o $(LDFLAGS_EXE) $(SENC3D_LIBS) $(RSYS_LIBS) $(S3DUT_LIBS) #-lm
+
+test_senc3d_sample_enclosure: config.mk senc3d-local.pc $(LIBNAME)
+ $(CC) $(CFLAGS_EXE) -o $@ src/$@.o $(LDFLAGS_EXE) $(SENC3D_LIBS) $(RSYS_LIBS) $(S3D_LIBS) $(SSP_LIBS)
diff --git a/config.mk b/config.mk
@@ -0,0 +1,94 @@
+VERSION = 0.5.5
+PREFIX = /usr/local
+
+LIB_TYPE = SHARED
+#LIB_TYPE = STATIC
+
+BUILD_TYPE = RELEASE
+#BUILD_TYPE = DEBUG
+
+################################################################################
+# Tools
+################################################################################
+AR = ar
+CC = cc
+LD = ld
+OBJCOPY = objcopy
+PKG_CONFIG = pkg-config
+RANLIB = ranlib
+
+################################################################################
+# Dependencies
+################################################################################
+PCFLAGS_SHARED =
+PCFLAGS_STATIC = --static
+PCFLAGS = $(PCFLAGS_$(LIB_TYPE))
+
+RSYS_VERSION = 0.14
+RSYS_CFLAGS = $$($(PKG_CONFIG) $(PCFLAGS) --cflags rsys)
+RSYS_LIBS = $$($(PKG_CONFIG) $(PCFLAGS) --libs rsys)
+
+S3D_VERSION = 0.10
+S3D_CFLAGS = $$($(PKG_CONFIG) $(PCFLAGS) --cflags s3d)
+S3D_LIBS = $$($(PKG_CONFIG) $(PCFLAGS) --libs s3d)
+
+# Optional dependency
+SSP_VERSION = 0.14
+SSP_CFLAGS = $$($(PKG_CONFIG) $(PCFLAGS) --cflags star-sp)
+SSP_LIBS = $$($(PKG_CONFIG) $(PCFLAGS) --libs star-sp)
+
+# Optional dependency
+S3DUT_VERSION = 0.4
+S3DUT_CFLAGS = $$($(PKG_CONFIG) $(PCFLAGS) --cflags s3dut)
+S3DUT_LIBS = $$($(PKG_CONFIG) $(PCFLAGS) --libs s3dut)
+
+DPDC_CFLAGS = $(RSYS_CFLAGS) $(S3D_CFLAGS) -fopenmp
+DPDC_LIBS = $(RSYS_LIBS) $(S3D_LIBS) -lm -fopenmp
+
+################################################################################
+# Compilation options
+################################################################################
+WFLAGS =\
+ -Wall\
+ -Wcast-align\
+ -Wconversion\
+ -Wextra\
+ -Wmissing-declarations\
+ -Wmissing-prototypes\
+ -Wshadow
+
+CFLAGS_HARDENED =\
+ -D_FORTIFY_SOURCES=2\
+ -fcf-protection=full\
+ -fstack-clash-protection\
+ -fstack-protector-strong
+
+CFLAGS_COMMON =\
+ -std=c89\
+ -pedantic\
+ -fvisibility=hidden\
+ -fstrict-aliasing\
+ $(CFLAGS_HARDENED)\
+ $(WFLAGS)
+
+CFLAGS_RELEASE = -O3 -DNDEBUG $(CFLAGS_COMMON)
+CFLAGS_DEBUG = -g $(CFLAGS_COMMON)
+CFLAGS = $(CFLAGS_$(BUILD_TYPE))
+
+CFLAGS_SO = $(CFLAGS) -fPIC
+CFLAGS_EXE = $(CFLAGS) -fPIE
+
+################################################################################
+# Linker options
+################################################################################
+LDFLAGS_HARDENED = -Wl,-z,relro,-z,now
+LDFLAGS_DEBUG = $(LDFLAGS_HARDENED)
+LDFLAGS_RELEASE = -s $(LDFLAGS_HARDENED)
+LDFLAGS = $(LDFLAGS_$(BUILD_TYPE))
+
+LDFLAGS_SO = $(LDFLAGS) -shared -Wl,--no-undefined
+LDFLAGS_EXE = $(LDFLAGS) -pie
+
+OCPFLAGS_DEBUG = --localize-hidden
+OCPFLAGS_RELEASE = --localize-hidden --strip-unneeded
+OCPFLAGS = $(OCPFLAGS_$(BUILD_TYPE))
diff --git a/make.sh b/make.sh
@@ -0,0 +1,70 @@
+#!/bin/sh
+
+# Copyright (C) 2018-2020, 2023 |Méso|Star> (contact@meso-star.com)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+set -e
+
+config_test()
+{
+ for i in "$@"; do
+ test=$(basename "${i}" ".c")
+ test_list="${test_list} ${test}"
+ printf "%s: %s\n" "${test}" "src/${test}.o"
+ done
+ printf "test_bin: %s\n" "${test_list}"
+}
+
+run_test()
+{
+ for i in "$@"; do
+ test=$(basename "${i}" ".c")
+
+ printf "%s " "${test}"
+ if "./${test}" > /dev/null 2>&1; then
+ printf "\033[1;32mOK\033[m\n"
+ else
+ printf "\033[1;31mError\033[m\n"
+ fi
+ done 2> /dev/null
+}
+
+clean_test()
+{
+ for i in "$@"; do
+ rm -f "$(basename "${i}" ".c")"
+ done
+}
+
+install()
+{
+ prefix=$1
+ shift 1
+
+ mkdir -p "${prefix}"
+
+ for i in "$@"; do
+ dst="${prefix}/${i##*/}"
+
+ if cmp -s "${i}" "${dst}"; then
+ printf "Up to date %s\n" "${dst}"
+ else
+ printf "Installing %s\n" "${dst}"
+ cp "${i}" "${prefix}"
+ fi
+ done
+}
+
+"$@"
diff --git a/senc3d.pc.in b/senc3d.pc.in
@@ -0,0 +1,12 @@
+prefix=@PREFIX@
+includedir=${prefix}/include
+libdir=${prefix}/lib
+
+Requires: rsys >= @RSYS_VERSION@
+Requires.private: s3d >= @S3D_VERSION@
+Name: senc3d
+Description: Star ENClosures 3D library
+Version: @VERSION@
+Libs: -L${libdir} -lsenc3d
+Libs.private: -fopenmp -lm
+CFlags: -I${includedir}
