From f993147b0ea0bdc6d80a3e043a7bdfd03f86f83e Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Mon, 9 Dec 2019 13:48:43 +0100 Subject: [PATCH 01/25] git: ignore cmake build directories --- .gitignore | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 696e0ec95..519e92772 100644 --- a/.gitignore +++ b/.gitignore @@ -104,3 +104,7 @@ logs/*.png logs/*-*.dem callgraph.txt + +# cmake build directories +build*/ + From 44b6517bcae2092b4cf1fcdedb19542dff796bb0 Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Mon, 9 Dec 2019 13:49:10 +0100 Subject: [PATCH 02/25] git: ignore kdevelop generated files --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 519e92772..36fd9dd9b 100644 --- a/.gitignore +++ b/.gitignore @@ -108,3 +108,6 @@ callgraph.txt # cmake build directories build*/ +# kdevelop section +.kdev4/ +*.kdev4 From 019c3dcc128af3ace0ea7501cd285e2dfbb36535 Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Mon, 9 Dec 2019 13:51:43 +0100 Subject: [PATCH 03/25] cmake: add cmake lists file --- CMakeLists.txt | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 CMakeLists.txt diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 000000000..d9235995e --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,97 @@ +# +# LibTomMath, a free open source portable number theoretic multiple-precision +# integer (MPI) library written entirely in C. +# + +cmake_minimum_required(VERSION 3.7) +project(tommath VERSION 1.2.0) + +#----------------------------------------------------------------------------- +# Include cmake modules +#----------------------------------------------------------------------------- +include(GNUInstallDirs) +include(CMakePackageConfigHelpers) +include(sources.cmake) + +#----------------------------------------------------------------------------- +# library target +#----------------------------------------------------------------------------- +add_library(${PROJECT_NAME} + ${SOURCES} +) + +target_include_directories(${PROJECT_NAME} PUBLIC + $ + $ +) + +set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${PROJECT_VERSION}) +set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR}) + +#----------------------------------------------------------------------------- +# demo target +#----------------------------------------------------------------------------- +add_executable(test EXCLUDE_FROM_ALL + ${CMAKE_CURRENT_SOURCE_DIR}/demo/shared.c + ${CMAKE_CURRENT_SOURCE_DIR}/demo/test.c +) + +target_include_directories(test PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} +) + +target_link_libraries(test PRIVATE + ${PROJECT_NAME} +) + +#----------------------------------------------------------------------------- +# demo target +#----------------------------------------------------------------------------- +add_custom_target(check + COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test +) + +add_dependencies(check test) + +#----------------------------------------------------------------------------- +# Install/export targets and files +#----------------------------------------------------------------------------- +set(CONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}") +set(PROJECT_VERSION_FILE "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake") +set(PROJECT_CONFIG_FILE "${PROJECT_NAME}-config.cmake") +set(TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets") + +install(TARGETS ${PROJECT_NAME} + EXPORT ${TARGETS_EXPORT_NAME} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} +) + +install(FILES ${HEADERS} + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME} +) + +# generate package version file +write_basic_package_version_file( + ${PROJECT_VERSION_FILE} + VERSION ${PROJECT_VERSION} + COMPATIBILITY SameMajorVersion +) + +# install version file +install(FILES ${PROJECT_VERSION_FILE} + DESTINATION ${CONFIG_INSTALL_DIR} +) + +# build directory package config +export(EXPORT ${TARGETS_EXPORT_NAME} + FILE ${PROJECT_CONFIG_FILE} +) + +# installed package config +install(EXPORT ${TARGETS_EXPORT_NAME} + DESTINATION ${CONFIG_INSTALL_DIR} + FILE ${PROJECT_CONFIG_FILE} +) + +# add to CMake registry +export(PACKAGE ${PROJECT_NAME}) From 8fd791d8365b4871f7cd061f3626416708231107 Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Mon, 9 Dec 2019 13:52:40 +0100 Subject: [PATCH 04/25] cmake: have the sources/headers variables defined in a separated file --- sources.cmake | 165 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 165 insertions(+) create mode 100644 sources.cmake diff --git a/sources.cmake b/sources.cmake new file mode 100644 index 000000000..503a13c92 --- /dev/null +++ b/sources.cmake @@ -0,0 +1,165 @@ +set(SOURCES +mp_2expt.c +mp_abs.c +mp_add.c +mp_add_d.c +mp_addmod.c +mp_and.c +mp_clamp.c +mp_clear.c +mp_clear_multi.c +mp_cmp.c +mp_cmp_d.c +mp_cmp_mag.c +mp_cnt_lsb.c +mp_complement.c +mp_copy.c +mp_count_bits.c +mp_cutoffs.c +mp_div_2.c +mp_div_2d.c +mp_div_3.c +mp_div.c +mp_div_d.c +mp_dr_is_modulus.c +mp_dr_reduce.c +mp_dr_setup.c +mp_error_to_string.c +mp_exch.c +mp_exptmod.c +mp_expt_u32.c +mp_exteuclid.c +mp_fread.c +mp_from_sbin.c +mp_from_ubin.c +mp_fwrite.c +mp_gcd.c +mp_get_double.c +mp_get_i32.c +mp_get_i64.c +mp_get_l.c +mp_get_ll.c +mp_get_mag_u32.c +mp_get_mag_u64.c +mp_get_mag_ul.c +mp_get_mag_ull.c +mp_grow.c +mp_init.c +mp_init_copy.c +mp_init_i32.c +mp_init_i64.c +mp_init_l.c +mp_init_ll.c +mp_init_multi.c +mp_init_set.c +mp_init_size.c +mp_init_u32.c +mp_init_u64.c +mp_init_ul.c +mp_init_ull.c +mp_invmod.c +mp_is_square.c +mp_kronecker.c +mp_lcm.c +mp_log_u32.c +mp_lshd.c +mp_mod_2d.c +mp_mod.c +mp_montgomery_calc_normalization.c +mp_montgomery_reduce.c +mp_montgomery_setup.c +mp_mul_2.c +mp_mul_2d.c +mp_mul.c +mp_mul_d.c +mp_mulmod.c +mp_neg.c +mp_or.c +mp_pack.c +mp_pack_count.c +mp_prime_fermat.c +mp_prime_frobenius_underwood.c +mp_prime_is_prime.c +mp_prime_miller_rabin.c +mp_prime_next_prime.c +mp_prime_rabin_miller_trials.c +mp_prime_rand.c +mp_prime_strong_lucas_selfridge.c +mp_radix_size.c +mp_rand.c +mp_read_radix.c +mp_reduce_2k.c +mp_reduce_2k_l.c +mp_reduce_2k_setup.c +mp_reduce_2k_setup_l.c +mp_reduce.c +mp_reduce_is_2k.c +mp_reduce_is_2k_l.c +mp_reduce_setup.c +mp_root_u32.c +mp_rshd.c +mp_sbin_size.c +mp_set.c +mp_set_double.c +mp_set_i32.c +mp_set_i64.c +mp_set_l.c +mp_set_ll.c +mp_set_u32.c +mp_set_u64.c +mp_set_ul.c +mp_set_ull.c +mp_shrink.c +mp_signed_rsh.c +mp_sqr.c +mp_sqrmod.c +mp_sqrt.c +mp_sqrtmod_prime.c +mp_sub.c +mp_sub_d.c +mp_submod.c +mp_to_radix.c +mp_to_sbin.c +mp_to_ubin.c +mp_ubin_size.c +mp_unpack.c +mp_xor.c +mp_zero.c +s_mp_add.c +s_mp_copy_digs.c +s_mp_div_recursive.c +s_mp_div_school.c +s_mp_div_small.c +s_mp_exptmod.c +s_mp_exptmod_fast.c +s_mp_get_bit.c +s_mp_invmod.c +s_mp_invmod_odd.c +s_mp_log.c +s_mp_log_d.c +s_mp_log_pow2.c +s_mp_montgomery_reduce_comba.c +s_mp_mul_balance.c +s_mp_mul.c +s_mp_mul_comba.c +s_mp_mul_high.c +s_mp_mul_high_comba.c +s_mp_mul_karatsuba.c +s_mp_mul_toom.c +s_mp_prime_is_divisible.c +s_mp_prime_tab.c +s_mp_radix_map.c +s_mp_rand_jenkins.c +s_mp_rand_platform.c +s_mp_sqr.c +s_mp_sqr_comba.c +s_mp_sqr_karatsuba.c +s_mp_sqr_toom.c +s_mp_sub.c +s_mp_zero_buf.c +s_mp_zero_digs.c +) + +set(HEADERS +tommath.h +) From 6da9d1a970e9f83800d66e606e7281c6b2c8fd3b Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Mon, 9 Dec 2019 16:08:59 +0100 Subject: [PATCH 05/25] cmake: rename test target fixes cmake (v3.10.2) error under ubuntu 18.04 due to reserved target name --- CMakeLists.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index d9235995e..5a0d84907 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -31,16 +31,16 @@ set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION_MAJ #----------------------------------------------------------------------------- # demo target #----------------------------------------------------------------------------- -add_executable(test EXCLUDE_FROM_ALL +add_executable(test-target EXCLUDE_FROM_ALL ${CMAKE_CURRENT_SOURCE_DIR}/demo/shared.c ${CMAKE_CURRENT_SOURCE_DIR}/demo/test.c ) -target_include_directories(test PRIVATE +target_include_directories(test-target PRIVATE ${CMAKE_CURRENT_SOURCE_DIR} ) -target_link_libraries(test PRIVATE +target_link_libraries(test-target PRIVATE ${PROJECT_NAME} ) @@ -48,10 +48,10 @@ target_link_libraries(test PRIVATE # demo target #----------------------------------------------------------------------------- add_custom_target(check - COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test + COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-target ) -add_dependencies(check test) +add_dependencies(check test-target) #----------------------------------------------------------------------------- # Install/export targets and files From 3c94017d7be3a8adb6fd9225ac5af19fb59f4f04 Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Mon, 9 Dec 2019 16:12:38 +0100 Subject: [PATCH 06/25] cmake: add cpack for generating packages --- CMakeLists.txt | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5a0d84907..de68266d6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -95,3 +95,60 @@ install(EXPORT ${TARGETS_EXPORT_NAME} # add to CMake registry export(PACKAGE ${PROJECT_NAME}) + +#--------------------------------------------------------------------------------------- +# Create release packages +#--------------------------------------------------------------------------------------- +# package release version +set(PACKAGE_RELEASE_VERSION 1) + +# determine distribution and architecture +find_program(LSB_RELEASE lsb_release) + +execute_process(COMMAND uname -m OUTPUT_VARIABLE MACHINE_ARCH OUTPUT_STRIP_TRAILING_WHITESPACE) + +if(LSB_RELEASE) + execute_process(COMMAND lsb_release -sr OUTPUT_VARIABLE LINUX_DISTRO_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) + execute_process(COMMAND lsb_release -si OUTPUT_VARIABLE LINUX_DISTRO OUTPUT_STRIP_TRAILING_WHITESPACE) + + string(TOLOWER ${LINUX_DISTRO} LINUX_DISTRO) +endif() + +# default CPack generators +set(CPACK_GENERATOR TGZ STGZ) + +# extra CPack generators +if(LINUX_DISTRO STREQUAL "debian" OR LINUX_DISTRO STREQUAL "ubuntu" OR LINUX_DISTRO STREQUAL "linuxmint") + list(APPEND CPACK_GENERATOR DEB) +elseif(LINUX_DISTRO STREQUAL "fedora" OR LINUX_DISTRO STREQUAL "opensuse" OR LINUX_DISTRO STREQUAL "centos") + list(APPEND CPACK_GENERATOR RPM) +endif() + +# general CPack config +set(CPACK_PACKAGE_DIRECTORY ${CMAKE_BINARY_DIR}/packages) +message(STATUS "CPack: packages will be generated under ${CPACK_PACKAGE_DIRECTORY}") +set(CPACK_PACKAGE_NAME "lib${PROJECT_NAME}") +set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION}) +set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "LibTomMath") +set(CPACK_PACKAGE_VENDOR "LibTomMath") +set(CPACK_PACKAGE_CONTACT "libtom@googlegroups.com") +set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE") +set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${PACKAGE_RELEASE_VERSION}_${LINUX_DISTRO}-${LINUX_DISTRO_VERSION}_${MACHINE_ARCH}) +set(CPACK_STRIP_FILES ON) + +# deb specific CPack config +set(CPACK_DEBIAN_PACKAGE_RELEASE ${PACKAGE_RELEASE_VERSION}) +set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) +set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) +set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://www.libtom.net/LibTomMath") +set(CPACK_DEBIAN_PACKAGE_SECTION "devel") + +# rpm specific CPack config +set(CPACK_RPM_PACKAGE_URL "https://www.libtom.net/LibTomMath") +set(CPACK_RPM_PACKAGE_RELEASE ${PACKAGE_RELEASE_VERSION}) +set(CPACK_RPM_PACKAGE_ARCHITECTURE ${MACHINE_ARCH}) +set(CPACK_RPM_PACKAGE_NAME "lib${PROJECT_NAME}-${PROJECT_VERSION}") +set(CPACK_RPM_FILE_NAME "lib${PROJECT_NAME}_${PROJECT_VERSION}-${CPACK_RPM_PACKAGE_RELEASE}_${LINUX_DISTRO}-${LINUX_DISTRO_VERSION}_${CPACK_RPM_PACKAGE_ARCHITECTURE}.rpm") +set(CPACK_RPM_PACKAGE_LICENSE "WTFPL") + +include(CPack) From 7f9fbb648bbd41ad617b0a8df586c0a7e4e56247 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Thu, 16 Jan 2020 15:21:30 +0100 Subject: [PATCH 07/25] helper.pl: add support to update sources.cmake --- helper.pl | 16 ++++++++++++++-- sources.cmake | 29 ++++++++++++----------------- 2 files changed, 26 insertions(+), 19 deletions(-) diff --git a/helper.pl b/helper.pl index 20b0dc91d..ac87556b1 100755 --- a/helper.pl +++ b/helper.pl @@ -221,6 +221,16 @@ sub patch_file { return $content; } +sub make_sources_cmake { + my @list = @_; + my $output = "set(SOURCES\n"; + foreach my $obj (sort @list) { + $output .= $obj . "\n"; + } + $output .= ")\n\nset(HEADERS\ntommath.h\n)\n"; + return $output; +} + sub process_makefiles { my $write = shift; my $changed_count = 0; @@ -244,10 +254,12 @@ sub process_makefiles { } # update OBJECTS + HEADERS in makefile* - for my $m (qw/ makefile makefile.shared makefile_include.mk makefile.msvc makefile.unix makefile.mingw /) { + for my $m (qw/ makefile makefile.shared makefile_include.mk makefile.msvc makefile.unix makefile.mingw sources.cmake /) { my $old = read_file($m); my $new = $m eq 'makefile.msvc' ? patch_file($old, $var_obj) - : patch_file($old, $var_o); + : $m eq 'sources.cmake' ? make_sources_cmake(bsd_glob("*.c")) + : patch_file($old, $var_o); + if ($old ne $new) { write_file($m, $new) if $write; warn "changed: $m\n"; diff --git a/sources.cmake b/sources.cmake index 503a13c92..fd353c00a 100644 --- a/sources.cmake +++ b/sources.cmake @@ -16,18 +16,17 @@ mp_complement.c mp_copy.c mp_count_bits.c mp_cutoffs.c +mp_div.c mp_div_2.c mp_div_2d.c -mp_div_3.c -mp_div.c mp_div_d.c mp_dr_is_modulus.c mp_dr_reduce.c mp_dr_setup.c mp_error_to_string.c mp_exch.c +mp_expt_n.c mp_exptmod.c -mp_expt_u32.c mp_exteuclid.c mp_fread.c mp_from_sbin.c @@ -38,39 +37,35 @@ mp_get_double.c mp_get_i32.c mp_get_i64.c mp_get_l.c -mp_get_ll.c mp_get_mag_u32.c mp_get_mag_u64.c mp_get_mag_ul.c -mp_get_mag_ull.c mp_grow.c mp_init.c mp_init_copy.c mp_init_i32.c mp_init_i64.c mp_init_l.c -mp_init_ll.c mp_init_multi.c mp_init_set.c mp_init_size.c mp_init_u32.c mp_init_u64.c mp_init_ul.c -mp_init_ull.c mp_invmod.c mp_is_square.c mp_kronecker.c mp_lcm.c -mp_log_u32.c +mp_log_n.c mp_lshd.c -mp_mod_2d.c mp_mod.c +mp_mod_2d.c mp_montgomery_calc_normalization.c mp_montgomery_reduce.c mp_montgomery_setup.c +mp_mul.c mp_mul_2.c mp_mul_2d.c -mp_mul.c mp_mul_d.c mp_mulmod.c mp_neg.c @@ -86,17 +81,18 @@ mp_prime_rabin_miller_trials.c mp_prime_rand.c mp_prime_strong_lucas_selfridge.c mp_radix_size.c +mp_radix_size_overestimate.c mp_rand.c mp_read_radix.c +mp_reduce.c mp_reduce_2k.c mp_reduce_2k_l.c mp_reduce_2k_setup.c mp_reduce_2k_setup_l.c -mp_reduce.c mp_reduce_is_2k.c mp_reduce_is_2k_l.c mp_reduce_setup.c -mp_root_u32.c +mp_root_n.c mp_rshd.c mp_sbin_size.c mp_set.c @@ -104,14 +100,11 @@ mp_set_double.c mp_set_i32.c mp_set_i64.c mp_set_l.c -mp_set_ll.c mp_set_u32.c mp_set_u64.c mp_set_ul.c -mp_set_ull.c mp_shrink.c mp_signed_rsh.c -mp_sqr.c mp_sqrmod.c mp_sqrt.c mp_sqrtmod_prime.c @@ -127,6 +120,7 @@ mp_xor.c mp_zero.c s_mp_add.c s_mp_copy_digs.c +s_mp_div_3.c s_mp_div_recursive.c s_mp_div_school.c s_mp_div_small.c @@ -136,11 +130,11 @@ s_mp_get_bit.c s_mp_invmod.c s_mp_invmod_odd.c s_mp_log.c +s_mp_log_2expt.c s_mp_log_d.c -s_mp_log_pow2.c s_mp_montgomery_reduce_comba.c -s_mp_mul_balance.c s_mp_mul.c +s_mp_mul_balance.c s_mp_mul_comba.c s_mp_mul_high.c s_mp_mul_high_comba.c @@ -149,6 +143,7 @@ s_mp_mul_toom.c s_mp_prime_is_divisible.c s_mp_prime_tab.c s_mp_radix_map.c +s_mp_radix_size_overestimate.c s_mp_rand_jenkins.c s_mp_rand_platform.c s_mp_sqr.c From 97ba3e15d2bd08d38a21b9f0f2bfcbef935d28c6 Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Sun, 13 Feb 2022 12:47:40 +0100 Subject: [PATCH 08/25] cmake: update cmake sources file --- sources.cmake | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sources.cmake b/sources.cmake index fd353c00a..7f395c952 100644 --- a/sources.cmake +++ b/sources.cmake @@ -41,6 +41,7 @@ mp_get_mag_u32.c mp_get_mag_u64.c mp_get_mag_ul.c mp_grow.c +mp_hash.c mp_init.c mp_init_copy.c mp_init_i32.c @@ -83,6 +84,7 @@ mp_prime_strong_lucas_selfridge.c mp_radix_size.c mp_radix_size_overestimate.c mp_rand.c +mp_rand_source.c mp_read_radix.c mp_reduce.c mp_reduce_2k.c @@ -144,7 +146,6 @@ s_mp_prime_is_divisible.c s_mp_prime_tab.c s_mp_radix_map.c s_mp_radix_size_overestimate.c -s_mp_rand_jenkins.c s_mp_rand_platform.c s_mp_sqr.c s_mp_sqr_comba.c From cc8614abee1c08c31cecd3f2c5ad4ffef76c2f3a Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Sat, 19 Feb 2022 12:18:20 +0100 Subject: [PATCH 09/25] cmake: define BUILD_SHARED_LIBS option... in addition to be able to pass it on cmake invokation tools like ccmake et al. will show it as a configurable option --- CMakeLists.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index de68266d6..33e923e65 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -13,6 +13,11 @@ include(GNUInstallDirs) include(CMakePackageConfigHelpers) include(sources.cmake) +#----------------------------------------------------------------------------- +# Options +#----------------------------------------------------------------------------- +option(BUILD_SHARED_LIBS "Build shared library" FALSE) + #----------------------------------------------------------------------------- # library target #----------------------------------------------------------------------------- From 0a370845043f1c73bc0789d5baf7bb97d5170d2b Mon Sep 17 00:00:00 2001 From: Adrian Antonana Date: Sat, 19 Feb 2022 14:37:06 +0100 Subject: [PATCH 10/25] cmake: add missing LIBRARY DESTINATION in install targets --- CMakeLists.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 33e923e65..8394d1ff1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -68,6 +68,7 @@ set(TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets") install(TARGETS ${PROJECT_NAME} EXPORT ${TARGETS_EXPORT_NAME} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} ) From 9412d1a63d137778cc690c4d8b9ba506d83f92de Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Thu, 17 Feb 2022 17:18:40 +0100 Subject: [PATCH 11/25] update README Signed-off-by: Steffen Jaeckel --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index be5b20783..7ee58bbc0 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ This is the git repository for [LibTomMath](http://www.libtom.net/LibTomMath/), ### Travis CI -master: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=master)](https://travis-ci.org/libtom/libtommath) +master: [![Build Status](https://github.com/libtom/libtommath/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/libtom/libtommath/actions/workflows/main.yml?query=branch%3Amaster+++) -develop: [![Build Status](https://api.travis-ci.org/libtom/libtommath.png?branch=develop)](https://travis-ci.org/libtom/libtommath) +develop: [![Build Status](https://github.com/libtom/libtommath/actions/workflows/main.yml/badge.svg?branch=develop)](https://github.com/libtom/libtommath/actions/workflows/main.yml?query=branch%3Adevelop+++) ### AppVeyor @@ -42,3 +42,17 @@ Tests are located in `demo/` and can be built in two flavors. ## Building and Installing Building is straightforward for GNU Linux only, the section "Building LibTomMath" in the documentation in `doc/bn.pdf` has the details. + +### CMake support + +The project provides support for the CMake build system. + +``` +git clone https://github.com/libtom/libtommath.git +mkdir -p libtommath/build +cd libtommath/build +cmake .. +make -j$(nproc) +``` + +A shared library build can be done by setting `-DBUILD_SHARED_LIBS=On` when invoking the `cmake` command. From e1788a822de827a5f869321f6a90b5ad31b420ca Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Thu, 17 Feb 2022 18:06:19 +0100 Subject: [PATCH 12/25] allow unit tests in shared library builds The test sources must be compiled with a special define and require optimisation in order to be able to run. Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 8394d1ff1..be652dd38 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -49,6 +49,19 @@ target_link_libraries(test-target PRIVATE ${PROJECT_NAME} ) +# for the SHARED_LIBRARY build we need some special flags enabled +# We also allow our users to override our selection by defining their own +# `CMAKE_C_FLAGS` on generation-phase. CMake itself doesn't allow a user +# to override settings defined in the CMakeLists.txt so we append it manually +# again even though CMake prepended it already. +target_compile_options(test-target BEFORE PRIVATE + $<$,SHARED_LIBRARY>:-O1 -DLTM_TEST_DYNAMIC> + ${CMAKE_C_FLAGS} +) +target_link_options(test-target BEFORE PRIVATE + $<$,SHARED_LIBRARY>:-O1> +) + #----------------------------------------------------------------------------- # demo target #----------------------------------------------------------------------------- From 7cacdedc874fc4463ef2a15c4038369a9106083b Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Thu, 17 Feb 2022 18:06:43 +0100 Subject: [PATCH 13/25] add cmake tests to CI Signed-off-by: Steffen Jaeckel --- .github/workflows/main.yml | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9e4cee07a..015afe130 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -25,7 +25,7 @@ on: - /^ci\/.*$/ jobs: - Build: + Testme: runs-on: ${{ matrix.os }} strategy: matrix: @@ -146,3 +146,26 @@ jobs: cat test_*.log || true cat valgrind_test.log || true cat gcc_errors_*.log || true + + CMake: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ ubuntu-18.04, ubuntu-20.04 ] + config: + # Static library build + - { CMAKEOPTIONS: '', TARGET: 'check' } + # Shared library build + - { CMAKEOPTIONS: '-DBUILD_SHARED_LIBS=On', TARGET: 'check'} + steps: + - uses: actions/checkout@v2 + - name: install dependencies + run: | + sudo apt-get update -qq + sudo apt-get install cmake + - name: build + run: | + mkdir build + cd build + cmake ${{ matrix.config.CMAKEOPTIONS }} .. + make -j$(nproc) ${{ matrix.config.TARGET }} From 391e47d1fb1f8a2f85e3ef02d343e9e745985ee9 Mon Sep 17 00:00:00 2001 From: czurnieden Date: Sun, 20 Feb 2022 08:28:34 +0100 Subject: [PATCH 14/25] Made "test" work with shared lib, started gathering environment variables for CFLAGS --- CMakeLists.txt | 119 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 114 insertions(+), 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index be652dd38..972321c3b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -13,16 +13,124 @@ include(GNUInstallDirs) include(CMakePackageConfigHelpers) include(sources.cmake) +# The only direct cmake argument for now +option(BUILD_SHARED_LIBS "Build shared library and only the shared library if \"ON\", default is static" OFF) + #----------------------------------------------------------------------------- -# Options +# Compose CFLAGS #----------------------------------------------------------------------------- -option(BUILD_SHARED_LIBS "Build shared library" FALSE) + +# check if there was one already set. +if(DEFINED ENV{LTM_CFLAGS}) + set(LTM_C_FLAGS $ENV{LTM_CFLAGS}) +endif() +if(DEFINED ENV{LTM_LDFLAGS}) + set(LTM_LD_FLAGS $ENV{LTM_LDFLAGS}) +endif() + +# Some information copied from makefile_include.mk + +# Basic set +set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wall -Wsign-compare -Wextra -Wshadow") + +# Do we run the sanitizer? +if(DEFINED ENV{SANITIZER}) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -fsanitize=undefined -fno-sanitize-recover=all -fno-sanitize=float-divide-by-zero") +endif() + +if(NOT DEFINED ENV{NO_ADDTL_WARNINGS}) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wdeclaration-after-statement -Wbad-function-cast -Wcast-align") + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wstrict-prototypes -Wpointer-arith") +endif() + +if(DEFINED ENV{CONV_WARNINGS}) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -std=c89 -Wconversion -Wsign-conversion") + if($ENV{CONV_WARNINGS} EQUAL "strict") + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wc++-compat") + endif() +else() + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wsystem-headers") +endif() + +if(DEFINED ENV{COMPILE_DEBUG}) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -g3") +endif() + +if(DEFINED ENV{COMPILE_SIZE}) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Os") +else() + if(NOT DEFINED ENV{IGNORE_SPEED}) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -O3 -funroll-loops") + #x86 optimizations [should be valid for any GCC install though] + set(LTM_C_FLAGS "${LTM_C_FLAGS} -fomit-frame-pointer") + endif() + # TODO: + # if(DEFINED ENV{COMPILE_LTO}) + # set(LTM_C_FLAGS "${LTM_C_FLAGS} -flto") + # set(LTM_LD_FLAGS "${LTM_LD_FLAGS} -flto") + # #AR = $(subst clang,llvm-ar,$(subst gcc,gcc-ar,$(CC))) + # endif() +endif() + +# What compiler do we have and what are their...uhm... peculiarities +# TODO: is the check for a C++ compiler necessary? +if( (CMAKE_C_COMPILER_ID MATCHES "(C|c?)lang") OR (CMAKE_CXX_COMPILER_ID MATCHES "(C|c?)lang")) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wno-typedef-redefinition -Wno-tautological-compare -Wno-builtin-requires-header") +endif() + +if( (CMAKE_C_COMPILER_ID MATCHES "mingw") OR (CMAKE_CXX_COMPILER_ID MATCHES "mingw")) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wno-shadow") +endif() + +if(DEFINED ENV{PLATFORM}) + if($ENV{PLATFORM} MATCHES "Darwin") + set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wno-nullability-completeness") + endif() + if($ENV{PLATFORM} MATCHES "CYGWIN") + set(LTM_C_FLAGS "${LTM_C_FLAGS} -no-undefined") + endif() +endif() + +# TODO: coverage (lgcov) + +# We have several private functions in the library and the "demo/test" programm +# needs a littkle note to be able to switch them off. Please use the static build +# to get a full test. +if(BUILD_SHARED_LIBS) + set(LTM_C_FLAGS "${LTM_C_FLAGS} -DLTM_TEST_DYNAMIC") +endif() + +# Bring it home +set(CMAKE_C_FLAGS "${LTM_C_FLAGS}") +set(CMAKE_C_FLAGS_DEBUG "${LTM_C_FLAGS}") +set(CMAKE_C_FLAGS_RELEASE "${LTM_C_FLAGS}") #----------------------------------------------------------------------------- # library target #----------------------------------------------------------------------------- -add_library(${PROJECT_NAME} - ${SOURCES} + +# TODO: There may be a way but I found none to build both at once without complication. +# It is possible with e.g. Linux where the static library is named libtommath.a +# and the dynamic library libtommath.so*, two different names. +# That is not the case with e.g. Windows where both types have the same name. +# See also: +# https://stackoverflow.com/questions/2152077/is-it-possible-to-get-cmake-to-build-both-a-static-and-shared-library-at-the-sam +if(BUILD_SHARED_LIBS) + add_library(${PROJECT_NAME} SHARED + ${SOURCES} + ) +else() + add_library(${PROJECT_NAME} STATIC + ${SOURCES} + ) +endif() + +# Clear cache manually +unset(BUILD_SHARED_LIBS CACHE) + +target_include_directories(${PROJECT_NAME} PUBLIC + $ + $ ) target_include_directories(${PROJECT_NAME} PUBLIC @@ -36,6 +144,8 @@ set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION_MAJ #----------------------------------------------------------------------------- # demo target #----------------------------------------------------------------------------- + + add_executable(test-target EXCLUDE_FROM_ALL ${CMAKE_CURRENT_SOURCE_DIR}/demo/shared.c ${CMAKE_CURRENT_SOURCE_DIR}/demo/test.c @@ -81,7 +191,6 @@ set(TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets") install(TARGETS ${PROJECT_NAME} EXPORT ${TARGETS_EXPORT_NAME} - LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} ) From 41574fab61ae47665ea3fd010363a8744aa97439 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Mon, 21 Feb 2022 10:51:14 +0100 Subject: [PATCH 15/25] simplify what was ported from the makefiles * remove some of the complicated logic. The additional warnings always make sense. CMake uses the state of `BUILD_SHARED_LIBS` to determine the library target type. Also remove the comment regarding building shared and static at the same time, as usually that's done as necessary by the user. * append user-defined {C,LD}FLAGS instead of preprending - we expect them to know what they do, so they can override our defaults * use target_{compile,link}_options() instead of setting variables Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 100 ++++++++++++++++++------------------------------- 1 file changed, 36 insertions(+), 64 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 972321c3b..3efd9535e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -20,49 +20,38 @@ option(BUILD_SHARED_LIBS "Build shared library and only the shared library if \" # Compose CFLAGS #----------------------------------------------------------------------------- -# check if there was one already set. -if(DEFINED ENV{LTM_CFLAGS}) - set(LTM_C_FLAGS $ENV{LTM_CFLAGS}) -endif() -if(DEFINED ENV{LTM_LDFLAGS}) - set(LTM_LD_FLAGS $ENV{LTM_LDFLAGS}) -endif() - # Some information copied from makefile_include.mk # Basic set -set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wall -Wsign-compare -Wextra -Wshadow") +set(LTM_C_FLAGS -Wall -Wsign-compare -Wextra -Wshadow) +set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wdeclaration-after-statement -Wbad-function-cast -Wcast-align) +set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wstrict-prototypes -Wpointer-arith) # Do we run the sanitizer? if(DEFINED ENV{SANITIZER}) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -fsanitize=undefined -fno-sanitize-recover=all -fno-sanitize=float-divide-by-zero") -endif() - -if(NOT DEFINED ENV{NO_ADDTL_WARNINGS}) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wdeclaration-after-statement -Wbad-function-cast -Wcast-align") - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wstrict-prototypes -Wpointer-arith") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -fsanitize=undefined -fno-sanitize-recover=all -fno-sanitize=float-divide-by-zero) endif() if(DEFINED ENV{CONV_WARNINGS}) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -std=c89 -Wconversion -Wsign-conversion") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -std=c89 -Wconversion -Wsign-conversion) if($ENV{CONV_WARNINGS} EQUAL "strict") - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wc++-compat") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wc++-compat) endif() else() - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wsystem-headers") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wsystem-headers) endif() if(DEFINED ENV{COMPILE_DEBUG}) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -g3") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -g3) endif() if(DEFINED ENV{COMPILE_SIZE}) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Os") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Os) else() if(NOT DEFINED ENV{IGNORE_SPEED}) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -O3 -funroll-loops") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -O3 -funroll-loops) #x86 optimizations [should be valid for any GCC install though] - set(LTM_C_FLAGS "${LTM_C_FLAGS} -fomit-frame-pointer") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -fomit-frame-pointer) endif() # TODO: # if(DEFINED ENV{COMPILE_LTO}) @@ -72,70 +61,56 @@ else() # endif() endif() +# TODO +# Are the coming three checks really the best way? + # What compiler do we have and what are their...uhm... peculiarities # TODO: is the check for a C++ compiler necessary? if( (CMAKE_C_COMPILER_ID MATCHES "(C|c?)lang") OR (CMAKE_CXX_COMPILER_ID MATCHES "(C|c?)lang")) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wno-typedef-redefinition -Wno-tautological-compare -Wno-builtin-requires-header") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-typedef-redefinition -Wno-tautological-compare -Wno-builtin-requires-header) endif() if( (CMAKE_C_COMPILER_ID MATCHES "mingw") OR (CMAKE_CXX_COMPILER_ID MATCHES "mingw")) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wno-shadow") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-shadow) endif() if(DEFINED ENV{PLATFORM}) if($ENV{PLATFORM} MATCHES "Darwin") - set(LTM_C_FLAGS "${LTM_C_FLAGS} -Wno-nullability-completeness") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-nullability-completeness) endif() if($ENV{PLATFORM} MATCHES "CYGWIN") - set(LTM_C_FLAGS "${LTM_C_FLAGS} -no-undefined") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -no-undefined) endif() endif() # TODO: coverage (lgcov) -# We have several private functions in the library and the "demo/test" programm -# needs a littkle note to be able to switch them off. Please use the static build -# to get a full test. -if(BUILD_SHARED_LIBS) - set(LTM_C_FLAGS "${LTM_C_FLAGS} -DLTM_TEST_DYNAMIC") +# If the user set the environment variables at generate-time, append them +# in order to allow overriding our defaults. +if(DEFINED ENV{LTM_CFLAGS}) + set(LTM_C_FLAGS ${LTM_C_FLAGS} $ENV{LTM_CFLAGS}) +endif() +if(DEFINED ENV{LTM_LDFLAGS}) + set(LTM_LD_FLAGS ${LTM_LD_FLAGS} $ENV{LTM_LDFLAGS}) endif() - -# Bring it home -set(CMAKE_C_FLAGS "${LTM_C_FLAGS}") -set(CMAKE_C_FLAGS_DEBUG "${LTM_C_FLAGS}") -set(CMAKE_C_FLAGS_RELEASE "${LTM_C_FLAGS}") #----------------------------------------------------------------------------- # library target #----------------------------------------------------------------------------- - -# TODO: There may be a way but I found none to build both at once without complication. -# It is possible with e.g. Linux where the static library is named libtommath.a -# and the dynamic library libtommath.so*, two different names. -# That is not the case with e.g. Windows where both types have the same name. -# See also: -# https://stackoverflow.com/questions/2152077/is-it-possible-to-get-cmake-to-build-both-a-static-and-shared-library-at-the-sam -if(BUILD_SHARED_LIBS) - add_library(${PROJECT_NAME} SHARED - ${SOURCES} - ) -else() - add_library(${PROJECT_NAME} STATIC - ${SOURCES} - ) -endif() - -# Clear cache manually -unset(BUILD_SHARED_LIBS CACHE) +add_library(${PROJECT_NAME} + ${SOURCES} +) target_include_directories(${PROJECT_NAME} PUBLIC $ $ ) -target_include_directories(${PROJECT_NAME} PUBLIC - $ - $ +target_compile_options(${PROJECT_NAME} BEFORE PRIVATE + ${LTM_C_FLAGS} +) +target_link_options(${PROJECT_NAME} BEFORE PRIVATE + ${LTM_LD_FLAGS} ) set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${PROJECT_VERSION}) @@ -159,17 +134,13 @@ target_link_libraries(test-target PRIVATE ${PROJECT_NAME} ) -# for the SHARED_LIBRARY build we need some special flags enabled -# We also allow our users to override our selection by defining their own -# `CMAKE_C_FLAGS` on generation-phase. CMake itself doesn't allow a user -# to override settings defined in the CMakeLists.txt so we append it manually -# again even though CMake prepended it already. target_compile_options(test-target BEFORE PRIVATE $<$,SHARED_LIBRARY>:-O1 -DLTM_TEST_DYNAMIC> - ${CMAKE_C_FLAGS} + ${LTM_C_FLAGS} ) target_link_options(test-target BEFORE PRIVATE $<$,SHARED_LIBRARY>:-O1> + ${LTM_LD_FLAGS} ) #----------------------------------------------------------------------------- @@ -191,6 +162,7 @@ set(TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets") install(TARGETS ${PROJECT_NAME} EXPORT ${TARGETS_EXPORT_NAME} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} ) From cb8f2128a19ab04bf34e82a00841e1bff6dda88c Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Mon, 21 Feb 2022 11:18:52 +0100 Subject: [PATCH 16/25] add SPDX identifiers Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 1 + helper.pl | 5 ++++- sources.cmake | 3 +++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 3efd9535e..d74e86643 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,3 +1,4 @@ +# SPDX-License-Identifier: Unlicense # # LibTomMath, a free open source portable number theoretic multiple-precision # integer (MPI) library written entirely in C. diff --git a/helper.pl b/helper.pl index ac87556b1..3701799fe 100755 --- a/helper.pl +++ b/helper.pl @@ -223,7 +223,10 @@ sub patch_file { sub make_sources_cmake { my @list = @_; - my $output = "set(SOURCES\n"; + my $output = "# SPDX-License-Identifier: Unlicense +# Autogenerated File! Do not edit. + +set(SOURCES\n"; foreach my $obj (sort @list) { $output .= $obj . "\n"; } diff --git a/sources.cmake b/sources.cmake index 7f395c952..2bc891139 100644 --- a/sources.cmake +++ b/sources.cmake @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: Unlicense +# Autogenerated File! Do not edit. + set(SOURCES mp_2expt.c mp_abs.c From ba74457fb46aa4def2978b713eb0ea0f182ff6f0 Mon Sep 17 00:00:00 2001 From: czurnieden Date: Wed, 2 Mar 2022 22:28:49 +0100 Subject: [PATCH 17/25] Build and install libtommath.pc --- CMakeLists.txt | 13 +++++++++++++ libtommath.pc.in | 9 ++++----- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index d74e86643..474ae691c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -171,6 +171,19 @@ install(FILES ${HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME} ) +# Install libtommath.pc for pkg-config if we build a shared library +if(BUILD_SHARED_LIBS) + configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/lib${PROJECT_NAME}.pc.in + ${CMAKE_CURRENT_BINARY_DIR}/lib${PROJECT_NAME}.pc + @ONLY + ) + + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib${PROJECT_NAME}.pc + DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig + ) +endif() + # generate package version file write_basic_package_version_file( ${PROJECT_VERSION_FILE} diff --git a/libtommath.pc.in b/libtommath.pc.in index 099b1cd74..ad8f5c3bb 100644 --- a/libtommath.pc.in +++ b/libtommath.pc.in @@ -1,10 +1,9 @@ -prefix=@to-be-replaced@ -exec_prefix=${prefix} -libdir=${exec_prefix}/lib -includedir=${prefix}/include +prefix=@CMAKE_INSTALL_PREFIX@ +libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@ +includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@PROJECT_NAME@ Name: LibTomMath Description: public domain library for manipulating large integer numbers -Version: @to-be-replaced@ +Version: @PROJECT_VERSION@ Libs: -L${libdir} -ltommath Cflags: -I${includedir} From 22dfda7ea085d51c00dcbe841c94a61819c5dc39 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Sun, 27 Feb 2022 12:56:09 +0100 Subject: [PATCH 18/25] further simplifications/improvements * bump to CMake 3.10 * only support the CMake standard way to define variables via `-DFOO=On` and not via the environment * clean-up switches only used for unit tests * mingw's ID is "GNU", so we match on the full compiler name instead * use CMake variables instead of environment variables via `$ENV{}` * unconditionally set {C,LD}FLAGS passed by user * clean-up duplicate CPack keys + add FreeBSD config * store pack files in distro-specific paths * use default names where possible * use `CMAKE_BUILD_TYPE`-style variables instead of our own flags * set default `CMAKE_BUILD_TYPE` to "Release" Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 138 +++++++++++++++++++++++++------------------------ 1 file changed, 70 insertions(+), 68 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 474ae691c..a4bdac3e9 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,8 +4,18 @@ # integer (MPI) library written entirely in C. # -cmake_minimum_required(VERSION 3.7) -project(tommath VERSION 1.2.0) +cmake_minimum_required(VERSION 3.10) + +project(tommath + VERSION 1.2.0 + DESCRIPTION "A free open source portable number theoretic multiple-precision integer (MPI) library written entirely in C." + HOMEPAGE_URL "https://www.libtom.net/LibTomMath" + LANGUAGES C) + +# package release version +# bump if re-releasing the same VERSION + patches +# set to 1 if releasing a new VERSION +set(PACKAGE_RELEASE_VERSION 1) #----------------------------------------------------------------------------- # Include cmake modules @@ -26,74 +36,47 @@ option(BUILD_SHARED_LIBS "Build shared library and only the shared library if \" # Basic set set(LTM_C_FLAGS -Wall -Wsign-compare -Wextra -Wshadow) set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wdeclaration-after-statement -Wbad-function-cast -Wcast-align) -set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wstrict-prototypes -Wpointer-arith) +set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wstrict-prototypes -Wpointer-arith -Wsystem-headers) -# Do we run the sanitizer? -if(DEFINED ENV{SANITIZER}) - set(LTM_C_FLAGS ${LTM_C_FLAGS} -fsanitize=undefined -fno-sanitize-recover=all -fno-sanitize=float-divide-by-zero) +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message(STATUS "Setting build type to 'Release' as none was specified.") + set(CMAKE_BUILD_TYPE "Release") endif() -if(DEFINED ENV{CONV_WARNINGS}) - set(LTM_C_FLAGS ${LTM_C_FLAGS} -std=c89 -Wconversion -Wsign-conversion) - if($ENV{CONV_WARNINGS} EQUAL "strict") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wc++-compat) - endif() -else() - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wsystem-headers) -endif() +set(CMAKE_C_FLAGS_DEBUG "-g3") +set(CMAKE_C_FLAGS_RELEASE "-O3 -funroll-loops -fomit-frame-pointer") +set(CMAKE_C_FLAGS_RELWITHDEBINFO "-g3 -O2") +set(CMAKE_C_FLAGS_MINSIZEREL "-Os") -if(DEFINED ENV{COMPILE_DEBUG}) - set(LTM_C_FLAGS ${LTM_C_FLAGS} -g3) +if(COMPILE_LTO) + set(LTM_C_FLAGS ${LTM_C_FLAGS} -flto) + set(LTM_LD_FLAGS ${LTM_LD_FLAGS} -flto) endif() -if(DEFINED ENV{COMPILE_SIZE}) - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Os) -else() - if(NOT DEFINED ENV{IGNORE_SPEED}) - set(LTM_C_FLAGS ${LTM_C_FLAGS} -O3 -funroll-loops) - #x86 optimizations [should be valid for any GCC install though] - set(LTM_C_FLAGS ${LTM_C_FLAGS} -fomit-frame-pointer) - endif() - # TODO: - # if(DEFINED ENV{COMPILE_LTO}) - # set(LTM_C_FLAGS "${LTM_C_FLAGS} -flto") - # set(LTM_LD_FLAGS "${LTM_LD_FLAGS} -flto") - # #AR = $(subst clang,llvm-ar,$(subst gcc,gcc-ar,$(CC))) - # endif() -endif() - -# TODO -# Are the coming three checks really the best way? - # What compiler do we have and what are their...uhm... peculiarities -# TODO: is the check for a C++ compiler necessary? -if( (CMAKE_C_COMPILER_ID MATCHES "(C|c?)lang") OR (CMAKE_CXX_COMPILER_ID MATCHES "(C|c?)lang")) +if(CMAKE_C_COMPILER_ID MATCHES "(C|c?)lang") set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-typedef-redefinition -Wno-tautological-compare -Wno-builtin-requires-header) + # Clang requires at least '-O1' for dead code eliminiation + set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O1") endif() - -if( (CMAKE_C_COMPILER_ID MATCHES "mingw") OR (CMAKE_CXX_COMPILER_ID MATCHES "mingw")) +if(CMAKE_C_COMPILER MATCHES "mingw") set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-shadow) endif() - -if(DEFINED ENV{PLATFORM}) - if($ENV{PLATFORM} MATCHES "Darwin") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-nullability-completeness) - endif() - if($ENV{PLATFORM} MATCHES "CYGWIN") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -no-undefined) - endif() +if(CMAKE_SYSTEM_NAME MATCHES "Darwin") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-nullability-completeness) +endif() +if(CMAKE_SYSTEM_NAME MATCHES "CYGWIN") + set(LTM_C_FLAGS ${LTM_C_FLAGS} -no-undefined) endif() # TODO: coverage (lgcov) # If the user set the environment variables at generate-time, append them # in order to allow overriding our defaults. -if(DEFINED ENV{LTM_CFLAGS}) - set(LTM_C_FLAGS ${LTM_C_FLAGS} $ENV{LTM_CFLAGS}) -endif() -if(DEFINED ENV{LTM_LDFLAGS}) - set(LTM_LD_FLAGS ${LTM_LD_FLAGS} $ENV{LTM_LDFLAGS}) -endif() +# ${LTM_CFLAGS} means the user passed it via sth like: +# $ cmake -DLTM_CFLAGS="foo" +set(LTM_C_FLAGS ${LTM_C_FLAGS} ${LTM_CFLAGS}) +set(LTM_LD_FLAGS ${LTM_LD_FLAGS} ${LTM_LDFLAGS}) #----------------------------------------------------------------------------- # library target @@ -114,8 +97,10 @@ target_link_options(${PROJECT_NAME} BEFORE PRIVATE ${LTM_LD_FLAGS} ) -set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${PROJECT_VERSION}) -set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR}) +set_target_properties(${PROJECT_NAME} PROPERTIES + VERSION ${PROJECT_VERSION} + SOVERSION ${PROJECT_VERSION_MAJOR} +) #----------------------------------------------------------------------------- # demo target @@ -213,8 +198,6 @@ export(PACKAGE ${PROJECT_NAME}) #--------------------------------------------------------------------------------------- # Create release packages #--------------------------------------------------------------------------------------- -# package release version -set(PACKAGE_RELEASE_VERSION 1) # determine distribution and architecture find_program(LSB_RELEASE lsb_release) @@ -222,10 +205,18 @@ find_program(LSB_RELEASE lsb_release) execute_process(COMMAND uname -m OUTPUT_VARIABLE MACHINE_ARCH OUTPUT_STRIP_TRAILING_WHITESPACE) if(LSB_RELEASE) - execute_process(COMMAND lsb_release -sr OUTPUT_VARIABLE LINUX_DISTRO_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) execute_process(COMMAND lsb_release -si OUTPUT_VARIABLE LINUX_DISTRO OUTPUT_STRIP_TRAILING_WHITESPACE) + execute_process(COMMAND lsb_release -sc OUTPUT_VARIABLE LINUX_DISTRO_CODENAME OUTPUT_STRIP_TRAILING_WHITESPACE) + execute_process(COMMAND lsb_release -sr OUTPUT_VARIABLE LINUX_DISTRO_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) string(TOLOWER ${LINUX_DISTRO} LINUX_DISTRO) + if(LINUX_DISTRO_CODENAME STREQUAL "n/a") + set(DISTRO_PACK_PATH ${LINUX_DISTRO}/${LINUX_DISTRO_VERSION}/) + else() + set(DISTRO_PACK_PATH ${LINUX_DISTRO}/${LINUX_DISTRO_CODENAME}/) + endif() +else() + set(DISTRO_PACK_PATH ${CMAKE_SYSTEM_NAME}/) endif() # default CPack generators @@ -236,33 +227,44 @@ if(LINUX_DISTRO STREQUAL "debian" OR LINUX_DISTRO STREQUAL "ubuntu" OR LINUX_DIS list(APPEND CPACK_GENERATOR DEB) elseif(LINUX_DISTRO STREQUAL "fedora" OR LINUX_DISTRO STREQUAL "opensuse" OR LINUX_DISTRO STREQUAL "centos") list(APPEND CPACK_GENERATOR RPM) +elseif(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD") + list(APPEND CPACK_GENERATOR FREEBSD) endif() # general CPack config -set(CPACK_PACKAGE_DIRECTORY ${CMAKE_BINARY_DIR}/packages) +set(CPACK_PACKAGE_DIRECTORY ${CMAKE_BINARY_DIR}/packages/${DISTRO_PACK_PATH}) message(STATUS "CPack: packages will be generated under ${CPACK_PACKAGE_DIRECTORY}") set(CPACK_PACKAGE_NAME "lib${PROJECT_NAME}") set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION}) set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "LibTomMath") -set(CPACK_PACKAGE_VENDOR "LibTomMath") +set(CPACK_PACKAGE_VENDOR "libtom projects") set(CPACK_PACKAGE_CONTACT "libtom@googlegroups.com") set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE") -set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${PACKAGE_RELEASE_VERSION}_${LINUX_DISTRO}-${LINUX_DISTRO_VERSION}_${MACHINE_ARCH}) +set(PACKAGE_NAME_TRAILER ${CPACK_PACKAGE_VERSION}-${PACKAGE_RELEASE_VERSION}_${MACHINE_ARCH}) +set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}-${PACKAGE_NAME_TRAILER}) set(CPACK_STRIP_FILES ON) # deb specific CPack config -set(CPACK_DEBIAN_PACKAGE_RELEASE ${PACKAGE_RELEASE_VERSION}) set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) -set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://www.libtom.net/LibTomMath") -set(CPACK_DEBIAN_PACKAGE_SECTION "devel") +set(CPACK_DEBIAN_PACKAGE_RELEASE ${PACKAGE_RELEASE_VERSION}) +if(BUILD_SHARED_LIBS) + set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}1") + set(CPACK_DEBIAN_PACKAGE_SECTION "libs") +else() + set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}-dev") + set(CPACK_DEBIAN_PACKAGE_SECTION "devel") +endif() # rpm specific CPack config -set(CPACK_RPM_PACKAGE_URL "https://www.libtom.net/LibTomMath") set(CPACK_RPM_PACKAGE_RELEASE ${PACKAGE_RELEASE_VERSION}) set(CPACK_RPM_PACKAGE_ARCHITECTURE ${MACHINE_ARCH}) -set(CPACK_RPM_PACKAGE_NAME "lib${PROJECT_NAME}-${PROJECT_VERSION}") -set(CPACK_RPM_FILE_NAME "lib${PROJECT_NAME}_${PROJECT_VERSION}-${CPACK_RPM_PACKAGE_RELEASE}_${LINUX_DISTRO}-${LINUX_DISTRO_VERSION}_${CPACK_RPM_PACKAGE_ARCHITECTURE}.rpm") -set(CPACK_RPM_PACKAGE_LICENSE "WTFPL") +set(CPACK_RPM_PACKAGE_NAME "${CPACK_PACKAGE_NAME}-${PROJECT_VERSION}") +set(CPACK_RPM_PACKAGE_LICENSE "The Unlicense") + +# FreeBSD specific CPack config +set(CPACK_FREEBSD_PACKAGE_MAINTAINER "gahr@FreeBSD.org") +set(CPACK_FREEBSD_PACKAGE_ORIGIN "math/libtommath") +set(CPACK_FREEBSD_PACKAGE_CATEGORIES "math") include(CPack) From ed6ad7d9abaf92204ad9e5f7cf1261bbe72b1fc4 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Tue, 15 Mar 2022 14:12:09 +0100 Subject: [PATCH 19/25] extend CI matrix for different cmake options Signed-off-by: Steffen Jaeckel --- .github/workflows/main.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 015afe130..bfda74b7c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -152,6 +152,8 @@ jobs: strategy: matrix: os: [ ubuntu-18.04, ubuntu-20.04 ] + build_type: [ '', -DCMAKE_BUILD_TYPE=Debug, -DCMAKE_BUILD_TYPE=Release, -DCMAKE_BUILD_TYPE=RelWithDebInfo, -DCMAKE_BUILD_TYPE=MinSizeRel ] + cc: [ clang, gcc ] config: # Static library build - { CMAKEOPTIONS: '', TARGET: 'check' } @@ -162,10 +164,10 @@ jobs: - name: install dependencies run: | sudo apt-get update -qq - sudo apt-get install cmake + sudo apt-get install -y cmake gcc clang llvm - name: build run: | mkdir build cd build - cmake ${{ matrix.config.CMAKEOPTIONS }} .. + CC=${{ matrix.cc }} cmake ${{ matrix.config.CMAKEOPTIONS }} ${{ matrix.build_type }} .. make -j$(nproc) ${{ matrix.config.TARGET }} From ab9ba06d4deb5e50d8efb43c9b18f4c1e99626b3 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Tue, 22 Mar 2022 13:49:02 +0100 Subject: [PATCH 20/25] fix `pkgconfig` creation in `makefile.shared` Signed-off-by: Steffen Jaeckel --- makefile.shared | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/makefile.shared b/makefile.shared index 41a0cd200..4938da820 100644 --- a/makefile.shared +++ b/makefile.shared @@ -65,7 +65,8 @@ install: $(LIBNAME) install -d $(DESTDIR)$(INCPATH) $(LIBTOOL) --mode=install install -m 644 $(LIBNAME) $(DESTDIR)$(LIBPATH)/$(LIBNAME) install -m 644 $(HEADERS_PUB) $(DESTDIR)$(INCPATH) - sed -e 's,^prefix=.*,prefix=$(PREFIX),' -e 's,^Version:.*,Version: $(VERSION_PC),' libtommath.pc.in > libtommath.pc + sed -e 's,^prefix=.*,prefix=$(PREFIX),' -e 's,^Version:.*,Version: $(VERSION_PC),' -e 's,@CMAKE_INSTALL_LIBDIR@,lib,' \ + -e 's,@CMAKE_INSTALL_INCLUDEDIR@/@PROJECT_NAME@,include/tommath,' libtommath.pc.in > libtommath.pc install -d $(DESTDIR)$(LIBPATH)/pkgconfig install -m 644 libtommath.pc $(DESTDIR)$(LIBPATH)/pkgconfig/ From a107eafd84d55faf2612ccd352dd088db69fee10 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Tue, 22 Mar 2022 13:49:36 +0100 Subject: [PATCH 21/25] include all headers in sources.cmake Signed-off-by: Steffen Jaeckel --- helper.pl | 22 +++++++++++++++------- sources.cmake | 5 +++++ 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/helper.pl b/helper.pl index 3701799fe..e5ad27ac5 100755 --- a/helper.pl +++ b/helper.pl @@ -222,23 +222,31 @@ sub patch_file { } sub make_sources_cmake { - my @list = @_; + my ($src_ref, $hdr_ref) = @_; + my @sources = @{ $src_ref }; + my @headers = @{ $hdr_ref }; my $output = "# SPDX-License-Identifier: Unlicense # Autogenerated File! Do not edit. set(SOURCES\n"; - foreach my $obj (sort @list) { - $output .= $obj . "\n"; + foreach my $sobj (sort @sources) { + $output .= $sobj . "\n"; + } + $output .= ")\n\nset(HEADERS\n"; + foreach my $hobj (sort @headers) { + $output .= $hobj . "\n"; } - $output .= ")\n\nset(HEADERS\ntommath.h\n)\n"; + $output .= ")\n"; return $output; } sub process_makefiles { my $write = shift; my $changed_count = 0; - my @o = map { my $x = $_; $x =~ s/\.c$/.o/; $x } bsd_glob("*.c"); - my @all = bsd_glob("*.{c,h}"); + my @headers = bsd_glob("*.h"); + my @sources = bsd_glob("*.c"); + my @o = map { my $x = $_; $x =~ s/\.c$/.o/; $x } @sources; + my @all = sort(@sources, @headers); my $var_o = prepare_variable("OBJECTS", @o); (my $var_obj = $var_o) =~ s/\.o\b/.obj/sg; @@ -260,7 +268,7 @@ sub process_makefiles { for my $m (qw/ makefile makefile.shared makefile_include.mk makefile.msvc makefile.unix makefile.mingw sources.cmake /) { my $old = read_file($m); my $new = $m eq 'makefile.msvc' ? patch_file($old, $var_obj) - : $m eq 'sources.cmake' ? make_sources_cmake(bsd_glob("*.c")) + : $m eq 'sources.cmake' ? make_sources_cmake(\@sources, \@headers) : patch_file($old, $var_o); if ($old ne $new) { diff --git a/sources.cmake b/sources.cmake index 2bc891139..797d461e2 100644 --- a/sources.cmake +++ b/sources.cmake @@ -161,4 +161,9 @@ s_mp_zero_digs.c set(HEADERS tommath.h +tommath_c89.h +tommath_class.h +tommath_cutoffs.h +tommath_private.h +tommath_superclass.h ) From 0b98bc717f48ff16d859c4bdef9f0300c92348e8 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Tue, 22 Mar 2022 15:35:55 +0100 Subject: [PATCH 22/25] split up into two CMakeLists.txt one for the library, one for the demo Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 32 +---------------------- demo/CMakeLists.txt | 63 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 31 deletions(-) create mode 100644 demo/CMakeLists.txt diff --git a/CMakeLists.txt b/CMakeLists.txt index a4bdac3e9..b36718c8f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -102,41 +102,11 @@ set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR} ) -#----------------------------------------------------------------------------- -# demo target -#----------------------------------------------------------------------------- - - -add_executable(test-target EXCLUDE_FROM_ALL - ${CMAKE_CURRENT_SOURCE_DIR}/demo/shared.c - ${CMAKE_CURRENT_SOURCE_DIR}/demo/test.c -) - -target_include_directories(test-target PRIVATE - ${CMAKE_CURRENT_SOURCE_DIR} -) - -target_link_libraries(test-target PRIVATE - ${PROJECT_NAME} -) - -target_compile_options(test-target BEFORE PRIVATE - $<$,SHARED_LIBRARY>:-O1 -DLTM_TEST_DYNAMIC> - ${LTM_C_FLAGS} -) -target_link_options(test-target BEFORE PRIVATE - $<$,SHARED_LIBRARY>:-O1> - ${LTM_LD_FLAGS} -) #----------------------------------------------------------------------------- # demo target #----------------------------------------------------------------------------- -add_custom_target(check - COMMAND ${CMAKE_CURRENT_BINARY_DIR}/test-target -) - -add_dependencies(check test-target) +add_subdirectory(demo) #----------------------------------------------------------------------------- # Install/export targets and files diff --git a/demo/CMakeLists.txt b/demo/CMakeLists.txt new file mode 100644 index 000000000..f8cfef25a --- /dev/null +++ b/demo/CMakeLists.txt @@ -0,0 +1,63 @@ +# SPDX-License-Identifier: Unlicense +# +# LibTomMath, a free open source portable number theoretic multiple-precision +# integer (MPI) library written entirely in C. +# + +cmake_minimum_required(VERSION 3.10) + +set(LTM_TEST test-ltm) + +# This file can be included from the top level or used stand-alone +if(PROJECT_NAME) + set(LIBRARY_NAME ${PROJECT_NAME}) +else() + # Define an independent project and all the necessary stuff around + project(${LTM_TEST} + LANGUAGES C) + set(LIBRARY_NAME tommath) + find_package(${LIBRARY_NAME}) + include(CTest) + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Release") + endif() +endif() + +#----------------------------------------------------------------------------- +# Compose CFLAGS etc. +#----------------------------------------------------------------------------- + +if(NOT MSVC) + set(CMAKE_C_FLAGS_DEBUG "-g3 -O1") +endif() + +#----------------------------------------------------------------------------- +# demo target +#----------------------------------------------------------------------------- + +add_executable(${LTM_TEST} + ${CMAKE_CURRENT_SOURCE_DIR}/shared.c + ${CMAKE_CURRENT_SOURCE_DIR}/test.c +) + +target_include_directories(${LTM_TEST} PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + $<$:${CMAKE_CURRENT_SOURCE_DIR}/..> +) + +target_link_libraries(${LTM_TEST} PRIVATE + ${LIBRARY_NAME} +) + +target_compile_options(${LTM_TEST} PRIVATE + $<$,SHARED_LIBRARY>:-DLTM_TEST_DYNAMIC> + ${LTM_C_FLAGS} +) +target_link_options(${LTM_TEST} BEFORE PUBLIC + ${LTM_LD_FLAGS} +) + +#----------------------------------------------------------------------------- +# CTest +#----------------------------------------------------------------------------- +add_test(NAME ${LTM_TEST} COMMAND ${LTM_TEST}) From 0f80b46a6d53d4e1861793d14de08cd43ca73491 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Tue, 22 Mar 2022 19:56:27 +0100 Subject: [PATCH 23/25] adjust CI builds * split up build and test process * build and run tests twice - once from regular build folder - once from demo Signed-off-by: Steffen Jaeckel --- .github/workflows/main.yml | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bfda74b7c..06eb58add 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -156,9 +156,9 @@ jobs: cc: [ clang, gcc ] config: # Static library build - - { CMAKEOPTIONS: '', TARGET: 'check' } + - { CMAKEOPTIONS: '-DBUILD_SHARED_LIBS=Off' } # Shared library build - - { CMAKEOPTIONS: '-DBUILD_SHARED_LIBS=On', TARGET: 'check'} + - { CMAKEOPTIONS: '-DBUILD_SHARED_LIBS=On' } steps: - uses: actions/checkout@v2 - name: install dependencies @@ -169,5 +169,18 @@ jobs: run: | mkdir build cd build - CC=${{ matrix.cc }} cmake ${{ matrix.config.CMAKEOPTIONS }} ${{ matrix.build_type }} .. - make -j$(nproc) ${{ matrix.config.TARGET }} + CC=${{ matrix.cc }} cmake ${{ matrix.config.CMAKEOPTIONS }} ${{ matrix.build_type }} .. + make -j$(nproc) + - name: test + run: | + cd build + CC=${{ matrix.cc }} cmake ${{ matrix.config.CMAKEOPTIONS }} ${{ matrix.build_type }} -DBUILD_TESTING=On .. + make -j$(nproc) + ctest + - name: test (in demo folder) + run: | + mkdir -p demo/build + cd demo/build + CC=${{ matrix.cc }} cmake ${{ matrix.config.CMAKEOPTIONS }} ${{ matrix.build_type }} .. + make -j$(nproc) + ctest From d31801fe03ba93d184586c91060344ed36b14534 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Tue, 22 Mar 2022 15:39:00 +0100 Subject: [PATCH 24/25] take review comments into account * protect GCC-specific stuff * use `list(APPEND...)` * use CMake-style way to choose whether LTO should/can be done or not * only install public header, not all * add correct `install` option for DLL's on Windows * use correct folder for .pc files * check if `uname` exists & add support for FreeBSD Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 81 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 54 insertions(+), 27 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index b36718c8f..1b9877604 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -21,7 +21,11 @@ set(PACKAGE_RELEASE_VERSION 1) # Include cmake modules #----------------------------------------------------------------------------- include(GNUInstallDirs) +include(CheckIPOSupported) include(CMakePackageConfigHelpers) +# default is "No tests" +option(BUILD_TESTING "" OFF) +include(CTest) include(sources.cmake) # The only direct cmake argument for now @@ -31,42 +35,41 @@ option(BUILD_SHARED_LIBS "Build shared library and only the shared library if \" # Compose CFLAGS #----------------------------------------------------------------------------- -# Some information copied from makefile_include.mk +# Some information ported from makefile_include.mk -# Basic set -set(LTM_C_FLAGS -Wall -Wsign-compare -Wextra -Wshadow) -set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wdeclaration-after-statement -Wbad-function-cast -Wcast-align) -set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wstrict-prototypes -Wpointer-arith -Wsystem-headers) if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) message(STATUS "Setting build type to 'Release' as none was specified.") set(CMAKE_BUILD_TYPE "Release") endif() -set(CMAKE_C_FLAGS_DEBUG "-g3") -set(CMAKE_C_FLAGS_RELEASE "-O3 -funroll-loops -fomit-frame-pointer") -set(CMAKE_C_FLAGS_RELWITHDEBINFO "-g3 -O2") -set(CMAKE_C_FLAGS_MINSIZEREL "-Os") - -if(COMPILE_LTO) - set(LTM_C_FLAGS ${LTM_C_FLAGS} -flto) - set(LTM_LD_FLAGS ${LTM_LD_FLAGS} -flto) +# We only differentiate between MSVC and GCC-compatible compilers +if(MSVC) + set(LTM_C_FLAGS -W3) +else() + set(LTM_C_FLAGS -Wall -Wsign-compare -Wextra -Wshadow + -Wdeclaration-after-statement -Wbad-function-cast -Wcast-align + -Wstrict-prototypes -Wpointer-arith -Wsystem-headers) + set(CMAKE_C_FLAGS_DEBUG "-g3") + set(CMAKE_C_FLAGS_RELEASE "-O3 -funroll-loops -fomit-frame-pointer") + set(CMAKE_C_FLAGS_RELWITHDEBINFO "-g3 -O2") + set(CMAKE_C_FLAGS_MINSIZEREL "-Os") endif() # What compiler do we have and what are their...uhm... peculiarities if(CMAKE_C_COMPILER_ID MATCHES "(C|c?)lang") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-typedef-redefinition -Wno-tautological-compare -Wno-builtin-requires-header) + list(APPEND LTM_C_FLAGS -Wno-typedef-redefinition -Wno-tautological-compare -Wno-builtin-requires-header) # Clang requires at least '-O1' for dead code eliminiation - set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O1") + set(CMAKE_C_FLAGS_DEBUG "-O1 ${CMAKE_C_FLAGS_DEBUG}") endif() if(CMAKE_C_COMPILER MATCHES "mingw") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-shadow) + list(APPEND LTM_C_FLAGS -Wno-shadow -Wno-expansion-to-defined -Wno-declaration-after-statement -Wno-bad-function-cast) endif() if(CMAKE_SYSTEM_NAME MATCHES "Darwin") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -Wno-nullability-completeness) + list(APPEND LTM_C_FLAGS -Wno-nullability-completeness) endif() if(CMAKE_SYSTEM_NAME MATCHES "CYGWIN") - set(LTM_C_FLAGS ${LTM_C_FLAGS} -no-undefined) + list(APPEND LTM_C_FLAGS -no-undefined) endif() # TODO: coverage (lgcov) @@ -75,14 +78,15 @@ endif() # in order to allow overriding our defaults. # ${LTM_CFLAGS} means the user passed it via sth like: # $ cmake -DLTM_CFLAGS="foo" -set(LTM_C_FLAGS ${LTM_C_FLAGS} ${LTM_CFLAGS}) -set(LTM_LD_FLAGS ${LTM_LD_FLAGS} ${LTM_LDFLAGS}) +list(APPEND LTM_C_FLAGS ${LTM_CFLAGS}) +list(APPEND LTM_LD_FLAGS ${LTM_LDFLAGS}) #----------------------------------------------------------------------------- # library target #----------------------------------------------------------------------------- add_library(${PROJECT_NAME} ${SOURCES} + ${HEADERS} ) target_include_directories(${PROJECT_NAME} PUBLIC @@ -100,13 +104,27 @@ target_link_options(${PROJECT_NAME} BEFORE PRIVATE set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR} + PUBLIC_HEADER tommath.h ) +option(COMPILE_LTO "Build with LTO enabled") +if(COMPILE_LTO) + check_ipo_supported(RESULT COMPILER_SUPPORTS_LTO) + if(COMPILER_SUPPORTS_LTO) + set_property(TARGET ${PROJECT_NAME} PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE) + else() + message(SEND_ERROR "This compiler does not support LTO. Reconfigure ${PROJECT_NAME} with -DCOMPILE_LTO=OFF.") + endif() +endif() #----------------------------------------------------------------------------- # demo target #----------------------------------------------------------------------------- -add_subdirectory(demo) + +if(BUILD_TESTING) + enable_testing() + add_subdirectory(demo) +endif() #----------------------------------------------------------------------------- # Install/export targets and files @@ -120,14 +138,15 @@ install(TARGETS ${PROJECT_NAME} EXPORT ${TARGETS_EXPORT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} -) - -install(FILES ${HEADERS} - DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME} ) # Install libtommath.pc for pkg-config if we build a shared library if(BUILD_SHARED_LIBS) + # Let the user override the default directory of the pkg-config file (usually this shouldn't be required to be changed) + set(CMAKE_INSTALL_PKGCONFIGDIR "${CMAKE_INSTALL_LIBDIR}/pkgconfig" CACHE PATH "Folder where to install .pc files") + configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/lib${PROJECT_NAME}.pc.in ${CMAKE_CURRENT_BINARY_DIR}/lib${PROJECT_NAME}.pc @@ -135,7 +154,7 @@ if(BUILD_SHARED_LIBS) ) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib${PROJECT_NAME}.pc - DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig + DESTINATION ${CMAKE_INSTALL_PKGCONFIGDIR} ) endif() @@ -171,8 +190,16 @@ export(PACKAGE ${PROJECT_NAME}) # determine distribution and architecture find_program(LSB_RELEASE lsb_release) +find_program(SYSCTL sysctl) +find_program(UNAME uname) -execute_process(COMMAND uname -m OUTPUT_VARIABLE MACHINE_ARCH OUTPUT_STRIP_TRAILING_WHITESPACE) +if(UNAME) + execute_process(COMMAND uname -m OUTPUT_VARIABLE MACHINE_ARCH OUTPUT_STRIP_TRAILING_WHITESPACE) +elseif(SYSCTL) + execute_process(COMMAND sysctl -b hw.machine_arch OUTPUT_VARIABLE MACHINE_ARCH OUTPUT_STRIP_TRAILING_WHITESPACE) +else() + string(TOLOWER ${CMAKE_SYSTEM_NAME} MACHINE_ARCH) +endif() if(LSB_RELEASE) execute_process(COMMAND lsb_release -si OUTPUT_VARIABLE LINUX_DISTRO OUTPUT_STRIP_TRAILING_WHITESPACE) From 72ce1e53731dc0a4d42d7568280b063789205db3 Mon Sep 17 00:00:00 2001 From: Steffen Jaeckel Date: Wed, 23 Mar 2022 12:21:27 +0100 Subject: [PATCH 25/25] rename cmake project to `libtommath` Instead of prepending multiple times 'lib', change the target-properties `OUTPUT_NAME` once. This also improves cpack package names to be more distro-style. Signed-off-by: Steffen Jaeckel --- CMakeLists.txt | 18 +++++++++++------- demo/CMakeLists.txt | 2 +- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 1b9877604..bca46ea57 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.10) -project(tommath +project(libtommath VERSION 1.2.0 DESCRIPTION "A free open source portable number theoretic multiple-precision integer (MPI) library written entirely in C." HOMEPAGE_URL "https://www.libtom.net/LibTomMath" @@ -102,6 +102,7 @@ target_link_options(${PROJECT_NAME} BEFORE PRIVATE ) set_target_properties(${PROJECT_NAME} PROPERTIES + OUTPUT_NAME tommath VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR} PUBLIC_HEADER tommath.h @@ -148,12 +149,12 @@ if(BUILD_SHARED_LIBS) set(CMAKE_INSTALL_PKGCONFIGDIR "${CMAKE_INSTALL_LIBDIR}/pkgconfig" CACHE PATH "Folder where to install .pc files") configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/lib${PROJECT_NAME}.pc.in - ${CMAKE_CURRENT_BINARY_DIR}/lib${PROJECT_NAME}.pc + ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_NAME}.pc.in + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc @ONLY ) - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib${PROJECT_NAME}.pc + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc DESTINATION ${CMAKE_INSTALL_PKGCONFIGDIR} ) endif() @@ -231,7 +232,11 @@ endif() # general CPack config set(CPACK_PACKAGE_DIRECTORY ${CMAKE_BINARY_DIR}/packages/${DISTRO_PACK_PATH}) message(STATUS "CPack: packages will be generated under ${CPACK_PACKAGE_DIRECTORY}") -set(CPACK_PACKAGE_NAME "lib${PROJECT_NAME}") +if(BUILD_SHARED_LIBS) + set(CPACK_PACKAGE_NAME "${PROJECT_NAME}${PROJECT_VERSION_MAJOR}") +else() + set(CPACK_PACKAGE_NAME "${PROJECT_NAME}-devel") +endif() set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION}) set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "LibTomMath") set(CPACK_PACKAGE_VENDOR "libtom projects") @@ -246,10 +251,9 @@ set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) set(CPACK_DEBIAN_PACKAGE_RELEASE ${PACKAGE_RELEASE_VERSION}) if(BUILD_SHARED_LIBS) - set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}1") set(CPACK_DEBIAN_PACKAGE_SECTION "libs") else() - set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}-dev") + set(CPACK_DEBIAN_PACKAGE_NAME "${PROJECT_NAME}-dev") set(CPACK_DEBIAN_PACKAGE_SECTION "devel") endif() diff --git a/demo/CMakeLists.txt b/demo/CMakeLists.txt index f8cfef25a..06ff898b4 100644 --- a/demo/CMakeLists.txt +++ b/demo/CMakeLists.txt @@ -15,7 +15,7 @@ else() # Define an independent project and all the necessary stuff around project(${LTM_TEST} LANGUAGES C) - set(LIBRARY_NAME tommath) + set(LIBRARY_NAME libtommath) find_package(${LIBRARY_NAME}) include(CTest) if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)