Introduce AE_FEATURE to manage configure features
[urcu.git] / configure.ac
index 8e7ff4c15b4f8914f5de15290e506347565f7387..70e8e01b7a687275a23e41c32d6735eda1adfdfe 100644 (file)
@@ -1,9 +1,31 @@
-AC_PREREQ(2.59)
-AC_INIT([userspace-rcu],[0.11.0-pre],[mathieu dot desnoyers at efficios dot com], [], [http://liburcu.org/])
-
+dnl SPDX-License-Identifier: LGPL-2.1-only
+dnl
+dnl Copyright (C) 2021 EfficiOS, Inc.
+dnl
+dnl Process this file with autoconf to produce a configure script.
+
+# Project version information
+m4_define([urcu_version_major], [0])
+m4_define([urcu_version_minor], [12])
+m4_define([urcu_version_patch], [0])
+m4_define([urcu_version_dev_stage], [])
+m4_define([urcu_version], urcu_version_major[.]urcu_version_minor[.]urcu_version_patch[]urcu_version_dev_stage)
+
+# Library version information of "liburcu"
 # Following the numbering scheme proposed by libtool for the library version
 # http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
-AC_SUBST([URCU_LIBRARY_VERSION], [6:0:0])
+m4_define([urcu_lib_version_current], [7])
+m4_define([urcu_lib_version_revision], [0])
+m4_define([urcu_lib_version_age], [1])
+m4_define([urcu_lib_version], urcu_lib_version_current[:]urcu_lib_version_revision[:]urcu_lib_version_age)
+
+
+##                     ##
+## Autoconf base setup ##
+##                     ##
+
+AC_PREREQ([2.69])
+AC_INIT([userspace-rcu],[urcu_version],[mathieu dot desnoyers at efficios dot com],[],[http://liburcu.org/])
 
 AC_CONFIG_HEADERS([include/config.h include/urcu/config.h])
 AC_CONFIG_AUX_DIR([config])
@@ -12,57 +34,91 @@ AC_CONFIG_MACRO_DIR([m4])
 AC_CANONICAL_TARGET
 AC_CANONICAL_HOST
 
-AM_INIT_AUTOMAKE([foreign dist-bzip2 no-dist-gzip nostdinc])
+
+##                     ##
+## Automake base setup ##
+##                     ##
+
+AM_INIT_AUTOMAKE([1.12 foreign dist-bzip2 no-dist-gzip nostdinc -Wall -Wno-portability -Werror])
 AM_MAINTAINER_MODE([enable])
 
-# Enable silent rules if available (Introduced in AM 1.11)
-m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
-
-AC_REQUIRE_AUX_FILE([tap-driver.sh])
-
-AH_TEMPLATE([CONFIG_RCU_SMP], [Enable SMP support. With SMP support enabled, uniprocessors are also supported. With SMP support disabled, UP systems work fine, but the behavior of SMP systems is undefined.])
-AH_TEMPLATE([CONFIG_RCU_HAVE_FENCE], [Defined when on a system that has memory fence instructions.])
-AH_TEMPLATE([CONFIG_RCU_HAVE_FUTEX], [Defined when on a system with futex support.])
-AH_TEMPLATE([CONFIG_RCU_COMPAT_ARCH], [Compatibility mode for i386 which lacks cmpxchg instruction.])
-AH_TEMPLATE([CONFIG_RCU_ARM_HAVE_DMB], [Use the dmb instruction if available for use on ARM.])
-AH_TEMPLATE([CONFIG_RCU_TLS], [TLS provided by the compiler.])
-AH_TEMPLATE([CONFIG_RCU_HAVE_CLOCK_GETTIME], [clock_gettime() is detected.])
-AH_TEMPLATE([CONFIG_RCU_FORCE_SYS_MEMBARRIER], [Require the operating system to support the membarrier system call for default and bulletproof flavors.])
-AH_TEMPLATE([CONFIG_RCU_DEBUG], [Enable internal debugging self-checks. Introduce performance penalty.])
-
-# Allow requiring the operating system to support the membarrier system
-# call. Applies to default and bulletproof flavors.
-AC_ARG_ENABLE([sys-membarrier-fallback],
-       AS_HELP_STRING([--disable-sys-membarrier-fallback], [Abort if sys-membarrier is needed but not available rather than using a fallback.]),
-       [def_sys_membarrier_fallback=$enableval],
-       [def_sys_membarrier_fallback="yes"])
-AS_IF([test "x$def_sys_membarrier_fallback" != "xyes"], [AC_DEFINE([CONFIG_RCU_FORCE_SYS_MEMBARRIER], [1])])
-
-# Allow overriding storage used for TLS variables.
-AC_ARG_ENABLE([compiler-tls],
-       AS_HELP_STRING([--disable-compiler-tls], [Use pthread_getspecific() to emulate Thread Local Storage (TLS) variables.]),
-       [def_compiler_tls=$enableval],
-       [def_compiler_tls="yes"])
-
-# If not overridden, use ax_tls.m4 to check if TLS is available.
-AS_IF([test "x$def_compiler_tls" = "xyes"],
-       [AX_TLS([def_tls_detect=$ac_cv_tls], [:])],
-       [:])
-
-AS_IF([test "x$def_tls_detect" = "x"],
-       [:],
-       [AC_DEFINE_UNQUOTED([CONFIG_RCU_TLS], $def_tls_detect)])
-
-# Checks for C compiler
-AC_USE_SYSTEM_EXTENSIONS
+# Enable silent rules by default
+AM_SILENT_RULES([yes])
+
+
+##                               ##
+## OS and Arch specific defaults ##
+##                               ##
+
+AS_CASE([$host],
+  [*-cygwin*], [LT_NO_UNDEFINED="-no-undefined"]
+)
+
+
+##                   ##
+## C compiler checks ##
+##                   ##
+
+# Choose the C compiler
 AC_PROG_CC
-AC_PROG_CC_STDC
+# AC_PROG_CC_STDC was merged in AC_PROG_CC in autoconf 2.70
+m4_version_prereq([2.70], [], [AC_PROG_CC_STDC])
+
+# Make sure the C compiler supports C99
+AS_IF([test "$ac_cv_prog_cc_c99" = "no"], [AC_MSG_ERROR([The compiler does not support C99])])
+
+# Enable available system extensions and LFS support
+AC_USE_SYSTEM_EXTENSIONS
+AC_SYS_LARGEFILE
+
+# Make sure the C compiler supports __attribute__
+AX_C___ATTRIBUTE__
+AS_IF([test "x$ax_cv___attribute__" != "xyes"],
+  [AC_MSG_ERROR([The compiler does not support __attribute__ extensions])])
+
+# Make sure we have pthread support
+AX_PTHREAD([], [AC_MSG_ERROR([Could not configure pthread support])])
+
+# Make sure the C compiler supports weak symbols
+AX_SYS_WEAK_ALIAS
+AS_IF([test "x$ax_cv_sys_weak_alias" = "xno"],
+  [AC_MSG_ERROR([Your platform doesn't support weak symbols.])])
+
+# Checks for typedefs, structures, and compiler characteristics.
+AC_C_INLINE
+AC_C_TYPEOF
+AC_TYPE_INT32_T
+AC_TYPE_PID_T
+AC_TYPE_SIZE_T
+AC_TYPE_SSIZE_T
+AC_TYPE_UINT16_T
+AC_TYPE_UINT32_T
+AC_TYPE_UINT64_T
+AC_TYPE_UINT8_T
+
+
+##               ##
+## Header checks ##
+##               ##
+
+AC_HEADER_STDBOOL
+AC_CHECK_HEADERS([ \
+       limits.h \
+       stddef.h \
+       sys/param.h \
+       sys/time.h \
+])
+
+
+##                 ##
+## Programs checks ##
+##                 ##
 
-# Checks for programs.
 AC_PROG_AWK
+AC_PROG_GREP
 AC_PROG_MAKE_SET
 AC_CHECK_PROGS(NPROC, [nproc gnproc])
-AC_CHECK_PROGS(GETCONF, [getconf])
+AC_CHECK_PROG(GETCONF, [getconf])
 AS_IF([test "x$NPROC" != "x"],
        [NPROC_CMD=$NPROC],
        [AS_IF([test "x$GETCONF" != "x"],
@@ -72,27 +128,13 @@ AS_IF([test "x$NPROC" != "x"],
 )
 AC_SUBST([NPROC_CMD], [$NPROC_CMD])
 
+# Initialize and configure libtool
 LT_INIT
 
-# Checks for typedefs, structures, and compiler characteristics.
-AC_C_INLINE
-AC_TYPE_PID_T
-AC_TYPE_SIZE_T
-AC_TYPE_SSIZE_T
-AC_TYPE_UINT16_T
-AC_TYPE_INT32_T
-AC_TYPE_UINT32_T
-AC_TYPE_UINT64_T
-AC_TYPE_UINT8_T
-
-AX_C___ATTRIBUTE__
-AS_IF([test "x$ax_cv___attribute__" = "xyes"],
-       [:],
-       [AC_MSG_ERROR([The compiler does not support __attribute__ extensions])])
 
-AX_PTHREAD(,[AC_MSG_ERROR([Could not configure pthreads support])])
-
-AM_CFLAGS="$AM_CFLAGS $PTHREAD_CFLAGS"
+##                ##
+## Library checks ##
+##                ##
 
 # Checks for library functions.
 AC_FUNC_MMAP
@@ -115,158 +157,73 @@ AC_CHECK_FUNCS([ \
 # AC_FUNC_MALLOC causes problems when cross-compiling.
 #AC_FUNC_MALLOC
 
-# Check for headers
-AC_HEADER_STDBOOL
-AC_CHECK_HEADERS([ \
-       limits.h \
-       stddef.h \
-       sys/param.h \
-       sys/time.h \
+# Search for clock_gettime() in -lrt
+AC_SEARCH_LIBS([clock_gettime], [rt], [
+  AC_DEFINE([CONFIG_RCU_HAVE_CLOCK_GETTIME], [1], [clock_gettime() is detected.])
 ])
 
-# Find arch type
-AS_CASE([$host_cpu],
-       [k1om], [ARCHTYPE="x86"],
-       [i386], [ARCHTYPE="x86" && SUBARCHTYPE="x86compat"],
-       [i486], [ARCHTYPE="x86"],
-       [i586], [ARCHTYPE="x86"],
-       [i686], [ARCHTYPE="x86"],
-       [amd64], [ARCHTYPE="x86"],
-       [x86_64], [ARCHTYPE="x86"],
-       [powerpc], [ARCHTYPE="ppc"],
-       [ppc64], [ARCHTYPE="ppc"],
-       [powerpc64], [ARCHTYPE="ppc"],
-       [powerpc64le], [ARCHTYPE="ppc"],
-       [ppc], [ARCHTYPE="ppc"],
-       [s390], [ARCHTYPE="s390"],
-       [s390x], [ARCHTYPE="s390"],
-       [sparc], [ARCHTYPE="sparc64"],
-       [sparc64], [ARCHTYPE="sparc64"],
-       [alpha*], [ARCHTYPE="alpha"],
-       [ia64], [ARCHTYPE="ia64"],
-       [arm*], [ARCHTYPE="arm"],
-       [aarch64*], [ARCHTYPE="aarch64"],
-       [mips*], [ARCHTYPE="mips"],
-       [nios2*], [ARCHTYPE="nios2"],
-       [tile*], [ARCHTYPE="tile"],
-       [hppa*], [ARCHTYPE="hppa"],
-       [m68k], [ARCHTYPE="m68k"],
-       [riscv*], [ARCHTYPE="riscv"],
-       [ARCHTYPE="unknown"]
-)
 
-AS_CASE([$host],[*-cygwin*],
-       [AM_CONDITIONAL(USE_CYGWIN, true)],
-       [AM_CONDITIONAL(USE_CYGWIN, false)]
-)
+##                              ##
+## Optionnal features selection ##
+##                              ##
 
-AC_SUBST(ARCHTYPE)
-AC_SUBST(SUBARCHTYPE)
+# Allow to fallback to FIXME if the membarrier syscall is unavailable on the
+# running kernel, when disabled, abort if the syscall is unavailable. Applies
+# to default and bulletproof flavors.
+# Enabled by default
+AE_FEATURE_DEFAULT_ENABLE
+AE_FEATURE([sys-membarrier-fallback], [Abort if sys-membarrier is needed but not available rather than using a fallback.])
 
-UATOMICSRC=include/urcu/uatomic/$ARCHTYPE.h
-ARCHSRC=include/urcu/arch/$ARCHTYPE.h
+# Use compiler Thread Local Storage, when disabled use pthread_getspecific() to emulate TLS.
+# Enabled by default
+AE_FEATURE_DEFAULT_ENABLE
+AE_FEATURE([compiler-tls], [Use pthread_getspecific() to emulate Thread Local Storage (TLS) variables.])
 
-AS_IF([test "x$SUBARCHTYPE" = xx86compat],[
-       AC_DEFINE([CONFIG_RCU_COMPAT_ARCH], [1])
-])
+# smp-support configure option
+# Enabled by default
+AE_FEATURE_DEFAULT_ENABLE
+AE_FEATURE([smp-support], [Disable SMP support. Warning: only use this on uniprocessor systems.])
+
+# RCU debugging option
+# Disabled by default
+AE_FEATURE_DEFAULT_DISABLE
+AE_FEATURE([rcu-debug], [Enable internal debugging self-checks. Introduces a performance penalty.])
+
+# rculfhash iterator debugging
+# Disabled by default
+AE_FEATURE_DEFAULT_DISABLE
+AE_FEATURE([cds-lfht-iter-debug], [Enable extra debugging checks for lock-free hash table iterator traversal. Alters the rculfhash ABI. Make sure to compile both library and application with matching configuration.])
 
-AS_IF([test "$host_cpu" = "armv7l"],[
-       AM_CFLAGS="$AM_CFLAGS -mcpu=cortex-a9 -mtune=cortex-a9 -O1"
+
+##                                                                    ##
+## Set defines for optional features conditionnals in the source code ##
+##                                                                    ##
+
+AE_IF_FEATURE_DISABLED([sys-membarrier-fallback], [
+  AC_DEFINE([CONFIG_RCU_FORCE_SYS_MEMBARRIER], [1], [Require the operating system to support the membarrier system call for default and bulletproof flavors.])
 ])
 
-# ARM-specific checks
-AS_IF([test "x$ARCHTYPE" = "xarm"],[
-       AC_MSG_CHECKING([for dmb instruction])
-       AC_COMPILE_IFELSE([AC_LANG_SOURCE([[
-                               int main()
-                               {
-                                       asm volatile("dmb":::"memory");
-                                       return 0;
-                               }
-               ]])
-       ],[
-               AC_MSG_RESULT([yes])
-               AC_DEFINE([CONFIG_RCU_ARM_HAVE_DMB], [1])
-       ],[
-               AC_MSG_RESULT([no])
-       ])
+AE_IF_FEATURE_ENABLED([compiler-tls], [
+  AC_DEFINE([CONFIG_RCU_TLS], [1], [Use compiler provided Thread Local Storage.])
 ])
 
-# Tile-specific checks
-AS_IF([echo "$host_cpu" | grep "^tile"],[
-       AC_MSG_CHECKING([for Tile architecture type])
-       AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[
-                               #ifndef __tilegx__
-                               #error
-                               #endif
-               ]])
-       ],[
-               AC_MSG_RESULT([ok])
-       ],[
-               AC_MSG_FAILURE([URCU has only been tested on the TileGx architecture. For other Tile* architectures, please run the tests first and report the results to the maintainer so that proper support can be added.])
-       ])
+AE_IF_FEATURE_ENABLED([smp-support], [
+  AC_DEFINE([CONFIG_RCU_SMP], [1], [Enable SMP support. With SMP support enabled, uniprocessors are also supported. With SMP support disabled, UP systems work fine, but the behavior of SMP systems is undefined.])
 ])
 
-# x86-specific checks
-AS_IF([test "x$ARCHTYPE" = "xx86"],[
-       AC_MSG_CHECKING([if architecture really supports the mfence instruction])
-       #For now, using lock; addl compatibility mode even for i686, because the
-       #Pentium III is seen as a i686, but lacks mfence instruction.
-       #Only using fence for x86_64.
-       #
-       #k1om is the name for the Intel MIC family (Xeon Phi). It is an x86_64
-       #variant but lacks fence instructions.
-       AS_IF([test "x$host_cpu" != "xi386" -a "x$host_cpu" != "xi486" -a "x$host_cpu" != "xi586" -a "x$host_cpu" != "xi686" -a "x$host_vendor" != "xk1om" -a "x$host_cpu" != "xk1om"],[
-               AC_MSG_RESULT([yes])
-               AC_DEFINE([CONFIG_RCU_HAVE_FENCE], [1])
-               config_rcu_have_fence=yes
-       ],[
-               AC_MSG_RESULT([no])
-               config_rcu_have_fence=no
-       ])
+AE_IF_FEATURE_ENABLED([rcu-debug], [
+  AC_DEFINE([CONFIG_RCU_DEBUG], [1], [Enable internal debugging self-checks. Introduces a performance penalty.])
 ])
 
-# Check if sys_futex() is available
-AC_MSG_CHECKING([for sys_futex()])
-AC_COMPILE_IFELSE([AC_LANG_SOURCE([[
-               #include <sys/syscall.h>
-               #ifndef __NR_futex
-               #error "futexes not available"
-               #endif
-       ]])
-],[
-       AC_MSG_RESULT([yes])
-       AC_DEFINE([CONFIG_RCU_HAVE_FUTEX], [1])
-       compat_futex_test=0
-],[
-       AC_MSG_RESULT([no])
-       compat_futex_test=1
+AE_IF_FEATURE_ENABLED([cds-lfht-iter-debug], [
+  AC_DEFINE([CONFIG_CDS_LFHT_ITER_DEBUG], [1], [Enable extra debugging checks for lock-free hash table iterator traversal. Alters the rculfhash ABI. Make sure to compile both library and application with matching configuration.])
 ])
 
-# Search for clock_gettime
-AC_SEARCH_LIBS([clock_gettime], [rt], [
-       AC_DEFINE([CONFIG_RCU_HAVE_CLOCK_GETTIME], [1])
-       config_rcu_have_clock_gettime=yes
-], [])
+AM_CFLAGS="$AM_CFLAGS $PTHREAD_CFLAGS"
 
-AM_CONDITIONAL([COMPAT_FUTEX], [test "x$compat_futex_test" = "x1"])
-AM_CONDITIONAL([COMPAT_ARCH], [test "x$SUBARCHTYPE" = "xx86compat"])
 AM_CONDITIONAL([NO_SHARED], [test "x$enable_shared" = "xno"])
 
-# smp-support configure option
-AC_ARG_ENABLE([smp-support], 
-       AS_HELP_STRING([--disable-smp-support], [Disable SMP support. Warning: only use this on uniprocessor systems. [default=enabled]]),
-       [def_smp_support=$enableval],
-       [def_smp_support="yes"])
-AS_IF([test "x$def_smp_support" = "xyes"], [AC_DEFINE([CONFIG_RCU_SMP], [1])])
 
-# RCU debugging option
-AC_ARG_ENABLE([rcu-debug],
-      AS_HELP_STRING([--enable-rcu-debug], [Enable internal debugging
-                     self-checks. Introduce performance penalty.]))
-AS_IF([test "x$enable_rcu_debug" = "xyes"], [
-       AC_DEFINE([CONFIG_RCU_DEBUG], [1])
-])
 
 # From the sched_setaffinity(2)'s man page:
 # ~~~~
@@ -324,7 +281,7 @@ AC_COMPILE_IFELSE([AC_LANG_SOURCE([[
                #include <sched.h>
                int main()
                {
-                       cpu_set_t foo, mask; CPU_SET(0, &foo);
+                       cpu_set_t foo; CPU_SET(0, &foo);
                        return 0;
                }
        ]])
@@ -370,16 +327,21 @@ AC_CHECK_FUNCS([sched_setaffinity],[
        ])
 ])
 
+##                                             ##
+## Substitute variables for use in Makefile.am ##
+##                                             ##
+
+# Library versions for libtool
+AC_SUBST([URCU_LIBRARY_VERSION], [urcu_lib_version])
+
+AC_SUBST(LT_NO_UNDEFINED)
+
 AM_CPPFLAGS="-include config.h"
 AC_SUBST(AM_CPPFLAGS)
 
-AM_CFLAGS="-Wall $AM_CFLAGS"
+AM_CFLAGS="-Wall -Wextra -Wno-unused-parameter $AM_CFLAGS"
 AC_SUBST(AM_CFLAGS)
 
-AC_CONFIG_LINKS([
-       include/urcu/arch.h:$ARCHSRC
-       include/urcu/uatomic.h:$UATOMICSRC
-])
 AC_CONFIG_FILES([
        Makefile
        doc/Makefile
@@ -481,39 +443,35 @@ PPRINT_SUBTITLE([Features])
 PPRINT_PROP_STRING([Target architecture], $host_cpu)
 
 # SMP support enabled/disabled
-test "x$def_smp_support" = "xyes" && value=1 || value=0
+AE_IS_FEATURE_ENABLED([smp-support]) && value=1 || value=0
 PPRINT_PROP_BOOL([SMP support], $value)
 
-# Memory fence support available
-test "x$config_rcu_have_fence" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL([Memory fence instructions], $value)
-
-# Futex support available
-test "x$compat_futex_test" = "x0" && value=1 || value=0
-PPRINT_PROP_BOOL([Futex support], $value)
-
 # TLS
-test "x$def_tls_detect" = "x" && value="pthread_getspecific()" || value="$def_tls_detect"
+AE_IS_FEATURE_ENABLED([compiler-tls]) && value="compiler TLS" || value="pthread_getspecific()"
 PPRINT_PROP_STRING([Thread Local Storage (TLS)], [$value])
 
 # clock_gettime() available
-test "x$config_rcu_have_clock_gettime" = "xyes" && value=1 || value=0
+test "x$ac_cv_search_function_clock_gettime" != "xno" && value=1 || value=0
 PPRINT_PROP_BOOL([clock_gettime()], $value)
 
 # Require membarrier
-test "x$def_sys_membarrier_fallback" != "xyes" && value=1 || value=0
+AE_IS_FEATURE_ENABLED([sys-membarrier-fallback]) && value=0 || value=1
 PPRINT_PROP_BOOL([Require membarrier], $value)
 
 # RCU debug enabled/disabled
-test "x$enable_rcu_debug" = "xyes" && value=1 || value=0
+AE_IS_FEATURE_ENABLED([rcu-debug]) && value=1 || value=0
 PPRINT_PROP_BOOL([Internal debugging], $value)
 
+# rculfhash iterator debug enabled/disabled
+AE_IS_FEATURE_ENABLED([cds-lfht-iter-debug]) && value=1 || value=0
+PPRINT_PROP_BOOL([Lock-free HT iterator debugging], $value)
+
 PPRINT_PROP_BOOL([Multi-flavor support], 1)
 
 report_bindir="`eval eval echo $bindir`"
 report_libdir="`eval eval echo $libdir`"
 
-# Print the bindir and libdir this `make install' will install into.
+# Print the bindir and libdir this 'make install' will install into.
 AS_ECHO
 PPRINT_SUBTITLE([Install directories])
 PPRINT_PROP_STRING([Binaries], [$report_bindir])
This page took 0.027155 seconds and 4 git commands to generate.